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 <simgear/structure/commands.hxx>
  28 #include <simgear/misc/sg_path.hxx>
  29 #include <simgear/misc/sg_dir.hxx>
  30 #include <simgear/timing/sg_time.hxx>
  31 #include <simgear/ephemeris/ephemeris.hxx>
  32 #include <simgear/magvar/magvar.hxx>
  33 #include <simgear/scene/material/matlib.hxx>
  34 #include <simgear/structure/subsystem_mgr.hxx>
  35 #include <simgear/structure/event_mgr.hxx>
  36 #include <simgear/sound/soundmgr_openal.hxx>
  37 #include <simgear/misc/ResourceManager.hxx>
  38 #include <simgear/props/propertyObject.hxx>
  39
  40 #include <Aircraft/controls.hxx>
  41 #include <Airports/runways.hxx>
  42 #include <ATCDCL/ATCmgr.hxx>
  43 #include <Autopilot/route_mgr.hxx>
  44 #include <Cockpit/panel.hxx>
  45 #include <GUI/new_gui.hxx>
  46 #include <Model/acmodel.hxx>
  47 #include <Model/modelmgr.hxx>
  48 #include <MultiPlayer/multiplaymgr.hxx>
  49 #include <Scenery/scenery.hxx>
  50 #include <Scenery/tilemgr.hxx>
  51 #include <Navaids/navlist.hxx>
  52
  53 #include "globals.hxx"
  54 #include "renderer.hxx"
  55 #include "viewmgr.hxx"
  56
  57 #include "fg_props.hxx"
  58 #include "fg_io.hxx"
  59
  60 class AircraftResourceProvider : public simgear::ResourceProvider
  61 {
  62 public:
  63   AircraftResourceProvider() :
  64     simgear::ResourceProvider(simgear::ResourceManager::PRIORITY_HIGH)
  65   {
  66   }
  67
  68   virtual SGPath resolve(const std::string& aResource, SGPath&) const
  69   {
  70     string_list pieces(sgPathBranchSplit(aResource));
  71     if ((pieces.size() < 3) || (pieces.front() != "Aircraft")) {
  72       return SGPath(); // not an Aircraft path
  73     }
  74
  75   // test against the aircraft-dir property
  76     const char* aircraftDir = fgGetString("/sim/aircraft-dir");
  77     string_list aircraftDirPieces(sgPathBranchSplit(aircraftDir));
  78     if (!aircraftDirPieces.empty() && (aircraftDirPieces.back() == pieces[1])) {
  79         // current aircraft-dir matches resource aircraft
  80         SGPath r(aircraftDir);
  81         for (unsigned int i=2; i<pieces.size(); ++i) {
  82           r.append(pieces[i]);
  83         }
  84
  85         if (r.exists()) {
  86           SG_LOG(SG_IO, SG_INFO, "found path:" << aResource << " via /sim/aircraft-dir: " << r.str());
  87           return r;
  88         }
  89     }
  90
  91   // try each aircraft dir in turn
  92     std::string res(aResource, 9); // resource path with 'Aircraft/' removed
  93     const string_list& dirs(globals->get_aircraft_paths());
  94     string_list::const_iterator it = dirs.begin();
  95     for (; it != dirs.end(); ++it) {
  96       SGPath p(*it, res);
  97       if (p.exists()) {
  98         SG_LOG(SG_IO, SG_INFO, "found path:" << aResource << " in aircraft dir: " << *it);
  99         return p;
 100       }
 101     } // of aircraft path iteration
 102
 103     return SGPath(); // not found
 104   }
 105 };
 106
 107 ////////////////////////////////////////////////////////////////////////
 108 // Implementation of FGGlobals.
 109 ////////////////////////////////////////////////////////////////////////
 110
 111 // global global :-)
 112 FGGlobals *globals;
 113
 114
 115 // Constructor
 116 FGGlobals::FGGlobals() :
 117     props( new SGPropertyNode ),
 118     initial_state( NULL ),
 119     locale( NULL ),
 120     renderer( new FGRenderer ),
 121     subsystem_mgr( new SGSubsystemMgr ),
 122     event_mgr( new SGEventMgr ),
 123     soundmgr( new SGSoundMgr ),
 124     sim_time_sec( 0.0 ),
 125     fg_root( "" ),
 126     time_params( NULL ),
 127     ephem( NULL ),
 128     mag( NULL ),
 129     matlib( NULL ),
 130     route_mgr( NULL ),
 131     current_panel( NULL ),
 132     ATC_mgr( NULL ),
 133     controls( NULL ),
 134     viewmgr( NULL ),
 135     commands( SGCommandMgr::instance() ),
 136     acmodel( NULL ),
 137     model_mgr( NULL ),
 138     channel_options_list( NULL ),
 139     initial_waypoints( NULL ),
 140     scenery( NULL ),
 141     tile_mgr( NULL ),
 142     fontcache ( new FGFontCache ),
 143     navlist( NULL ),
 144     loclist( NULL ),
 145     gslist( NULL ),
 146     dmelist( NULL ),
 147     tacanlist( NULL ),
 148     carrierlist( NULL ),
 149     channellist( NULL )
 150 {
 151   simgear::ResourceManager::instance()->addProvider(new AircraftResourceProvider());
 152   simgear::PropertyObjectBase::setDefaultRoot(props);
 153 }
 154
 155
 156 // Destructor
 157 FGGlobals::~FGGlobals()
 158 {
 159     delete renderer;
 160     renderer = NULL;
 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
 174     subsystem_mgr->shutdown();
 175     subsystem_mgr->unbind();
 176     delete subsystem_mgr;
 177
 178     delete time_params;
 179     delete mag;
 180     delete matlib;
 181     delete route_mgr;
 182     delete current_panel;
 183
 184     delete ATC_mgr;
 185     delete controls;
 186
 187     delete channel_options_list;
 188     delete initial_waypoints;
 189     delete scenery;
 190     delete fontcache;
 191
 192     delete navlist;
 193     delete loclist;
 194     delete gslist;
 195     delete dmelist;
 196     delete tacanlist;
 197     delete carrierlist;
 198     delete channellist;
 199
 200     soundmgr->unbind();
 201     delete soundmgr;
 202 }
 203
 204
 205 // set the fg_root path
 206 void FGGlobals::set_fg_root (const string &root) {
 207     fg_root = root;
 208
 209     // append /data to root if it exists
 210     SGPath tmp( fg_root );
 211     tmp.append( "data" );
 212     tmp.append( "version" );
 213     if ( ulFileExists( tmp.c_str() ) ) {
 214         fgGetNode("BAD_FG_ROOT", true)->setStringValue(fg_root);
 215         fg_root += "/data";
 216         fgGetNode("GOOD_FG_ROOT", true)->setStringValue(fg_root);
 217         SG_LOG(SG_GENERAL, SG_ALERT, "***\n***\n*** Warning: changing bad FG_ROOT/--fg-root to '"
 218                 << fg_root << "'\n***\n***");
 219     }
 220
 221     // remove /sim/fg-root before writing to prevent hijacking
 222     SGPropertyNode *n = fgGetNode("/sim", true);
 223     n->removeChild("fg-root", 0, false);
 224     n = n->getChild("fg-root", 0, true);
 225     n->setStringValue(fg_root.c_str());
 226     n->setAttribute(SGPropertyNode::WRITE, false);
 227
 228     simgear::ResourceManager::instance()->addBasePath(fg_root,
 229       simgear::ResourceManager::PRIORITY_DEFAULT);
 230 }
 231
 232 void FGGlobals::set_fg_scenery (const string &scenery)
 233 {
 234     SGPath s;
 235     if (scenery.empty()) {
 236         s.set( fg_root );
 237         s.append( "Scenery" );
 238     } else
 239         s.set( scenery );
 240
 241     string_list path_list = sgPathSplit( s.str() );
 242     fg_scenery.clear();
 243
 244     for (unsigned i = 0; i < path_list.size(); i++) {
 245         SGPath path(path_list[i]);
 246         if (!path.exists()) {
 247           SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << path.str());
 248           continue;
 249         }
 250
 251         simgear::Dir dir(path);
 252         SGPath terrainDir(dir.file("Terrain"));
 253         SGPath objectsDir(dir.file("Objects"));
 254
 255       // this code used to add *either* the base dir, OR add the
 256       // Terrain and Objects subdirs, but the conditional logic was commented
 257       // out, such that all three dirs are added. Unfortunately there's
 258       // no information as to why the change was made.
 259         fg_scenery.push_back(path.str());
 260
 261         if (terrainDir.exists()) {
 262           fg_scenery.push_back(terrainDir.str());
 263         }
 264
 265         if (objectsDir.exists()) {
 266           fg_scenery.push_back(objectsDir.str());
 267         }
 268
 269         // insert a marker for FGTileEntry::load(), so that
 270         // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
 271         // "B/Terrain", "B/Objects", ""]
 272         fg_scenery.push_back("");
 273     } // of path list iteration
 274 }
 275
 276 void FGGlobals::append_aircraft_path(const std::string& path)
 277 {
 278   SGPath dirPath(path);
 279   if (!dirPath.exists()) {
 280     SG_LOG(SG_GENERAL, SG_WARN, "aircraft path not found:" << path);
 281     return;
 282   }
 283
 284   unsigned int index = fg_aircraft_dirs.size();
 285   fg_aircraft_dirs.push_back(path);
 286
 287 // make aircraft dirs available to Nasal
 288   SGPropertyNode* sim = fgGetNode("/sim", true);
 289   sim->removeChild("fg-aircraft", index, false);
 290   SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
 291   n->setStringValue(path);
 292   n->setAttribute(SGPropertyNode::WRITE, false);
 293 }
 294
 295 void FGGlobals::append_aircraft_paths(const std::string& path)
 296 {
 297   string_list paths = sgPathSplit(path);
 298   for (unsigned int p = 0; p<paths.size(); ++p) {
 299     append_aircraft_path(paths[p]);
 300   }
 301 }
 302
 303 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
 304 {
 305   return simgear::ResourceManager::instance()->findPath(branch);
 306 }
 307
 308 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
 309 {
 310   return simgear::ResourceManager::instance()->findPath(branch);
 311 }
 312
 313 FGRenderer *
 314 FGGlobals::get_renderer () const
 315 {
 316    return renderer;
 317 }
 318
 319 SGSubsystemMgr *
 320 FGGlobals::get_subsystem_mgr () const
 321 {
 322     return subsystem_mgr;
 323 }
 324
 325 SGSubsystem *
 326 FGGlobals::get_subsystem (const char * name)
 327 {
 328     return subsystem_mgr->get_subsystem(name);
 329 }
 330
 331 void
 332 FGGlobals::add_subsystem (const char * name,
 333                           SGSubsystem * subsystem,
 334                           SGSubsystemMgr::GroupType type,
 335                           double min_time_sec)
 336 {
 337     subsystem_mgr->add(name, subsystem, type, min_time_sec);
 338 }
 339
 340 SGSoundMgr *
 341 FGGlobals::get_soundmgr () const
 342 {
 343     return soundmgr;
 344 }
 345
 346 SGEventMgr *
 347 FGGlobals::get_event_mgr () const
 348 {
 349     return event_mgr;
 350 }
 351
 352
 353 // Save the current state as the initial state.
 354 void
 355 FGGlobals::saveInitialState ()
 356 {
 357   initial_state = new SGPropertyNode();
 358
 359   if (!copyProperties(props, initial_state))
 360     SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
 361
 362   // delete various properties from the initial state, since we want to
 363   // preserve their values even if doing a restore
 364
 365   SGPropertyNode* sim = initial_state->getChild("sim");
 366   sim->removeChild("presets");
 367   SGPropertyNode* simStartup = sim->getChild("startup");
 368   simStartup->removeChild("xsize");
 369   simStartup->removeChild("ysize");
 370
 371   SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
 372   if (cameraGroupNode) {
 373     cameraGroupNode->removeChild("camera");
 374     cameraGroupNode->removeChild("gui");
 375   }
 376 }
 377
 378
 379 // Restore the saved initial state, if any
 380 void
 381 FGGlobals::restoreInitialState ()
 382 {
 383     if ( initial_state == 0 ) {
 384         SG_LOG(SG_GENERAL, SG_ALERT,
 385                "No initial state available to restore!!!");
 386         return;
 387     }
 388
 389     if ( copyProperties(initial_state, props) ) {
 390         SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
 391     } else {
 392         SG_LOG( SG_GENERAL, SG_INFO,
 393                 "Some errors restoring initial state (read-only props?)" );
 394     }
 395
 396 }
 397
 398 FGViewer *
 399 FGGlobals::get_current_view () const
 400 {
 401   return viewmgr->get_current_view();
 402 }
 403
 404 long int FGGlobals::get_warp() const
 405 {
 406   return fgGetInt("/sim/time/warp");
 407 }
 408
 409 void FGGlobals::set_warp( long int w )
 410 {
 411   fgSetInt("/sim/time/warp", w);
 412 }
 413
 414 long int FGGlobals::get_warp_delta() const
 415 {
 416   return fgGetInt("/sim/time/warp-delta");
 417 }
 418
 419 void FGGlobals::set_warp_delta( long int d )
 420 {
 421   fgSetInt("/sim/time/warp-delta", d);
 422 }
 423
 424 // end of globals.cxx