]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/globals.cxx
Make PerformanceDB a real subsystem
[flightgear.git] / src / Main / globals.cxx
index 909c83fb662157b84911850e2d10e8442968824f..084d77128ae73cb6b86f92532c36b34c67f7e5fe 100644 (file)
@@ -27,6 +27,9 @@
 #include <boost/foreach.hpp>
 #include <algorithm>
 
+#include <osgViewer/Viewer>
+#include <osgDB/Registry>
+
 #include <simgear/structure/commands.hxx>
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/misc/sg_dir.hxx>
 #include <simgear/props/propertyObject.hxx>
 #include <simgear/props/props_io.hxx>
 #include <simgear/scene/model/modellib.hxx>
+#include <simgear/package/Root.hxx>
 
 #include <Aircraft/controls.hxx>
 #include <Airports/runways.hxx>
-#include <ATCDCL/ATISmgr.hxx>
 #include <Autopilot/route_mgr.hxx>
 #include <GUI/FGFontCache.hxx>
 #include <GUI/gui.h>
-#include <MultiPlayer/multiplaymgr.hxx>
 #include <Scenery/scenery.hxx>
 #include <Scenery/tilemgr.hxx>
 #include <Navaids/navlist.hxx>
 #include <Viewer/renderer.hxx>
 #include <Viewer/viewmgr.hxx>
+#include <Sound/sample_queue.hxx>
 
 #include "globals.hxx"
 #include "locale.hxx"
@@ -67,29 +70,44 @@ public:
     simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
   {
   }
-  
+
   virtual SGPath resolve(const std::string& aResource, SGPath&) const
   {
     string_list pieces(sgPathBranchSplit(aResource));
     if ((pieces.size() < 3) || (pieces.front() != "Aircraft")) {
       return SGPath(); // not an Aircraft path
     }
-    
+
   // test against the aircraft-dir property
     const char* aircraftDir = fgGetString("/sim/aircraft-dir");
     string_list aircraftDirPieces(sgPathBranchSplit(aircraftDir));
     if (!aircraftDirPieces.empty() && (aircraftDirPieces.back() == pieces[1])) {
+        // disable this warning for release builds
+#if defined(ENABLE_DEV_WARNINGS)
+        SGPath betterPath;
+        for (unsigned int i=2; i<pieces.size(); ++i) {
+            betterPath.append(pieces[i]);
+        }
+        SG_LOG(SG_AIRCRAFT, SG_WARN, "resolved path:" << aResource << " using /sim/aircraft-dir.\n"
+               "This is legacy behaviour, change to an aircraft relative path:" << betterPath);
+#endif
+
         // current aircraft-dir matches resource aircraft
         SGPath r(aircraftDir);
         for (unsigned int i=2; i<pieces.size(); ++i) {
           r.append(pieces[i]);
         }
-        
+
         if (r.exists()) {
           return r;
+        } else {
+          // Stop here, otherwise we could end up returning a resource that
+          // belongs to an unrelated version of the same aircraft (from a
+          // different aircraft directory).
+          return SGPath();
         }
     }
-  
+
   // try each aircraft dir in turn
     std::string res(aResource, 9); // resource path with 'Aircraft/' removed
     const string_list& dirs(globals->get_aircraft_paths());
@@ -100,7 +118,7 @@ public:
         return p;
       }
     } // of aircraft path iteration
-    
+
     return SGPath(); // not found
   }
 };
@@ -112,7 +130,7 @@ public:
     simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
   {
   }
-  
+
   virtual SGPath resolve(const std::string& aResource, SGPath&) const
   {
     const char* aircraftDir = fgGetString("/sim/aircraft-dir");
@@ -132,7 +150,6 @@ FGGlobals *globals = NULL;
 
 // Constructor
 FGGlobals::FGGlobals() :
-    initial_state( NULL ),
     renderer( new FGRenderer ),
     subsystem_mgr( new SGSubsystemMgr ),
     event_mgr( new SGEventMgr ),
@@ -141,22 +158,18 @@ FGGlobals::FGGlobals() :
     fg_home( "" ),
     time_params( NULL ),
     ephem( NULL ),
-    matlib( NULL ),
-    route_mgr( NULL ),
-    ATIS_mgr( NULL ),
-    controls( NULL ),
-    viewmgr( NULL ),
     commands( SGCommandMgr::instance() ),
     channel_options_list( NULL ),
     initial_waypoints( NULL ),
     fontcache ( new FGFontCache ),
     channellist( NULL ),
-    haveUserSettings(false)
+    haveUserSettings(false),
+    _chatter_queue(NULL)
 {
     SGPropertyNode* root = new SGPropertyNode;
     props = SGPropertyNode_ptr(root);
     locale = new FGLocale(props);
-    
+
     simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider);
     simgear::ResourceManager::instance()->addProvider(new CurrentAircraftDirProvider);
     initProperties();
@@ -165,15 +178,15 @@ FGGlobals::FGGlobals() :
 void FGGlobals::initProperties()
 {
     simgear::PropertyObjectBase::setDefaultRoot(props);
-    
+
     positionLon = props->getNode("position/longitude-deg", true);
     positionLat = props->getNode("position/latitude-deg", true);
     positionAlt = props->getNode("position/altitude-ft", true);
-    
+
     viewLon = props->getNode("sim/current-view/viewer-lon-deg", true);
     viewLat = props->getNode("sim/current-view/viewer-lat-deg", true);
     viewAlt = props->getNode("sim/current-view/viewer-elev-ft", true);
-    
+
     orientPitch = props->getNode("orientation/pitch-deg", true);
     orientHeading = props->getNode("orientation/heading-deg", true);
     orientRoll = props->getNode("orientation/roll-deg", true);
@@ -181,16 +194,29 @@ void FGGlobals::initProperties()
 }
 
 // Destructor
-FGGlobals::~FGGlobals() 
+FGGlobals::~FGGlobals()
 {
     // save user settings (unless already saved)
     saveUserSettings();
 
+    // stop OSG threading first, to avoid thread races while we tear down
+    // scene-graph pieces
+
+    osg::ref_ptr<osgViewer::Viewer> vw(renderer->getViewer());
+    if (vw) {
+        // https://code.google.com/p/flightgear-bugs/issues/detail?id=1291
+        // explicitly stop trheading before we delete the renderer or
+        // viewMgr (which ultimately holds refs to the CameraGroup, and
+        // GraphicsContext)
+        vw->stopThreading();
+    }
+
+#if 0
     // The AIModels manager performs a number of actions upon
     // Shutdown that implicitly assume that other subsystems
     // are still operational (Due to the dynamic allocation and
     // deallocation of AIModel objects. To ensure we can safely
-    // shut down all subsystems, make sure we take down the 
+    // shut down all subsystems, make sure we take down the
     // AIModels system first.
     SGSubsystemRef ai = subsystem_mgr->get_subsystem("ai-model");
     if (ai) {
@@ -198,26 +224,33 @@ FGGlobals::~FGGlobals()
         ai->unbind();
         ai.clear(); // ensure AI is deleted now, not at end of this method
     }
-    
+#endif
+
     subsystem_mgr->shutdown();
-    subsystem_mgr->unbind();    
+    subsystem_mgr->unbind();
+
+    subsystem_mgr->remove(FGTileMgr::subsystemName());
+    // don't cancel the pager until after shutdown, since AIModels (and
+    // potentially others) can queue delete requests on the pager.
+    if (vw && vw->getDatabasePager()) {
+        vw->getDatabasePager()->cancel();
+        vw->getDatabasePager()->clear();
+    }
 
-    subsystem_mgr->remove("aircraft-model");
-    subsystem_mgr->remove("tile-manager");
-    subsystem_mgr->remove("model-manager");
-    _tile_mgr.clear();
+    osgDB::Registry::instance()->clearObjectCache();
+    subsystem_mgr->remove(FGScenery::subsystemName());
 
     // renderer touches subsystems during its destruction
     set_renderer(NULL);
-    _scenery.clear();
+    _chatter_queue.clear();
 
     delete subsystem_mgr;
-    subsystem_mgr = NULL; // important so ::get_subsystem returns NULL 
+    subsystem_mgr = NULL; // important so ::get_subsystem returns NULL
+    vw = 0; // don't delete the viewer until now
 
     delete time_params;
-    delete matlib;
-    delete route_mgr;
-    delete ATIS_mgr;
+    set_matlib(NULL);
+
     delete channel_options_list;
     delete initial_waypoints;
     delete fontcache;
@@ -225,11 +258,15 @@ FGGlobals::~FGGlobals()
 
     simgear::PropertyObjectBase::setDefaultRoot(NULL);
     simgear::SGModelLib::resetPropertyRoot();
-    
+
     delete locale;
     locale = NULL;
-    
+
+    cleanupListeners();
+
     props.clear();
+
+    delete commands;
 }
 
 // set the fg_root path
@@ -248,14 +285,15 @@ void FGGlobals::set_fg_root (const std::string &root) {
                 << fg_root << "'\n***\n***");
     }
 
-    // remove /sim/fg-root before writing to prevent hijacking
+    // deliberately not a tied property, for fgValidatePath security
+    // write-protect to avoid accidents
     SGPropertyNode *n = fgGetNode("/sim", true);
-    n->removeChild("fg-root", 0, false);
+    n->removeChild("fg-root", 0);
     n = n->getChild("fg-root", 0, true);
     n->setStringValue(fg_root.c_str());
     n->setAttribute(SGPropertyNode::WRITE, false);
-    
-    simgear::ResourceManager::instance()->addBasePath(fg_root, 
+
+    simgear::ResourceManager::instance()->addBasePath(fg_root,
       simgear::ResourceManager::PRIORITY_DEFAULT);
 }
 
@@ -290,7 +328,7 @@ void FGGlobals::append_data_path(const SGPath& path)
     if (!path.exists()) {
         SG_LOG(SG_GENERAL, SG_WARN, "adding non-existant data path:" << path);
     }
-    
+
     additional_data_paths.push_back(path);
 }
 
@@ -302,28 +340,27 @@ SGPath FGGlobals::find_data_dir(const std::string& pathSuffix) const
             return p;
         }
     }
-    
+
     SGPath rootPath(fg_root);
     rootPath.append(pathSuffix);
     if (rootPath.exists()) {
         return rootPath;
     }
-    
+
     SG_LOG(SG_GENERAL, SG_WARN, "dir not found in any data path:" << pathSuffix);
     return SGPath();
 }
 
-void FGGlobals::append_fg_scenery (const std::string &paths)
+void FGGlobals::append_fg_scenery (const std::string &paths, bool secure)
 {
-//    fg_scenery.clear();
     SGPropertyNode* sim = fgGetNode("/sim", true);
 
   // find first unused fg-scenery property in /sim
     int propIndex = 0;
     while (sim->getChild("fg-scenery", propIndex) != NULL) {
-      ++propIndex; 
+      ++propIndex;
     }
-  
+
     BOOST_FOREACH(const SGPath& path, sgPathSplit( paths )) {
         SGPath abspath(path.realpath());
         if (!abspath.exists()) {
@@ -337,55 +374,89 @@ void FGGlobals::append_fg_scenery (const std::string &paths)
         SG_LOG(SG_GENERAL, SG_INFO, "skipping duplicate add of scenery path:" << abspath.str());
         continue;
       }
-      
+
         simgear::Dir dir(abspath);
         SGPath terrainDir(dir.file("Terrain"));
         SGPath objectsDir(dir.file("Objects"));
-        
-      // this code used to add *either* the base dir, OR add the 
+
+      // this code used to add *either* the base dir, OR add the
       // Terrain and Objects subdirs, but the conditional logic was commented
       // out, such that all three dirs are added. Unfortunately there's
       // no information as to why the change was made.
         fg_scenery.push_back(abspath.str());
-        
+        if (secure) {
+          secure_fg_scenery.push_back(abspath.str());
+        }
+
         if (terrainDir.exists()) {
           fg_scenery.push_back(terrainDir.str());
         }
-        
+
         if (objectsDir.exists()) {
           fg_scenery.push_back(objectsDir.str());
         }
-        
+
         // insert a marker for FGTileEntry::load(), so that
         // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
         // "B/Terrain", "B/Objects", ""]
         fg_scenery.push_back("");
-        
+
       // make scenery dirs available to Nasal
         SGPropertyNode* n = sim->getChild("fg-scenery", propIndex++, true);
         n->setStringValue(abspath.str());
         n->setAttribute(SGPropertyNode::WRITE, false);
+
+        // temporary fix so these values survive reset
+        n->setAttribute(SGPropertyNode::PRESERVE, true);
     } // of path list iteration
 }
 
+void FGGlobals::clear_fg_scenery()
+{
+  fg_scenery.clear();
+  secure_fg_scenery.clear();
+  fgGetNode("/sim", true)->removeChildren("fg-scenery");
+
+}
+
+void FGGlobals::set_catalog_aircraft_path(const SGPath& path)
+{
+    catalog_aircraft_dir = path;
+}
+
+string_list FGGlobals::get_aircraft_paths() const
+{
+    string_list r;
+    if (!catalog_aircraft_dir.isNull()) {
+        r.push_back(catalog_aircraft_dir.str());
+    }
+
+    r.insert(r.end(), fg_aircraft_dirs.begin(), fg_aircraft_dirs.end());
+    return r;
+}
+
 void FGGlobals::append_aircraft_path(const std::string& path)
 {
   SGPath dirPath(path);
   if (!dirPath.exists()) {
-    SG_LOG(SG_GENERAL, SG_WARN, "aircraft path not found:" << path);
+    SG_LOG(SG_GENERAL, SG_ALERT, "aircraft path not found:" << path);
     return;
   }
+
+  SGPath acSubdir(dirPath);
+  acSubdir.append("Aircraft");
+  if (acSubdir.exists()) {
+      SG_LOG(
+        SG_GENERAL,
+        SG_WARN,
+        "Specified an aircraft-dir with an 'Aircraft' subdirectory:" << dirPath
+        << ", will instead use child directory:" << acSubdir
+      );
+      dirPath = acSubdir;
+  }
+
   std::string abspath = dirPath.realpath();
-  
-  unsigned int index = fg_aircraft_dirs.size();  
   fg_aircraft_dirs.push_back(abspath);
-  
-// make aircraft dirs available to Nasal
-  SGPropertyNode* sim = fgGetNode("/sim", true);
-  sim->removeChild("fg-aircraft", index, false);
-  SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
-  n->setStringValue(abspath);
-  n->setAttribute(SGPropertyNode::WRITE, false);
 }
 
 void FGGlobals::append_aircraft_paths(const std::string& path)
@@ -423,7 +494,7 @@ void FGGlobals::set_renderer(FGRenderer *render)
     if (render == renderer) {
         return;
     }
-    
+
     delete renderer;
     renderer = render;
 }
@@ -435,12 +506,12 @@ FGGlobals::get_subsystem_mgr () const
 }
 
 SGSubsystem *
-FGGlobals::get_subsystem (const char * name)
+FGGlobals::get_subsystem (const char * name) const
 {
     if (!subsystem_mgr) {
         return NULL;
     }
-    
+
     return subsystem_mgr->get_subsystem(name);
 }
 
@@ -456,10 +527,7 @@ FGGlobals::add_subsystem (const char * name,
 SGSoundMgr *
 FGGlobals::get_soundmgr () const
 {
-    if (subsystem_mgr)
-        return (SGSoundMgr*) subsystem_mgr->get_subsystem("sound");
-
-    return NULL;
+    return get_subsystem<SGSoundMgr>();
 }
 
 SGEventMgr *
@@ -510,57 +578,63 @@ static void treeDumpRefCounts(int depth, SGPropertyNode* nd)
         if (SGReferenced::count(cp) > 1) {
             SG_LOG(SG_GENERAL, SG_INFO, "\t" << cp->getPath() << " refcount:" << SGReferenced::count(cp));
         }
-        
+
         treeDumpRefCounts(depth + 1, cp);
     }
 }
 
+static void treeClearAliases(SGPropertyNode* nd)
+{
+    if (nd->isAlias()) {
+        nd->unalias();
+    }
+
+    for (int i=0; i<nd->nChildren(); ++i) {
+        SGPropertyNode* cp = nd->getChild(i);
+        treeClearAliases(cp);
+    }
+}
+
 void
 FGGlobals::resetPropertyRoot()
 {
     delete locale;
-    
-#if DEBUG_RESET
+
+    cleanupListeners();
+
+    // we don't strictly need to clear these (they will be reset when we
+    // initProperties again), but trying to reduce false-positives when dumping
+    // ref-counts.
+    positionLon.clear();
+    positionLat.clear();
+    positionAlt.clear();
+    viewLon.clear();
+    viewLat.clear();
+    viewAlt.clear();
+    orientPitch.clear();
+    orientHeading.clear();
+    orientRoll.clear();
+
+    // clear aliases so ref-counts are accurate when dumped
+    treeClearAliases(props);
+
     SG_LOG(SG_GENERAL, SG_INFO, "root props refcount:" << props.getNumRefs());
     treeDumpRefCounts(0, props);
-#endif
+
+    //BaseStackSnapshot::dumpAll(std::cout);
+
     props = new SGPropertyNode;
     initProperties();
     locale = new FGLocale(props);
-    
+
     // remove /sim/fg-root before writing to prevent hijacking
     SGPropertyNode *n = props->getNode("/sim", true);
-    n->removeChild("fg-root", 0, false);
+    n->removeChild("fg-root", 0);
     n = n->getChild("fg-root", 0, true);
     n->setStringValue(fg_root.c_str());
     n->setAttribute(SGPropertyNode::WRITE, false);
 }
 
-// Save the current state as the initial state.
-void
-FGGlobals::saveInitialState ()
-{
-  initial_state = new SGPropertyNode();
-
-  // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
-  int checked  = SGPropertyNode::READ+SGPropertyNode::WRITE+
-                 SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
-  int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
-  if (!copyProperties(props, initial_state, expected, checked))
-    SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
-    
-  // delete various properties from the initial state, since we want to
-  // preserve their values even if doing a restore
-  // => Properties should now use the PRESERVE flag to protect their values
-  // on sim-reset. Remove some specific properties for backward compatibility.
-  SGPropertyNode* sim = initial_state->getChild("sim");
-  SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
-  if (cameraGroupNode) {
-    cameraGroupNode->removeChild("camera");
-    cameraGroupNode->removeChild("gui");
-  }
-}
-
 static std::string autosaveName()
 {
     std::ostringstream os;
@@ -568,33 +642,11 @@ static std::string autosaveName()
     if (versionParts.size() < 2) {
         return "autosave.xml";
     }
-    
+
     os << "autosave_" << versionParts[0] << "_" << versionParts[1] << ".xml";
     return os.str();
 }
 
-// Restore the saved initial state, if any
-void
-FGGlobals::restoreInitialState ()
-{
-    if ( initial_state == 0 ) {
-        SG_LOG(SG_GENERAL, SG_ALERT,
-               "No initial state available to restore!!!");
-        return;
-    }
-    // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
-    int checked  = SGPropertyNode::READ+SGPropertyNode::WRITE+
-                   SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
-    int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
-    if ( copyProperties(initial_state, props, expected, checked)) {
-        SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
-    } else {
-        SG_LOG( SG_GENERAL, SG_INFO,
-                "Some errors restoring initial state (read-only props?)" );
-    }
-
-}
-
 // Load user settings from autosave.xml
 void
 FGGlobals::loadUserSettings(const SGPath& dataPath)
@@ -642,12 +694,6 @@ FGGlobals::saveUserSettings()
     }
 }
 
-FGViewer *
-FGGlobals::get_current_view () const
-{
-  return viewmgr->get_current_view();
-}
-
 long int FGGlobals::get_warp() const
 {
   return fgGetInt("/sim/time/warp");
@@ -670,22 +716,67 @@ void FGGlobals::set_warp_delta( long int d )
 
 FGScenery* FGGlobals::get_scenery () const
 {
-    return _scenery.get();
+    return get_subsystem<FGScenery>();
 }
 
-void FGGlobals::set_scenery ( FGScenery *s )
+FGTileMgr* FGGlobals::get_tile_mgr () const
 {
-    _scenery = s;
+    return get_subsystem<FGTileMgr>();
 }
 
-FGTileMgr* FGGlobals::get_tile_mgr () const
+FGViewMgr *FGGlobals::get_viewmgr() const
+{
+    return get_subsystem<FGViewMgr>();
+}
+
+FGViewer* FGGlobals::get_current_view () const
+{
+    FGViewMgr* vm = get_viewmgr();
+    return vm ? vm->get_current_view() : 0;
+}
+
+void FGGlobals::set_matlib( SGMaterialLib *m )
+{
+    matlib = m;
+}
+
+FGControls *FGGlobals::get_controls() const
+{
+    return get_subsystem<FGControls>();
+}
+
+FGSampleQueue* FGGlobals::get_chatter_queue() const
+{
+    return _chatter_queue;
+}
+
+void FGGlobals::set_chatter_queue(FGSampleQueue* queue)
+{
+    _chatter_queue = queue;
+}
+
+void FGGlobals::addListenerToCleanup(SGPropertyChangeListener* l)
+{
+    _listeners_to_cleanup.push_back(l);
+}
+
+void FGGlobals::cleanupListeners()
+{
+    SGPropertyChangeListenerVec::iterator i = _listeners_to_cleanup.begin();
+    for (; i != _listeners_to_cleanup.end(); ++i) {
+        delete *i;
+    }
+    _listeners_to_cleanup.clear();
+}
+
+simgear::pkg::Root* FGGlobals::packageRoot()
 {
-    return _tile_mgr.get();
+  return _packageRoot.get();
 }
 
-void FGGlobals::set_tile_mgr ( FGTileMgr *t )
+void FGGlobals::setPackageRoot(const SGSharedPtr<simgear::pkg::Root>& p)
 {
-    _tile_mgr = t;
+  _packageRoot = p;
 }
 
 // end of globals.cxx