src/Main/fg_init.cxx

   1 // fg_init.cxx -- Flight Gear top level initialization routines
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>             // strcmp()
  31
  32 #ifdef _WIN32
  33 #  include <io.h>               // isatty()
  34 #  define isatty _isatty
  35 #endif
  36
  37 #include <simgear/compiler.h>
  38
  39 #include <string>
  40 #include <boost/algorithm/string/compare.hpp>
  41 #include <boost/algorithm/string/predicate.hpp>
  42
  43 #include <simgear/constants.h>
  44 #include <simgear/debug/logstream.hxx>
  45 #include <simgear/structure/exception.hxx>
  46 #include <simgear/structure/event_mgr.hxx>
  47 #include <simgear/structure/SGPerfMon.hxx>
  48 #include <simgear/misc/sg_path.hxx>
  49 #include <simgear/misc/sg_dir.hxx>
  50 #include <simgear/misc/sgstream.hxx>
  51 #include <simgear/misc/strutils.hxx>
  52 #include <simgear/props/props_io.hxx>
  53
  54 #include <simgear/scene/material/matlib.hxx>
  55 #include <simgear/scene/model/particles.hxx>
  56 #include <simgear/scene/tsync/terrasync.hxx>
  57
  58 #include <Aircraft/controls.hxx>
  59 #include <Aircraft/replay.hxx>
  60 #include <Aircraft/FlightHistory.hxx>
  61 #include <Airports/runways.hxx>
  62 #include <Airports/airport.hxx>
  63 #include <Airports/dynamics.hxx>
  64
  65 #include <AIModel/AIManager.hxx>
  66
  67 #include <ATCDCL/ATISmgr.hxx>
  68 #include <ATC/atc_mgr.hxx>
  69
  70 #include <Autopilot/route_mgr.hxx>
  71 #include <Autopilot/autopilotgroup.hxx>
  72
  73 #include <Cockpit/panel.hxx>
  74 #include <Cockpit/panel_io.hxx>
  75
  76 #include <Canvas/canvas_mgr.hxx>
  77 #include <Canvas/gui_mgr.hxx>
  78 #include <GUI/new_gui.hxx>
  79 #include <Input/input.hxx>
  80 #include <Instrumentation/instrument_mgr.hxx>
  81 #include <Model/acmodel.hxx>
  82 #include <Model/modelmgr.hxx>
  83 #include <AIModel/submodel.hxx>
  84 #include <AIModel/AIManager.hxx>
  85 #include <Navaids/navdb.hxx>
  86 #include <Navaids/navlist.hxx>
  87 #include <Scenery/scenery.hxx>
  88 #include <Scenery/tilemgr.hxx>
  89 #include <Scripting/NasalSys.hxx>
  90 #include <Sound/voice.hxx>
  91 #include <Sound/soundmanager.hxx>
  92 #include <Systems/system_mgr.hxx>
  93 #include <Time/light.hxx>
  94 #include <Traffic/TrafficMgr.hxx>
  95 #include <MultiPlayer/multiplaymgr.hxx>
  96 #include <FDM/fdm_shell.hxx>
  97 #include <Environment/ephemeris.hxx>
  98 #include <Environment/environment_mgr.hxx>
  99 #include <Viewer/renderer.hxx>
 100 #include <Viewer/viewmgr.hxx>
 101 #include <Navaids/NavDataCache.hxx>
 102 #include <Instrumentation/HUD/HUD.hxx>
 103 #include <Cockpit/cockpitDisplayManager.hxx>
 104 #include <Network/HTTPClient.hxx>
 105 #include <Network/fgcom.hxx>
 106
 107 #include "fg_init.hxx"
 108 #include "fg_io.hxx"
 109 #include "fg_commands.hxx"
 110 #include "fg_props.hxx"
 111 #include "FGInterpolator.hxx"
 112 #include "options.hxx"
 113 #include "globals.hxx"
 114 #include "logger.hxx"
 115 #include "main.hxx"
 116 #include "positioninit.hxx"
 117 #include "util.hxx"
 118
 119 using std::string;
 120 using std::endl;
 121 using std::cerr;
 122 using std::cout;
 123 using namespace boost::algorithm;
 124
 125
 126 // Return the current base package version
 127 string fgBasePackageVersion() {
 128     SGPath base_path( globals->get_fg_root() );
 129     base_path.append("version");
 130
 131     sg_gzifstream in( base_path.str() );
 132     if ( !in.is_open() ) {
 133         SGPath old_path( globals->get_fg_root() );
 134         old_path.append( "Thanks" );
 135         sg_gzifstream old( old_path.str() );
 136         if ( !old.is_open() ) {
 137             return "[none]";
 138         } else {
 139             return "[old version]";
 140         }
 141     }
 142
 143     string version;
 144     in >> version;
 145
 146     return version;
 147 }
 148
 149
 150 template <class T>
 151 bool fgFindAircraftInDir(const SGPath& dirPath, T* obj, bool (T::*pred)(const SGPath& p))
 152 {
 153   if (!dirPath.exists()) {
 154     SG_LOG(SG_GENERAL, SG_WARN, "fgFindAircraftInDir: no such path:" << dirPath.str());
 155     return false;
 156   }
 157
 158   bool recurse = true;
 159   simgear::Dir dir(dirPath);
 160   simgear::PathList setFiles(dir.children(simgear::Dir::TYPE_FILE, "-set.xml"));
 161   simgear::PathList::iterator p;
 162   for (p = setFiles.begin(); p != setFiles.end(); ++p) {
 163     // check file name ends with -set.xml
 164
 165     // if we found a -set.xml at this level, don't recurse any deeper
 166     recurse = false;
 167
 168     bool done = (obj->*pred)(*p);
 169     if (done) {
 170       return true;
 171     }
 172   } // of -set.xml iteration
 173
 174   if (!recurse) {
 175     return false;
 176   }
 177
 178   simgear::PathList subdirs(dir.children(simgear::Dir::TYPE_DIR | simgear::Dir::NO_DOT_OR_DOTDOT));
 179   for (p = subdirs.begin(); p != subdirs.end(); ++p) {
 180     if (p->file() == "CVS") {
 181       continue;
 182     }
 183
 184     if (fgFindAircraftInDir(*p, obj, pred)) {
 185       return true;
 186     }
 187   } // of subdirs iteration
 188
 189   return false;
 190 }
 191
 192 template <class T>
 193 void fgFindAircraft(T* obj, bool (T::*pred)(const SGPath& p))
 194 {
 195   const string_list& paths(globals->get_aircraft_paths());
 196   string_list::const_iterator it = paths.begin();
 197   for (; it != paths.end(); ++it) {
 198     bool done = fgFindAircraftInDir(SGPath(*it), obj, pred);
 199     if (done) {
 200       return;
 201     }
 202   } // of aircraft paths iteration
 203
 204   // if we reach this point, search the default location (always last)
 205   SGPath rootAircraft(globals->get_fg_root());
 206   rootAircraft.append("Aircraft");
 207   fgFindAircraftInDir(rootAircraft, obj, pred);
 208 }
 209
 210 class FindAndCacheAircraft
 211 {
 212 public:
 213   FindAndCacheAircraft(SGPropertyNode* autoSave)
 214   {
 215     _cache = autoSave->getNode("sim/startup/path-cache", true);
 216   }
 217
 218   bool loadAircraft()
 219   {
 220     std::string aircraft = fgGetString( "/sim/aircraft", "");
 221     if (aircraft.empty()) {
 222       SG_LOG(SG_GENERAL, SG_ALERT, "no aircraft specified");
 223       return false;
 224     }
 225
 226     _searchAircraft = aircraft + "-set.xml";
 227     std::string aircraftDir = fgGetString("/sim/aircraft-dir", "");
 228     if (!aircraftDir.empty()) {
 229       // aircraft-dir was set, skip any searching at all, if it's valid
 230       simgear::Dir acPath(aircraftDir);
 231       SGPath setFile = acPath.file(_searchAircraft);
 232       if (setFile.exists()) {
 233         SG_LOG(SG_GENERAL, SG_INFO, "found aircraft in dir: " << aircraftDir );
 234
 235         try {
 236           readProperties(setFile.str(), globals->get_props());
 237         } catch ( const sg_exception &e ) {
 238           SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
 239           return false;
 240         }
 241
 242         return true;
 243       } else {
 244         SG_LOG(SG_GENERAL, SG_ALERT, "aircraft '" << _searchAircraft <<
 245                "' not found in specified dir:" << aircraftDir);
 246         return false;
 247       }
 248     }
 249
 250     if (!checkCache()) {
 251       // prepare cache for re-scan
 252       SGPropertyNode *n = _cache->getNode("fg-root", true);
 253       n->setStringValue(globals->get_fg_root().c_str());
 254       n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 255       n = _cache->getNode("fg-aircraft", true);
 256       n->setStringValue(getAircraftPaths().c_str());
 257       n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 258       _cache->removeChildren("aircraft");
 259
 260       fgFindAircraft(this, &FindAndCacheAircraft::checkAircraft);
 261     }
 262
 263     if (_foundPath.str().empty()) {
 264       SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find specified aircraft: " << aircraft );
 265       return false;
 266     }
 267
 268     SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft -set file from:" << _foundPath.str());
 269     fgSetString( "/sim/aircraft-dir", _foundPath.dir().c_str());
 270     if (!_foundPath.exists()) {
 271       SG_LOG(SG_GENERAL, SG_ALERT, "Unable to find -set file:" << _foundPath.str());
 272       return false;
 273     }
 274
 275     try {
 276       readProperties(_foundPath.str(), globals->get_props());
 277     } catch ( const sg_exception &e ) {
 278       SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
 279       return false;
 280     }
 281
 282     return true;
 283   }
 284
 285 private:
 286   SGPath getAircraftPaths() {
 287     string_list pathList = globals->get_aircraft_paths();
 288     SGPath aircraftPaths;
 289     string_list::const_iterator it = pathList.begin();
 290     if (it != pathList.end()) {
 291         aircraftPaths.set(*it);
 292         it++;
 293     }
 294     for (; it != pathList.end(); ++it) {
 295         aircraftPaths.add(*it);
 296     }
 297     return aircraftPaths;
 298   }
 299
 300   bool checkCache()
 301   {
 302     if (globals->get_fg_root() != _cache->getStringValue("fg-root", "")) {
 303       return false; // cache mismatch
 304     }
 305
 306     if (getAircraftPaths().str() != _cache->getStringValue("fg-aircraft", "")) {
 307       return false; // cache mismatch
 308     }
 309
 310     vector<SGPropertyNode_ptr> cache = _cache->getChildren("aircraft");
 311     for (unsigned int i = 0; i < cache.size(); i++) {
 312       const char *name = cache[i]->getStringValue("file", "");
 313       if (!boost::equals(_searchAircraft, name, is_iequal())) {
 314         continue;
 315       }
 316
 317       SGPath xml(cache[i]->getStringValue("path", ""));
 318       xml.append(name);
 319       if (xml.exists()) {
 320         _foundPath = xml;
 321         return true;
 322       }
 323
 324       return false;
 325     } // of aircraft in cache iteration
 326
 327     return false;
 328   }
 329
 330   bool checkAircraft(const SGPath& p)
 331   {
 332     // create cache node
 333     int i = 0;
 334     while (1) {
 335         if (!_cache->getChild("aircraft", i++, false))
 336             break;
 337     }
 338
 339     SGPropertyNode *n, *entry = _cache->getChild("aircraft", --i, true);
 340
 341     std::string fileName(p.file());
 342     n = entry->getNode("file", true);
 343     n->setStringValue(fileName);
 344     n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 345
 346     n = entry->getNode("path", true);
 347     n->setStringValue(p.dir());
 348     n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 349
 350     if ( boost::equals(fileName, _searchAircraft.c_str(), is_iequal()) ) {
 351         _foundPath = p;
 352         return true;
 353     }
 354
 355     return false;
 356   }
 357
 358   std::string _searchAircraft;
 359   SGPath _foundPath;
 360   SGPropertyNode* _cache;
 361 };
 362
 363 #ifdef _WIN32
 364 static SGPath platformDefaultDataPath()
 365 {
 366   char *envp = ::getenv( "APPDATA" );
 367   SGPath config( envp );
 368   config.append( "flightgear.org" );
 369   return config;
 370 }
 371
 372 #elif __APPLE__
 373 #include <CoreServices/CoreServices.h>
 374
 375 static SGPath platformDefaultDataPath()
 376 {
 377   FSRef ref;
 378   OSErr err = FSFindFolder(kUserDomain, kApplicationSupportFolderType, false, &ref);
 379   if (err) {
 380     return SGPath();
 381   }
 382
 383   unsigned char path[1024];
 384   if (FSRefMakePath(&ref, path, 1024) != noErr) {
 385     return SGPath();
 386   }
 387
 388   SGPath appData;
 389   appData.set((const char*) path);
 390   appData.append("FlightGear");
 391   return appData;
 392 }
 393 #else
 394 static SGPath platformDefaultDataPath()
 395 {
 396   return SGPath::home() / ".fgfs";
 397 }
 398 #endif
 399
 400 void fgInitHome()
 401 {
 402   SGPath dataPath = SGPath::fromEnv("FG_HOME", platformDefaultDataPath());
 403   globals->set_fg_home(dataPath.c_str());
 404
 405     simgear::Dir fgHome(dataPath);
 406     if (!fgHome.exists()) {
 407         fgHome.create(0755);
 408     }
 409 }
 410
 411 // Read in configuration (file and command line)
 412 int fgInitConfig ( int argc, char **argv )
 413 {
 414     SGPath dataPath = globals->get_fg_home();
 415
 416     simgear::Dir exportDir(simgear::Dir(dataPath).file("Export"));
 417     if (!exportDir.exists()) {
 418       exportDir.create(0777);
 419     }
 420
 421     // Set /sim/fg-home and don't allow malign code to override it until
 422     // Nasal security is set up.  Use FG_HOME if necessary.
 423     SGPropertyNode *home = fgGetNode("/sim", true);
 424     home->removeChild("fg-home", 0, false);
 425     home = home->getChild("fg-home", 0, true);
 426     home->setStringValue(dataPath.c_str());
 427     home->setAttribute(SGPropertyNode::WRITE, false);
 428
 429     flightgear::Options* options = flightgear::Options::sharedInstance();
 430     options->init(argc, argv, dataPath);
 431     bool loadDefaults = flightgear::Options::sharedInstance()->shouldLoadDefaultConfig();
 432     if (loadDefaults) {
 433       // Read global preferences from $FG_ROOT/preferences.xml
 434       SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences");
 435       fgLoadProps("preferences.xml", globals->get_props());
 436       SG_LOG(SG_INPUT, SG_INFO, "Finished Reading global preferences");
 437
 438       // do not load user settings when reset to default is requested
 439       if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults"))
 440       {
 441           SG_LOG(SG_ALL, SG_ALERT, "Ignoring user settings. Restoring defaults.");
 442       }
 443       else
 444       {
 445           globals->loadUserSettings(dataPath);
 446       }
 447     } else {
 448       SG_LOG(SG_GENERAL, SG_INFO, "not reading default configuration files");
 449     }// of no-default-config selected
 450
 451     // Scan user config files and command line for a specified aircraft.
 452     options->initAircraft();
 453
 454     FindAndCacheAircraft f(globals->get_props());
 455     if (!f.loadAircraft()) {
 456       return flightgear::FG_OPTIONS_ERROR;
 457     }
 458
 459     // parse options after loading aircraft to ensure any user
 460     // overrides of defaults are honored.
 461     return options->processOptions();
 462 }
 463
 464
 465
 466 /**
 467  * Initialize vor/ndb/ils/fix list management and query systems (as
 468  * well as simple airport db list)
 469  * This is called multiple times in the case of a cache rebuild,
 470  * to allow length caching to take place in the background, without
 471  * blocking the main/UI thread.
 472  */
 473 bool
 474 fgInitNav ()
 475 {
 476   flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
 477   static bool doingRebuild = false;
 478   if (doingRebuild || cache->isRebuildRequired()) {
 479     doingRebuild = true;
 480     bool finished = cache->rebuild();
 481     if (!finished) {
 482       // sleep to give the rebuild thread more time
 483       SGTimeStamp::sleepForMSec(50);
 484       return false;
 485     }
 486   }
 487
 488   FGTACANList *channellist = new FGTACANList;
 489   globals->set_channellist( channellist );
 490
 491   SGPath path(globals->get_fg_root());
 492   path.append( "Navaids/TACAN_freq.dat" );
 493   flightgear::loadTacan(path, channellist);
 494
 495   return true;
 496 }
 497
 498 // General house keeping initializations
 499 bool fgInitGeneral() {
 500     string root;
 501
 502     SG_LOG( SG_GENERAL, SG_INFO, "General Initialization" );
 503     SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
 504
 505     root = globals->get_fg_root();
 506     if ( ! root.length() ) {
 507         // No root path set? Then bail ...
 508         SG_LOG( SG_GENERAL, SG_ALERT,
 509                 "Cannot continue without a path to the base package "
 510                 << "being defined." );
 511         return false;
 512     }
 513     SG_LOG( SG_GENERAL, SG_INFO, "FG_ROOT = " << '"' << root << '"' << endl );
 514
 515     // Note: browser command is hard-coded for Mac/Windows, so this only affects other platforms
 516     globals->set_browser(fgGetString("/sim/startup/browser-app", WEB_BROWSER));
 517     fgSetString("/sim/startup/browser-app", globals->get_browser());
 518
 519     simgear::Dir cwd(simgear::Dir::current());
 520     SGPropertyNode *curr = fgGetNode("/sim", true);
 521     curr->removeChild("fg-current", 0, false);
 522     curr = curr->getChild("fg-current", 0, true);
 523     curr->setStringValue(cwd.path().str());
 524     curr->setAttribute(SGPropertyNode::WRITE, false);
 525
 526     fgSetBool("/sim/startup/stdout-to-terminal", isatty(1) != 0 );
 527     fgSetBool("/sim/startup/stderr-to-terminal", isatty(2) != 0 );
 528     return true;
 529 }
 530
 531 // Write various configuraton values out to the logs
 532 void fgOutputSettings()
 533 {
 534     SG_LOG( SG_GENERAL, SG_INFO, "Configuration State" );
 535     SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
 536
 537     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"' );
 538     SG_LOG( SG_GENERAL, SG_INFO, "fghome-dir = " << '"' << globals->get_fg_home() << '"');
 539     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"');
 540
 541     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-search-paths = \n\t" << simgear::strutils::join(globals->get_aircraft_paths(), "\n\t") );
 542     SG_LOG( SG_GENERAL, SG_INFO, "scenery-search-paths = \n\t" << simgear::strutils::join(globals->get_fg_scenery(), "\n\t") );
 543 }
 544
 545 // This is the top level init routine which calls all the other
 546 // initialization routines.  If you are adding a subsystem to flight
 547 // gear, its initialization call should located in this routine.
 548 // Returns non-zero if a problem encountered.
 549 void fgCreateSubsystems() {
 550
 551     SG_LOG( SG_GENERAL, SG_INFO, "Creating Subsystems");
 552     SG_LOG( SG_GENERAL, SG_INFO, "========== ==========");
 553
 554     ////////////////////////////////////////////////////////////////////
 555     // Initialize the sound subsystem.
 556     ////////////////////////////////////////////////////////////////////
 557     // Sound manager uses an own subsystem group "SOUND" which is the last
 558     // to be updated in every loop.
 559     // Sound manager is updated last so it can use the CPU while the GPU
 560     // is processing the scenery (doubled the frame-rate for me) -EMH-
 561     globals->add_subsystem("sound", new FGSoundManager, SGSubsystemMgr::SOUND);
 562
 563     ////////////////////////////////////////////////////////////////////
 564     // Initialize the event manager subsystem.
 565     ////////////////////////////////////////////////////////////////////
 566
 567     globals->get_event_mgr()->init();
 568     globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
 569
 570     ////////////////////////////////////////////////////////////////////
 571     // Initialize the property interpolator subsystem. Put into the INIT
 572     // group because the "nasal" subsystem may need it at GENERAL take-down.
 573     ////////////////////////////////////////////////////////////////////
 574     FGInterpolator* interp = new FGInterpolator;
 575     interp->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
 576     globals->add_subsystem("prop-interpolator", interp, SGSubsystemMgr::INIT);
 577     SGPropertyNode::setInterpolationMgr(interp);
 578
 579     ////////////////////////////////////////////////////////////////////
 580     // Add the FlightGear property utilities.
 581     ////////////////////////////////////////////////////////////////////
 582     globals->add_subsystem("properties", new FGProperties);
 583
 584
 585     ////////////////////////////////////////////////////////////////////
 586     // Add the performance monitoring system.
 587     ////////////////////////////////////////////////////////////////////
 588     globals->add_subsystem("performance-mon",
 589             new SGPerformanceMonitor(globals->get_subsystem_mgr(),
 590                                      fgGetNode("/sim/performance-monitor", true)));
 591
 592     ////////////////////////////////////////////////////////////////////
 593     // Initialize the material property subsystem.
 594     ////////////////////////////////////////////////////////////////////
 595
 596     SGPath mpath( globals->get_fg_root() );
 597     mpath.append( fgGetString("/sim/rendering/materials-file") );
 598     if ( ! globals->get_matlib()->load(globals->get_fg_root(), mpath.str(),
 599             globals->get_props()) ) {
 600         throw sg_io_exception("Error loading materials file", mpath);
 601     }
 602
 603     globals->add_subsystem( "http", new FGHTTPClient );
 604
 605     ////////////////////////////////////////////////////////////////////
 606     // Initialize the scenery management subsystem.
 607     ////////////////////////////////////////////////////////////////////
 608
 609     globals->get_scenery()->get_scene_graph()
 610         ->addChild(simgear::Particles::getCommonRoot());
 611     simgear::GlobalParticleCallback::setSwitch(fgGetNode("/sim/rendering/particles", true));
 612
 613     ////////////////////////////////////////////////////////////////////
 614     // Initialize the flight model subsystem.
 615     ////////////////////////////////////////////////////////////////////
 616
 617     globals->add_subsystem("flight", new FDMShell, SGSubsystemMgr::FDM);
 618
 619     ////////////////////////////////////////////////////////////////////
 620     // Initialize the weather subsystem.
 621     ////////////////////////////////////////////////////////////////////
 622
 623     // Initialize the weather modeling subsystem
 624     globals->add_subsystem("environment", new FGEnvironmentMgr);
 625     globals->add_subsystem("ephemeris", new Ephemeris);
 626
 627     ////////////////////////////////////////////////////////////////////
 628     // Initialize the aircraft systems and instrumentation (before the
 629     // autopilot.)
 630     ////////////////////////////////////////////////////////////////////
 631
 632     globals->add_subsystem("systems", new FGSystemMgr, SGSubsystemMgr::FDM);
 633     globals->add_subsystem("instrumentation", new FGInstrumentMgr, SGSubsystemMgr::FDM);
 634     globals->add_subsystem("hud", new HUD, SGSubsystemMgr::DISPLAY);
 635     globals->add_subsystem("cockpit-displays", new flightgear::CockpitDisplayManager, SGSubsystemMgr::DISPLAY);
 636
 637     ////////////////////////////////////////////////////////////////////
 638     // Initialize the XML Autopilot subsystem.
 639     ////////////////////////////////////////////////////////////////////
 640
 641     globals->add_subsystem( "xml-autopilot", FGXMLAutopilotGroup::createInstance("autopilot"), SGSubsystemMgr::FDM );
 642     globals->add_subsystem( "xml-proprules", FGXMLAutopilotGroup::createInstance("property-rule"), SGSubsystemMgr::GENERAL );
 643     globals->add_subsystem( "route-manager", new FGRouteMgr );
 644
 645     ////////////////////////////////////////////////////////////////////
 646     // Initialize the Input-Output subsystem
 647     ////////////////////////////////////////////////////////////////////
 648     globals->add_subsystem( "io", new FGIO );
 649
 650     ////////////////////////////////////////////////////////////////////
 651     // Create and register the logger.
 652     ////////////////////////////////////////////////////////////////////
 653
 654     globals->add_subsystem("logger", new FGLogger);
 655
 656     ////////////////////////////////////////////////////////////////////
 657     // Create and register the XML GUI.
 658     ////////////////////////////////////////////////////////////////////
 659
 660     globals->add_subsystem("gui", new NewGUI, SGSubsystemMgr::INIT);
 661
 662     //////////////////////////////////////////////////////////////////////
 663     // Initialize the 2D cloud subsystem.
 664     ////////////////////////////////////////////////////////////////////
 665     fgGetBool("/sim/rendering/bump-mapping", false);
 666
 667     ////////////////////////////////////////////////////////////////////
 668     // Initialize the canvas 2d drawing subsystem.
 669     ////////////////////////////////////////////////////////////////////
 670     globals->add_subsystem("Canvas", new CanvasMgr, SGSubsystemMgr::DISPLAY);
 671     globals->add_subsystem("CanvasGUI", new GUIMgr, SGSubsystemMgr::DISPLAY);
 672
 673     ////////////////////////////////////////////////////////////////////
 674     // Initialise the ATIS Manager
 675     // Note that this is old stuff, but is necessary for the
 676     // current ATIS implementation. Therefore, leave it in here
 677     // until the ATIS system is ported over to make use of the ATIS
 678     // sub system infrastructure.
 679     ////////////////////////////////////////////////////////////////////
 680
 681     globals->add_subsystem("ATIS", new FGATISMgr, SGSubsystemMgr::INIT, 0.4);
 682
 683     ////////////////////////////////////////////////////////////////////
 684    // Initialize the ATC subsystem
 685     ////////////////////////////////////////////////////////////////////
 686     globals->add_subsystem("ATC", new FGATCManager, SGSubsystemMgr::POST_FDM);
 687
 688     ////////////////////////////////////////////////////////////////////
 689     // Initialize multiplayer subsystem
 690     ////////////////////////////////////////////////////////////////////
 691
 692     globals->add_subsystem("mp", new FGMultiplayMgr, SGSubsystemMgr::POST_FDM);
 693
 694     ////////////////////////////////////////////////////////////////////
 695     // Initialise the AI Model Manager
 696     ////////////////////////////////////////////////////////////////////
 697     SG_LOG(SG_GENERAL, SG_INFO, "  AI Model Manager");
 698     globals->add_subsystem("ai-model", new FGAIManager, SGSubsystemMgr::POST_FDM);
 699     globals->add_subsystem("submodel-mgr", new FGSubmodelMgr, SGSubsystemMgr::POST_FDM);
 700
 701
 702     // It's probably a good idea to initialize the top level traffic manager
 703     // After the AI and ATC systems have been initialized properly.
 704     // AI Traffic manager
 705     globals->add_subsystem("traffic-manager", new FGTrafficManager, SGSubsystemMgr::POST_FDM);
 706
 707     ////////////////////////////////////////////////////////////////////
 708     // Add a new 2D panel.
 709     ////////////////////////////////////////////////////////////////////
 710
 711     fgSetArchivable("/sim/panel/visibility");
 712     fgSetArchivable("/sim/panel/x-offset");
 713     fgSetArchivable("/sim/panel/y-offset");
 714     fgSetArchivable("/sim/panel/jitter");
 715
 716     ////////////////////////////////////////////////////////////////////
 717     // Initialize the controls subsystem.
 718     ////////////////////////////////////////////////////////////////////
 719
 720     globals->add_subsystem("controls", new FGControls, SGSubsystemMgr::GENERAL);
 721
 722     ////////////////////////////////////////////////////////////////////
 723     // Initialize the input subsystem.
 724     ////////////////////////////////////////////////////////////////////
 725
 726     globals->add_subsystem("input", new FGInput, SGSubsystemMgr::GENERAL);
 727
 728
 729     ////////////////////////////////////////////////////////////////////
 730     // Initialize the replay subsystem
 731     ////////////////////////////////////////////////////////////////////
 732     globals->add_subsystem("replay", new FGReplay);
 733     globals->add_subsystem("history", new FGFlightHistory);
 734
 735 #ifdef ENABLE_AUDIO_SUPPORT
 736     ////////////////////////////////////////////////////////////////////
 737     // Initialize the sound-effects subsystem.
 738     ////////////////////////////////////////////////////////////////////
 739     globals->add_subsystem("voice", new FGVoiceMgr, SGSubsystemMgr::DISPLAY);
 740 #endif
 741
 742 #ifdef ENABLE_IAX
 743     ////////////////////////////////////////////////////////////////////
 744     // Initialize the FGCom subsystem.
 745     ////////////////////////////////////////////////////////////////////
 746     globals->add_subsystem("fgcom", new FGCom);
 747 #endif
 748
 749     ////////////////////////////////////////////////////////////////////
 750     // Initialize the lighting subsystem.
 751     ////////////////////////////////////////////////////////////////////
 752
 753     globals->add_subsystem("lighting", new FGLight, SGSubsystemMgr::DISPLAY);
 754
 755     // ordering here is important : Nasal (via events), then models, then views
 756     globals->add_subsystem("events", globals->get_event_mgr(), SGSubsystemMgr::DISPLAY);
 757
 758     globals->add_subsystem("aircraft-model", new FGAircraftModel, SGSubsystemMgr::DISPLAY);
 759     globals->add_subsystem("model-manager", new FGModelMgr, SGSubsystemMgr::DISPLAY);
 760
 761     globals->add_subsystem("view-manager", new FGViewMgr, SGSubsystemMgr::DISPLAY);
 762
 763     globals->add_subsystem("tile-manager", globals->get_tile_mgr(),
 764       SGSubsystemMgr::DISPLAY);
 765 }
 766
 767 void fgPostInitSubsystems()
 768 {
 769     SGTimeStamp st;
 770     st.stamp();
 771
 772     ////////////////////////////////////////////////////////////////////////
 773     // Initialize the Nasal interpreter.
 774     // Do this last, so that the loaded scripts see initialized state
 775     ////////////////////////////////////////////////////////////////////////
 776     FGNasalSys* nasal = new FGNasalSys();
 777     globals->add_subsystem("nasal", nasal, SGSubsystemMgr::INIT);
 778     nasal->init();
 779     SG_LOG(SG_GENERAL, SG_INFO, "Nasal init took:" << st.elapsedMSec());
 780
 781     // Ensure IOrules and path validation are working properly by trying to
 782     // access a folder/file which should never be accessible.
 783     const char* no_access_path =
 784 #ifdef _WIN32
 785       "Z:"
 786 #endif
 787       "/do-not-access";
 788
 789     if( fgValidatePath(no_access_path, true) )
 790       SG_LOG
 791       (
 792         SG_GENERAL,
 793         SG_ALERT,
 794         "Check your IOrules! (write to '" << no_access_path << "' is allowed)"
 795       );
 796     if( fgValidatePath(no_access_path, false) )
 797       SG_LOG
 798       (
 799         SG_GENERAL,
 800         SG_ALERT,
 801         "Check your IOrules! (read from '" << no_access_path << "' is allowed)"
 802       );
 803
 804     // initialize methods that depend on other subsystems.
 805     st.stamp();
 806     globals->get_subsystem_mgr()->postinit();
 807     SG_LOG(SG_GENERAL, SG_INFO, "Subsystems postinit took:" << st.elapsedMSec());
 808
 809     ////////////////////////////////////////////////////////////////////////
 810     // End of subsystem initialization.
 811     ////////////////////////////////////////////////////////////////////
 812
 813     fgSetBool("/sim/crashed", false);
 814     fgSetBool("/sim/initialized", true);
 815
 816     SG_LOG( SG_GENERAL, SG_INFO, endl);
 817
 818                                 // Save the initial state for future
 819                                 // reference.
 820     globals->saveInitialState();
 821 }
 822
 823 // Reset: this is what the 'reset' command (and hence, GUI) is attached to
 824 void fgReInitSubsystems()
 825 {
 826     SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 827
 828     SG_LOG( SG_GENERAL, SG_INFO, "fgReInitSubsystems()");
 829
 830 // setup state to begin re-init
 831     bool freeze = master_freeze->getBoolValue();
 832     if ( !freeze ) {
 833         master_freeze->setBoolValue(true);
 834     }
 835
 836     fgSetBool("/sim/signals/reinit", true);
 837     fgSetBool("/sim/crashed", false);
 838
 839 // do actual re-init steps
 840     globals->get_subsystem("flight")->unbind();
 841
 842   // reset control state, before restoring initial state; -set or config files
 843   // may specify values for flaps, trim tabs, magnetos, etc
 844     globals->get_controls()->reset_all();
 845
 846     globals->restoreInitialState();
 847
 848     // update our position based on current presets
 849     // this will mark position as needed finalized which we'll do in the
 850     // main-loop
 851     flightgear::initPosition();
 852
 853     simgear::SGTerraSync* terraSync =
 854         static_cast<simgear::SGTerraSync*>(globals->get_subsystem("terrasync"));
 855     if (terraSync) {
 856         terraSync->reposition();
 857     }
 858
 859     // Force reupdating the positions of the ai 3d models. They are used for
 860     // initializing ground level for the FDM.
 861     globals->get_subsystem("ai-model")->reinit();
 862
 863     // Initialize the FDM
 864     globals->get_subsystem("flight")->reinit();
 865
 866     // reset replay buffers
 867     globals->get_subsystem("replay")->reinit();
 868
 869     // reload offsets from config defaults
 870     globals->get_viewmgr()->reinit();
 871
 872     // ugly: finalizePosition waits for METAR to arrive for the new airport.
 873     // we don't re-init the environment manager here, since historically we did
 874     // not, and doing so seems to have other issues. All that's needed is to
 875     // schedule METAR fetch immediately, so it's available for finalizePosition.
 876     // So we manually extract the METAR-fetching component inside the environment
 877     // manager, and re-init that.
 878     SGSubsystemGroup* envMgr = static_cast<SGSubsystemGroup*>(globals->get_subsystem("environment"));
 879     if (envMgr) {
 880       envMgr->get_subsystem("realwx")->reinit();
 881     }
 882
 883     globals->get_subsystem("time")->reinit();
 884
 885     // need to bind FDMshell again, since we manually unbound it above...
 886     globals->get_subsystem("flight")->bind();
 887
 888     // need to reset aircraft (systems/instruments) so they can adapt to current environment
 889     globals->get_subsystem("systems")->reinit();
 890     globals->get_subsystem("instrumentation")->reinit();
 891
 892     globals->get_subsystem("ATIS")->reinit();
 893
 894 // setup state to end re-init
 895     fgSetBool("/sim/signals/reinit", false);
 896     if ( !freeze ) {
 897         master_freeze->setBoolValue(false);
 898     }
 899     fgSetBool("/sim/sceneryloaded",false);
 900 }
 901
 902
 903 ///////////////////////////////////////////////////////////////////////////////
 904 // helper object to implement the --show-aircraft command.
 905 // resides here so we can share the fgFindAircraftInDir template above,
 906 // and hence ensure this command lists exectly the same aircraft as the normal
 907 // loading path.
 908 class ShowAircraft
 909 {
 910 public:
 911   ShowAircraft()
 912   {
 913     _minStatus = getNumMaturity(fgGetString("/sim/aircraft-min-status", "all"));
 914   }
 915
 916
 917   void show(const SGPath& path)
 918   {
 919     fgFindAircraftInDir(path, this, &ShowAircraft::processAircraft);
 920
 921     std::sort(_aircraft.begin(), _aircraft.end(), ciLessLibC());
 922     SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
 923     cout << "Available aircraft:" << endl;
 924     for ( unsigned int i = 0; i < _aircraft.size(); i++ ) {
 925         cout << _aircraft[i] << endl;
 926     }
 927   }
 928
 929 private:
 930   bool processAircraft(const SGPath& path)
 931   {
 932     SGPropertyNode root;
 933     try {
 934        readProperties(path.str(), &root);
 935     } catch (sg_exception& ) {
 936        return false;
 937     }
 938
 939     int maturity = 0;
 940     string descStr("   ");
 941     descStr += path.file();
 942   // trim common suffix from file names
 943     int nPos = descStr.rfind("-set.xml");
 944     if (nPos == (int)(descStr.size() - 8)) {
 945       descStr.resize(nPos);
 946     }
 947
 948     SGPropertyNode *node = root.getNode("sim");
 949     if (node) {
 950       SGPropertyNode* desc = node->getNode("description");
 951       // if a status tag is found, read it in
 952       if (node->hasValue("status")) {
 953         maturity = getNumMaturity(node->getStringValue("status"));
 954       }
 955
 956       if (desc) {
 957         if (descStr.size() <= 27+3) {
 958           descStr.append(29+3-descStr.size(), ' ');
 959         } else {
 960           descStr += '\n';
 961           descStr.append( 32, ' ');
 962         }
 963         descStr += desc->getStringValue();
 964       }
 965     } // of have 'sim' node
 966
 967     if (maturity < _minStatus) {
 968       return false;
 969     }
 970
 971     _aircraft.push_back(descStr);
 972     return false;
 973   }
 974
 975
 976   int getNumMaturity(const char * str)
 977   {
 978     // changes should also be reflected in $FG_ROOT/data/options.xml &
 979     // $FG_ROOT/data/Translations/string-default.xml
 980     const char* levels[] = {"alpha","beta","early-production","production"};
 981
 982     if (!strcmp(str, "all")) {
 983       return 0;
 984     }
 985
 986     for (size_t i=0; i<(sizeof(levels)/sizeof(levels[0]));i++)
 987       if (strcmp(str,levels[i])==0)
 988         return i;
 989
 990     return 0;
 991   }
 992
 993   // recommended in Meyers, Effective STL when internationalization and embedded
 994   // NULLs aren't an issue.  Much faster than the STL or Boost lex versions.
 995   struct ciLessLibC : public std::binary_function<string, string, bool>
 996   {
 997     bool operator()(const std::string &lhs, const std::string &rhs) const
 998     {
 999       return strcasecmp(lhs.c_str(), rhs.c_str()) < 0 ? 1 : 0;
1000     }
1001   };
1002
1003   int _minStatus;
1004   string_list _aircraft;
1005 };
1006
1007 void fgShowAircraft(const SGPath &path)
1008 {
1009     ShowAircraft s;
1010     s.show(path);
1011
1012 #ifdef _MSC_VER
1013     cout << "Hit a key to continue..." << endl;
1014     std::cin.get();
1015 #endif
1016 }
1017
1018