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>
46 #include <simgear/package/Root.hxx>
48 #include <Aircraft/controls.hxx>
49 #include <Airports/runways.hxx>
50 #include <Autopilot/route_mgr.hxx>
52 #include <Scenery/scenery.hxx>
53 #include <Scenery/tilemgr.hxx>
54 #include <Navaids/navlist.hxx>
55 #include <Viewer/renderer.hxx>
56 #include <Viewer/viewmgr.hxx>
58 #include "globals.hxx"
61 #include "fg_props.hxx"
64 class AircraftResourceProvider : public simgear::ResourceProvider
67 AircraftResourceProvider() :
68 simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
72 virtual SGPath resolve(const std::string& aResource, SGPath&) const
74 string_list pieces(sgPathBranchSplit(aResource));
75 if ((pieces.size() < 3) || (pieces.front() != "Aircraft")) {
76 return SGPath(); // not an Aircraft path
79 // test against the aircraft-dir property
80 const char* aircraftDir = fgGetString("/sim/aircraft-dir");
81 string_list aircraftDirPieces(sgPathBranchSplit(aircraftDir));
82 if (!aircraftDirPieces.empty() && (aircraftDirPieces.back() == pieces[1])) {
83 // disable this warning for release builds
84 #if defined(ENABLE_DEV_WARNINGS)
86 for (unsigned int i=2; i<pieces.size(); ++i) {
87 betterPath.append(pieces[i]);
89 SG_LOG(SG_AIRCRAFT, SG_WARN, "resolved path:" << aResource << " using /sim/aircraft-dir.\n"
90 "This is legacy behaviour, change to an aircraft relative path:" << betterPath);
93 // current aircraft-dir matches resource aircraft
94 SGPath r(aircraftDir);
95 for (unsigned int i=2; i<pieces.size(); ++i) {
102 // Stop here, otherwise we could end up returning a resource that
103 // belongs to an unrelated version of the same aircraft (from a
104 // different aircraft directory).
109 // try each aircraft dir in turn
110 std::string res(aResource, 9); // resource path with 'Aircraft/' removed
111 const PathList& dirs(globals->get_aircraft_paths());
112 PathList::const_iterator it = dirs.begin();
113 for (; it != dirs.end(); ++it) {
119 } // of aircraft path iteration
121 return SGPath(); // not found
125 class CurrentAircraftDirProvider : public simgear::ResourceProvider
128 CurrentAircraftDirProvider() :
129 simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
133 virtual SGPath resolve(const std::string& aResource, SGPath&) const
135 SGPath p = SGPath::fromUtf8(fgGetString("/sim/aircraft-dir"));
137 return p.exists() ? p : SGPath();
141 ////////////////////////////////////////////////////////////////////////
142 // Implementation of FGGlobals.
143 ////////////////////////////////////////////////////////////////////////
146 FGGlobals *globals = NULL;
150 FGGlobals::FGGlobals() :
151 renderer( new FGRenderer ),
152 subsystem_mgr( new SGSubsystemMgr ),
153 event_mgr( new SGEventMgr ),
158 commands( SGCommandMgr::instance() ),
159 channel_options_list( NULL ),
160 initial_waypoints( NULL ),
162 haveUserSettings(false)
164 SGPropertyNode* root = new SGPropertyNode;
165 props = SGPropertyNode_ptr(root);
166 locale = new FGLocale(props);
168 simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider);
169 simgear::ResourceManager::instance()->addProvider(new CurrentAircraftDirProvider);
173 void FGGlobals::initProperties()
175 simgear::PropertyObjectBase::setDefaultRoot(props);
177 positionLon = props->getNode("position/longitude-deg", true);
178 positionLat = props->getNode("position/latitude-deg", true);
179 positionAlt = props->getNode("position/altitude-ft", true);
181 viewLon = props->getNode("sim/current-view/viewer-lon-deg", true);
182 viewLat = props->getNode("sim/current-view/viewer-lat-deg", true);
183 viewAlt = props->getNode("sim/current-view/viewer-elev-ft", true);
185 orientPitch = props->getNode("orientation/pitch-deg", true);
186 orientHeading = props->getNode("orientation/heading-deg", true);
187 orientRoll = props->getNode("orientation/roll-deg", true);
192 FGGlobals::~FGGlobals()
194 // save user settings (unless already saved)
197 // stop OSG threading first, to avoid thread races while we tear down
198 // scene-graph pieces
200 osg::ref_ptr<osgViewer::Viewer> vw(renderer->getViewer());
202 // https://code.google.com/p/flightgear-bugs/issues/detail?id=1291
203 // explicitly stop trheading before we delete the renderer or
204 // viewMgr (which ultimately holds refs to the CameraGroup, and
209 subsystem_mgr->shutdown();
210 subsystem_mgr->unbind();
212 subsystem_mgr->remove(FGTileMgr::subsystemName());
213 // don't cancel the pager until after shutdown, since AIModels (and
214 // potentially others) can queue delete requests on the pager.
215 if (vw && vw->getDatabasePager()) {
216 vw->getDatabasePager()->cancel();
217 vw->getDatabasePager()->clear();
220 osgDB::Registry::instance()->clearObjectCache();
221 subsystem_mgr->remove(FGScenery::subsystemName());
223 // renderer touches subsystems during its destruction
226 delete subsystem_mgr;
227 subsystem_mgr = NULL; // important so ::get_subsystem returns NULL
228 vw = 0; // don't delete the viewer until now
233 delete channel_options_list;
234 delete initial_waypoints;
237 simgear::PropertyObjectBase::setDefaultRoot(NULL);
238 simgear::SGModelLib::resetPropertyRoot();
250 // set the fg_root path
251 void FGGlobals::set_fg_root (const SGPath &root) {
253 fg_root = tmp.realpath();
255 // append /data to root if it exists
256 tmp.append( "data" );
257 tmp.append( "version" );
258 if ( tmp.exists() ) {
259 fgGetNode("BAD_FG_ROOT", true)->setStringValue(fg_root.utf8Str());
260 fg_root.append("data");
261 fgGetNode("GOOD_FG_ROOT", true)->setStringValue(fg_root.utf8Str());
262 SG_LOG(SG_GENERAL, SG_ALERT, "***\n***\n*** Warning: changing bad FG_ROOT/--fg-root to '"
263 << fg_root << "'\n***\n***");
266 // deliberately not a tied property, for fgValidatePath security
267 // write-protect to avoid accidents
268 SGPropertyNode *n = fgGetNode("/sim", true);
269 n->removeChild("fg-root", 0);
270 n = n->getChild("fg-root", 0, true);
271 n->setStringValue(fg_root.utf8Str());
272 n->setAttribute(SGPropertyNode::WRITE, false);
274 simgear::ResourceManager::instance()->addBasePath(fg_root,
275 simgear::ResourceManager::PRIORITY_DEFAULT);
278 // set the fg_home path
279 void FGGlobals::set_fg_home (const SGPath &home)
281 fg_home = home.realpath();
284 PathList FGGlobals::get_data_paths() const
286 PathList r(additional_data_paths);
287 r.push_back(fg_root);
291 PathList FGGlobals::get_data_paths(const std::string& suffix) const
294 BOOST_FOREACH(SGPath p, get_data_paths()) {
304 void FGGlobals::append_data_path(const SGPath& path)
306 if (!path.exists()) {
307 SG_LOG(SG_GENERAL, SG_WARN, "adding non-existant data path:" << path);
310 additional_data_paths.push_back(path);
313 SGPath FGGlobals::find_data_dir(const std::string& pathSuffix) const
315 BOOST_FOREACH(SGPath p, additional_data_paths) {
316 p.append(pathSuffix);
322 SGPath rootPath(fg_root);
323 rootPath.append(pathSuffix);
324 if (rootPath.exists()) {
328 SG_LOG(SG_GENERAL, SG_WARN, "dir not found in any data path:" << pathSuffix);
332 void FGGlobals::append_fg_scenery (const PathList &paths, bool secure)
334 BOOST_FOREACH(const SGPath& path, paths) {
335 append_fg_scenery(path);
339 void FGGlobals::append_fg_scenery (const SGPath &path, bool secure)
341 SGPropertyNode* sim = fgGetNode("/sim", true);
343 // find first unused fg-scenery property in /sim
345 while (sim->getChild("fg-scenery", propIndex) != NULL) {
349 SGPath abspath(path.realpath());
350 if (!abspath.exists()) {
351 SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << abspath);
355 // check for duplicates
356 PathList::const_iterator ex = std::find(fg_scenery.begin(), fg_scenery.end(), abspath);
357 if (ex != fg_scenery.end()) {
358 SG_LOG(SG_GENERAL, SG_INFO, "skipping duplicate add of scenery path:" << abspath);
362 // tell the ResouceManager about the scenery path
363 // needed to load Models from this scenery path
364 simgear::ResourceManager::instance()->addBasePath(abspath.local8BitStr(),
365 simgear::ResourceManager::PRIORITY_DEFAULT);
367 simgear::Dir dir(abspath);
368 SGPath terrainDir(dir.file("Terrain"));
369 SGPath objectsDir(dir.file("Objects"));
371 // this code used to add *either* the base dir, OR add the
372 // Terrain and Objects subdirs, but the conditional logic was commented
373 // out, such that all three dirs are added. Unfortunately there's
374 // no information as to why the change was made.
375 fg_scenery.push_back(abspath);
377 secure_fg_scenery.push_back(abspath);
380 if (terrainDir.exists()) {
381 fg_scenery.push_back(terrainDir);
384 if (objectsDir.exists()) {
385 fg_scenery.push_back(objectsDir);
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(SGPath());
393 // make scenery dirs available to Nasal
394 SGPropertyNode* n = sim->getChild("fg-scenery", propIndex++, true);
395 n->setStringValue(abspath.utf8Str());
396 n->setAttribute(SGPropertyNode::WRITE, false);
398 // temporary fix so these values survive reset
399 n->setAttribute(SGPropertyNode::PRESERVE, true);
402 void FGGlobals::clear_fg_scenery()
405 secure_fg_scenery.clear();
406 fgGetNode("/sim", true)->removeChildren("fg-scenery");
410 void FGGlobals::set_catalog_aircraft_path(const SGPath& path)
412 catalog_aircraft_dir = path;
415 PathList FGGlobals::get_aircraft_paths() const
418 if (!catalog_aircraft_dir.isNull()) {
419 r.push_back(catalog_aircraft_dir);
422 r.insert(r.end(), fg_aircraft_dirs.begin(), fg_aircraft_dirs.end());
426 void FGGlobals::append_aircraft_path(const SGPath& path)
428 SGPath dirPath(path);
429 if (!dirPath.exists()) {
430 SG_LOG(SG_GENERAL, SG_ALERT, "aircraft path not found:" << path);
434 SGPath acSubdir(dirPath);
435 acSubdir.append("Aircraft");
436 if (acSubdir.exists()) {
440 "Specified an aircraft-dir with an 'Aircraft' subdirectory:" << dirPath
441 << ", will instead use child directory:" << acSubdir
446 fg_aircraft_dirs.push_back(dirPath.realpath());
449 void FGGlobals::append_aircraft_paths(const PathList& paths)
451 for (unsigned int p = 0; p<paths.size(); ++p) {
452 append_aircraft_path(paths[p]);
456 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
458 return simgear::ResourceManager::instance()->findPath(branch);
461 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
463 return simgear::ResourceManager::instance()->findPath(branch);
466 SGPath FGGlobals::resolve_resource_path(const std::string& branch) const
468 return simgear::ResourceManager::instance()
469 ->findPath(branch, SGPath(fgGetString("/sim/aircraft-dir")));
473 FGGlobals::get_renderer () const
478 void FGGlobals::set_renderer(FGRenderer *render)
480 if (render == renderer) {
489 FGGlobals::get_subsystem_mgr () const
491 return subsystem_mgr;
495 FGGlobals::get_subsystem (const char * name) const
497 if (!subsystem_mgr) {
501 return subsystem_mgr->get_subsystem(name);
505 FGGlobals::add_subsystem (const char * name,
506 SGSubsystem * subsystem,
507 SGSubsystemMgr::GroupType type,
510 subsystem_mgr->add(name, subsystem, type, min_time_sec);
514 FGGlobals::get_event_mgr () const
520 FGGlobals::get_aircraft_position() const
522 return SGGeod::fromDegFt(positionLon->getDoubleValue(),
523 positionLat->getDoubleValue(),
524 positionAlt->getDoubleValue());
528 FGGlobals::get_aircraft_position_cart() const
530 return SGVec3d::fromGeod(get_aircraft_position());
533 void FGGlobals::get_aircraft_orientation(double& heading, double& pitch, double& roll)
535 heading = orientHeading->getDoubleValue();
536 pitch = orientPitch->getDoubleValue();
537 roll = orientRoll->getDoubleValue();
541 FGGlobals::get_view_position() const
543 return SGGeod::fromDegFt(viewLon->getDoubleValue(),
544 viewLat->getDoubleValue(),
545 viewAlt->getDoubleValue());
549 FGGlobals::get_view_position_cart() const
551 return SGVec3d::fromGeod(get_view_position());
554 static void treeDumpRefCounts(int depth, SGPropertyNode* nd)
556 for (int i=0; i<nd->nChildren(); ++i) {
557 SGPropertyNode* cp = nd->getChild(i);
558 if (SGReferenced::count(cp) > 1) {
559 SG_LOG(SG_GENERAL, SG_INFO, "\t" << cp->getPath() << " refcount:" << SGReferenced::count(cp));
562 treeDumpRefCounts(depth + 1, cp);
566 static void treeClearAliases(SGPropertyNode* nd)
572 for (int i=0; i<nd->nChildren(); ++i) {
573 SGPropertyNode* cp = nd->getChild(i);
574 treeClearAliases(cp);
579 FGGlobals::resetPropertyRoot()
585 // we don't strictly need to clear these (they will be reset when we
586 // initProperties again), but trying to reduce false-positives when dumping
595 orientHeading.clear();
598 // clear aliases so ref-counts are accurate when dumped
599 treeClearAliases(props);
601 SG_LOG(SG_GENERAL, SG_INFO, "root props refcount:" << props.getNumRefs());
602 treeDumpRefCounts(0, props);
604 //BaseStackSnapshot::dumpAll(std::cout);
606 props = new SGPropertyNode;
608 locale = new FGLocale(props);
610 // remove /sim/fg-root before writing to prevent hijacking
611 SGPropertyNode *n = props->getNode("/sim", true);
612 n->removeChild("fg-root", 0);
613 n = n->getChild("fg-root", 0, true);
614 n->setStringValue(fg_root.utf8Str());
615 n->setAttribute(SGPropertyNode::WRITE, false);
618 static std::string autosaveName()
620 std::ostringstream os;
621 string_list versionParts = simgear::strutils::split(VERSION, ".");
622 if (versionParts.size() < 2) {
623 return "autosave.xml";
626 os << "autosave_" << versionParts[0] << "_" << versionParts[1] << ".xml";
630 // Load user settings from autosave.xml
632 FGGlobals::loadUserSettings(const SGPath& dataPath)
634 // remember that we have (tried) to load any existing autsave.xml
635 haveUserSettings = true;
637 SGPath autosaveFile = simgear::Dir(dataPath).file(autosaveName());
638 SGPropertyNode autosave;
639 if (autosaveFile.exists()) {
640 SG_LOG(SG_INPUT, SG_INFO, "Reading user settings from " << autosaveFile);
642 readProperties(autosaveFile, &autosave, SGPropertyNode::USERARCHIVE);
643 } catch (sg_exception& e) {
644 SG_LOG(SG_INPUT, SG_WARN, "failed to read user settings:" << e.getMessage()
645 << "(from " << e.getOrigin() << ")");
648 copyProperties(&autosave, globals->get_props());
651 // Save user settings in autosave.xml
653 FGGlobals::saveUserSettings()
655 // only save settings when we have (tried) to load the previous
656 // settings (otherwise user data was lost)
657 if (!haveUserSettings)
660 if (fgGetBool("/sim/startup/save-on-exit")) {
661 // don't save settings more than once on shutdown
662 haveUserSettings = false;
664 SGPath autosaveFile(globals->get_fg_home());
665 autosaveFile.append(autosaveName());
666 autosaveFile.create_dir( 0700 );
667 SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << autosaveFile);
669 writeProperties(autosaveFile, globals->get_props(), false, SGPropertyNode::USERARCHIVE);
670 } catch (const sg_exception &e) {
671 guiErrorMessage("Error writing autosave:", e);
673 SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
677 long int FGGlobals::get_warp() const
679 return fgGetInt("/sim/time/warp");
682 void FGGlobals::set_warp( long int w )
684 fgSetInt("/sim/time/warp", w);
687 long int FGGlobals::get_warp_delta() const
689 return fgGetInt("/sim/time/warp-delta");
692 void FGGlobals::set_warp_delta( long int d )
694 fgSetInt("/sim/time/warp-delta", d);
697 FGScenery* FGGlobals::get_scenery () const
699 return get_subsystem<FGScenery>();
702 FGTileMgr* FGGlobals::get_tile_mgr () const
704 return get_subsystem<FGTileMgr>();
707 FGViewMgr *FGGlobals::get_viewmgr() const
709 return get_subsystem<FGViewMgr>();
712 flightgear::View* FGGlobals::get_current_view () const
714 FGViewMgr* vm = get_viewmgr();
715 return vm ? vm->get_current_view() : 0;
718 void FGGlobals::set_matlib( SGMaterialLib *m )
723 FGControls *FGGlobals::get_controls() const
725 return get_subsystem<FGControls>();
728 void FGGlobals::addListenerToCleanup(SGPropertyChangeListener* l)
730 _listeners_to_cleanup.push_back(l);
733 void FGGlobals::cleanupListeners()
735 SGPropertyChangeListenerVec::iterator i = _listeners_to_cleanup.begin();
736 for (; i != _listeners_to_cleanup.end(); ++i) {
739 _listeners_to_cleanup.clear();
742 simgear::pkg::Root* FGGlobals::packageRoot()
744 return _packageRoot.get();
747 void FGGlobals::setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p)
752 // end of globals.cxx