1 // fg_init.cxx -- Flight Gear top level initialization routines
3 // Written by Curtis Olson, started August 1997.
5 // Copyright (C) 1997 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
28 #include <simgear/compiler.h>
32 #include <string.h> // strcmp()
34 #if defined(SG_WINDOWS)
35 # include <io.h> // isatty()
36 # include <process.h> // _getpid()
38 # define isatty _isatty
40 // for open() and options
41 # include <sys/types.h>
42 # include <sys/stat.h>
48 #include <boost/algorithm/string/compare.hpp>
49 #include <boost/algorithm/string/predicate.hpp>
51 #include <osgViewer/Viewer>
53 #include <simgear/canvas/Canvas.hxx>
54 #include <simgear/constants.h>
55 #include <simgear/debug/logstream.hxx>
56 #include <simgear/structure/exception.hxx>
57 #include <simgear/structure/event_mgr.hxx>
58 #include <simgear/structure/SGPerfMon.hxx>
59 #include <simgear/misc/sg_path.hxx>
60 #include <simgear/misc/sg_dir.hxx>
61 #include <simgear/misc/sgstream.hxx>
62 #include <simgear/misc/strutils.hxx>
63 #include <simgear/props/props_io.hxx>
64 #include <simgear/scene/tsync/terrasync.hxx>
66 #include <simgear/scene/model/modellib.hxx>
67 #include <simgear/scene/material/matlib.hxx>
68 #include <simgear/scene/material/Effect.hxx>
69 #include <simgear/scene/model/particles.hxx>
70 #include <simgear/scene/tsync/terrasync.hxx>
72 #include <simgear/package/Root.hxx>
73 #include <simgear/package/Package.hxx>
74 #include <simgear/package/Install.hxx>
75 #include <simgear/package/Catalog.hxx>
77 #include <Aircraft/controls.hxx>
78 #include <Aircraft/replay.hxx>
79 #include <Aircraft/FlightHistory.hxx>
80 #include <Airports/runways.hxx>
81 #include <Airports/airport.hxx>
82 #include <Airports/dynamics.hxx>
83 #include <Airports/airportdynamicsmanager.hxx>
85 #include <AIModel/AIManager.hxx>
87 #include <ATC/atc_mgr.hxx>
89 #include <Autopilot/route_mgr.hxx>
90 #include <Autopilot/autopilotgroup.hxx>
92 #include <Cockpit/panel.hxx>
93 #include <Cockpit/panel_io.hxx>
95 #include <Canvas/canvas_mgr.hxx>
96 #include <Canvas/gui_mgr.hxx>
97 #include <Canvas/FGCanvasSystemAdapter.hxx>
98 #include <GUI/new_gui.hxx>
99 #include <GUI/MessageBox.hxx>
100 #include <Input/input.hxx>
101 #include <Instrumentation/instrument_mgr.hxx>
102 #include <Model/acmodel.hxx>
103 #include <Model/modelmgr.hxx>
104 #include <AIModel/submodel.hxx>
105 #include <AIModel/AIManager.hxx>
106 #include <Navaids/navdb.hxx>
107 #include <Navaids/navlist.hxx>
108 #include <Scenery/scenery.hxx>
109 #include <Scenery/SceneryPager.hxx>
110 #include <Scenery/tilemgr.hxx>
111 #include <Scripting/NasalSys.hxx>
112 #include <Sound/voice.hxx>
113 #include <Sound/soundmanager.hxx>
114 #include <Systems/system_mgr.hxx>
115 #include <Time/light.hxx>
116 #include <Time/TimeManager.hxx>
118 #include <Traffic/TrafficMgr.hxx>
119 #include <MultiPlayer/multiplaymgr.hxx>
120 #include <FDM/fdm_shell.hxx>
121 #include <Environment/ephemeris.hxx>
122 #include <Environment/environment_mgr.hxx>
123 #include <Viewer/renderer.hxx>
124 #include <Viewer/viewmgr.hxx>
125 #include <Viewer/FGEventHandler.hxx>
126 #include <Navaids/NavDataCache.hxx>
127 #include <Instrumentation/HUD/HUD.hxx>
128 #include <Cockpit/cockpitDisplayManager.hxx>
129 #include <Network/HTTPClient.hxx>
130 #include <Network/fgcom.hxx>
131 #include <Network/http/httpd.hxx>
132 #include <Include/version.h>
133 #include <Viewer/splash.hxx>
134 #include <Viewer/CameraGroup.hxx>
136 #include "fg_init.hxx"
138 #include "fg_commands.hxx"
139 #include "fg_props.hxx"
140 #include "FGInterpolator.hxx"
141 #include "options.hxx"
142 #include "globals.hxx"
143 #include "logger.hxx"
145 #include "positioninit.hxx"
147 #include "AircraftDirVisitorBase.hxx"
150 #include <GUI/CocoaHelpers.h> // for Mac impl of platformDefaultDataPath()
158 using namespace boost::algorithm;
159 using namespace simgear::pkg;
161 extern osg::ref_ptr<osgViewer::Viewer> viewer;
163 // Return the current base package version
164 string fgBasePackageVersion(const SGPath& base_path) {
171 sg_gzifstream in( p.str() );
182 class FindAndCacheAircraft : public AircraftDirVistorBase
185 FindAndCacheAircraft(SGPropertyNode* autoSave)
187 _cache = autoSave->getNode("sim/startup/path-cache", true);
192 std::string aircraft = fgGetString( "/sim/aircraft", "");
193 if (aircraft.empty()) {
194 flightgear::fatalMessageBox("No aircraft", "No aircraft was specified");
195 SG_LOG(SG_GENERAL, SG_ALERT, "no aircraft specified");
199 _searchAircraft = aircraft + "-set.xml";
200 std::string aircraftDir = fgGetString("/sim/aircraft-dir", "");
201 if (!aircraftDir.empty()) {
202 // aircraft-dir was set, skip any searching at all, if it's valid
203 simgear::Dir acPath(aircraftDir);
204 SGPath setFile = acPath.file(_searchAircraft);
205 if (setFile.exists()) {
206 SG_LOG(SG_GENERAL, SG_INFO, "found aircraft in dir: " << aircraftDir );
209 readProperties(setFile.str(), globals->get_props());
210 } catch ( const sg_exception &e ) {
211 SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
212 flightgear::fatalMessageBox("Error reading aircraft",
213 "An error occured reading the requested aircraft (" + aircraft + ")",
214 e.getFormattedMessage());
220 SG_LOG(SG_GENERAL, SG_ALERT, "aircraft '" << _searchAircraft <<
221 "' not found in specified dir:" << aircraftDir);
222 flightgear::fatalMessageBox("Aircraft not found",
223 "The requested aircraft '" + aircraft + "' could not be found in the specified location.",
230 // prepare cache for re-scan
231 SGPropertyNode *n = _cache->getNode("fg-root", true);
232 n->setStringValue(globals->get_fg_root().c_str());
233 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
234 n = _cache->getNode("fg-aircraft", true);
235 n->setStringValue(getAircraftPaths().c_str());
236 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
237 _cache->removeChildren("aircraft");
239 visitAircraftPaths();
242 if (_foundPath.str().empty()) {
243 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find specified aircraft: " << aircraft );
244 flightgear::fatalMessageBox("Aircraft not found",
245 "The requested aircraft '" + aircraft + "' could not be found in any of the search paths");
250 SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft -set file from:" << _foundPath.str());
251 fgSetString( "/sim/aircraft-dir", _foundPath.dir().c_str());
252 if (!_foundPath.exists()) {
253 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to find -set file:" << _foundPath.str());
258 readProperties(_foundPath.str(), globals->get_props());
259 } catch ( const sg_exception &e ) {
260 SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
261 flightgear::fatalMessageBox("Error reading aircraft",
262 "An error occured reading the requested aircraft (" + aircraft + ")",
263 e.getFormattedMessage());
271 SGPath getAircraftPaths() {
272 string_list pathList = globals->get_aircraft_paths();
273 SGPath aircraftPaths;
274 string_list::const_iterator it = pathList.begin();
275 if (it != pathList.end()) {
276 aircraftPaths.set(*it);
279 for (; it != pathList.end(); ++it) {
280 aircraftPaths.add(*it);
282 return aircraftPaths;
287 if (globals->get_fg_root() != _cache->getStringValue("fg-root", "")) {
288 return false; // cache mismatch
291 if (getAircraftPaths().str() != _cache->getStringValue("fg-aircraft", "")) {
292 return false; // cache mismatch
295 vector<SGPropertyNode_ptr> cache = _cache->getChildren("aircraft");
296 for (unsigned int i = 0; i < cache.size(); i++) {
297 const char *name = cache[i]->getStringValue("file", "");
298 if (!boost::equals(_searchAircraft, name, is_iequal())) {
302 SGPath xml(cache[i]->getStringValue("path", ""));
310 } // of aircraft in cache iteration
315 virtual VisitResult visit(const SGPath& p)
320 if (!_cache->getChild("aircraft", i++, false))
324 SGPropertyNode *n, *entry = _cache->getChild("aircraft", --i, true);
326 std::string fileName(p.file());
327 n = entry->getNode("file", true);
328 n->setStringValue(fileName);
329 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
331 n = entry->getNode("path", true);
332 n->setStringValue(p.dir());
333 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
335 if ( boost::equals(fileName, _searchAircraft.c_str(), is_iequal()) ) {
340 return VISIT_CONTINUE;
343 std::string _searchAircraft;
345 SGPropertyNode* _cache;
349 static SGPath platformDefaultDataPath()
351 char *envp = ::getenv( "APPDATA" );
352 SGPath config( envp );
353 config.append( "flightgear.org" );
357 #elif defined(SG_MAC)
359 // platformDefaultDataPath defined in GUI/CocoaHelpers.h
362 static SGPath platformDefaultDataPath()
364 return SGPath::home() / ".fgfs";
370 SGPath dataPath = SGPath::fromEnv("FG_HOME", platformDefaultDataPath());
371 globals->set_fg_home(dataPath.c_str());
373 simgear::Dir fgHome(dataPath);
374 if (!fgHome.exists()) {
378 if (!fgHome.exists()) {
379 flightgear::fatalMessageBox("Problem setting up user data",
380 "Unable to create the user-data storage folder at: '"
381 + dataPath.str() + "'");
385 if (fgGetBool("/sim/fghome-readonly", false)) {
386 // user / config forced us into readonly mode, fine
387 SG_LOG(SG_GENERAL, SG_INFO, "Running with FG_HOME readonly");
391 // write our PID, and check writeability
392 SGPath pidPath(dataPath, "fgfs.pid");
393 if (pidPath.exists()) {
394 SG_LOG(SG_GENERAL, SG_INFO, "flightgear instance already running, switching to FG_HOME read-only.");
395 // set a marker property so terrasync/navcache don't try to write
396 // from secondary instances
397 fgSetBool("/sim/fghome-readonly", true);
403 #if defined(SG_WINDOWS)
404 size_t len = snprintf(buf, 16, "%d", _getpid());
406 HANDLE f = CreateFileA(pidPath.c_str(), GENERIC_READ | GENERIC_WRITE,
407 FILE_SHARE_READ, /* sharing */
408 NULL, /* security attributes */
409 CREATE_NEW, /* error if already exists */
410 FILE_FLAG_DELETE_ON_CLOSE,
411 NULL /* template */);
413 result = (f != INVALID_HANDLE_VALUE);
416 WriteFile(f, buf, len, &written, NULL /* overlapped */);
419 // POSIX, do open+unlink trick to the file is deleted on exit, even if we
421 ssize_t len = snprintf(buf, 16, "%d", getpid());
422 int fd = ::open(pidPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
424 result = ::write(fd, buf, len) == len;
425 if( ::unlink(pidPath.c_str()) != 0 ) // delete file when app quits
430 fgSetBool("/sim/fghome-readonly", false);
433 flightgear::fatalMessageBox("File permissions problem",
434 "Can't write to user-data storage folder, check file permissions and FG_HOME.",
435 "User-data at:" + dataPath.str());
440 // Read in configuration (file and command line)
441 int fgInitConfig ( int argc, char **argv, bool reinit )
443 SGPath dataPath = globals->get_fg_home();
445 simgear::Dir exportDir(simgear::Dir(dataPath).file("Export"));
446 if (!exportDir.exists()) {
447 exportDir.create(0755);
450 // Set /sim/fg-home. Use FG_HOME if necessary.
451 // deliberately not a tied property, for fgValidatePath security
452 // write-protect to avoid accidents
453 SGPropertyNode *home = fgGetNode("/sim", true);
454 home->removeChild("fg-home", 0);
455 home = home->getChild("fg-home", 0, true);
456 home->setStringValue(dataPath.c_str());
457 home->setAttribute(SGPropertyNode::WRITE, false);
460 flightgear::Options* options = flightgear::Options::sharedInstance();
462 options->init(argc, argv, dataPath);
465 bool loadDefaults = options->shouldLoadDefaultConfig();
467 // Read global preferences from $FG_ROOT/preferences.xml
468 SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences");
469 fgLoadProps("preferences.xml", globals->get_props());
470 SG_LOG(SG_INPUT, SG_INFO, "Finished Reading global preferences");
472 // do not load user settings when reset to default is requested, or if
473 // told to explicitly ignore
474 if (options->isOptionSet("restore-defaults") || options->isOptionSet("ignore-autosave"))
476 SG_LOG(SG_GENERAL, SG_ALERT, "Ignoring user settings. Restoring defaults.");
480 globals->loadUserSettings(dataPath);
483 SG_LOG(SG_GENERAL, SG_INFO, "not reading default configuration files");
484 }// of no-default-config selected
486 return flightgear::FG_OPTIONS_OK;
489 static void initAircraftDirsNasalSecurity()
491 // deliberately not a tied property, for fgValidatePath security
492 // write-protect to avoid accidents
493 SGPropertyNode* sim = fgGetNode("/sim", true);
494 sim->removeChildren("fg-aircraft");
497 string_list const aircraft_paths = globals->get_aircraft_paths();
498 for( string_list::const_iterator it = aircraft_paths.begin();
499 it != aircraft_paths.end();
502 SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
503 n->setStringValue(*it);
504 n->setAttribute(SGPropertyNode::WRITE, false);
508 void fgInitAircraftPaths(bool reinit)
510 if (!globals->packageRoot()) {
514 SGSharedPtr<Root> pkgRoot(globals->packageRoot());
515 SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
516 aircraftProp->setAttribute(SGPropertyNode::PRESERVE, true);
519 flightgear::Options::sharedInstance()->initPaths();
523 int fgInitAircraft(bool reinit)
526 flightgear::Options::sharedInstance()->initAircraft();
529 SGSharedPtr<Root> pkgRoot(globals->packageRoot());
530 SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
532 string aircraftId(aircraftProp->getStringValue());
533 PackageRef acftPackage = pkgRoot->getPackageById(aircraftId);
535 if (acftPackage->isInstalled()) {
536 SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft from package:" << acftPackage->qualifiedId());
538 // set catalog path so intra-package dependencies within the catalog
539 // are resolved correctly.
540 globals->set_catalog_aircraft_path(acftPackage->catalog()->installRoot());
542 // set aircraft-dir to short circuit the search process
543 InstallRef acftInstall = acftPackage->install();
544 fgSetString("/sim/aircraft-dir", acftInstall->path().c_str());
546 // overwrite the fully qualified ID with the aircraft one, so the
547 // code in FindAndCacheAircraft works as normal
548 // note since we may be using a variant, we can't use the package ID
549 size_t lastDot = aircraftId.rfind('.');
550 if (lastDot != std::string::npos) {
551 aircraftId = aircraftId.substr(lastDot + 1);
553 aircraftProp->setStringValue(aircraftId);
555 // run the traditional-code path below
558 // naturally the better option would be to on-demand install it!
559 flightgear::fatalMessageBox("Aircraft not installed",
560 "Requested aircraft is not currently installed.",
563 return flightgear::FG_OPTIONS_ERROR;
565 // fall back the default aircraft instead
569 initAircraftDirsNasalSecurity();
571 FindAndCacheAircraft f(globals->get_props());
572 if (!f.loadAircraft()) {
573 return flightgear::FG_OPTIONS_ERROR;
576 return flightgear::FG_OPTIONS_OK;
580 * Initialize vor/ndb/ils/fix list management and query systems (as
581 * well as simple airport db list)
582 * This is called multiple times in the case of a cache rebuild,
583 * to allow lengthy caching to take place in the background, without
584 * blocking the main/UI thread.
589 flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
590 static bool doingRebuild = false;
593 cache = flightgear::NavDataCache::createInstance();
594 doingRebuild = cache->isRebuildRequired();
597 static const char* splashIdentsByRebuildPhase[] = {
606 flightgear::NavDataCache::RebuildPhase phase;
607 phase = cache->rebuild();
608 if (phase != flightgear::NavDataCache::REBUILD_DONE) {
609 // update the splash text based on percentage, phase
611 fgSplashProgress(splashIdentsByRebuildPhase[phase],
612 cache->rebuildPhaseCompletionPercentage());
614 // sleep to give the rebuild thread more time
615 SGTimeStamp::sleepForMSec(50);
620 FGTACANList *channellist = new FGTACANList;
621 globals->set_channellist( channellist );
623 SGPath path(globals->get_fg_root());
624 path.append( "Navaids/TACAN_freq.dat" );
625 flightgear::loadTacan(path, channellist);
630 // General house keeping initializations
631 bool fgInitGeneral() {
634 SG_LOG( SG_GENERAL, SG_INFO, "General Initialization" );
635 SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
637 root = globals->get_fg_root();
638 if ( ! root.length() ) {
639 // No root path set? Then bail ...
640 SG_LOG( SG_GENERAL, SG_ALERT,
641 "Cannot continue without a path to the base package "
642 << "being defined." );
645 SG_LOG( SG_GENERAL, SG_INFO, "FG_ROOT = " << '"' << root << '"' << endl );
647 // Note: browser command is hard-coded for Mac/Windows, so this only affects other platforms
648 globals->set_browser(fgGetString("/sim/startup/browser-app", WEB_BROWSER));
649 fgSetString("/sim/startup/browser-app", globals->get_browser());
651 simgear::Dir cwd(simgear::Dir::current());
652 SGPropertyNode *curr = fgGetNode("/sim", true);
653 curr->removeChild("fg-current", 0);
654 curr = curr->getChild("fg-current", 0, true);
655 curr->setStringValue(cwd.path().str());
656 curr->setAttribute(SGPropertyNode::WRITE, false);
658 fgSetBool("/sim/startup/stdout-to-terminal", isatty(1) != 0 );
659 fgSetBool("/sim/startup/stderr-to-terminal", isatty(2) != 0 );
663 // Write various configuraton values out to the logs
664 void fgOutputSettings()
666 SG_LOG( SG_GENERAL, SG_INFO, "Configuration State" );
667 SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
669 SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"' );
670 SG_LOG( SG_GENERAL, SG_INFO, "fghome-dir = " << '"' << globals->get_fg_home() << '"');
671 SG_LOG( SG_GENERAL, SG_INFO, "download-dir = " << '"' << fgGetString("/sim/paths/download-dir") << '"' );
672 SG_LOG( SG_GENERAL, SG_INFO, "terrasync-dir = " << '"' << fgGetString("/sim/terrasync/scenery-dir") << '"' );
674 SG_LOG( SG_GENERAL, SG_INFO, "aircraft-search-paths = \n\t" << simgear::strutils::join(globals->get_aircraft_paths(), "\n\t") );
675 SG_LOG( SG_GENERAL, SG_INFO, "scenery-search-paths = \n\t" << simgear::strutils::join(globals->get_fg_scenery(), "\n\t") );
678 // This is the top level init routine which calls all the other
679 // initialization routines. If you are adding a subsystem to flight
680 // gear, its initialization call should located in this routine.
681 // Returns non-zero if a problem encountered.
682 void fgCreateSubsystems(bool duringReset) {
684 SG_LOG( SG_GENERAL, SG_INFO, "Creating Subsystems");
685 SG_LOG( SG_GENERAL, SG_INFO, "========== ==========");
687 ////////////////////////////////////////////////////////////////////
688 // Initialize the sound subsystem.
689 ////////////////////////////////////////////////////////////////////
690 // Sound manager uses an own subsystem group "SOUND" which is the last
691 // to be updated in every loop.
692 // Sound manager is updated last so it can use the CPU while the GPU
693 // is processing the scenery (doubled the frame-rate for me) -EMH-
694 globals->add_subsystem("sound", new FGSoundManager, SGSubsystemMgr::SOUND);
696 ////////////////////////////////////////////////////////////////////
697 // Initialize the event manager subsystem.
698 ////////////////////////////////////////////////////////////////////
700 globals->get_event_mgr()->init();
701 globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
703 ////////////////////////////////////////////////////////////////////
704 // Initialize the property interpolator subsystem. Put into the INIT
705 // group because the "nasal" subsystem may need it at GENERAL take-down.
706 ////////////////////////////////////////////////////////////////////
707 globals->add_subsystem("prop-interpolator", new FGInterpolator, SGSubsystemMgr::INIT);
710 ////////////////////////////////////////////////////////////////////
711 // Add the FlightGear property utilities.
712 ////////////////////////////////////////////////////////////////////
713 globals->add_subsystem("properties", new FGProperties);
716 ////////////////////////////////////////////////////////////////////
717 // Add the FlightGear property utilities.
718 ////////////////////////////////////////////////////////////////////
719 globals->add_subsystem("airport-dynamics", new flightgear::AirportDynamicsManager);
721 ////////////////////////////////////////////////////////////////////
722 // Add the performance monitoring system.
723 ////////////////////////////////////////////////////////////////////
724 globals->add_subsystem("performance-mon",
725 new SGPerformanceMonitor(globals->get_subsystem_mgr(),
726 fgGetNode("/sim/performance-monitor", true)));
728 ////////////////////////////////////////////////////////////////////
729 // Initialize the material property subsystem.
730 ////////////////////////////////////////////////////////////////////
732 SGPath mpath( globals->get_fg_root() );
733 mpath.append( fgGetString("/sim/rendering/materials-file") );
734 if ( ! globals->get_matlib()->load(globals->get_fg_root(), mpath.str(),
735 globals->get_props()) ) {
736 throw sg_io_exception("Error loading materials file", mpath);
739 // may exist already due to GUI startup
740 if (!globals->get_subsystem("http")) {
741 globals->add_subsystem( "http", new FGHTTPClient );
744 ////////////////////////////////////////////////////////////////////
745 // Initialize the scenery management subsystem.
746 ////////////////////////////////////////////////////////////////////
748 globals->get_scenery()->get_scene_graph()
749 ->addChild(simgear::Particles::getCommonRoot());
750 simgear::GlobalParticleCallback::setSwitch(fgGetNode("/sim/rendering/particles", true));
752 ////////////////////////////////////////////////////////////////////
753 // Initialize the flight model subsystem.
754 ////////////////////////////////////////////////////////////////////
756 globals->add_subsystem("flight", new FDMShell, SGSubsystemMgr::FDM);
758 ////////////////////////////////////////////////////////////////////
759 // Initialize the weather subsystem.
760 ////////////////////////////////////////////////////////////////////
762 // Initialize the weather modeling subsystem
763 globals->add_subsystem("environment", new FGEnvironmentMgr);
764 globals->add_subsystem("ephemeris", new Ephemeris);
766 ////////////////////////////////////////////////////////////////////
767 // Initialize the aircraft systems and instrumentation (before the
769 ////////////////////////////////////////////////////////////////////
771 globals->add_subsystem("systems", new FGSystemMgr, SGSubsystemMgr::FDM);
772 globals->add_subsystem("instrumentation", new FGInstrumentMgr, SGSubsystemMgr::FDM);
773 globals->add_subsystem("hud", new HUD, SGSubsystemMgr::DISPLAY);
774 globals->add_subsystem("cockpit-displays", new flightgear::CockpitDisplayManager, SGSubsystemMgr::DISPLAY);
776 ////////////////////////////////////////////////////////////////////
777 // Initialize the XML Autopilot subsystem.
778 ////////////////////////////////////////////////////////////////////
780 globals->add_subsystem( "xml-autopilot", FGXMLAutopilotGroup::createInstance("autopilot"), SGSubsystemMgr::FDM );
781 globals->add_subsystem( "xml-proprules", FGXMLAutopilotGroup::createInstance("property-rule"), SGSubsystemMgr::GENERAL );
782 globals->add_new_subsystem<FGRouteMgr>();
784 ////////////////////////////////////////////////////////////////////
785 // Initialize the Input-Output subsystem
786 ////////////////////////////////////////////////////////////////////
787 globals->add_subsystem( "io", new FGIO );
789 ////////////////////////////////////////////////////////////////////
790 // Create and register the logger.
791 ////////////////////////////////////////////////////////////////////
793 globals->add_subsystem("logger", new FGLogger);
795 ////////////////////////////////////////////////////////////////////
796 // Create and register the XML GUI.
797 ////////////////////////////////////////////////////////////////////
799 globals->add_subsystem("gui", new NewGUI, SGSubsystemMgr::INIT);
801 //////////////////////////////////////////////////////////////////////
802 // Initialize the 2D cloud subsystem.
803 ////////////////////////////////////////////////////////////////////
804 fgGetBool("/sim/rendering/bump-mapping", false);
806 ////////////////////////////////////////////////////////////////////
807 // Initialize the canvas 2d drawing subsystem.
808 ////////////////////////////////////////////////////////////////////
809 simgear::canvas::Canvas::setSystemAdapter(
810 simgear::canvas::SystemAdapterPtr(new canvas::FGCanvasSystemAdapter)
812 globals->add_subsystem("Canvas", new CanvasMgr, SGSubsystemMgr::DISPLAY);
813 globals->add_subsystem("CanvasGUI", new GUIMgr, SGSubsystemMgr::DISPLAY);
815 ////////////////////////////////////////////////////////////////////
816 // Initialize the ATC subsystem
817 ////////////////////////////////////////////////////////////////////
818 globals->add_subsystem("ATC", new FGATCManager, SGSubsystemMgr::POST_FDM);
820 ////////////////////////////////////////////////////////////////////
821 // Initialize multiplayer subsystem
822 ////////////////////////////////////////////////////////////////////
824 globals->add_subsystem("mp", new FGMultiplayMgr, SGSubsystemMgr::POST_FDM);
826 ////////////////////////////////////////////////////////////////////
827 // Initialise the AI Model Manager
828 ////////////////////////////////////////////////////////////////////
829 SG_LOG(SG_GENERAL, SG_INFO, " AI Model Manager");
830 globals->add_subsystem("ai-model", new FGAIManager, SGSubsystemMgr::POST_FDM);
831 globals->add_subsystem("submodel-mgr", new FGSubmodelMgr, SGSubsystemMgr::POST_FDM);
834 // It's probably a good idea to initialize the top level traffic manager
835 // After the AI and ATC systems have been initialized properly.
836 // AI Traffic manager
837 globals->add_subsystem("traffic-manager", new FGTrafficManager, SGSubsystemMgr::POST_FDM);
839 ////////////////////////////////////////////////////////////////////
840 // Add a new 2D panel.
841 ////////////////////////////////////////////////////////////////////
843 fgSetArchivable("/sim/panel/visibility");
844 fgSetArchivable("/sim/panel/x-offset");
845 fgSetArchivable("/sim/panel/y-offset");
846 fgSetArchivable("/sim/panel/jitter");
848 ////////////////////////////////////////////////////////////////////
849 // Initialize the controls subsystem.
850 ////////////////////////////////////////////////////////////////////
852 globals->add_new_subsystem<FGControls>(SGSubsystemMgr::GENERAL);
854 ////////////////////////////////////////////////////////////////////
855 // Initialize the input subsystem.
856 ////////////////////////////////////////////////////////////////////
858 globals->add_subsystem("input", new FGInput, SGSubsystemMgr::GENERAL);
861 ////////////////////////////////////////////////////////////////////
862 // Initialize the replay subsystem
863 ////////////////////////////////////////////////////////////////////
864 globals->add_subsystem("replay", new FGReplay);
865 globals->add_subsystem("history", new FGFlightHistory);
867 #ifdef ENABLE_AUDIO_SUPPORT
868 ////////////////////////////////////////////////////////////////////
869 // Initialize the sound-effects subsystem.
870 ////////////////////////////////////////////////////////////////////
871 globals->add_subsystem("voice", new FGVoiceMgr, SGSubsystemMgr::DISPLAY);
875 ////////////////////////////////////////////////////////////////////
876 // Initialize the FGCom subsystem.
877 ////////////////////////////////////////////////////////////////////
878 globals->add_subsystem("fgcom", new FGCom);
882 SGSubsystem * httpd = flightgear::http::FGHttpd::createInstance( fgGetNode(flightgear::http::PROPERTY_ROOT) );
884 globals->add_subsystem("httpd", httpd );
887 ////////////////////////////////////////////////////////////////////
888 // Initialize the lighting subsystem.
889 ////////////////////////////////////////////////////////////////////
891 // ordering here is important : Nasal (via events), then models, then views
893 globals->add_subsystem("lighting", new FGLight, SGSubsystemMgr::DISPLAY);
894 globals->add_subsystem("events", globals->get_event_mgr(), SGSubsystemMgr::DISPLAY);
897 globals->add_subsystem("aircraft-model", new FGAircraftModel, SGSubsystemMgr::DISPLAY);
898 globals->add_subsystem("model-manager", new FGModelMgr, SGSubsystemMgr::DISPLAY);
900 globals->add_subsystem("view-manager", new FGViewMgr, SGSubsystemMgr::DISPLAY);
902 globals->add_subsystem("tile-manager", globals->get_tile_mgr(),
903 SGSubsystemMgr::DISPLAY);
906 void fgPostInitSubsystems()
911 ////////////////////////////////////////////////////////////////////////
912 // Initialize the Nasal interpreter.
913 // Do this last, so that the loaded scripts see initialized state
914 ////////////////////////////////////////////////////////////////////////
915 FGNasalSys* nasal = new FGNasalSys();
916 globals->add_subsystem("nasal", nasal, SGSubsystemMgr::INIT);
918 SG_LOG(SG_GENERAL, SG_INFO, "Nasal init took:" << st.elapsedMSec());
920 // initialize methods that depend on other subsystems.
922 globals->get_subsystem_mgr()->postinit();
923 SG_LOG(SG_GENERAL, SG_INFO, "Subsystems postinit took:" << st.elapsedMSec());
925 ////////////////////////////////////////////////////////////////////////
926 // End of subsystem initialization.
927 ////////////////////////////////////////////////////////////////////
929 fgSetBool("/sim/crashed", false);
930 fgSetBool("/sim/initialized", true);
932 SG_LOG( SG_GENERAL, SG_INFO, endl);
935 // re-position is a simplified version of the traditional (legacy)
936 // reset procedure. We only need to poke systems which will be upset by
937 // a sudden change in aircraft position. Since this potentially includes
938 // Nasal, we trigger the 'reinit' signal.
939 void fgStartReposition()
941 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
942 SG_LOG( SG_GENERAL, SG_INFO, "fgStartReposition()");
944 // ensure we are frozen
945 bool freeze = master_freeze->getBoolValue();
947 master_freeze->setBoolValue(true);
950 // set this signal so Nasal scripts can take action.
951 fgSetBool("/sim/signals/reinit", true);
952 fgSetBool("/sim/crashed", false);
954 FDMShell* fdm = static_cast<FDMShell*>(globals->get_subsystem("flight"));
957 // update our position based on current presets
958 // this will mark position as needed finalized which we'll do in the
960 flightgear::initPosition();
962 simgear::SGTerraSync* terraSync =
963 static_cast<simgear::SGTerraSync*>(globals->get_subsystem("terrasync"));
965 terraSync->reposition();
968 // Initialize the FDM
969 globals->get_subsystem("flight")->reinit();
971 // reset replay buffers
972 globals->get_subsystem("replay")->reinit();
974 // ugly: finalizePosition waits for METAR to arrive for the new airport.
975 // we don't re-init the environment manager here, since historically we did
976 // not, and doing so seems to have other issues. All that's needed is to
977 // schedule METAR fetch immediately, so it's available for finalizePosition.
978 // So we manually extract the METAR-fetching component inside the environment
979 // manager, and re-init that.
980 SGSubsystemGroup* envMgr = static_cast<SGSubsystemGroup*>(globals->get_subsystem("environment"));
982 envMgr->get_subsystem("realwx")->reinit();
985 // need to bind FDMshell again, since we manually unbound it above...
988 // need to reset aircraft (systems/instruments/autopilot)
989 // so they can adapt to current environment
990 globals->get_subsystem("systems")->reinit();
991 globals->get_subsystem("instrumentation")->reinit();
992 globals->get_subsystem("xml-autopilot")->reinit();
994 // setup state to end re-init
995 fgSetBool("/sim/signals/reinit", false);
997 master_freeze->setBoolValue(false);
999 fgSetBool("/sim/sceneryloaded",false);
1002 void fgStartNewReset()
1004 SGPropertyNode_ptr preserved(new SGPropertyNode);
1006 if (!copyPropertiesWithAttribute(globals->get_props(), preserved, SGPropertyNode::PRESERVE))
1007 SG_LOG(SG_GENERAL, SG_ALERT, "Error saving preserved state");
1009 fgSetBool("/sim/signals/reinit", true);
1010 fgSetBool("/sim/freeze/master", true);
1012 SGSubsystemMgr* subsystemManger = globals->get_subsystem_mgr();
1013 // Nasal is manually inited in fgPostInit, ensure it's already shutdown
1014 // before other subsystems, so Nasal listeners don't fire during shutdonw
1015 SGSubsystem* nasal = subsystemManger->get_subsystem("nasal");
1018 subsystemManger->remove("nasal");
1020 subsystemManger->shutdown();
1021 subsystemManger->unbind();
1023 // remove most subsystems, with a few exceptions.
1024 for (int g=0; g<SGSubsystemMgr::MAX_GROUPS; ++g) {
1025 SGSubsystemGroup* grp = subsystemManger->get_group(static_cast<SGSubsystemMgr::GroupType>(g));
1026 const string_list& names(grp->member_names());
1027 string_list::const_iterator it;
1028 for (it = names.begin(); it != names.end(); ++it) {
1029 if ((*it == "time") || (*it == "terrasync") || (*it == "events")
1030 || (*it == "lighting"))
1036 subsystemManger->remove(it->c_str());
1037 } catch (std::exception& e) {
1038 SG_LOG(SG_GENERAL, SG_INFO, "caught std::exception shutting down:" << *it);
1040 SG_LOG(SG_GENERAL, SG_INFO, "caught generic exception shutting down:" << *it);
1043 // don't delete here, dropping the ref should be sufficient
1045 } // of top-level groups iteration
1047 FGRenderer* render = globals->get_renderer();
1048 // needed or we crash in multi-threaded OSG mode
1049 render->getViewer()->stopThreading();
1051 // order is important here since tile-manager shutdown needs to
1052 // access the scenery object
1053 globals->set_tile_mgr(NULL);
1054 globals->set_scenery(NULL);
1055 FGScenery::getPagerSingleton()->clearRequests();
1056 flightgear::CameraGroup::setDefault(NULL);
1058 // don't cancel the pager until after shutdown, since AIModels (and
1059 // potentially others) can queue delete requests on the pager.
1060 render->getViewer()->getDatabasePager()->cancel();
1061 render->getViewer()->getDatabasePager()->clear();
1063 osgDB::Registry::instance()->clearObjectCache();
1065 // preserve the event handler; re-creating it would entail fixing the
1067 osg::ref_ptr<flightgear::FGEventHandler> eventHandler = render->getEventHandler();
1069 globals->set_renderer(NULL);
1070 globals->set_matlib(NULL);
1071 globals->set_chatter_queue(NULL);
1073 simgear::clearEffectCache();
1074 simgear::SGModelLib::resetPropertyRoot();
1076 simgear::GlobalParticleCallback::setSwitch(NULL);
1078 globals->resetPropertyRoot();
1079 // otherwise channels are duplicated
1080 globals->get_channel_options_list()->clear();
1082 fgInitConfig(0, NULL, true);
1083 fgInitGeneral(); // all of this?
1085 flightgear::Options::sharedInstance()->processOptions();
1087 // PRESERVED properties over-write state from options, intentionally
1088 if ( copyProperties(preserved, globals->get_props()) ) {
1089 SG_LOG( SG_GENERAL, SG_INFO, "Preserved state restored successfully" );
1091 SG_LOG( SG_GENERAL, SG_INFO,
1092 "Some errors restoring preserved state (read-only props?)" );
1095 fgGetNode("/sim")->removeChild("aircraft-dir");
1096 fgInitAircraftPaths(true);
1097 fgInitAircraft(true);
1099 render = new FGRenderer;
1100 render->setEventHandler(eventHandler);
1101 eventHandler->reset();
1102 globals->set_renderer(render);
1104 render->setViewer(viewer.get());
1106 viewer->getDatabasePager()->setUpThreads(1, 1);
1108 // must do this before splashinit for Rembrandt
1109 flightgear::CameraGroup::buildDefaultGroup(viewer.get());
1110 render->splashinit();
1111 viewer->startThreading();
1113 fgOSResetProperties();
1115 // init some things manually
1116 // which do not follow the regular init pattern
1118 globals->get_event_mgr()->init();
1119 globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
1121 globals->set_matlib( new SGMaterialLib );
1123 // terra-sync needs the property tree root, pass it back in
1124 simgear::SGTerraSync* terra_sync = static_cast<simgear::SGTerraSync*>(subsystemManger->get_subsystem("terrasync"));
1125 terra_sync->setRoot(globals->get_props());
1127 fgSetBool("/sim/signals/reinit", false);
1128 fgSetBool("/sim/freeze/master", false);
1129 fgSetBool("/sim/sceneryloaded",false);
1132 void fgInitPackageRoot()
1134 if (globals->packageRoot()) {
1138 SGPath packageAircraftDir = flightgear::defaultDownloadDir();
1139 packageAircraftDir.append("Aircraft");
1141 SGSharedPtr<Root> pkgRoot(new Root(packageAircraftDir, FLIGHTGEAR_VERSION));
1142 // set the http client later (too early in startup right now)
1143 globals->setPackageRoot(pkgRoot);