src/Main/main.cxx

   1 // main.cxx -- top level sim routines
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997 - 2002  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
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <iostream>
  31
  32 #include <osg/Camera>
  33 #include <osg/GraphicsContext>
  34 #include <osgDB/Registry>
  35
  36 #if defined(HAVE_CRASHRPT)
  37         #include <CrashRpt.h>
  38
  39 // defined in bootstrap.cxx
  40 extern bool global_crashRptEnabled;
  41
  42 #endif
  43
  44 // Class references
  45 #include <simgear/canvas/VGInitOperation.hxx>
  46 #include <simgear/scene/model/modellib.hxx>
  47 #include <simgear/scene/material/matlib.hxx>
  48 #include <simgear/scene/material/Effect.hxx>
  49 #include <simgear/props/AtomicChangeListener.hxx>
  50 #include <simgear/props/props.hxx>
  51 #include <simgear/timing/sg_time.hxx>
  52 #include <simgear/io/raw_socket.hxx>
  53 #include <simgear/scene/tsync/terrasync.hxx>
  54 #include <simgear/math/SGMath.hxx>
  55 #include <simgear/math/sg_random.h>
  56 #include <simgear/misc/strutils.hxx>
  57 #include <simgear/scene/tgdb/GroundLightManager.hxx>
  58
  59 #include <Model/panelnode.hxx>
  60 #include <Scenery/scenery.hxx>
  61 #include <Scenery/tilemgr.hxx>
  62 #include <Sound/soundmanager.hxx>
  63 #include <Time/TimeManager.hxx>
  64 #include <GUI/gui.h>
  65 #include <GUI/MessageBox.hxx>
  66 #include <Viewer/splash.hxx>
  67 #include <Viewer/renderer.hxx>
  68 #include <Viewer/WindowSystemAdapter.hxx>
  69 #include <Navaids/NavDataCache.hxx>
  70 #include <Include/version.h>
  71
  72 #include "fg_commands.hxx"
  73 #include "fg_io.hxx"
  74 #include "main.hxx"
  75 #include "util.hxx"
  76 #include "fg_init.hxx"
  77 #include "fg_os.hxx"
  78 #include "fg_props.hxx"
  79 #include "positioninit.hxx"
  80 #include "screensaver_control.hxx"
  81 #include "subsystemFactory.hxx"
  82 #include "options.hxx"
  83
  84 #if defined(HAVE_QT)
  85 #include <GUI/QtLauncher.hxx>
  86 #endif
  87
  88 using namespace flightgear;
  89
  90 using std::cerr;
  91 using std::vector;
  92
  93 // The atexit() function handler should know when the graphical subsystem
  94 // is initialized.
  95 extern int _bootstrap_OSInit;
  96
  97 static SGPropertyNode_ptr frame_signal;
  98 static TimeManager* timeMgr;
  99
 100 // What should we do when we have nothing else to do?  Let's get ready
 101 // for the next move and update the display?
 102 static void fgMainLoop( void )
 103 {
 104     frame_signal->fireValueChanged();
 105
 106     // compute simulated time (allowing for pause, warp, etc) and
 107     // real elapsed time
 108     double sim_dt, real_dt;
 109     timeMgr->computeTimeDeltas(sim_dt, real_dt);
 110
 111     // update all subsystems
 112     globals->get_subsystem_mgr()->update(sim_dt);
 113
 114     simgear::AtomicChangeListener::fireChangeListeners();
 115 }
 116
 117 static void initTerrasync()
 118 {
 119     // add the terrasync root as a data path so data can be retrieved from it
 120     // (even if we are in read-only mode)
 121     std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
 122     globals->append_data_path(terraSyncDir);
 123
 124     if (fgGetBool("/sim/fghome-readonly", false)) {
 125         return;
 126     }
 127
 128     // start TerraSync up now, so it can be synchronizing shared models
 129     // and airports data in parallel with a nav-cache rebuild.
 130     SGPath tsyncCache(terraSyncDir);
 131     tsyncCache.append("terrasync-cache.xml");
 132
 133     // wipe the cache file if requested
 134     if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
 135         SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
 136                tsyncCache);
 137         if (tsyncCache.exists()) {
 138             tsyncCache.remove();
 139         }
 140     }
 141
 142     fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
 143
 144     simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
 145     terra_sync->setRoot(globals->get_props());
 146     globals->add_subsystem("terrasync", terra_sync);
 147
 148     terra_sync->bind();
 149     terra_sync->init();
 150 }
 151
 152 static void checkOpenGLVersion()
 153 {
 154 #if defined(SG_MAC)
 155     // Mac users can't upgrade their drivers, so complaining about
 156     // versions doesn't help them much
 157     return;
 158 #endif
 159
 160     // format of these strings is not standardised, so be careful about
 161     // parsing them.
 162     std::string versionString(fgGetString("/sim/rendering/gl-version"));
 163     string_list parts = simgear::strutils::split(versionString);
 164     if (parts.size() == 3) {
 165         if (parts[1].find("NVIDIA") != std::string::npos) {
 166             // driver version number, dot-seperared
 167             string_list driverVersion = simgear::strutils::split(parts[2], ".");
 168             if (!driverVersion.empty()) {
 169                 int majorDriverVersion = simgear::strutils::to_int(driverVersion[0]);
 170                 if (majorDriverVersion < 300) {
 171                     std::ostringstream ss;
 172                     ss << "Please upgrade to at least version 300 of the nVidia drivers (installed version is " << parts[2] << ")";
 173
 174                     flightgear::modalMessageBox("Outdated graphics drivers",
 175                                                 "FlightGear has detected outdated drivers for your graphics card.",
 176                                                 ss.str());
 177                 }
 178             }
 179         } // of NVIDIA-style version string
 180     } // of three parts
 181 }
 182
 183 static void registerMainLoop()
 184 {
 185     // stash current frame signal property
 186     frame_signal = fgGetNode("/sim/signals/frame", true);
 187     timeMgr = (TimeManager*) globals->get_subsystem("time");
 188     fgRegisterIdleHandler( fgMainLoop );
 189 }
 190
 191 // This is the top level master main function that is registered as
 192 // our idle function
 193
 194 // The first few passes take care of initialization things (a couple
 195 // per pass) and once everything has been initialized fgMainLoop from
 196 // then on.
 197
 198 static int idle_state = 0;
 199
 200 static void fgIdleFunction ( void ) {
 201     // Specify our current idle function state.  This is used to run all
 202     // our initializations out of the idle callback so that we can get a
 203     // splash screen up and running right away.
 204
 205     if ( idle_state == 0 ) {
 206         if (guiInit())
 207         {
 208             checkOpenGLVersion();
 209             idle_state+=2;
 210             fgSplashProgress("loading-aircraft-list");
 211         }
 212
 213     } else if ( idle_state == 2 ) {
 214         initTerrasync();
 215         idle_state++;
 216         fgSplashProgress("loading-nav-dat");
 217
 218     } else if ( idle_state == 3 ) {
 219
 220         bool done = fgInitNav();
 221         if (done) {
 222           ++idle_state;
 223           fgSplashProgress("init-scenery");
 224         }
 225     } else if ( idle_state == 4 ) {
 226         idle_state++;
 227
 228         TimeManager* t = new TimeManager;
 229         globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
 230
 231         // Do some quick general initializations
 232         if( !fgInitGeneral()) {
 233             throw sg_exception("General initialization failed");
 234         }
 235
 236         ////////////////////////////////////////////////////////////////////
 237         // Initialize the property-based built-in commands
 238         ////////////////////////////////////////////////////////////////////
 239         fgInitCommands();
 240
 241         flightgear::registerSubsystemCommands(globals->get_commands());
 242
 243         ////////////////////////////////////////////////////////////////////
 244         // Initialize the material manager
 245         ////////////////////////////////////////////////////////////////////
 246         globals->set_matlib( new SGMaterialLib );
 247         simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
 248
 249     } else if (( idle_state == 5 ) || (idle_state == 2005)) {
 250         idle_state+=2;
 251         flightgear::initPosition();
 252         flightgear::initTowerLocationListener();
 253
 254         simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
 255
 256         TimeManager* timeManager = (TimeManager*) globals->get_subsystem("time");
 257         timeManager->init();
 258
 259         ////////////////////////////////////////////////////////////////////
 260         // Initialize the TG scenery subsystem.
 261         ////////////////////////////////////////////////////////////////////
 262
 263         globals->add_new_subsystem<FGScenery>(SGSubsystemMgr::DISPLAY);
 264         globals->get_scenery()->init();
 265         globals->get_scenery()->bind();
 266         globals->add_new_subsystem<FGTileMgr>(SGSubsystemMgr::DISPLAY);
 267
 268         fgSplashProgress("creating-subsystems");
 269     } else if (( idle_state == 7 ) || (idle_state == 2007)) {
 270         bool isReset = (idle_state == 2007);
 271         idle_state = 8; // from the next state on, reset & startup are identical
 272         SGTimeStamp st;
 273         st.stamp();
 274         fgCreateSubsystems(isReset);
 275         SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
 276         fgSplashProgress("binding-subsystems");
 277
 278     } else if ( idle_state == 8 ) {
 279         idle_state++;
 280         SGTimeStamp st;
 281         st.stamp();
 282         globals->get_subsystem_mgr()->bind();
 283         SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
 284
 285         fgSplashProgress("init-subsystems");
 286     } else if ( idle_state == 9 ) {
 287         SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
 288         if ( status == SGSubsystem::INIT_DONE) {
 289           ++idle_state;
 290           fgSplashProgress("finishing-subsystems");
 291         } else {
 292           fgSplashProgress("init-subsystems");
 293         }
 294
 295     } else if ( idle_state == 10 ) {
 296         idle_state = 900;
 297         fgPostInitSubsystems();
 298         fgSplashProgress("finalize-position");
 299     } else if ( idle_state == 900 ) {
 300         idle_state = 1000;
 301
 302         // setup OpenGL view parameters
 303         globals->get_renderer()->setupView();
 304
 305         globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
 306                                          fgGetInt("/sim/startup/ysize") );
 307         WindowSystemAdapter::getWSA()->windows[0]->gc->add(
 308           new simgear::canvas::VGInitOperation()
 309         );
 310
 311         int session = fgGetInt("/sim/session",0);
 312         session++;
 313         fgSetInt("/sim/session",session);
 314     }
 315
 316     if ( idle_state == 1000 ) {
 317         // We've finished all our initialization steps, from now on we
 318         // run the main loop.
 319         fgSetBool("sim/sceneryloaded", false);
 320         registerMainLoop();
 321     }
 322
 323     if ( idle_state == 2000 ) {
 324         fgStartNewReset();
 325         idle_state = 2005;
 326     }
 327 }
 328
 329 void fgResetIdleState()
 330 {
 331     idle_state = 2000;
 332     fgRegisterIdleHandler( &fgIdleFunction );
 333 }
 334
 335
 336 static void upper_case_property(const char *name)
 337 {
 338     using namespace simgear;
 339     SGPropertyNode *p = fgGetNode(name, false);
 340     if (!p) {
 341         p = fgGetNode(name, true);
 342         p->setStringValue("");
 343     } else {
 344         props::Type t = p->getType();
 345         if (t == props::NONE || t == props::UNSPECIFIED)
 346             p->setStringValue("");
 347         else
 348             assert(t == props::STRING);
 349     }
 350     SGPropertyChangeListener* muc = new FGMakeUpperCase;
 351     globals->addListenerToCleanup(muc);
 352     p->addChangeListener(muc);
 353 }
 354
 355 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
 356 // for the details of this.
 357 static void ATIScreenSizeHack()
 358 {
 359     osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
 360     hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
 361     int prettyMuchAnyInt = 1;
 362     hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
 363     globals->get_renderer()->addCamera(hackCam, false);
 364 }
 365
 366 // Propose NVIDIA Optimus to use high-end GPU
 367 #if defined(SG_WINDOWS)
 368 extern "C" {
 369     _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
 370 }
 371 #endif
 372
 373 static void logToFile()
 374 {
 375     SGPath logPath = globals->get_fg_home();
 376     logPath.append("fgfs.log");
 377     if (logPath.exists()) {
 378         SGPath prevLogPath = globals->get_fg_home();
 379         prevLogPath.append("fgfs_0.log");
 380         logPath.rename(prevLogPath);
 381         // bit strange, we need to restore the correct value of logPath now
 382         logPath = globals->get_fg_home();
 383         logPath.append("fgfs.log");
 384     }
 385     sglog().logToFile(logPath, SG_ALL, SG_INFO);
 386
 387 #if defined(HAVE_CRASHRPT)
 388         if (global_crashRptEnabled) {
 389                 crAddFile2(logPath.c_str(), NULL, "FlightGear Log File", CR_AF_MAKE_FILE_COPY);
 390                 SG_LOG( SG_GENERAL, SG_INFO, "CrashRpt enabled");
 391         } else {
 392                 SG_LOG(SG_GENERAL, SG_WARN, "CrashRpt enabled at compile time but failed to install");
 393         }
 394 #endif
 395 }
 396
 397 // Main top level initialization
 398 int fgMainInit( int argc, char **argv )
 399 {
 400     // set default log levels
 401     sglog().setLogLevels( SG_ALL, SG_ALERT );
 402
 403     globals = new FGGlobals;
 404     if (!fgInitHome()) {
 405         return EXIT_FAILURE;
 406     }
 407
 408     if (!fgGetBool("/sim/fghome-readonly")) {
 409         // now home is initialised, we can log to a file inside it
 410         logToFile();
 411     }
 412
 413     std::string version(FLIGHTGEAR_VERSION);
 414     SG_LOG( SG_GENERAL, SG_INFO, "FlightGear:  Version "
 415             << version );
 416     SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR);
 417         SG_LOG( SG_GENERAL, SG_INFO, "Jenkins number/ID " << HUDSON_BUILD_NUMBER << ":"
 418                         << HUDSON_BUILD_ID);
 419
 420     // seed the random number generator
 421     sg_srandom_time();
 422
 423     string_list *col = new string_list;
 424     globals->set_channel_options_list( col );
 425
 426     fgValidatePath(globals->get_fg_home(), false);  // initialize static variables
 427     upper_case_property("/sim/presets/airport-id");
 428     upper_case_property("/sim/presets/runway");
 429     upper_case_property("/sim/tower/airport-id");
 430     upper_case_property("/autopilot/route-manager/input");
 431
 432     // Load the configuration parameters.  (Command line options
 433     // override config file options.  Config file options override
 434     // defaults.)
 435     int configResult = fgInitConfig(argc, argv, false);
 436     if (configResult == flightgear::FG_OPTIONS_ERROR) {
 437         return EXIT_FAILURE;
 438     } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
 439         return EXIT_SUCCESS;
 440     }
 441
 442   // launcher needs to know the aircraft paths in use
 443     fgInitAircraftPaths(false);
 444
 445 #if defined(HAVE_QT)
 446     bool showLauncher = flightgear::Options::checkForArg(argc, argv, "launcher");
 447     // an Info.plist bundle can't define command line arguments, but it can set
 448     // environment variables. This avoids needed a wrapper shell-script on OS-X.
 449     showLauncher |= (::getenv("FG_LAUNCHER") != 0);
 450
 451     if (showLauncher) {
 452         flightgear::initApp(argc, argv);
 453         if (!flightgear::runLauncherDialog()) {
 454             return EXIT_SUCCESS;
 455         }
 456     }
 457 #endif
 458
 459     configResult = fgInitAircraft(false);
 460     if (configResult == flightgear::FG_OPTIONS_ERROR) {
 461         return EXIT_FAILURE;
 462     } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
 463         return EXIT_SUCCESS;
 464     }
 465
 466     configResult = flightgear::Options::sharedInstance()->processOptions();
 467     if (configResult == flightgear::FG_OPTIONS_ERROR) {
 468         return EXIT_FAILURE;
 469     } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
 470         return EXIT_SUCCESS;
 471     }
 472
 473     // Initialize the Window/Graphics environment.
 474     fgOSInit(&argc, argv);
 475     _bootstrap_OSInit++;
 476
 477     fgRegisterIdleHandler( &fgIdleFunction );
 478
 479     // Initialize sockets (WinSock needs this)
 480     simgear::Socket::initSockets();
 481
 482     // Clouds3D requires an alpha channel
 483     fgOSOpenWindow(true /* request stencil buffer */);
 484     fgOSResetProperties();
 485
 486     // Initialize the splash screen right away
 487     fntInit();
 488     fgSplashInit();
 489
 490     if (fgGetBool("/sim/ati-viewport-hack", true)) {
 491         SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
 492         ATIScreenSizeHack();
 493     }
 494
 495     fgOutputSettings();
 496
 497     //try to disable the screensaver
 498     fgOSDisableScreensaver();
 499
 500     // pass control off to the master event handler
 501     int result = fgOSMainLoop();
 502     frame_signal.clear();
 503     fgOSCloseWindow();
 504
 505     simgear::clearEffectCache();
 506
 507     // clean up here; ensure we null globals to avoid
 508     // confusing the atexit() handler
 509     delete globals;
 510     globals = NULL;
 511
 512     // delete the NavCache here. This will cause the destruction of many cached
 513     // objects (eg, airports, navaids, runways).
 514     delete flightgear::NavDataCache::instance();
 515     simgear::GroundLightManager::instance()->getRunwayLightStateSet()->clear();
 516     simgear::GroundLightManager::instance()->getTaxiLightStateSet()->clear();
 517     simgear::GroundLightManager::instance()->getGroundLightStateSet()->clear();
 518
 519     return result;
 520 }