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 class CurrentAircraftDirProvider : public simgear::ResourceProvider
 110 {
 111 public:
 112   CurrentAircraftDirProvider() :
 113     simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
 114   {
 115   }
 116
 117   virtual SGPath resolve(const std::string& aResource, SGPath&) const
 118   {
 119     const char* aircraftDir = fgGetString("/sim/aircraft-dir");
 120     SGPath p(aircraftDir);
 121     p.append(aResource);
 122     return p.exists() ? p : SGPath();
 123   }
 124 };
 125
 126 ////////////////////////////////////////////////////////////////////////
 127 // Implementation of FGGlobals.
 128 ////////////////////////////////////////////////////////////////////////
 129
 130 // global global :-)
 131 FGGlobals *globals;
 132
 133
 134 // Constructor
 135 FGGlobals::FGGlobals() :
 136     props( new SGPropertyNode ),
 137     initial_state( NULL ),
 138     locale( new FGLocale(props) ),
 139     renderer( new FGRenderer ),
 140     subsystem_mgr( new SGSubsystemMgr ),
 141     event_mgr( new SGEventMgr ),
 142     sim_time_sec( 0.0 ),
 143     fg_root( "" ),
 144     fg_home( "" ),
 145     time_params( NULL ),
 146     ephem( NULL ),
 147     matlib( NULL ),
 148     route_mgr( NULL ),
 149     ATIS_mgr( NULL ),
 150     controls( NULL ),
 151     viewmgr( NULL ),
 152     commands( SGCommandMgr::instance() ),
 153     channel_options_list( NULL ),
 154     initial_waypoints( NULL ),
 155     scenery( NULL ),
 156     tile_mgr( NULL ),
 157     fontcache ( new FGFontCache ),
 158     channellist( NULL ),
 159     haveUserSettings(false)
 160 {
 161   simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider);
 162   simgear::ResourceManager::instance()->addProvider(new CurrentAircraftDirProvider);
 163   simgear::PropertyObjectBase::setDefaultRoot(props);
 164
 165   positionLon = props->getNode("position/longitude-deg", true);
 166   positionLat = props->getNode("position/latitude-deg", true);
 167   positionAlt = props->getNode("position/altitude-ft", true);
 168
 169   viewLon = props->getNode("sim/current-view/viewer-lon-deg", true);
 170   viewLat = props->getNode("sim/current-view/viewer-lat-deg", true);
 171   viewAlt = props->getNode("sim/current-view/viewer-elev-ft", true);
 172
 173   orientPitch = props->getNode("orientation/pitch-deg", true);
 174   orientHeading = props->getNode("orientation/heading-deg", true);
 175   orientRoll = props->getNode("orientation/roll-deg", true);
 176 }
 177
 178 // Destructor
 179 FGGlobals::~FGGlobals()
 180 {
 181     // save user settings (unless already saved)
 182     saveUserSettings();
 183
 184     // The AIModels manager performs a number of actions upon
 185     // Shutdown that implicitly assume that other subsystems
 186     // are still operational (Due to the dynamic allocation and
 187     // deallocation of AIModel objects. To ensure we can safely
 188     // shut down all subsystems, make sure we take down the
 189     // AIModels system first.
 190     SGSubsystem* ai = subsystem_mgr->remove("ai-model");
 191     if (ai) {
 192         ai->unbind();
 193         delete ai;
 194     }
 195     SGSubsystem* sound = subsystem_mgr->remove("sound");
 196
 197     subsystem_mgr->shutdown();
 198     subsystem_mgr->unbind();
 199     delete subsystem_mgr;
 200
 201     delete renderer;
 202     renderer = NULL;
 203
 204     delete time_params;
 205     delete matlib;
 206     delete route_mgr;
 207
 208     delete ATIS_mgr;
 209
 210     delete channel_options_list;
 211     delete initial_waypoints;
 212     delete scenery;
 213     delete fontcache;
 214
 215     delete channellist;
 216     delete sound;
 217
 218     delete locale;
 219     locale = NULL;
 220 }
 221
 222 // set the fg_root path
 223 void FGGlobals::set_fg_root (const string &root) {
 224     SGPath tmp(root);
 225     fg_root = tmp.realpath();
 226
 227     // append /data to root if it exists
 228     tmp.append( "data" );
 229     tmp.append( "version" );
 230     if ( tmp.exists() ) {
 231         fgGetNode("BAD_FG_ROOT", true)->setStringValue(fg_root);
 232         fg_root += "/data";
 233         fgGetNode("GOOD_FG_ROOT", true)->setStringValue(fg_root);
 234         SG_LOG(SG_GENERAL, SG_ALERT, "***\n***\n*** Warning: changing bad FG_ROOT/--fg-root to '"
 235                 << fg_root << "'\n***\n***");
 236     }
 237
 238     // remove /sim/fg-root before writing to prevent hijacking
 239     SGPropertyNode *n = fgGetNode("/sim", true);
 240     n->removeChild("fg-root", 0, false);
 241     n = n->getChild("fg-root", 0, true);
 242     n->setStringValue(fg_root.c_str());
 243     n->setAttribute(SGPropertyNode::WRITE, false);
 244
 245     simgear::ResourceManager::instance()->addBasePath(fg_root,
 246       simgear::ResourceManager::PRIORITY_DEFAULT);
 247 }
 248
 249 // set the fg_home path
 250 void FGGlobals::set_fg_home (const string &home) {
 251     SGPath tmp(home);
 252     fg_home = tmp.realpath();
 253 }
 254
 255 void FGGlobals::append_fg_scenery (const string &paths)
 256 {
 257 //    fg_scenery.clear();
 258     SGPropertyNode* sim = fgGetNode("/sim", true);
 259
 260   // find first unused fg-scenery property in /sim
 261     int propIndex = 0;
 262     while (sim->getChild("fg-scenery", propIndex) != NULL) {
 263       ++propIndex;
 264     }
 265
 266     BOOST_FOREACH(const SGPath& path, sgPathSplit( paths )) {
 267         SGPath abspath(path.realpath());
 268         if (!abspath.exists()) {
 269           SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << abspath.str());
 270           continue;
 271         }
 272
 273       // check for duplicates
 274       string_list::const_iterator ex = std::find(fg_scenery.begin(), fg_scenery.end(), abspath.str());
 275       if (ex != fg_scenery.end()) {
 276         SG_LOG(SG_GENERAL, SG_INFO, "skipping duplicate add of scenery path:" << abspath.str());
 277         continue;
 278       }
 279
 280         simgear::Dir dir(abspath);
 281         SGPath terrainDir(dir.file("Terrain"));
 282         SGPath objectsDir(dir.file("Objects"));
 283
 284       // this code used to add *either* the base dir, OR add the
 285       // Terrain and Objects subdirs, but the conditional logic was commented
 286       // out, such that all three dirs are added. Unfortunately there's
 287       // no information as to why the change was made.
 288         fg_scenery.push_back(abspath.str());
 289
 290         if (terrainDir.exists()) {
 291           fg_scenery.push_back(terrainDir.str());
 292         }
 293
 294         if (objectsDir.exists()) {
 295           fg_scenery.push_back(objectsDir.str());
 296         }
 297
 298         // insert a marker for FGTileEntry::load(), so that
 299         // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
 300         // "B/Terrain", "B/Objects", ""]
 301         fg_scenery.push_back("");
 302
 303       // make scenery dirs available to Nasal
 304         SGPropertyNode* n = sim->getChild("fg-scenery", propIndex++, true);
 305         n->setStringValue(abspath.str());
 306         n->setAttribute(SGPropertyNode::WRITE, false);
 307     } // of path list iteration
 308 }
 309
 310 void FGGlobals::append_aircraft_path(const std::string& path)
 311 {
 312   SGPath dirPath(path);
 313   if (!dirPath.exists()) {
 314     SG_LOG(SG_GENERAL, SG_WARN, "aircraft path not found:" << path);
 315     return;
 316   }
 317   std::string abspath = dirPath.realpath();
 318
 319   unsigned int index = fg_aircraft_dirs.size();
 320   fg_aircraft_dirs.push_back(abspath);
 321
 322 // make aircraft dirs available to Nasal
 323   SGPropertyNode* sim = fgGetNode("/sim", true);
 324   sim->removeChild("fg-aircraft", index, false);
 325   SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
 326   n->setStringValue(abspath);
 327   n->setAttribute(SGPropertyNode::WRITE, false);
 328 }
 329
 330 void FGGlobals::append_aircraft_paths(const std::string& path)
 331 {
 332   string_list paths = sgPathSplit(path);
 333   for (unsigned int p = 0; p<paths.size(); ++p) {
 334     append_aircraft_path(paths[p]);
 335   }
 336 }
 337
 338 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
 339 {
 340   return simgear::ResourceManager::instance()->findPath(branch);
 341 }
 342
 343 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
 344 {
 345   return simgear::ResourceManager::instance()->findPath(branch);
 346 }
 347
 348 SGPath FGGlobals::resolve_resource_path(const std::string& branch) const
 349 {
 350   return simgear::ResourceManager::instance()
 351     ->findPath(branch, SGPath(fgGetString("/sim/aircraft-dir")));
 352 }
 353
 354 FGRenderer *
 355 FGGlobals::get_renderer () const
 356 {
 357    return renderer;
 358 }
 359
 360 SGSubsystemMgr *
 361 FGGlobals::get_subsystem_mgr () const
 362 {
 363     return subsystem_mgr;
 364 }
 365
 366 SGSubsystem *
 367 FGGlobals::get_subsystem (const char * name)
 368 {
 369     return subsystem_mgr->get_subsystem(name);
 370 }
 371
 372 void
 373 FGGlobals::add_subsystem (const char * name,
 374                           SGSubsystem * subsystem,
 375                           SGSubsystemMgr::GroupType type,
 376                           double min_time_sec)
 377 {
 378     subsystem_mgr->add(name, subsystem, type, min_time_sec);
 379 }
 380
 381 SGSoundMgr *
 382 FGGlobals::get_soundmgr () const
 383 {
 384     if (subsystem_mgr)
 385         return (SGSoundMgr*) subsystem_mgr->get_subsystem("sound");
 386
 387     return NULL;
 388 }
 389
 390 SGEventMgr *
 391 FGGlobals::get_event_mgr () const
 392 {
 393     return event_mgr;
 394 }
 395
 396 SGGeod
 397 FGGlobals::get_aircraft_position() const
 398 {
 399   return SGGeod::fromDegFt(positionLon->getDoubleValue(),
 400                            positionLat->getDoubleValue(),
 401                            positionAlt->getDoubleValue());
 402 }
 403
 404 SGVec3d
 405 FGGlobals::get_aircraft_position_cart() const
 406 {
 407     return SGVec3d::fromGeod(get_aircraft_position());
 408 }
 409
 410 void FGGlobals::get_aircraft_orientation(double& heading, double& pitch, double& roll)
 411 {
 412   heading = orientHeading->getDoubleValue();
 413   pitch = orientPitch->getDoubleValue();
 414   roll = orientRoll->getDoubleValue();
 415 }
 416
 417 SGGeod
 418 FGGlobals::get_view_position() const
 419 {
 420   return SGGeod::fromDegFt(viewLon->getDoubleValue(),
 421                            viewLat->getDoubleValue(),
 422                            viewAlt->getDoubleValue());
 423 }
 424
 425 SGVec3d
 426 FGGlobals::get_view_position_cart() const
 427 {
 428   return SGVec3d::fromGeod(get_view_position());
 429 }
 430
 431 // Save the current state as the initial state.
 432 void
 433 FGGlobals::saveInitialState ()
 434 {
 435   initial_state = new SGPropertyNode();
 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(props, initial_state, expected, checked))
 442     SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
 443
 444   // delete various properties from the initial state, since we want to
 445   // preserve their values even if doing a restore
 446   // => Properties should now use the PRESERVE flag to protect their values
 447   // on sim-reset. Remove some specific properties for backward compatibility.
 448   SGPropertyNode* sim = initial_state->getChild("sim");
 449   SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
 450   if (cameraGroupNode) {
 451     cameraGroupNode->removeChild("camera");
 452     cameraGroupNode->removeChild("gui");
 453   }
 454 }
 455
 456
 457 // Restore the saved initial state, if any
 458 void
 459 FGGlobals::restoreInitialState ()
 460 {
 461     if ( initial_state == 0 ) {
 462         SG_LOG(SG_GENERAL, SG_ALERT,
 463                "No initial state available to restore!!!");
 464         return;
 465     }
 466     // copy properties which are READ/WRITEable - but not USERARCHIVEd or PRESERVEd
 467     int checked  = SGPropertyNode::READ+SGPropertyNode::WRITE+
 468                    SGPropertyNode::USERARCHIVE+SGPropertyNode::PRESERVE;
 469     int expected = SGPropertyNode::READ+SGPropertyNode::WRITE;
 470     if ( copyProperties(initial_state, props, expected, checked)) {
 471         SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
 472     } else {
 473         SG_LOG( SG_GENERAL, SG_INFO,
 474                 "Some errors restoring initial state (read-only props?)" );
 475     }
 476
 477 }
 478
 479 // Load user settings from autosave.xml
 480 void
 481 FGGlobals::loadUserSettings(const SGPath& dataPath)
 482 {
 483     // remember that we have (tried) to load any existing autsave.xml
 484     haveUserSettings = true;
 485
 486     SGPath autosaveFile = simgear::Dir(dataPath).file("autosave.xml");
 487     SGPropertyNode autosave;
 488     if (autosaveFile.exists()) {
 489       SG_LOG(SG_INPUT, SG_INFO, "Reading user settings from " << autosaveFile.str());
 490       try {
 491           readProperties(autosaveFile.str(), &autosave, SGPropertyNode::USERARCHIVE);
 492       } catch (sg_exception& e) {
 493           SG_LOG(SG_INPUT, SG_WARN, "failed to read user settings:" << e.getMessage()
 494             << "(from " << e.getOrigin() << ")");
 495       }
 496     }
 497     copyProperties(&autosave, globals->get_props());
 498 }
 499
 500 // Save user settings in autosave.xml
 501 void
 502 FGGlobals::saveUserSettings()
 503 {
 504     // only save settings when we have (tried) to load the previous
 505     // settings (otherwise user data was lost)
 506     if (!haveUserSettings)
 507         return;
 508
 509     if (fgGetBool("/sim/startup/save-on-exit")) {
 510       // don't save settings more than once on shutdown
 511       haveUserSettings = false;
 512
 513       SGPath autosaveFile(globals->get_fg_home());
 514       autosaveFile.append( "autosave.xml" );
 515       autosaveFile.create_dir( 0700 );
 516       SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << autosaveFile.str());
 517       try {
 518         writeProperties(autosaveFile.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
 519       } catch (const sg_exception &e) {
 520         guiErrorMessage("Error writing autosave.xml: ", e);
 521       }
 522       SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
 523     }
 524 }
 525
 526 FGViewer *
 527 FGGlobals::get_current_view () const
 528 {
 529   return viewmgr->get_current_view();
 530 }
 531
 532 long int FGGlobals::get_warp() const
 533 {
 534   return fgGetInt("/sim/time/warp");
 535 }
 536
 537 void FGGlobals::set_warp( long int w )
 538 {
 539   fgSetInt("/sim/time/warp", w);
 540 }
 541
 542 long int FGGlobals::get_warp_delta() const
 543 {
 544   return fgGetInt("/sim/time/warp-delta");
 545 }
 546
 547 void FGGlobals::set_warp_delta( long int d )
 548 {
 549   fgSetInt("/sim/time/warp-delta", d);
 550 }
 551
 552 // end of globals.cxx