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>
84 #include <AIModel/AIManager.hxx>
86 #include <ATC/atc_mgr.hxx>
88 #include <Autopilot/route_mgr.hxx>
89 #include <Autopilot/autopilotgroup.hxx>
91 #include <Cockpit/panel.hxx>
92 #include <Cockpit/panel_io.hxx>
94 #include <Canvas/canvas_mgr.hxx>
95 #include <Canvas/gui_mgr.hxx>
96 #include <Canvas/FGCanvasSystemAdapter.hxx>
97 #include <GUI/new_gui.hxx>
98 #include <GUI/MessageBox.hxx>
99 #include <Input/input.hxx>
100 #include <Instrumentation/instrument_mgr.hxx>
101 #include <Model/acmodel.hxx>
102 #include <Model/modelmgr.hxx>
103 #include <AIModel/submodel.hxx>
104 #include <AIModel/AIManager.hxx>
105 #include <Navaids/navdb.hxx>
106 #include <Navaids/navlist.hxx>
107 #include <Scenery/scenery.hxx>
108 #include <Scenery/SceneryPager.hxx>
109 #include <Scenery/tilemgr.hxx>
110 #include <Scripting/NasalSys.hxx>
111 #include <Sound/voice.hxx>
112 #include <Sound/soundmanager.hxx>
113 #include <Systems/system_mgr.hxx>
114 #include <Time/light.hxx>
115 #include <Time/TimeManager.hxx>
117 #include <Traffic/TrafficMgr.hxx>
118 #include <MultiPlayer/multiplaymgr.hxx>
119 #include <FDM/fdm_shell.hxx>
120 #include <Environment/ephemeris.hxx>
121 #include <Environment/environment_mgr.hxx>
122 #include <Viewer/renderer.hxx>
123 #include <Viewer/viewmgr.hxx>
124 #include <Viewer/FGEventHandler.hxx>
125 #include <Navaids/NavDataCache.hxx>
126 #include <Instrumentation/HUD/HUD.hxx>
127 #include <Cockpit/cockpitDisplayManager.hxx>
128 #include <Network/HTTPClient.hxx>
129 #include <Network/fgcom.hxx>
130 #include <Network/http/httpd.hxx>
131 #include <Include/version.h>
133 #include <Viewer/CameraGroup.hxx>
135 #include "fg_init.hxx"
137 #include "fg_commands.hxx"
138 #include "fg_props.hxx"
139 #include "FGInterpolator.hxx"
140 #include "options.hxx"
141 #include "globals.hxx"
142 #include "logger.hxx"
144 #include "positioninit.hxx"
146 #include "AircraftDirVisitorBase.hxx"
149 #include <GUI/CocoaHelpers.h> // for Mac impl of platformDefaultDataPath()
157 using namespace boost::algorithm;
158 using namespace simgear::pkg;
160 extern osg::ref_ptr<osgViewer::Viewer> viewer;
162 // Return the current base package version
163 string fgBasePackageVersion() {
164 SGPath base_path( globals->get_fg_root() );
165 base_path.append("version");
166 if (!base_path.exists()) {
170 sg_gzifstream in( base_path.str() );
181 class FindAndCacheAircraft : public AircraftDirVistorBase
184 FindAndCacheAircraft(SGPropertyNode* autoSave)
186 _cache = autoSave->getNode("sim/startup/path-cache", true);
191 std::string aircraft = fgGetString( "/sim/aircraft", "");
192 if (aircraft.empty()) {
193 flightgear::fatalMessageBox("No aircraft", "No aircraft was specified");
194 SG_LOG(SG_GENERAL, SG_ALERT, "no aircraft specified");
198 _searchAircraft = aircraft + "-set.xml";
199 std::string aircraftDir = fgGetString("/sim/aircraft-dir", "");
200 if (!aircraftDir.empty()) {
201 // aircraft-dir was set, skip any searching at all, if it's valid
202 simgear::Dir acPath(aircraftDir);
203 SGPath setFile = acPath.file(_searchAircraft);
204 if (setFile.exists()) {
205 SG_LOG(SG_GENERAL, SG_INFO, "found aircraft in dir: " << aircraftDir );
208 readProperties(setFile.str(), globals->get_props());
209 } catch ( const sg_exception &e ) {
210 SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
211 flightgear::fatalMessageBox("Error reading aircraft",
212 "An error occured reading the requested aircraft (" + aircraft + ")",
213 e.getFormattedMessage());
219 SG_LOG(SG_GENERAL, SG_ALERT, "aircraft '" << _searchAircraft <<
220 "' not found in specified dir:" << aircraftDir);
221 flightgear::fatalMessageBox("Aircraft not found",
222 "The requested aircraft '" + aircraft + "' could not be found in the specified location.",
229 // prepare cache for re-scan
230 SGPropertyNode *n = _cache->getNode("fg-root", true);
231 n->setStringValue(globals->get_fg_root().c_str());
232 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
233 n = _cache->getNode("fg-aircraft", true);
234 n->setStringValue(getAircraftPaths().c_str());
235 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
236 _cache->removeChildren("aircraft");
238 visitAircraftPaths();
241 if (_foundPath.str().empty()) {
242 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find specified aircraft: " << aircraft );
243 flightgear::fatalMessageBox("Aircraft not found",
244 "The requested aircraft '" + aircraft + "' could not be found in any of the search paths");
249 SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft -set file from:" << _foundPath.str());
250 fgSetString( "/sim/aircraft-dir", _foundPath.dir().c_str());
251 if (!_foundPath.exists()) {
252 SG_LOG(SG_GENERAL, SG_ALERT, "Unable to find -set file:" << _foundPath.str());
257 readProperties(_foundPath.str(), globals->get_props());
258 } catch ( const sg_exception &e ) {
259 SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
260 flightgear::fatalMessageBox("Error reading aircraft",
261 "An error occured reading the requested aircraft (" + aircraft + ")",
262 e.getFormattedMessage());
270 SGPath getAircraftPaths() {
271 string_list pathList = globals->get_aircraft_paths();
272 SGPath aircraftPaths;
273 string_list::const_iterator it = pathList.begin();
274 if (it != pathList.end()) {
275 aircraftPaths.set(*it);
278 for (; it != pathList.end(); ++it) {
279 aircraftPaths.add(*it);
281 return aircraftPaths;
286 if (globals->get_fg_root() != _cache->getStringValue("fg-root", "")) {
287 return false; // cache mismatch
290 if (getAircraftPaths().str() != _cache->getStringValue("fg-aircraft", "")) {
291 return false; // cache mismatch
294 vector<SGPropertyNode_ptr> cache = _cache->getChildren("aircraft");
295 for (unsigned int i = 0; i < cache.size(); i++) {
296 const char *name = cache[i]->getStringValue("file", "");
297 if (!boost::equals(_searchAircraft, name, is_iequal())) {
301 SGPath xml(cache[i]->getStringValue("path", ""));
309 } // of aircraft in cache iteration
314 virtual VisitResult visit(const SGPath& p)
319 if (!_cache->getChild("aircraft", i++, false))
323 SGPropertyNode *n, *entry = _cache->getChild("aircraft", --i, true);
325 std::string fileName(p.file());
326 n = entry->getNode("file", true);
327 n->setStringValue(fileName);
328 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
330 n = entry->getNode("path", true);
331 n->setStringValue(p.dir());
332 n->setAttribute(SGPropertyNode::USERARCHIVE, true);
334 if ( boost::equals(fileName, _searchAircraft.c_str(), is_iequal()) ) {
339 return VISIT_CONTINUE;
342 std::string _searchAircraft;
344 SGPropertyNode* _cache;
348 static SGPath platformDefaultDataPath()
350 char *envp = ::getenv( "APPDATA" );
351 SGPath config( envp );
352 config.append( "flightgear.org" );
356 #elif defined(SG_MAC)
358 // platformDefaultDataPath defined in GUI/CocoaHelpers.h
361 static SGPath platformDefaultDataPath()
363 return SGPath::home() / ".fgfs";
369 SGPath dataPath = SGPath::fromEnv("FG_HOME", platformDefaultDataPath());
370 globals->set_fg_home(dataPath.c_str());
372 simgear::Dir fgHome(dataPath);
373 if (!fgHome.exists()) {
377 if (!fgHome.exists()) {
378 flightgear::fatalMessageBox("Problem setting up user data",
379 "Unable to create the user-data storage folder at: '"
380 + dataPath.str() + "'");
384 if (fgGetBool("/sim/fghome-readonly", false)) {
385 // user / config forced us into readonly mode, fine
386 SG_LOG(SG_GENERAL, SG_INFO, "Running with FG_HOME readonly");
390 // write our PID, and check writeability
391 SGPath pidPath(dataPath, "fgfs.pid");
392 if (pidPath.exists()) {
393 SG_LOG(SG_GENERAL, SG_INFO, "flightgear instance already running, switching to FG_HOME read-only.");
394 // set a marker property so terrasync/navcache don't try to write
395 // from secondary instances
396 fgSetBool("/sim/fghome-readonly", true);
402 #if defined(SG_WINDOWS)
403 size_t len = snprintf(buf, 16, "%d", _getpid());
405 HANDLE f = CreateFileA(pidPath.c_str(), GENERIC_READ | GENERIC_WRITE,
406 FILE_SHARE_READ, /* sharing */
407 NULL, /* security attributes */
408 CREATE_NEW, /* error if already exists */
409 FILE_FLAG_DELETE_ON_CLOSE,
410 NULL /* template */);
412 result = (f != INVALID_HANDLE_VALUE);
415 WriteFile(f, buf, len, &written, NULL /* overlapped */);
418 // POSIX, do open+unlink trick to the file is deleted on exit, even if we
420 ssize_t len = snprintf(buf, 16, "%d", getpid());
421 int fd = ::open(pidPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
423 result = ::write(fd, buf, len) == len;
424 if( ::unlink(pidPath.c_str()) != 0 ) // delete file when app quits
429 fgSetBool("/sim/fghome-readonly", false);
432 flightgear::fatalMessageBox("File permissions problem",
433 "Can't write to user-data storage folder, check file permissions and FG_HOME.",
434 "User-data at:" + dataPath.str());
439 // Read in configuration (file and command line)
440 int fgInitConfig ( int argc, char **argv, bool reinit )
442 SGPath dataPath = globals->get_fg_home();
444 simgear::Dir exportDir(simgear::Dir(dataPath).file("Export"));
445 if (!exportDir.exists()) {
446 exportDir.create(0755);
449 // Set /sim/fg-home and don't allow malign code to override it until
450 // Nasal security is set up. Use FG_HOME if necessary.
451 SGPropertyNode *home = fgGetNode("/sim", true);
452 home->removeChild("fg-home", 0);
453 home = home->getChild("fg-home", 0, true);
454 home->setStringValue(dataPath.c_str());
455 home->setAttribute(SGPropertyNode::WRITE, false);
458 flightgear::Options* options = flightgear::Options::sharedInstance();
460 options->init(argc, argv, dataPath);
463 bool loadDefaults = options->shouldLoadDefaultConfig();
465 // Read global preferences from $FG_ROOT/preferences.xml
466 SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences");
467 fgLoadProps("preferences.xml", globals->get_props());
468 SG_LOG(SG_INPUT, SG_INFO, "Finished Reading global preferences");
470 // do not load user settings when reset to default is requested, or if
471 // told to explicitly ignore
472 if (options->isOptionSet("restore-defaults") || options->isOptionSet("ignore-autosave"))
474 SG_LOG(SG_GENERAL, SG_ALERT, "Ignoring user settings. Restoring defaults.");
478 globals->loadUserSettings(dataPath);
481 SG_LOG(SG_GENERAL, SG_INFO, "not reading default configuration files");
482 }// of no-default-config selected
484 return flightgear::FG_OPTIONS_OK;
487 static void initAircraftDirsNasalSecurity()
489 SGPropertyNode* sim = fgGetNode("/sim", true);
490 sim->removeChildren("fg-aircraft");
493 string_list const aircraft_paths = globals->get_aircraft_paths();
494 for( string_list::const_iterator it = aircraft_paths.begin();
495 it != aircraft_paths.end();
498 SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
499 n->setStringValue(*it);
500 n->setAttribute(SGPropertyNode::WRITE, false);
504 void fgInitAircraftPaths(bool reinit)
507 SGPath userAircraftDir = SGPath::documents(globals->get_fg_home());
508 if (userAircraftDir != globals->get_fg_home()) {
509 userAircraftDir.append("FlightGear");
511 userAircraftDir.append("Aircraft");
513 SGSharedPtr<Root> pkgRoot(new Root(userAircraftDir, FLIGHTGEAR_VERSION));
514 // set the http client later (too early in startup right now)
515 globals->setPackageRoot(pkgRoot);
518 SGSharedPtr<Root> pkgRoot(globals->packageRoot());
519 SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
520 aircraftProp->setAttribute(SGPropertyNode::PRESERVE, true);
523 flightgear::Options::sharedInstance()->initPaths();
527 int fgInitAircraft(bool reinit)
530 flightgear::Options::sharedInstance()->initAircraft();
533 SGSharedPtr<Root> pkgRoot(globals->packageRoot());
534 SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
536 string aircraftId(aircraftProp->getStringValue());
537 PackageRef acftPackage = pkgRoot->getPackageById(aircraftId);
539 if (acftPackage->isInstalled()) {
540 SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft from package:" << acftPackage->qualifiedId());
542 // set catalog path so intra-package dependencies within the catalog
543 // are resolved correctly.
544 globals->set_catalog_aircraft_path(acftPackage->catalog()->installRoot());
546 // set aircraft-dir to short circuit the search process
547 InstallRef acftInstall = acftPackage->install();
548 fgSetString("/sim/aircraft-dir", acftInstall->path().c_str());
550 // overwrite the fully qualified ID with the aircraft one, so the
551 // code in FindAndCacheAircraft works as normal
552 // note since we may be using a variant, we can't use the package ID
553 size_t lastDot = aircraftId.rfind('.');
554 if (lastDot != std::string::npos) {
555 aircraftId = aircraftId.substr(lastDot + 1);
556 aircraftProp->setStringValue(aircraftId);
559 // run the traditional-code path below
562 // naturally the better option would be to on-demand install it!
563 flightgear::fatalMessageBox("Aircraft not installed",
564 "Requested aircraft is not currently installed.",
567 return flightgear::FG_OPTIONS_ERROR;
572 initAircraftDirsNasalSecurity();
574 FindAndCacheAircraft f(globals->get_props());
575 if (!f.loadAircraft()) {
576 return flightgear::FG_OPTIONS_ERROR;
579 return flightgear::FG_OPTIONS_OK;
583 * Initialize vor/ndb/ils/fix list management and query systems (as
584 * well as simple airport db list)
585 * This is called multiple times in the case of a cache rebuild,
586 * to allow lengthy caching to take place in the background, without
587 * blocking the main/UI thread.
592 flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
593 static bool doingRebuild = false;
594 if (doingRebuild || cache->isRebuildRequired()) {
596 bool finished = cache->rebuild();
598 // sleep to give the rebuild thread more time
599 SGTimeStamp::sleepForMSec(50);
604 // depend on when the NavCache was initialised, scenery paths may not
605 // have been setup. This is a safe place to consistently check the value,
606 // and drop the ground-nets if something has changed
607 cache->dropGroundnetsIfRequired();
609 FGTACANList *channellist = new FGTACANList;
610 globals->set_channellist( channellist );
612 SGPath path(globals->get_fg_root());
613 path.append( "Navaids/TACAN_freq.dat" );
614 flightgear::loadTacan(path, channellist);
619 // General house keeping initializations
620 bool fgInitGeneral() {
623 SG_LOG( SG_GENERAL, SG_INFO, "General Initialization" );
624 SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
626 root = globals->get_fg_root();
627 if ( ! root.length() ) {
628 // No root path set? Then bail ...
629 SG_LOG( SG_GENERAL, SG_ALERT,
630 "Cannot continue without a path to the base package "
631 << "being defined." );
634 SG_LOG( SG_GENERAL, SG_INFO, "FG_ROOT = " << '"' << root << '"' << endl );
636 // Note: browser command is hard-coded for Mac/Windows, so this only affects other platforms
637 globals->set_browser(fgGetString("/sim/startup/browser-app", WEB_BROWSER));
638 fgSetString("/sim/startup/browser-app", globals->get_browser());
640 simgear::Dir cwd(simgear::Dir::current());
641 SGPropertyNode *curr = fgGetNode("/sim", true);
642 curr->removeChild("fg-current", 0);
643 curr = curr->getChild("fg-current", 0, true);
644 curr->setStringValue(cwd.path().str());
645 curr->setAttribute(SGPropertyNode::WRITE, false);
647 fgSetBool("/sim/startup/stdout-to-terminal", isatty(1) != 0 );
648 fgSetBool("/sim/startup/stderr-to-terminal", isatty(2) != 0 );
652 // Write various configuraton values out to the logs
653 void fgOutputSettings()
655 SG_LOG( SG_GENERAL, SG_INFO, "Configuration State" );
656 SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
658 SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"' );
659 SG_LOG( SG_GENERAL, SG_INFO, "fghome-dir = " << '"' << globals->get_fg_home() << '"');
660 SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"');
662 SG_LOG( SG_GENERAL, SG_INFO, "aircraft-search-paths = \n\t" << simgear::strutils::join(globals->get_aircraft_paths(), "\n\t") );
663 SG_LOG( SG_GENERAL, SG_INFO, "scenery-search-paths = \n\t" << simgear::strutils::join(globals->get_fg_scenery(), "\n\t") );
666 // This is the top level init routine which calls all the other
667 // initialization routines. If you are adding a subsystem to flight
668 // gear, its initialization call should located in this routine.
669 // Returns non-zero if a problem encountered.
670 void fgCreateSubsystems(bool duringReset) {
672 SG_LOG( SG_GENERAL, SG_INFO, "Creating Subsystems");
673 SG_LOG( SG_GENERAL, SG_INFO, "========== ==========");
675 ////////////////////////////////////////////////////////////////////
676 // Initialize the sound subsystem.
677 ////////////////////////////////////////////////////////////////////
678 // Sound manager uses an own subsystem group "SOUND" which is the last
679 // to be updated in every loop.
680 // Sound manager is updated last so it can use the CPU while the GPU
681 // is processing the scenery (doubled the frame-rate for me) -EMH-
682 globals->add_subsystem("sound", new FGSoundManager, SGSubsystemMgr::SOUND);
684 ////////////////////////////////////////////////////////////////////
685 // Initialize the event manager subsystem.
686 ////////////////////////////////////////////////////////////////////
688 globals->get_event_mgr()->init();
689 globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
691 ////////////////////////////////////////////////////////////////////
692 // Initialize the property interpolator subsystem. Put into the INIT
693 // group because the "nasal" subsystem may need it at GENERAL take-down.
694 ////////////////////////////////////////////////////////////////////
695 globals->add_subsystem("prop-interpolator", new FGInterpolator, SGSubsystemMgr::INIT);
698 ////////////////////////////////////////////////////////////////////
699 // Add the FlightGear property utilities.
700 ////////////////////////////////////////////////////////////////////
701 globals->add_subsystem("properties", new FGProperties);
704 ////////////////////////////////////////////////////////////////////
705 // Add the performance monitoring system.
706 ////////////////////////////////////////////////////////////////////
707 globals->add_subsystem("performance-mon",
708 new SGPerformanceMonitor(globals->get_subsystem_mgr(),
709 fgGetNode("/sim/performance-monitor", true)));
711 ////////////////////////////////////////////////////////////////////
712 // Initialize the material property subsystem.
713 ////////////////////////////////////////////////////////////////////
715 SGPath mpath( globals->get_fg_root() );
716 mpath.append( fgGetString("/sim/rendering/materials-file") );
717 if ( ! globals->get_matlib()->load(globals->get_fg_root(), mpath.str(),
718 globals->get_props()) ) {
719 throw sg_io_exception("Error loading materials file", mpath);
722 globals->add_subsystem( "http", new FGHTTPClient );
724 ////////////////////////////////////////////////////////////////////
725 // Initialize the scenery management subsystem.
726 ////////////////////////////////////////////////////////////////////
728 globals->get_scenery()->get_scene_graph()
729 ->addChild(simgear::Particles::getCommonRoot());
730 simgear::GlobalParticleCallback::setSwitch(fgGetNode("/sim/rendering/particles", true));
732 ////////////////////////////////////////////////////////////////////
733 // Initialize the flight model subsystem.
734 ////////////////////////////////////////////////////////////////////
736 globals->add_subsystem("flight", new FDMShell, SGSubsystemMgr::FDM);
738 ////////////////////////////////////////////////////////////////////
739 // Initialize the weather subsystem.
740 ////////////////////////////////////////////////////////////////////
742 // Initialize the weather modeling subsystem
743 globals->add_subsystem("environment", new FGEnvironmentMgr);
744 globals->add_subsystem("ephemeris", new Ephemeris);
746 ////////////////////////////////////////////////////////////////////
747 // Initialize the aircraft systems and instrumentation (before the
749 ////////////////////////////////////////////////////////////////////
751 globals->add_subsystem("systems", new FGSystemMgr, SGSubsystemMgr::FDM);
752 globals->add_subsystem("instrumentation", new FGInstrumentMgr, SGSubsystemMgr::FDM);
753 globals->add_subsystem("hud", new HUD, SGSubsystemMgr::DISPLAY);
754 globals->add_subsystem("cockpit-displays", new flightgear::CockpitDisplayManager, SGSubsystemMgr::DISPLAY);
756 ////////////////////////////////////////////////////////////////////
757 // Initialize the XML Autopilot subsystem.
758 ////////////////////////////////////////////////////////////////////
760 globals->add_subsystem( "xml-autopilot", FGXMLAutopilotGroup::createInstance("autopilot"), SGSubsystemMgr::FDM );
761 globals->add_subsystem( "xml-proprules", FGXMLAutopilotGroup::createInstance("property-rule"), SGSubsystemMgr::GENERAL );
762 globals->add_subsystem( "route-manager", new FGRouteMgr );
764 ////////////////////////////////////////////////////////////////////
765 // Initialize the Input-Output subsystem
766 ////////////////////////////////////////////////////////////////////
767 globals->add_subsystem( "io", new FGIO );
769 ////////////////////////////////////////////////////////////////////
770 // Create and register the logger.
771 ////////////////////////////////////////////////////////////////////
773 globals->add_subsystem("logger", new FGLogger);
775 ////////////////////////////////////////////////////////////////////
776 // Create and register the XML GUI.
777 ////////////////////////////////////////////////////////////////////
779 globals->add_subsystem("gui", new NewGUI, SGSubsystemMgr::INIT);
781 //////////////////////////////////////////////////////////////////////
782 // Initialize the 2D cloud subsystem.
783 ////////////////////////////////////////////////////////////////////
784 fgGetBool("/sim/rendering/bump-mapping", false);
786 ////////////////////////////////////////////////////////////////////
787 // Initialize the canvas 2d drawing subsystem.
788 ////////////////////////////////////////////////////////////////////
789 simgear::canvas::Canvas::setSystemAdapter(
790 simgear::canvas::SystemAdapterPtr(new canvas::FGCanvasSystemAdapter)
792 globals->add_subsystem("Canvas", new CanvasMgr, SGSubsystemMgr::DISPLAY);
793 globals->add_subsystem("CanvasGUI", new GUIMgr, SGSubsystemMgr::DISPLAY);
795 ////////////////////////////////////////////////////////////////////
796 // Initialize the ATC subsystem
797 ////////////////////////////////////////////////////////////////////
798 globals->add_subsystem("ATC", new FGATCManager, SGSubsystemMgr::POST_FDM);
800 ////////////////////////////////////////////////////////////////////
801 // Initialize multiplayer subsystem
802 ////////////////////////////////////////////////////////////////////
804 globals->add_subsystem("mp", new FGMultiplayMgr, SGSubsystemMgr::POST_FDM);
806 ////////////////////////////////////////////////////////////////////
807 // Initialise the AI Model Manager
808 ////////////////////////////////////////////////////////////////////
809 SG_LOG(SG_GENERAL, SG_INFO, " AI Model Manager");
810 globals->add_subsystem("ai-model", new FGAIManager, SGSubsystemMgr::POST_FDM);
811 globals->add_subsystem("submodel-mgr", new FGSubmodelMgr, SGSubsystemMgr::POST_FDM);
814 // It's probably a good idea to initialize the top level traffic manager
815 // After the AI and ATC systems have been initialized properly.
816 // AI Traffic manager
817 globals->add_subsystem("traffic-manager", new FGTrafficManager, SGSubsystemMgr::POST_FDM);
819 ////////////////////////////////////////////////////////////////////
820 // Add a new 2D panel.
821 ////////////////////////////////////////////////////////////////////
823 fgSetArchivable("/sim/panel/visibility");
824 fgSetArchivable("/sim/panel/x-offset");
825 fgSetArchivable("/sim/panel/y-offset");
826 fgSetArchivable("/sim/panel/jitter");
828 ////////////////////////////////////////////////////////////////////
829 // Initialize the controls subsystem.
830 ////////////////////////////////////////////////////////////////////
832 globals->add_subsystem("controls", new FGControls, SGSubsystemMgr::GENERAL);
834 ////////////////////////////////////////////////////////////////////
835 // Initialize the input subsystem.
836 ////////////////////////////////////////////////////////////////////
838 globals->add_subsystem("input", new FGInput, SGSubsystemMgr::GENERAL);
841 ////////////////////////////////////////////////////////////////////
842 // Initialize the replay subsystem
843 ////////////////////////////////////////////////////////////////////
844 globals->add_subsystem("replay", new FGReplay);
845 globals->add_subsystem("history", new FGFlightHistory);
847 #ifdef ENABLE_AUDIO_SUPPORT
848 ////////////////////////////////////////////////////////////////////
849 // Initialize the sound-effects subsystem.
850 ////////////////////////////////////////////////////////////////////
851 globals->add_subsystem("voice", new FGVoiceMgr, SGSubsystemMgr::DISPLAY);
855 ////////////////////////////////////////////////////////////////////
856 // Initialize the FGCom subsystem.
857 ////////////////////////////////////////////////////////////////////
858 globals->add_subsystem("fgcom", new FGCom);
862 SGSubsystem * httpd = flightgear::http::FGHttpd::createInstance( fgGetNode(flightgear::http::PROPERTY_ROOT) );
864 globals->add_subsystem("httpd", httpd );
867 ////////////////////////////////////////////////////////////////////
868 // Initialize the lighting subsystem.
869 ////////////////////////////////////////////////////////////////////
871 // ordering here is important : Nasal (via events), then models, then views
873 globals->add_subsystem("lighting", new FGLight, SGSubsystemMgr::DISPLAY);
874 globals->add_subsystem("events", globals->get_event_mgr(), SGSubsystemMgr::DISPLAY);
877 globals->add_subsystem("aircraft-model", new FGAircraftModel, SGSubsystemMgr::DISPLAY);
878 globals->add_subsystem("model-manager", new FGModelMgr, SGSubsystemMgr::DISPLAY);
880 globals->add_subsystem("view-manager", new FGViewMgr, SGSubsystemMgr::DISPLAY);
882 globals->add_subsystem("tile-manager", globals->get_tile_mgr(),
883 SGSubsystemMgr::DISPLAY);
886 void fgPostInitSubsystems()
891 ////////////////////////////////////////////////////////////////////////
892 // Initialize the Nasal interpreter.
893 // Do this last, so that the loaded scripts see initialized state
894 ////////////////////////////////////////////////////////////////////////
895 FGNasalSys* nasal = new FGNasalSys();
896 globals->add_subsystem("nasal", nasal, SGSubsystemMgr::INIT);
898 SG_LOG(SG_GENERAL, SG_INFO, "Nasal init took:" << st.elapsedMSec());
900 // initialize methods that depend on other subsystems.
902 globals->get_subsystem_mgr()->postinit();
903 SG_LOG(SG_GENERAL, SG_INFO, "Subsystems postinit took:" << st.elapsedMSec());
905 ////////////////////////////////////////////////////////////////////////
906 // End of subsystem initialization.
907 ////////////////////////////////////////////////////////////////////
909 fgSetBool("/sim/crashed", false);
910 fgSetBool("/sim/initialized", true);
912 SG_LOG( SG_GENERAL, SG_INFO, endl);
915 // re-position is a simplified version of the traditional (legacy)
916 // reset procedure. We only need to poke systems which will be upset by
917 // a sudden change in aircraft position. Since this potentially includes
918 // Nasal, we trigger the 'reinit' signal.
919 void fgStartReposition()
921 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
922 SG_LOG( SG_GENERAL, SG_INFO, "fgStartReposition()");
924 // ensure we are frozen
925 bool freeze = master_freeze->getBoolValue();
927 master_freeze->setBoolValue(true);
930 // set this signal so Nasal scripts can take action.
931 fgSetBool("/sim/signals/reinit", true);
932 fgSetBool("/sim/crashed", false);
934 FDMShell* fdm = static_cast<FDMShell*>(globals->get_subsystem("flight"));
937 // update our position based on current presets
938 // this will mark position as needed finalized which we'll do in the
940 flightgear::initPosition();
942 simgear::SGTerraSync* terraSync =
943 static_cast<simgear::SGTerraSync*>(globals->get_subsystem("terrasync"));
945 terraSync->reposition();
948 // Initialize the FDM
949 globals->get_subsystem("flight")->reinit();
951 // reset replay buffers
952 globals->get_subsystem("replay")->reinit();
954 // ugly: finalizePosition waits for METAR to arrive for the new airport.
955 // we don't re-init the environment manager here, since historically we did
956 // not, and doing so seems to have other issues. All that's needed is to
957 // schedule METAR fetch immediately, so it's available for finalizePosition.
958 // So we manually extract the METAR-fetching component inside the environment
959 // manager, and re-init that.
960 SGSubsystemGroup* envMgr = static_cast<SGSubsystemGroup*>(globals->get_subsystem("environment"));
962 envMgr->get_subsystem("realwx")->reinit();
965 // need to bind FDMshell again, since we manually unbound it above...
968 // need to reset aircraft (systems/instruments/autopilot)
969 // so they can adapt to current environment
970 globals->get_subsystem("systems")->reinit();
971 globals->get_subsystem("instrumentation")->reinit();
972 globals->get_subsystem("xml-autopilot")->reinit();
974 // setup state to end re-init
975 fgSetBool("/sim/signals/reinit", false);
977 master_freeze->setBoolValue(false);
979 fgSetBool("/sim/sceneryloaded",false);
982 void fgStartNewReset()
984 SGPropertyNode_ptr preserved(new SGPropertyNode);
986 if (!copyPropertiesWithAttribute(globals->get_props(), preserved, SGPropertyNode::PRESERVE))
987 SG_LOG(SG_GENERAL, SG_ALERT, "Error saving preserved state");
989 fgSetBool("/sim/signals/reinit", true);
990 fgSetBool("/sim/freeze/master", true);
992 SGSubsystemMgr* subsystemManger = globals->get_subsystem_mgr();
993 // Nasal is manually inited in fgPostInit, ensure it's already shutdown
994 // before other subsystems, so Nasal listeners don't fire during shutdonw
995 SGSubsystem* nasal = subsystemManger->get_subsystem("nasal");
998 subsystemManger->remove("nasal");
1000 subsystemManger->shutdown();
1001 subsystemManger->unbind();
1003 // remove most subsystems, with a few exceptions.
1004 for (int g=0; g<SGSubsystemMgr::MAX_GROUPS; ++g) {
1005 SGSubsystemGroup* grp = subsystemManger->get_group(static_cast<SGSubsystemMgr::GroupType>(g));
1006 const string_list& names(grp->member_names());
1007 string_list::const_iterator it;
1008 for (it = names.begin(); it != names.end(); ++it) {
1009 if ((*it == "time") || (*it == "terrasync") || (*it == "events")
1010 || (*it == "lighting"))
1016 subsystemManger->remove(it->c_str());
1017 } catch (std::exception& e) {
1018 SG_LOG(SG_GENERAL, SG_INFO, "caught std::exception shutting down:" << *it);
1020 SG_LOG(SG_GENERAL, SG_INFO, "caught generic exception shutting down:" << *it);
1023 // don't delete here, dropping the ref should be sufficient
1025 } // of top-level groups iteration
1027 FGRenderer* render = globals->get_renderer();
1028 // needed or we crash in multi-threaded OSG mode
1029 render->getViewer()->stopThreading();
1031 // order is important here since tile-manager shutdown needs to
1032 // access the scenery object
1033 globals->set_tile_mgr(NULL);
1034 globals->set_scenery(NULL);
1035 FGScenery::getPagerSingleton()->clearRequests();
1036 flightgear::CameraGroup::setDefault(NULL);
1038 // don't cancel the pager until after shutdown, since AIModels (and
1039 // potentially others) can queue delete requests on the pager.
1040 render->getViewer()->getDatabasePager()->cancel();
1041 render->getViewer()->getDatabasePager()->clear();
1043 osgDB::Registry::instance()->clearObjectCache();
1045 // preserve the event handler; re-creating it would entail fixing the
1047 osg::ref_ptr<flightgear::FGEventHandler> eventHandler = render->getEventHandler();
1049 globals->set_renderer(NULL);
1050 globals->set_matlib(NULL);
1051 globals->set_chatter_queue(NULL);
1053 simgear::clearEffectCache();
1054 simgear::SGModelLib::resetPropertyRoot();
1056 simgear::GlobalParticleCallback::setSwitch(NULL);
1058 globals->resetPropertyRoot();
1059 // otherwise channels are duplicated
1060 globals->get_channel_options_list()->clear();
1062 fgInitConfig(0, NULL, true);
1063 fgInitGeneral(); // all of this?
1065 flightgear::Options::sharedInstance()->processOptions();
1067 // PRESERVED properties over-write state from options, intentionally
1068 if ( copyProperties(preserved, globals->get_props()) ) {
1069 SG_LOG( SG_GENERAL, SG_INFO, "Preserved state restored successfully" );
1071 SG_LOG( SG_GENERAL, SG_INFO,
1072 "Some errors restoring preserved state (read-only props?)" );
1075 fgGetNode("/sim")->removeChild("aircraft-dir");
1076 fgInitAircraftPaths(true);
1077 fgInitAircraft(true);
1079 render = new FGRenderer;
1080 render->setEventHandler(eventHandler);
1081 eventHandler->reset();
1082 globals->set_renderer(render);
1084 render->setViewer(viewer.get());
1086 viewer->getDatabasePager()->setUpThreads(1, 1);
1088 // must do this before splashinit for Rembrandt
1089 flightgear::CameraGroup::buildDefaultGroup(viewer.get());
1090 render->splashinit();
1091 viewer->startThreading();
1093 fgOSResetProperties();
1095 // init some things manually
1096 // which do not follow the regular init pattern
1098 globals->get_event_mgr()->init();
1099 globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
1101 globals->set_matlib( new SGMaterialLib );
1103 // terra-sync needs the property tree root, pass it back in
1104 simgear::SGTerraSync* terra_sync = static_cast<simgear::SGTerraSync*>(subsystemManger->get_subsystem("terrasync"));
1105 terra_sync->setRoot(globals->get_props());
1107 fgSetBool("/sim/signals/reinit", false);
1108 fgSetBool("/sim/freeze/master", false);
1109 fgSetBool("/sim/sceneryloaded",false);