]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/fg_io.cxx
Abstraction for the user's desktop location.
[flightgear.git] / src / Main / fg_io.cxx
index 827993b0c86412adc2377f8efa3565ac69a418ff..cd66cf0c6447a7b689067f5446cc57a286c4f13e 100644 (file)
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
 
 #include <simgear/compiler.h>
 
-#include <stdlib.h>             // atoi()
+#include <cstdlib>             // atoi()
 
-#include STL_STRING
+#include <string>
+#include <algorithm>
 
 #include <simgear/debug/logstream.hxx>
 #include <simgear/io/iochannel.hxx>
@@ -40,6 +44,9 @@
 #include <Network/protocol.hxx>
 #include <Network/ATC-Main.hxx>
 #include <Network/atlas.hxx>
+#include <Network/AV400.hxx>
+#include <Network/AV400Sim.hxx>
+#include <Network/AV400WSim.hxx>
 #include <Network/garmin.hxx>
 #include <Network/httpd.hxx>
 #ifdef FG_JPEG_SERVER
 #include <Network/rul.hxx>
 #include <Network/generic.hxx>
 
-#ifdef FG_MPLAYER_AS
-#include <Network/multiplay.hxx>
+#ifdef FG_HAVE_HLA
+#include <Network/HLA/hla.hxx>
 #endif
 
 #include "globals.hxx"
 #include "fg_io.hxx"
 
-SG_USING_STD(string);
+using std::atoi;
+using std::string;
 
 
 FGIO::FGIO()
 {
 }
 
-#include STL_ALGORITHM
-SG_USING_STD(for_each);
-
-static void delete_ptr( FGProtocol* p ) { delete p; }
 
 FGIO::~FGIO()
 {
-    shutdown_all();
-    for_each( io_channels.begin(), io_channels.end(), delete_ptr );
+
 }
 
 
@@ -91,28 +94,29 @@ FGIO::parse_port_config( const string& config )
 {
     SG_LOG( SG_IO, SG_INFO, "Parse I/O channel request: " << config );
 
-    vector<string> tokens = simgear::strutils::split( config, "," );
+    string_list tokens = simgear::strutils::split( config, "," );
     if (tokens.empty())
     {
-       SG_LOG( SG_IO, SG_ALERT,
-               "Port configuration error: empty config string" );
-       return 0;
+        SG_LOG( SG_IO, SG_ALERT,
+                "Port configuration error: empty config string" );
+        return NULL;
     }
 
     string protocol = tokens[0];
     SG_LOG( SG_IO, SG_INFO, "  protocol = " << protocol );
 
-    FGProtocol *io = 0;
+    FGProtocol *io = NULL;
 
     try
     {
-       if ( protocol == "atcsim" ) {
+        if ( protocol == "atcsim" ) {
             FGATCMain *atcsim = new FGATCMain;
-           atcsim->set_hz( 30 );
+            atcsim->set_hz( 30 );
             if ( tokens.size() != 6 ) {
                 SG_LOG( SG_IO, SG_ALERT, "Usage: --atcsim=[no-]pedals,"
                         << "input0_config,input1_config,"
                         << "output0_config,output1_config,file.nas" );
+                delete atcsim;
                 return NULL;
             }
             if ( tokens[1] == "no-pedals" ) {
@@ -121,92 +125,138 @@ FGIO::parse_port_config( const string& config )
                 fgSetBool( "/input/atcsim/ignore-pedal-controls", false );
             }
             atcsim->set_path_names(tokens[2], tokens[3], tokens[4], tokens[5]);
-           return atcsim;
-       } else if ( protocol == "atlas" ) {
-           FGAtlas *atlas = new FGAtlas;
-           io = atlas;
-       } else if ( protocol == "opengc" ) {
-           // char wait;
-           // printf("Parsed opengc\n"); cin >> wait;
-           FGOpenGC *opengc = new FGOpenGC;
-           io = opengc;
-       } else if ( protocol == "garmin" ) {
-           FGGarmin *garmin = new FGGarmin;
-           io = garmin;
-       } else if ( protocol == "httpd" ) {
-           // determine port
-           string port = tokens[1];
-           return new FGHttpd( atoi(port.c_str()) );
+            return atcsim;
+        } else if ( protocol == "atlas" ) {
+            FGAtlas *atlas = new FGAtlas;
+            io = atlas;
+        } else if ( protocol == "opengc" ) {
+            FGOpenGC *opengc = new FGOpenGC;
+            io = opengc;
+        } else if ( protocol == "AV400" ) {
+            FGAV400 *av400 = new FGAV400;
+            io = av400;
+        } else if ( protocol == "AV400Sim" ) {
+            FGAV400Sim *av400sim = new FGAV400Sim;
+            io = av400sim;
+        } else if ( protocol == "AV400WSimA" ) {
+            FGAV400WSimA *av400wsima = new FGAV400WSimA;
+            io = av400wsima;
+        } else if ( protocol == "AV400WSimB" ) {
+            FGAV400WSimB *av400wsimb = new FGAV400WSimB;
+            io = av400wsimb;
+        } else if ( protocol == "garmin" ) {
+            FGGarmin *garmin = new FGGarmin;
+            io = garmin;
+        } else if ( protocol == "httpd" ) {
+            // determine port
+            string port = tokens[1];
+            return new FGHttpd( atoi(port.c_str()) );
 #ifdef FG_JPEG_SERVER
-       } else if ( protocol == "jpg-httpd" ) {
-           // determine port
-           string port = tokens[1];
-           return new FGJpegHttpd( atoi(port.c_str()) );
+        } else if ( protocol == "jpg-httpd" ) {
+            // determine port
+            string port = tokens[1];
+            return new FGJpegHttpd( atoi(port.c_str()) );
 #endif
-       } else if ( protocol == "joyclient" ) {
-           FGJoyClient *joyclient = new FGJoyClient;
-           io = joyclient;
+        } else if ( protocol == "joyclient" ) {
+            FGJoyClient *joyclient = new FGJoyClient;
+            io = joyclient;
         } else if ( protocol == "jsclient" ) {
             FGJsClient *jsclient = new FGJsClient;
             io = jsclient;
-       } else if ( protocol == "native" ) {
-           FGNative *native = new FGNative;
-           io = native;
-       } else if ( protocol == "native-ctrls" ) {
-           FGNativeCtrls *native_ctrls = new FGNativeCtrls;
-           io = native_ctrls;
-       } else if ( protocol == "native-fdm" ) {
-           FGNativeFDM *native_fdm = new FGNativeFDM;
-           io = native_fdm;
-       } else if ( protocol == "native-gui" ) {
-           FGNativeGUI *net_gui = new FGNativeGUI;
-           io = net_gui;
-       } else if ( protocol == "nmea" ) {
-           FGNMEA *nmea = new FGNMEA;
-           io = nmea;
-       } else if ( protocol == "props" || protocol == "telnet" ) {
-           io = new FGProps( tokens );
-           return io;
-       } else if ( protocol == "pve" ) {
-           FGPVE *pve = new FGPVE;
-           io = pve;
-       } else if ( protocol == "ray" ) {
-           FGRAY *ray = new FGRAY;
-           io = ray;
-       } else if ( protocol == "rul" ) {
-           FGRUL *rul = new FGRUL;
-           io = rul;
+        } else if ( protocol == "native" ) {
+            FGNative *native = new FGNative;
+            io = native;
+        } else if ( protocol == "native-ctrls" ) {
+            FGNativeCtrls *native_ctrls = new FGNativeCtrls;
+            io = native_ctrls;
+        } else if ( protocol == "native-fdm" ) {
+            FGNativeFDM *native_fdm = new FGNativeFDM;
+            io = native_fdm;
+        } else if ( protocol == "native-gui" ) {
+            FGNativeGUI *net_gui = new FGNativeGUI;
+            io = net_gui;
+        } else if ( protocol == "nmea" ) {
+            FGNMEA *nmea = new FGNMEA;
+            io = nmea;
+        } else if ( protocol == "props" || protocol == "telnet" ) {
+            io = new FGProps( tokens );
+            return io;
+        } else if ( protocol == "pve" ) {
+            FGPVE *pve = new FGPVE;
+            io = pve;
+        } else if ( protocol == "ray" ) {
+            FGRAY *ray = new FGRAY;
+            io = ray;
+        } else if ( protocol == "rul" ) {
+            FGRUL *rul = new FGRUL;
+            io = rul;
         } else if ( protocol == "generic" ) {
-            int n = 6;
-            if (tokens[1] == "socket")  n++;
-            else if (tokens[1] == "file") n--;
-            FGGeneric *generic = new FGGeneric( tokens[n] );
+            FGGeneric *generic = new FGGeneric( tokens );
+            if (!generic->getInitOk())
+            {
+                // failed to initialize (i.e. invalid configuration)
+                delete generic;
+                return NULL;
+            }
             io = generic;
+        } else if ( protocol == "multiplay" ) {
+            if ( tokens.size() != 5 ) {
+                SG_LOG( SG_IO, SG_ALERT, "Ignoring invalid --multiplay option "
+                        "(4 arguments expected: --multiplay=dir,hz,hostname,port)" );
+                return NULL;
+            }
+            string dir = tokens[1];
+            int rate = atoi(tokens[2].c_str());
+            string host = tokens[3];
+
+            short port = atoi(tokens[4].c_str());
+
+            // multiplay used to be handled by an FGProtocol, but no longer. This code
+            // retains compatibility with existing command-line syntax
+            fgSetInt("/sim/multiplay/tx-rate-hz", rate);
+            if (dir == "in") {
+                fgSetInt("/sim/multiplay/rxport", port);
+                fgSetString("/sim/multiplay/rxhost", host.c_str());
+            } else if (dir == "out") {
+                fgSetInt("/sim/multiplay/txport", port);
+                fgSetString("/sim/multiplay/txhost", host.c_str());
+            }
 
-#ifdef FG_MPLAYER_AS
-       } else if ( protocol == "multiplay" ) {\
-           //Determine dir, rate, host & port
-           string dir = tokens[1];
-           string rate = tokens[2];
-           string host = tokens[3];
-           string port = tokens[4];
-           return new FGMultiplay(dir, atoi(rate.c_str()), host, atoi(port.c_str()));
+            return NULL;
+        }
+#ifdef FG_HAVE_HLA
+        else if ( protocol == "hla" ) {
+            return new FGHLA(tokens);
+        }
+        else if ( protocol == "hla-local" ) {
+            // This is just about to bring up some defaults
+            if (tokens.size() != 2) {
+                SG_LOG( SG_IO, SG_ALERT, "Ignoring invalid --hla-local option "
+                        "(one argument expected: --hla-local=<federationname>" );
+                return NULL;
+            }
+            tokens.insert(tokens.begin(), "");
+            tokens.insert(tokens.begin(), "60");
+            tokens.insert(tokens.begin(), "bi");
+            tokens.push_back("fg-local.xml");
+            return new FGHLA(tokens);
+        }
 #endif
-
-       } else {
-           return NULL;
-       }
+        else {
+            return NULL;
+        }
     }
     catch (FGProtocolConfigError& err)
     {
-       SG_LOG( SG_IO, SG_ALERT, "Port configuration error: " << err.what() );
-       delete io;
-       return 0;
+        SG_LOG( SG_IO, SG_ALERT, "Port configuration error: " << err.what() );
+        delete io;
+        return NULL;
     }
-    
+
     if (tokens.size() < 3) {
-      SG_LOG( SG_IO, SG_ALERT, "Incompatible number of network arguments.");
-      return NULL;
+        SG_LOG( SG_IO, SG_ALERT, "Incompatible number of network arguments.");
+        delete io;
+        return NULL;
     }
     string medium = tokens[1];
     SG_LOG( SG_IO, SG_INFO, "  medium = " << medium );
@@ -222,45 +272,71 @@ FGIO::parse_port_config( const string& config )
 
     if ( medium == "serial" ) {
         if ( tokens.size() < 5) {
-          SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for serial communications.");
-         return NULL;
+            SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for serial communications.");
+            delete io;
+            return NULL;
         }
-       // device name
-       string device = tokens[4];
-       SG_LOG( SG_IO, SG_INFO, "  device = " << device );
+        // device name
+        string device = tokens[4];
+        SG_LOG( SG_IO, SG_INFO, "  device = " << device );
+
+        // baud
+        string baud = tokens[5];
+        SG_LOG( SG_IO, SG_INFO, "  baud = " << baud );
+
 
-       // baud
-       string baud = tokens[5];
-       SG_LOG( SG_IO, SG_INFO, "  baud = " << baud );
+        SGSerial *ch = new SGSerial( device, baud );
+        io->set_io_channel( ch );
 
-       SGSerial *ch = new SGSerial( device, baud );
-       io->set_io_channel( ch );
+        if ( protocol == "AV400WSimB" ) {
+            if ( tokens.size() < 7 ) {
+                SG_LOG( SG_IO, SG_ALERT, "Missing second hz for AV400WSimB.");
+                delete io;
+                return NULL;
+            }
+            FGAV400WSimB *fgavb = static_cast<FGAV400WSimB*>(io);
+            string hz2_str = tokens[6];
+            double hz2 = atof(hz2_str.c_str());
+            fgavb->set_hz2(hz2);
+        }
     } else if ( medium == "file" ) {
-       // file name
+        // file name
         if ( tokens.size() < 4) {
-          SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for file I/O.");
-         return NULL;
+            SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for file I/O.");
+            delete io;
+            return NULL;
         }
-         
-       string file = tokens[4];
-       SG_LOG( SG_IO, SG_INFO, "  file name = " << file );
 
-       SGFile *ch = new SGFile( file );
-       io->set_io_channel( ch );
+        string file = tokens[4];
+        SG_LOG( SG_IO, SG_INFO, "  file name = " << file );
+        int repeat = 1;
+        if (tokens.size() >= 7 && tokens[6] == "repeat") {
+            if (tokens.size() >= 8) {
+                repeat = atoi(tokens[7].c_str());
+                FGGeneric* generic = dynamic_cast<FGGeneric*>(io);
+                if (generic)
+                    generic->setExitOnError(true);
+            } else {
+                repeat = -1;
+            }
+        }
+        SGFile *ch = new SGFile( file, repeat );
+        io->set_io_channel( ch );
     } else if ( medium == "socket" ) {
         if ( tokens.size() < 6) {
-          SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for socket communications.");
-         return NULL;
+            SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for socket communications.");
+            delete io;
+            return NULL;
         }
-       string hostname = tokens[4];
-       string port = tokens[5];
-       string style = tokens[6];
+        string hostname = tokens[4];
+        string port = tokens[5];
+        string style = tokens[6];
 
-       SG_LOG( SG_IO, SG_INFO, "  hostname = " << hostname );
-       SG_LOG( SG_IO, SG_INFO, "  port = " << port );
-       SG_LOG( SG_IO, SG_INFO, "  style = " << style );
+        SG_LOG( SG_IO, SG_INFO, "  hostname = " << hostname );
+        SG_LOG( SG_IO, SG_INFO, "  port = " << port );
+        SG_LOG( SG_IO, SG_INFO, "  style = " << style );
 
-       io->set_io_channel( new SGSocket( hostname, port, style ) );
+        io->set_io_channel( new SGSocket( hostname, port, style ) );
     }
 
     return io;
@@ -275,81 +351,90 @@ FGIO::init()
     // SG_LOG( SG_IO, SG_INFO, "I/O Channel initialization, " <<
     //         globals->get_channel_options_list()->size() << " requests." );
 
-    FGProtocol *p;
+    _realDeltaTime = fgGetNode("/sim/time/delta-realtime-sec");
 
     // we could almost do this in a single step except pushing a valid
     // port onto the port list copies the structure and destroys the
     // original, which closes the port and frees up the fd ... doh!!!
 
-    // parse the configuration strings and store the results in the
-    // appropriate FGIOChannel structures
-    typedef vector<string> container;
-    container::iterator i = globals->get_channel_options_list()->begin();
-    container::iterator end = globals->get_channel_options_list()->end();
-    for (; i != end; ++i )
+    string_list::iterator i = globals->get_channel_options_list()->begin();
+    string_list::iterator end = globals->get_channel_options_list()->end();
+    for (; i != end; ++i ) {
+        add_channel( *i );
+    } // of channel options iteration
+}
+
+// add another I/O channel
+void FGIO::add_channel(const string& config)
+{
+    // parse the configuration string and store the results in the
+    // appropriate FGIOChannel structure
+    FGProtocol *p = parse_port_config( config );
+    if (!p)
     {
-       p = parse_port_config( *i );
-       if ( p != NULL ) {
-           p->open();
-           io_channels.push_back( p );
-           if ( !p->is_enabled() ) {
-               SG_LOG( SG_IO, SG_ALERT, "I/O Channel config failed." );
-               exit(-1);
-           }
-       } else {
-           SG_LOG( SG_IO, SG_INFO, "I/O Channel parse failed." );
-       }
+        return;
     }
+
+    p->open();
+    if ( !p->is_enabled() ) {
+        SG_LOG( SG_IO, SG_ALERT, "I/O Channel config failed." );
+        delete p;
+        return;
+    }
+
+    io_channels.push_back( p );
 }
 
+void
+FGIO::reinit()
+{
+}
 
 // process any IO channel work
 void
-FGIO::update( double delta_time_sec )
+FGIO::update( double /* delta_time_sec */ )
 {
-    // cout << "processing I/O channels" << endl;
-    // cout << "  Elapsed time = " << delta_time_sec << endl;
+    // use wall-clock, not simulation, delta time, so that network
+    // protocols update when the simulation is paused
+    // see http://code.google.com/p/flightgear-bugs/issues/detail?id=125
+    double delta_time_sec = _realDeltaTime->getDoubleValue();
 
-    typedef vector< FGProtocol* > container;
-    container::iterator i = io_channels.begin();
-    container::iterator end = io_channels.end();
+    ProtocolVec::iterator i = io_channels.begin();
+    ProtocolVec::iterator end = io_channels.end();
     for (; i != end; ++i ) {
-       FGProtocol* p = *i;
-
-       if ( p->is_enabled() ) {
-           p->dec_count_down( delta_time_sec );
-           double dt = 1 / p->get_hz();
-           if ( p->get_count_down() < 0.33 * dt ) {
-             p->process();
-             p->inc_count();
-             while ( p->get_count_down() < 0.33 * dt ) {
-               p->inc_count_down( dt );
-             }
-             // double ave = elapsed_time / p->get_count();
-             // cout << "  ave rate = " << ave << endl;
-           }
-       }
-    }
-}
+        FGProtocol* p = *i;
+        if (!p->is_enabled()) {
+            continue;
+        }
 
+        p->dec_count_down( delta_time_sec );
+        double dt = 1 / p->get_hz();
+        if ( p->get_count_down() < 0.33 * dt ) {
+            p->process();
+            p->inc_count();
+            while ( p->get_count_down() < 0.33 * dt ) {
+                p->inc_count_down( dt );
+            }
+        } // of channel processing
+    } // of io_channels iteration
+}
 
 void
-FGIO::shutdown_all() {
-    FGProtocol *p;
-
-    // cout << "shutting down all I/O channels" << endl;
-
-    typedef vector< FGProtocol* > container;
-    container::iterator i = io_channels.begin();
-    container::iterator end = io_channels.end();
+FGIO::shutdown()
+{
+    ProtocolVec::iterator i = io_channels.begin();
+    ProtocolVec::iterator end = io_channels.end();
     for (; i != end; ++i )
     {
-       p = *i;
+        FGProtocol *p = *i;
+        if ( p->is_enabled() ) {
+            p->close();
+        }
 
-       if ( p->is_enabled() ) {
-           p->close();
-       }
+        delete p;
     }
+
+    io_channels.clear();
 }
 
 void
@@ -361,4 +446,3 @@ void
 FGIO::unbind()
 {
 }
-