1 // globals.cxx -- Global state that needs to be shared among the sim modules
3 // Written by Curtis Olson, started July 2000.
5 // Copyright (C) 2000 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 Foundation,
19 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <boost/foreach.hpp>
30 #include <osgViewer/Viewer>
31 #include <osgDB/Registry>
33 #include <simgear/structure/commands.hxx>
34 #include <simgear/misc/sg_path.hxx>
35 #include <simgear/misc/sg_dir.hxx>
36 #include <simgear/timing/sg_time.hxx>
37 #include <simgear/ephemeris/ephemeris.hxx>
38 #include <simgear/scene/material/matlib.hxx>
39 #include <simgear/structure/subsystem_mgr.hxx>
40 #include <simgear/structure/event_mgr.hxx>
41 #include <simgear/sound/soundmgr_openal.hxx>
42 #include <simgear/misc/ResourceManager.hxx>
43 #include <simgear/props/propertyObject.hxx>
44 #include <simgear/props/props_io.hxx>
45 #include <simgear/scene/model/modellib.hxx>
47 #include <Aircraft/controls.hxx>
48 #include <Airports/runways.hxx>
49 #include <ATCDCL/ATISmgr.hxx>
50 #include <Autopilot/route_mgr.hxx>
51 #include <GUI/FGFontCache.hxx>
53 #include <MultiPlayer/multiplaymgr.hxx>
54 #include <Scenery/scenery.hxx>
55 #include <Scenery/tilemgr.hxx>
56 #include <Navaids/navlist.hxx>
57 #include <Viewer/renderer.hxx>
58 #include <Viewer/viewmgr.hxx>
59 #include <Sound/sample_queue.hxx>
61 #include "globals.hxx"
64 #include "fg_props.hxx"
67 class AircraftResourceProvider : public simgear::ResourceProvider
70 AircraftResourceProvider() :
71 simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
75 virtual SGPath resolve(const std::string& aResource, SGPath&) const
77 string_list pieces(sgPathBranchSplit(aResource));
78 if ((pieces.size() < 3) || (pieces.front() != "Aircraft")) {
79 return SGPath(); // not an Aircraft path
82 // test against the aircraft-dir property
83 const char* aircraftDir = fgGetString("/sim/aircraft-dir");
84 string_list aircraftDirPieces(sgPathBranchSplit(aircraftDir));
85 if (!aircraftDirPieces.empty() && (aircraftDirPieces.back() == pieces[1])) {
86 // current aircraft-dir matches resource aircraft
87 SGPath r(aircraftDir);
88 for (unsigned int i=2; i<pieces.size(); ++i) {
97 // try each aircraft dir in turn
98 std::string res(aResource, 9); // resource path with 'Aircraft/' removed
99 const string_list& dirs(globals->get_aircraft_paths());
100 string_list::const_iterator it = dirs.begin();
101 for (; it != dirs.end(); ++it) {
106 } // of aircraft path iteration
108 return SGPath(); // not found
112 class CurrentAircraftDirProvider : public simgear::ResourceProvider
115 CurrentAircraftDirProvider() :
116 simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
120 virtual SGPath resolve(const std::string& aResource, SGPath&) const
122 const char* aircraftDir = fgGetString("/sim/aircraft-dir");
123 SGPath p(aircraftDir);
125 return p.exists() ? p : SGPath();
129 ////////////////////////////////////////////////////////////////////////
130 // Implementation of FGGlobals.
131 ////////////////////////////////////////////////////////////////////////
134 FGGlobals *globals = NULL;
138 FGGlobals::FGGlobals() :
139 initial_state( NULL ),
140 renderer( new FGRenderer ),
141 subsystem_mgr( new SGSubsystemMgr ),
142 event_mgr( new SGEventMgr ),
153 commands( SGCommandMgr::instance() ),
154 channel_options_list( NULL ),
155 initial_waypoints( NULL ),
156 fontcache ( new FGFontCache ),
158 haveUserSettings(false),
161 SGPropertyNode* root = new SGPropertyNode;
162 props = SGPropertyNode_ptr(root);
163 locale = new FGLocale(props);
165 simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider);
166 simgear::ResourceManager::instance()->addProvider(new CurrentAircraftDirProvider);
170 void FGGlobals::initProperties()
172 simgear::PropertyObjectBase::setDefaultRoot(props);
174 positionLon = props->getNode("position/longitude-deg", true);
175 positionLat = props->getNode("position/latitude-deg", true);
176 positionAlt = props->getNode("position/altitude-ft", true);
178 viewLon = props->getNode("sim/current-view/viewer-lon-deg", true);
179 viewLat = props->getNode("sim/current-view/viewer-lat-deg", true);
180 viewAlt = props->getNode("sim/current-view/viewer-elev-ft", true);
182 orientPitch = props->getNode("orientation/pitch-deg", true);
183 orientHeading = props->getNode("orientation/heading-deg", true);
184 orientRoll = props->getNode("orientation/roll-deg", true);
189 FGGlobals::~FGGlobals()
191 // save user settings (unless already saved)
194 // The AIModels manager performs a number of actions upon
195 // Shutdown that implicitly assume that other subsystems
196 // are still operational (Due to the dynamic allocation and
197 // deallocation of AIModel objects. To ensure we can safely
198 // shut down all subsystems, make sure we take down the
199 // AIModels system first.
200 SGSubsystemRef ai = subsystem_mgr->get_subsystem("ai-model");
202 subsystem_mgr->remove("ai-model");
204 ai.clear(); // ensure AI is deleted now, not at end of this method
207 subsystem_mgr->shutdown();
208 subsystem_mgr->unbind();
210 subsystem_mgr->remove("aircraft-model");
211 subsystem_mgr->remove("tile-manager");
212 subsystem_mgr->remove("model-manager");
215 osg::ref_ptr<osgViewer::Viewer> vw(renderer->getViewer());
217 // https://code.google.com/p/flightgear-bugs/issues/detail?id=1291
218 // explicitly stop trheading before we delete the renderer or
219 // viewMgr (which ultimately holds refs to the CameraGroup, and
224 // don't cancel the pager until after shutdown, since AIModels (and
225 // potentially others) can queue delete requests on the pager.
226 if (vw && vw->getDatabasePager()) {
227 vw->getDatabasePager()->cancel();
228 vw->getDatabasePager()->clear();
231 osgDB::Registry::instance()->clearObjectCache();
233 // renderer touches subsystems during its destruction
236 _chatter_queue.clear();
238 delete subsystem_mgr;
239 subsystem_mgr = NULL; // important so ::get_subsystem returns NULL
240 vw = 0; // don't delete the viewer until now
246 delete channel_options_list;
247 delete initial_waypoints;
251 simgear::PropertyObjectBase::setDefaultRoot(NULL);
252 simgear::SGModelLib::resetPropertyRoot();
264 // set the fg_root path
265 void FGGlobals::set_fg_root (const std::string &root) {
267 fg_root = tmp.realpath();
269 // append /data to root if it exists
270 tmp.append( "data" );
271 tmp.append( "version" );
272 if ( tmp.exists() ) {
273 fgGetNode("BAD_FG_ROOT", true)->setStringValue(fg_root);
275 fgGetNode("GOOD_FG_ROOT", true)->setStringValue(fg_root);
276 SG_LOG(SG_GENERAL, SG_ALERT, "***\n***\n*** Warning: changing bad FG_ROOT/--fg-root to '"
277 << fg_root << "'\n***\n***");
280 // remove /sim/fg-root before writing to prevent hijacking
281 SGPropertyNode *n = fgGetNode("/sim", true);
282 n->removeChild("fg-root", 0, false);
283 n = n->getChild("fg-root", 0, true);
284 n->setStringValue(fg_root.c_str());
285 n->setAttribute(SGPropertyNode::WRITE, false);
287 simgear::ResourceManager::instance()->addBasePath(fg_root,
288 simgear::ResourceManager::PRIORITY_DEFAULT);
291 // set the fg_home path
292 void FGGlobals::set_fg_home (const std::string &home) {
294 fg_home = tmp.realpath();
297 PathList FGGlobals::get_data_paths() const
299 PathList r(additional_data_paths);
300 r.push_back(SGPath(fg_root));
304 PathList FGGlobals::get_data_paths(const std::string& suffix) const
307 BOOST_FOREACH(SGPath p, get_data_paths()) {
317 void FGGlobals::append_data_path(const SGPath& path)
319 if (!path.exists()) {
320 SG_LOG(SG_GENERAL, SG_WARN, "adding non-existant data path:" << path);
323 additional_data_paths.push_back(path);
326 SGPath FGGlobals::find_data_dir(const std::string& pathSuffix) const
328 BOOST_FOREACH(SGPath p, additional_data_paths) {
329 p.append(pathSuffix);
335 SGPath rootPath(fg_root);
336 rootPath.append(pathSuffix);
337 if (rootPath.exists()) {
341 SG_LOG(SG_GENERAL, SG_WARN, "dir not found in any data path:" << pathSuffix);
345 void FGGlobals::append_fg_scenery (const std::string &paths)
347 // fg_scenery.clear();
348 SGPropertyNode* sim = fgGetNode("/sim", true);
350 // find first unused fg-scenery property in /sim
352 while (sim->getChild("fg-scenery", propIndex) != NULL) {
356 BOOST_FOREACH(const SGPath& path, sgPathSplit( paths )) {
357 SGPath abspath(path.realpath());
358 if (!abspath.exists()) {
359 SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << abspath.str());
363 // check for duplicates
364 string_list::const_iterator ex = std::find(fg_scenery.begin(), fg_scenery.end(), abspath.str());
365 if (ex != fg_scenery.end()) {
366 SG_LOG(SG_GENERAL, SG_INFO, "skipping duplicate add of scenery path:" << abspath.str());
370 simgear::Dir dir(abspath);
371 SGPath terrainDir(dir.file("Terrain"));
372 SGPath objectsDir(dir.file("Objects"));
374 // this code used to add *either* the base dir, OR add the
375 // Terrain and Objects subdirs, but the conditional logic was commented
376 // out, such that all three dirs are added. Unfortunately there's
377 // no information as to why the change was made.
378 fg_scenery.push_back(abspath.str());
380 if (terrainDir.exists()) {
381 fg_scenery.push_back(terrainDir.str());
384 if (objectsDir.exists()) {
385 fg_scenery.push_back(objectsDir.str());
388 // insert a marker for FGTileEntry::load(), so that
389 // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
390 // "B/Terrain", "B/Objects", ""]
391 fg_scenery.push_back("");
393 // make scenery dirs available to Nasal
394 SGPropertyNode* n = sim->getChild("fg-scenery", propIndex++, true);
395 n->setStringValue(abspath.str());
396 n->setAttribute(SGPropertyNode::WRITE, false);
397 } // of path list iteration
400 void FGGlobals::append_aircraft_path(const std::string& path)
402 SGPath dirPath(path);
403 if (!dirPath.exists()) {
404 SG_LOG(SG_GENERAL, SG_ALERT, "aircraft path not found:" << path);
408 SGPath acSubdir(dirPath);
409 acSubdir.append("Aircraft");
410 if (!acSubdir.exists()) {
411 if (dirPath.file() == "Aircraft") {
412 dirPath = dirPath.dir();
413 SG_LOG(SG_GENERAL, SG_WARN, "Specified an aircraft-dir path ending in 'Aircraft':" << path
414 << ", will instead use parent directory:" << dirPath);
416 SG_LOG(SG_GENERAL, SG_ALERT, "Aircraft-dir path '" << path <<
417 "' does not contain an 'Aircraft' subdirectory, cross-aircraft paths will not resolve correctly.");
421 std::string abspath = dirPath.realpath();
423 unsigned int index = fg_aircraft_dirs.size();
424 fg_aircraft_dirs.push_back(abspath);
426 // make aircraft dirs available to Nasal
427 SGPropertyNode* sim = fgGetNode("/sim", true);
428 sim->removeChild("fg-aircraft", index, false);
429 SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
430 n->setStringValue(abspath);
431 n->setAttribute(SGPropertyNode::WRITE, false);
434 void FGGlobals::append_aircraft_paths(const std::string& path)
436 string_list paths = sgPathSplit(path);
437 for (unsigned int p = 0; p<paths.size(); ++p) {
438 append_aircraft_path(paths[p]);
442 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
444 return simgear::ResourceManager::instance()->findPath(branch);
447 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
449 return simgear::ResourceManager::instance()->findPath(branch);
452 SGPath FGGlobals::resolve_resource_path(const std::string& branch) const
454 return simgear::ResourceManager::instance()
455 ->findPath(branch, SGPath(fgGetString("/sim/aircraft-dir")));
459 FGGlobals::get_renderer () const
464 void FGGlobals::set_renderer(FGRenderer *render)
466 if (render == renderer) {
475 FGGlobals::get_subsystem_mgr () const
477 return subsystem_mgr;
481 FGGlobals::get_subsystem (const char * name)
483 if (!subsystem_mgr) {
487 return subsystem_mgr->get_subsystem(name);
491 FGGlobals::add_subsystem (const char * name,
492 SGSubsystem * subsystem,
493 SGSubsystemMgr::GroupType type,
496 subsystem_mgr->add(name, subsystem, type, min_time_sec);
500 FGGlobals::get_soundmgr () const
503 return (SGSoundMgr*) subsystem_mgr->get_subsystem("sound");
509 FGGlobals::get_event_mgr () const
515 FGGlobals::get_aircraft_position() const
517 return SGGeod::fromDegFt(positionLon->getDoubleValue(),
518 positionLat->getDoubleValue(),
519 positionAlt->getDoubleValue());
523 FGGlobals::get_aircraft_position_cart() const
525 return SGVec3d::fromGeod(get_aircraft_position());
528 void FGGlobals::get_aircraft_orientation(double& heading, double& pitch, double& roll)
530 heading = orientHeading->getDoubleValue();
531 pitch = orientPitch->getDoubleValue();
532 roll = orientRoll->getDoubleValue();
536 FGGlobals::get_view_position() const
538 return SGGeod::fromDegFt(viewLon->getDoubleValue(),
539 viewLat->getDoubleValue(),
540 viewAlt->getDoubleValue());
544 FGGlobals::get_view_position_cart() const
546 return SGVec3d::fromGeod(get_view_position());
549 static void treeDumpRefCounts(int depth, SGPropertyNode* nd)
551 for (int i=0; i<nd->nChildren(); ++i) {
552 SGPropertyNode* cp = nd->getChild(i);
553 if (SGReferenced::count(cp) > 1) {
554 SG_LOG(SG_GENERAL, SG_INFO, "\t" << cp->getPath() << " refcount:" << SGReferenced::count(cp));
557 treeDumpRefCounts(depth + 1, cp);
561 static void treeClearAliases(SGPropertyNode* nd)
567 for (int i=0; i<nd->nChildren(); ++i) {
568 SGPropertyNode* cp = nd->getChild(i);
569 treeClearAliases(cp);
574 FGGlobals::resetPropertyRoot()
580 // we don't strictly need to clear these (they will be reset when we
581 // initProperties again), but trying to reduce false-positives when dumping
590 orientHeading.clear();
593 // clear aliases so ref-counts are accurate when dumped
594 treeClearAliases(props);
596 SG_LOG(SG_GENERAL, SG_INFO, "root props refcount:" << props.getNumRefs());
597 treeDumpRefCounts(0, props);
599 //BaseStackSnapshot::dumpAll(std::cout);
601 props = new SGPropertyNode;
603 locale = new FGLocale(props);
605 // remove /sim/fg-root before writing to prevent hijacking
606 SGPropertyNode *n = props->getNode("/sim", true);
607 n->removeChild("fg-root", 0, false);
608 n = n->getChild("fg-root", 0, true);
609 n->setStringValue(fg_root.c_str());
610 n->setAttribute(SGPropertyNode::WRITE, false);
613 // Save the current state as the initial state.
615 FGGlobals::saveInitialState ()
617 initial_state = new SGPropertyNode();
619 // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
620 int checked = SGPropertyNode::READ+SGPropertyNode::WRITE+
621 SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
622 int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
623 if (!copyProperties(props, initial_state, expected, checked))
624 SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
626 // delete various properties from the initial state, since we want to
627 // preserve their values even if doing a restore
628 // => Properties should now use the PRESERVE flag to protect their values
629 // on sim-reset. Remove some specific properties for backward compatibility.
630 SGPropertyNode* sim = initial_state->getChild("sim");
631 SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
632 if (cameraGroupNode) {
633 cameraGroupNode->removeChild("camera");
634 cameraGroupNode->removeChild("gui");
638 static std::string autosaveName()
640 std::ostringstream os;
641 string_list versionParts = simgear::strutils::split(VERSION, ".");
642 if (versionParts.size() < 2) {
643 return "autosave.xml";
646 os << "autosave_" << versionParts[0] << "_" << versionParts[1] << ".xml";
650 // Restore the saved initial state, if any
652 FGGlobals::restoreInitialState ()
654 if ( initial_state == 0 ) {
655 SG_LOG(SG_GENERAL, SG_ALERT,
656 "No initial state available to restore!!!");
659 // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
660 int checked = SGPropertyNode::READ+SGPropertyNode::WRITE+
661 SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
662 int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
663 if ( copyProperties(initial_state, props, expected, checked)) {
664 SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
666 SG_LOG( SG_GENERAL, SG_INFO,
667 "Some errors restoring initial state (read-only props?)" );
672 // Load user settings from autosave.xml
674 FGGlobals::loadUserSettings(const SGPath& dataPath)
676 // remember that we have (tried) to load any existing autsave.xml
677 haveUserSettings = true;
679 SGPath autosaveFile = simgear::Dir(dataPath).file(autosaveName());
680 SGPropertyNode autosave;
681 if (autosaveFile.exists()) {
682 SG_LOG(SG_INPUT, SG_INFO, "Reading user settings from " << autosaveFile.str());
684 readProperties(autosaveFile.str(), &autosave, SGPropertyNode::USERARCHIVE);
685 } catch (sg_exception& e) {
686 SG_LOG(SG_INPUT, SG_WARN, "failed to read user settings:" << e.getMessage()
687 << "(from " << e.getOrigin() << ")");
690 copyProperties(&autosave, globals->get_props());
693 // Save user settings in autosave.xml
695 FGGlobals::saveUserSettings()
697 // only save settings when we have (tried) to load the previous
698 // settings (otherwise user data was lost)
699 if (!haveUserSettings)
702 if (fgGetBool("/sim/startup/save-on-exit")) {
703 // don't save settings more than once on shutdown
704 haveUserSettings = false;
706 SGPath autosaveFile(globals->get_fg_home());
707 autosaveFile.append(autosaveName());
708 autosaveFile.create_dir( 0700 );
709 SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << autosaveFile.str());
711 writeProperties(autosaveFile.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
712 } catch (const sg_exception &e) {
713 guiErrorMessage("Error writing autosave:", e);
715 SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
720 FGGlobals::get_current_view () const
722 return viewmgr->get_current_view();
725 long int FGGlobals::get_warp() const
727 return fgGetInt("/sim/time/warp");
730 void FGGlobals::set_warp( long int w )
732 fgSetInt("/sim/time/warp", w);
735 long int FGGlobals::get_warp_delta() const
737 return fgGetInt("/sim/time/warp-delta");
740 void FGGlobals::set_warp_delta( long int d )
742 fgSetInt("/sim/time/warp-delta", d);
745 FGScenery* FGGlobals::get_scenery () const
747 return _scenery.get();
750 void FGGlobals::set_scenery ( FGScenery *s )
755 FGTileMgr* FGGlobals::get_tile_mgr () const
757 return _tile_mgr.get();
760 void FGGlobals::set_tile_mgr ( FGTileMgr *t )
765 void FGGlobals::set_matlib( SGMaterialLib *m )
772 FGSampleQueue* FGGlobals::get_chatter_queue() const
774 return _chatter_queue;
777 void FGGlobals::set_chatter_queue(FGSampleQueue* queue)
779 _chatter_queue = queue;
782 void FGGlobals::addListenerToCleanup(SGPropertyChangeListener* l)
784 _listeners_to_cleanup.push_back(l);
787 void FGGlobals::cleanupListeners()
789 SGPropertyChangeListenerVec::iterator i = _listeners_to_cleanup.begin();
790 for (; i != _listeners_to_cleanup.end(); ++i) {
793 _listeners_to_cleanup.clear();
796 // end of globals.cxx