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_DEBUG, "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_DEBUG, "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     controls->unbind();
 186     delete controls;
 187
 188     delete channel_options_list;
 189     delete initial_waypoints;
 190     delete scenery;
 191     delete fontcache;
 192
 193     delete navlist;
 194     delete loclist;
 195     delete gslist;
 196     delete dmelist;
 197     delete tacanlist;
 198     delete carrierlist;
 199     delete channellist;
 200
 201     soundmgr->unbind();
 202     delete soundmgr;
 203 }
 204
 205
 206 // set the fg_root path
 207 void FGGlobals::set_fg_root (const string &root) {
 208     fg_root = root;
 209
 210     // append /data to root if it exists
 211     SGPath tmp( fg_root );
 212     tmp.append( "data" );
 213     tmp.append( "version" );
 214     if ( ulFileExists( tmp.c_str() ) ) {
 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 void FGGlobals::set_fg_scenery (const string &scenery)
 234 {
 235     SGPath s;
 236     if (scenery.empty()) {
 237         s.set( fg_root );
 238         s.append( "Scenery" );
 239     } else
 240         s.set( scenery );
 241
 242     string_list path_list = sgPathSplit( s.str() );
 243     fg_scenery.clear();
 244
 245     for (unsigned i = 0; i < path_list.size(); i++) {
 246         SGPath path(path_list[i]);
 247         if (!path.exists()) {
 248           SG_LOG(SG_GENERAL, SG_WARN, "scenery path not found:" << path.str());
 249           continue;
 250         }
 251
 252         simgear::Dir dir(path);
 253         SGPath terrainDir(dir.file("Terrain"));
 254         SGPath objectsDir(dir.file("Objects"));
 255
 256       // this code used to add *either* the base dir, OR add the
 257       // Terrain and Objects subdirs, but the conditional logic was commented
 258       // out, such that all three dirs are added. Unfortunately there's
 259       // no information as to why the change was made.
 260         fg_scenery.push_back(path.str());
 261
 262         if (terrainDir.exists()) {
 263           fg_scenery.push_back(terrainDir.str());
 264         }
 265
 266         if (objectsDir.exists()) {
 267           fg_scenery.push_back(objectsDir.str());
 268         }
 269
 270         // insert a marker for FGTileEntry::load(), so that
 271         // FG_SCENERY=A:B becomes list ["A/Terrain", "A/Objects", "",
 272         // "B/Terrain", "B/Objects", ""]
 273         fg_scenery.push_back("");
 274     } // of path list iteration
 275 }
 276
 277 void FGGlobals::append_aircraft_path(const std::string& path)
 278 {
 279   SGPath dirPath(path);
 280   if (!dirPath.exists()) {
 281     SG_LOG(SG_GENERAL, SG_WARN, "aircraft path not found:" << path);
 282     return;
 283   }
 284
 285   unsigned int index = fg_aircraft_dirs.size();
 286   fg_aircraft_dirs.push_back(path);
 287
 288 // make aircraft dirs available to Nasal
 289   SGPropertyNode* sim = fgGetNode("/sim", true);
 290   sim->removeChild("fg-aircraft", index, false);
 291   SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
 292   n->setStringValue(path);
 293   n->setAttribute(SGPropertyNode::WRITE, false);
 294 }
 295
 296 void FGGlobals::append_aircraft_paths(const std::string& path)
 297 {
 298   string_list paths = sgPathSplit(path);
 299   for (unsigned int p = 0; p<paths.size(); ++p) {
 300     append_aircraft_path(paths[p]);
 301   }
 302 }
 303
 304 SGPath FGGlobals::resolve_aircraft_path(const std::string& branch) const
 305 {
 306   return simgear::ResourceManager::instance()->findPath(branch);
 307 }
 308
 309 SGPath FGGlobals::resolve_maybe_aircraft_path(const std::string& branch) const
 310 {
 311   return simgear::ResourceManager::instance()->findPath(branch);
 312 }
 313
 314 FGRenderer *
 315 FGGlobals::get_renderer () const
 316 {
 317    return renderer;
 318 }
 319
 320 SGSubsystemMgr *
 321 FGGlobals::get_subsystem_mgr () const
 322 {
 323     return subsystem_mgr;
 324 }
 325
 326 SGSubsystem *
 327 FGGlobals::get_subsystem (const char * name)
 328 {
 329     return subsystem_mgr->get_subsystem(name);
 330 }
 331
 332 void
 333 FGGlobals::add_subsystem (const char * name,
 334                           SGSubsystem * subsystem,
 335                           SGSubsystemMgr::GroupType type,
 336                           double min_time_sec)
 337 {
 338     subsystem_mgr->add(name, subsystem, type, min_time_sec);
 339 }
 340
 341 SGSoundMgr *
 342 FGGlobals::get_soundmgr () const
 343 {
 344     return soundmgr;
 345 }
 346
 347 SGEventMgr *
 348 FGGlobals::get_event_mgr () const
 349 {
 350     return event_mgr;
 351 }
 352
 353
 354 // Save the current state as the initial state.
 355 void
 356 FGGlobals::saveInitialState ()
 357 {
 358   initial_state = new SGPropertyNode();
 359
 360   if (!copyProperties(props, initial_state))
 361     SG_LOG(SG_GENERAL, SG_ALERT, "Error saving initial state");
 362
 363   // delete various properties from the initial state, since we want to
 364   // preserve their values even if doing a restore
 365
 366   SGPropertyNode* sim = initial_state->getChild("sim");
 367   sim->removeChild("presets");
 368   SGPropertyNode* simStartup = sim->getChild("startup");
 369   simStartup->removeChild("xsize");
 370   simStartup->removeChild("ysize");
 371
 372   SGPropertyNode* cameraGroupNode = sim->getNode("rendering/camera-group");
 373   if (cameraGroupNode) {
 374     cameraGroupNode->removeChild("camera");
 375     cameraGroupNode->removeChild("gui");
 376   }
 377 }
 378
 379
 380 // Restore the saved initial state, if any
 381 void
 382 FGGlobals::restoreInitialState ()
 383 {
 384     if ( initial_state == 0 ) {
 385         SG_LOG(SG_GENERAL, SG_ALERT,
 386                "No initial state available to restore!!!");
 387         return;
 388     }
 389
 390     if ( copyProperties(initial_state, props) ) {
 391         SG_LOG( SG_GENERAL, SG_INFO, "Initial state restored successfully" );
 392     } else {
 393         SG_LOG( SG_GENERAL, SG_INFO,
 394                 "Some errors restoring initial state (read-only props?)" );
 395     }
 396
 397 }
 398
 399 FGViewer *
 400 FGGlobals::get_current_view () const
 401 {
 402   return viewmgr->get_current_view();
 403 }
 404
 405 long int FGGlobals::get_warp() const
 406 {
 407   return fgGetInt("/sim/time/warp");
 408 }
 409
 410 void FGGlobals::set_warp( long int w )
 411 {
 412   fgSetInt("/sim/time/warp", w);
 413 }
 414
 415 long int FGGlobals::get_warp_delta() const
 416 {
 417   return fgGetInt("/sim/time/warp-delta");
 418 }
 419
 420 void FGGlobals::set_warp_delta( long int d )
 421 {
 422   fgSetInt("/sim/time/warp-delta", d);
 423 }
 424
 425 // end of globals.cxx