src/Main/globals.cxx

   1 // globals.cxx -- Global state that needs to be shared among the sim modules
   2 //
   3 // Written by Curtis Olson, started July 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <boost/foreach.hpp>
  28 #include <algorithm>
  29
  30 #include <simgear/structure/commands.hxx>
  31 #include <simgear/misc/sg_path.hxx>
  32 #include <simgear/misc/sg_dir.hxx>
  33 #include <simgear/timing/sg_time.hxx>
  34 #include <simgear/ephemeris/ephemeris.hxx>
  35 #include <simgear/scene/material/matlib.hxx>
  36 #include <simgear/structure/subsystem_mgr.hxx>
  37 #include <simgear/structure/event_mgr.hxx>
  38 #include <simgear/sound/soundmgr_openal.hxx>
  39 #include <simgear/misc/ResourceManager.hxx>
  40 #include <simgear/props/propertyObject.hxx>
  41 #include <simgear/props/props_io.hxx>
  42
  43 #include <Aircraft/controls.hxx>
  44 #include <Airports/runways.hxx>
  45 #include <ATCDCL/ATISmgr.hxx>
  46 #include <Autopilot/route_mgr.hxx>
  47 #include <GUI/FGFontCache.hxx>
  48 #include <GUI/gui.h>
  49 #include <MultiPlayer/multiplaymgr.hxx>
  50 #include <Scenery/scenery.hxx>
  51 #include <Scenery/tilemgr.hxx>
  52 #include <Navaids/navlist.hxx>
  53 #include <Viewer/renderer.hxx>
  54 #include <Viewer/viewmgr.hxx>
  55
  56 #include "globals.hxx"
  57 #include "locale.hxx"
  58
  59 #include "fg_props.hxx"
  60 #include "fg_io.hxx"
  61
  62 class AircraftResourceProvider : public simgear::ResourceProvider
  63 {
  64 public:
  65   AircraftResourceProvider() :
  66     simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
  67   {
  68   }
  69
  70   virtual SGPath resolve(const std::string& aResource, SGPath&) const
  71   {
  72     string_list pieces(sgPathBranchSplit(aResource));
  73     if ((pieces.size() < 3) || (pieces.front() != "Aircraft")) {
  74       return SGPath(); // not an Aircraft path
  75     }
  76
  77   // test against the aircraft-dir property
  78     const char* aircraftDir = fgGetString("/sim/aircraft-dir");
  79     string_list aircraftDirPieces(sgPathBranchSplit(aircraftDir));
  80     if (!aircraftDirPieces.empty() && (aircraftDirPieces.back() == pieces[1])) {
  81         // current aircraft-dir matches resource aircraft
  82         SGPath r(aircraftDir);
  83         for (unsigned int i=2; i<pieces.size(); ++i) {
  84           r.append(pieces[i]);
  85         }
  86
  87         if (r.exists()) {
  88           SG_LOG(SG_IO, SG_DEBUG, "found path:" << aResource << " via /sim/aircraft-dir: " << r.str());
  89           return r;
  90         }
  91     }
  92
  93   // try each aircraft dir in turn
  94     std::string res(aResource, 9); // resource path with 'Aircraft/' removed
  95     const string_list& dirs(globals->get_aircraft_paths());
  96     string_list::const_iterator it = dirs.begin();
  97     for (; it != dirs.end(); ++it) {
  98       SGPath p(*it, res);
  99       if (p.exists()) {
 100         SG_LOG(SG_IO, SG_DEBUG, "found path:" << aResource << " in aircraft dir: " << *it);
 101         return p;
 102       }
 103     } // of aircraft path iteration
 104
 105     return SGPath(); // not found
 106   }
 107 };
 108
 109 ////////////////////////////////////////////////////////////////////////
 110 // Implementation of FGGlobals.
 111 ////////////////////////////////////////////////////////////////////////
 112
 113 // global global :-)
 114 FGGlobals *globals;
 115
 116
 117 // Constructor
 118 FGGlobals::FGGlobals() :
 119     props( new SGPropertyNode ),
 120     initial_state( NULL ),
 121     locale( new FGLocale(props) ),
 122     renderer( new FGRenderer ),
 123     subsystem_mgr( new SGSubsystemMgr ),
 124     event_mgr( new SGEventMgr ),
 125     sim_time_sec( 0.0 ),
 126     fg_root( "" ),
 127     fg_home( "" ),
 128     time_params( NULL ),
 129     ephem( NULL ),
 130     matlib( NULL ),
 131     route_mgr( NULL ),
 132     ATIS_mgr( NULL ),
 133     controls( NULL ),
 134     viewmgr( NULL ),
 135     commands( SGCommandMgr::instance() ),
 136     channel_options_list( NULL ),
 137     initial_waypoints( NULL ),
 138     scenery( NULL ),
 139     tile_mgr( NULL ),
 140     fontcache ( new FGFontCache ),
 141     channellist( NULL ),
 142     haveUserSettings(false)
 143 {
 144   simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider());
 145   simgear::PropertyObjectBase::setDefaultRoot(props);
 146
 147   positionLon = props->getNode("position/longitude-deg", true);
 148   positionLat = props->getNode("position/latitude-deg", true);
 149   positionAlt = props->getNode("position/altitude-ft", true);
 150
 151   orientPitch = props->getNode("orientation/pitch-deg", true);
 152   orientHeading = props->getNode("orientation/heading-deg", true);
 153   orientRoll = props->getNode("orientation/roll-deg", true);
 154 }
 155
 156 // Destructor
 157 FGGlobals::~FGGlobals()
 158 {
 159     // save user settings (unless already saved)
 160     saveUserSettings();
 161
 162     // The AIModels manager performs a number of actions upon
 163     // Shutdown that implicitly assume that other subsystems
 164     // are still operational (Due to the dynamic allocation and
 165     // deallocation of AIModel objects. To ensure we can safely
 166     // shut down all subsystems, make sure we take down the
 167     // AIModels system first.
 168     SGSubsystem* ai = subsystem_mgr->remove("ai-model");
 169     if (ai) {
 170         ai->unbind();
 171         delete ai;
 172     }
 173     SGSubsystem* sound = subsystem_mgr->remove("sound");
 174
 175     subsystem_mgr->shutdown();
 176     subsystem_mgr->unbind();
 177     delete subsystem_mgr;
 178
 179     delete renderer;
 180     renderer = NULL;
 181
 182     delete time_params;
 183     delete matlib;
 184     delete route_mgr;
 185
 186     delete ATIS_mgr;
 187
 188     if (controls)
 189     {
 190         controls->unbind();
 191         delete controls;
 192     }
 193
 194     delete channel_options_list;
 195     delete initial_waypoints;
 196     delete scenery;
 197     delete fontcache;
 198
 199     delete channellist;
 200     delete sound;
 201
 202     delete locale;
 203     locale = NULL;
 204 }
 205
 206 // set the fg_root path
 207 void FGGlobals::set_fg_root (const string &root) {
 208     SGPath tmp(root);
 209     fg_root = tmp.realpath();
 210
 211     // append /data to root if it exists
 212     tmp.append( "data" );
 213     tmp.append( "version" );
 214     if ( tmp.exists() ) {
 215         fgGetNode("BAD_FG_ROOT", true)->setStringValue(fg_root);
 216         fg_root += "/data";
 217         fgGetNode("GOOD_FG_ROOT", true)->setStringValue(fg_root);
 218         SG_LOG(SG_GENERAL, SG_ALERT, "***\n***\n*** Warning: changing bad FG_ROOT/--fg-root to '"
 219                 << fg_root << "'\n***\n***");
 220     }
 221
 222     // remove /sim/fg-root before writing to prevent hijacking
 223     SGPropertyNode *n = fgGetNode("/sim", true);
 224     n->removeChild("fg-root", 0, false);
 225     n = n->getChild("fg-root", 0, true);
 226     n->setStringValue(fg_root.c_str());
 227     n->setAttribute(SGPropertyNode::WRITE, false);
 228
 229     simgear::ResourceManager::instance()->addBasePath(fg_root,
 230       simgear::ResourceManager::PRIORITY_DEFAULT);
 231 }
 232
 233 // set the fg_home path
 234 void FGGlobals::set_fg_home (const string &home) {
 235     SGPath tmp(home);
 236     fg_home = tmp.realpath();
 237 }
 238
 239 void FGGlobals::append_fg_scenery (const string &paths)
 240 {
 241 //    fg_scenery.clear();
 242     SGPropertyNode* sim = fgGetNode("/sim", true);
 243
 244   // find first unused fg-scenery property in /sim
 245     int propIndex = 0;
 246     while (sim->getChild("fg-scenery", propIndex) != NULL) {
 247       ++propIndex;
 248     }
 249
 250     BOOST_FOREACH(const SGPath& path, sgPathSplit( paths )) {
 251         SGPath abspath(path.realpath());
 252         if (!abspath.exists()) {
 253           SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << abspath.str());
 254           continue;
 255         }
 256
 257       // check for duplicates
 258       string_list::const_iterator ex = std::find(fg_scenery.begin(), fg_scenery.end(), abspath.str());
 259       if (ex != fg_scenery.end()) {
 260         SG_LOG(SG_GENERAL, SG_INFO, "skipping duplicate add of scenery path:" << abspath.str());
 261         continue;
 262       }
 263
 264         simgear::Dir dir(abspath);
 265         SGPath terrainDir(dir.file("Terrain"));
 266         SGPath objectsDir(dir.file("Objects"));
 267
 268       // this code used to add *either* the base dir, OR add the
 269       // Terrain and Objects subdirs, but the conditional logic was commented
 270       // out, such that all three dirs are added. Unfortunately there's
 271       // no information as to why the change was made.
 272         fg_scenery.push_back(abspath.str());
 273
 274         if (terrainDir.exists()) {
 275           fg_scenery.push_back(terrainDir.str());
 276         }
 277
 278         if (objectsDir.exists()) {
 279           fg_scenery.push_back(objectsDir.str());
 280         }
 281
 282         // insert a marker for FGTileEntry::load(), so that
 283         // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
 284         // "B/Terrain", "B/Objects", ""]
 285         fg_scenery.push_back("");
 286
 287       // make scenery dirs available to Nasal
 288         SGPropertyNode* n = sim->getChild("fg-scenery", propIndex++, true);
 289         n->setStringValue(abspath.str());
 290         n->setAttribute(SGPropertyNode::WRITE, false);
 291     } // of path list iteration
 292 }
 293
 294 void FGGlobals::append_aircraft_path(const std::string& path)
 295 {
 296   SGPath dirPath(path);
 297   if (!dirPath.exists()) {
 298     SG_LOG(SG_GENERAL, SG_WARN, "aircraft path not found:" << path);
 299     return;
 300   }
 301   std::string abspath = dirPath.realpath();
 302
 303   unsigned int index = fg_aircraft_dirs.size();
 304   fg_aircraft_dirs.push_back(abspath);
 305
 306 // make aircraft dirs available to Nasal
 307   SGPropertyNode* sim = fgGetNode("/sim", true);
 308   sim->removeChild("fg-aircraft", index, false);
 309   SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
 310   n->setStringValue(abspath);
 311   n->setAttribute(SGPropertyNode::WRITE, false);
 312 }
 313
 314 void FGGlobals::append_aircraft_paths(const std::string& path)
 315 {
 316   string_list paths = sgPathSplit(path);
 317   for (unsigned int p = 0; p<paths.size(); ++p) {
 318     append_aircraft_path(paths[p]);
 319   }
 320 }
 321
 322 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
 323 {
 324   return simgear::ResourceManager::instance()->findPath(branch);
 325 }
 326
 327 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
 328 {
 329   return simgear::ResourceManager::instance()->findPath(branch);
 330 }
 331
 332 SGPath FGGlobals::resolve_ressource_path(const std::string& branch) const
 333 {
 334   return simgear::ResourceManager::instance()
 335     ->findPath(branch, SGPath(fgGetString("/sim/aircraft-dir")));
 336 }
 337
 338 FGRenderer *
 339 FGGlobals::get_renderer () const
 340 {
 341    return renderer;
 342 }
 343
 344 SGSubsystemMgr *
 345 FGGlobals::get_subsystem_mgr () const
 346 {
 347     return subsystem_mgr;
 348 }
 349
 350 SGSubsystem *
 351 FGGlobals::get_subsystem (const char * name)
 352 {
 353     return subsystem_mgr->get_subsystem(name);
 354 }
 355
 356 void
 357 FGGlobals::add_subsystem (const char * name,
 358                           SGSubsystem * subsystem,
 359                           SGSubsystemMgr::GroupType type,
 360                           double min_time_sec)
 361 {
 362     subsystem_mgr->add(name, subsystem, type, min_time_sec);
 363 }
 364
 365 SGSoundMgr *
 366 FGGlobals::get_soundmgr () const
 367 {
 368     if (subsystem_mgr)
 369         return (SGSoundMgr*) subsystem_mgr->get_subsystem("sound");
 370
 371     return NULL;
 372 }
 373
 374 SGEventMgr *
 375 FGGlobals::get_event_mgr () const
 376 {
 377     return event_mgr;
 378 }
 379
 380 SGGeod
 381 FGGlobals::get_aircraft_position() const
 382 {
 383   return SGGeod::fromDegFt(positionLon->getDoubleValue(),
 384                            positionLat->getDoubleValue(),
 385                            positionAlt->getDoubleValue());
 386 }
 387
 388 SGVec3d
 389 FGGlobals::get_aircraft_positon_cart() const
 390 {
 391     return SGVec3d::fromGeod(get_aircraft_position());
 392 }
 393
 394 void FGGlobals::get_aircraft_orientation(double& heading, double& pitch, double& roll)
 395 {
 396   heading = orientHeading->getDoubleValue();
 397   pitch = orientPitch->getDoubleValue();
 398   roll = orientRoll->getDoubleValue();
 399 }
 400
 401
 402 // Save the current state as the initial state.
 403 void
 404 FGGlobals::saveInitialState ()
 405 {
 406   initial_state = new SGPropertyNode();
 407
 408   // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
 409   int checked  = SGPropertyNode::READ+SGPropertyNode::WRITE+
 410                  SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
 411   int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
 412   if (!copyProperties(props, initial_state, expected, checked))
 413     SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
 414
 415   // delete various properties from the initial state, since we want to
 416   // preserve their values even if doing a restore
 417   // => Properties should now use the PRESERVE flag to protect their values
 418   // on sim-reset. Remove some specific properties for backward compatibility.
 419   SGPropertyNode* sim = initial_state->getChild("sim");
 420   SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
 421   if (cameraGroupNode) {
 422     cameraGroupNode->removeChild("camera");
 423     cameraGroupNode->removeChild("gui");
 424   }
 425 }
 426
 427
 428 // Restore the saved initial state, if any
 429 void
 430 FGGlobals::restoreInitialState ()
 431 {
 432     if ( initial_state == 0 ) {
 433         SG_LOG(SG_GENERAL, SG_ALERT,
 434                "No initial state available to restore!!!");
 435         return;
 436     }
 437     // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
 438     int checked  = SGPropertyNode::READ+SGPropertyNode::WRITE+
 439                    SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
 440     int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
 441     if ( copyProperties(initial_state, props, expected, checked)) {
 442         SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
 443     } else {
 444         SG_LOG( SG_GENERAL, SG_INFO,
 445                 "Some errors restoring initial state (read-only props?)" );
 446     }
 447
 448 }
 449
 450 // Load user settings from autosave.xml
 451 void
 452 FGGlobals::loadUserSettings(const SGPath& dataPath)
 453 {
 454     // remember that we have (tried) to load any existing autsave.xml
 455     haveUserSettings = true;
 456
 457     SGPath autosaveFile = simgear::Dir(dataPath).file("autosave.xml");
 458     SGPropertyNode autosave;
 459     if (autosaveFile.exists()) {
 460       SG_LOG(SG_INPUT, SG_INFO, "Reading user settings from " << autosaveFile.str());
 461       try {
 462           readProperties(autosaveFile.str(), &autosave, SGPropertyNode::USERARCHIVE);
 463       } catch (sg_exception& e) {
 464           SG_LOG(SG_INPUT, SG_WARN, "failed to read user settings:" << e.getMessage()
 465             << "(from " << e.getOrigin() << ")");
 466       }
 467     }
 468     copyProperties(&autosave, globals->get_props());
 469 }
 470
 471 // Save user settings in autosave.xml
 472 void
 473 FGGlobals::saveUserSettings()
 474 {
 475     // only save settings when we have (tried) to load the previous
 476     // settings (otherwise user data was lost)
 477     if (!haveUserSettings)
 478         return;
 479
 480     if (fgGetBool("/sim/startup/save-on-exit")) {
 481       // don't save settings more than once on shutdown
 482       haveUserSettings = false;
 483
 484       SGPath autosaveFile(globals->get_fg_home());
 485       autosaveFile.append( "autosave.xml" );
 486       autosaveFile.create_dir( 0700 );
 487       SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << autosaveFile.str());
 488       try {
 489         writeProperties(autosaveFile.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
 490       } catch (const sg_exception &e) {
 491         guiErrorMessage("Error writing autosave.xml: ", e);
 492       }
 493       SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
 494     }
 495 }
 496
 497 FGViewer *
 498 FGGlobals::get_current_view () const
 499 {
 500   return viewmgr->get_current_view();
 501 }
 502
 503 long int FGGlobals::get_warp() const
 504 {
 505   return fgGetInt("/sim/time/warp");
 506 }
 507
 508 void FGGlobals::set_warp( long int w )
 509 {
 510   fgSetInt("/sim/time/warp", w);
 511 }
 512
 513 long int FGGlobals::get_warp_delta() const
 514 {
 515   return fgGetInt("/sim/time/warp-delta");
 516 }
 517
 518 void FGGlobals::set_warp_delta( long int d )
 519 {
 520   fgSetInt("/sim/time/warp-delta", d);
 521 }
 522
 523 // end of globals.cxx