src/Main/fg_commands.cxx

   1 // fg_commands.cxx - internal FGFS commands.
   2
   3 #ifdef HAVE_CONFIG_H
   4 #  include "config.h"
   5 #endif
   6
   7 #include <string.h>             // strcmp()
   8
   9 #include <simgear/compiler.h>
  10
  11 #include <string>
  12 #include <fstream>
  13
  14 #include <simgear/sg_inlines.h>
  15 #include <simgear/debug/logstream.hxx>
  16 #include <simgear/math/sg_random.h>
  17 #include <simgear/scene/material/mat.hxx>
  18 #include <simgear/scene/material/matlib.hxx>
  19 #include <simgear/structure/exception.hxx>
  20 #include <simgear/structure/commands.hxx>
  21 #include <simgear/props/props.hxx>
  22 #include <simgear/structure/event_mgr.hxx>
  23 #include <simgear/sound/soundmgr_openal.hxx>
  24 #include <simgear/timing/sg_time.hxx>
  25
  26 #include <Cockpit/panel.hxx>
  27 #include <Cockpit/panel_io.hxx>
  28 #include <FDM/flight.hxx>
  29 #include <GUI/gui.h>
  30 #include <GUI/new_gui.hxx>
  31 #include <GUI/dialog.hxx>
  32 #include <Aircraft/replay.hxx>
  33 #include <Scenery/scenery.hxx>
  34 #include <Scripting/NasalSys.hxx>
  35 #include <Sound/sample_queue.hxx>
  36 #include <Time/sunsolver.hxx>
  37
  38 #include "fg_init.hxx"
  39 #include "fg_io.hxx"
  40 #include "fg_os.hxx"
  41 #include "fg_commands.hxx"
  42 #include "fg_props.hxx"
  43 #include "globals.hxx"
  44 #include "logger.hxx"
  45 #include "util.hxx"
  46 #include "viewmgr.hxx"
  47 #include "main.hxx"
  48 #include <Main/viewer.hxx>
  49 #include <Environment/presets.hxx>
  50
  51 using std::string;
  52 using std::ifstream;
  53 using std::ofstream;
  54
  55
  56 \f
  57 ////////////////////////////////////////////////////////////////////////
  58 // Static helper functions.
  59 ////////////////////////////////////////////////////////////////////////
  60
  61
  62 static inline SGPropertyNode *
  63 get_prop (const SGPropertyNode * arg)
  64 {
  65     return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
  66 }
  67
  68 static inline SGPropertyNode *
  69 get_prop2 (const SGPropertyNode * arg)
  70 {
  71     return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
  72 }
  73
  74
  75 /**
  76  * Get a double value and split it as required.
  77  */
  78 static void
  79 split_value (double full_value, const char * mask,
  80              double * unmodifiable, double * modifiable)
  81 {
  82     if (!strcmp("integer", mask)) {
  83         *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
  84         *unmodifiable = full_value - *modifiable;
  85     } else if (!strcmp("decimal", mask)) {
  86         *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
  87         *modifiable = full_value - *unmodifiable;
  88     } else {
  89         if (strcmp("all", mask))
  90             SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
  91                    << " assuming 'all'");
  92         *unmodifiable = 0;
  93         *modifiable = full_value;
  94     }
  95 }
  96
  97
  98 /**
  99  * Clamp or wrap a value as specified.
 100  */
 101 static void
 102 limit_value (double * value, const SGPropertyNode * arg)
 103 {
 104     const SGPropertyNode * min_node = arg->getChild("min");
 105     const SGPropertyNode * max_node = arg->getChild("max");
 106
 107     bool wrap = arg->getBoolValue("wrap");
 108
 109     if (min_node == 0 || max_node == 0)
 110         wrap = false;
 111
 112     if (wrap) {                 // wrap such that min <= x < max
 113         double min_val = min_node->getDoubleValue();
 114         double max_val = max_node->getDoubleValue();
 115         double resolution = arg->getDoubleValue("resolution");
 116         if (resolution > 0.0) {
 117             // snap to (min + N*resolution), taking special care to handle imprecision
 118             int n = (int)floor((*value - min_val) / resolution + 0.5);
 119             int steps = (int)floor((max_val - min_val) / resolution + 0.5);
 120             SG_NORMALIZE_RANGE(n, 0, steps);
 121             *value = min_val + resolution * n;
 122         } else {
 123             // plain circular wrapping
 124             SG_NORMALIZE_RANGE(*value, min_val, max_val);
 125         }
 126     } else {                    // clamp such that min <= x <= max
 127         if ((min_node != 0) && (*value < min_node->getDoubleValue()))
 128             *value = min_node->getDoubleValue();
 129         else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
 130             *value = max_node->getDoubleValue();
 131     }
 132 }
 133
 134 static bool
 135 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
 136 {
 137     switch (value1->getType()) {
 138     case simgear::props::BOOL:
 139         return (value1->getBoolValue() == value2->getBoolValue());
 140     case simgear::props::INT:
 141         return (value1->getIntValue() == value2->getIntValue());
 142     case simgear::props::LONG:
 143         return (value1->getLongValue() == value2->getLongValue());
 144     case simgear::props::FLOAT:
 145         return (value1->getFloatValue() == value2->getFloatValue());
 146     case simgear::props::DOUBLE:
 147         return (value1->getDoubleValue() == value2->getDoubleValue());
 148     default:
 149         return !strcmp(value1->getStringValue(), value2->getStringValue());
 150     }
 151 }
 152
 153
 154 \f
 155 ////////////////////////////////////////////////////////////////////////
 156 // Command implementations.
 157 ////////////////////////////////////////////////////////////////////////
 158
 159
 160 /**
 161  * Built-in command: do nothing.
 162  */
 163 static bool
 164 do_null (const SGPropertyNode * arg)
 165 {
 166   return true;
 167 }
 168
 169 /**
 170  * Built-in command: run a Nasal script.
 171  */
 172 static bool
 173 do_nasal (const SGPropertyNode * arg)
 174 {
 175     return ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(arg);
 176 }
 177
 178 /**
 179  * Built-in command: exit FlightGear.
 180  *
 181  * status: the exit status to return to the operating system (defaults to 0)
 182  */
 183 static bool
 184 do_exit (const SGPropertyNode * arg)
 185 {
 186     SG_LOG(SG_INPUT, SG_INFO, "Program exit requested.");
 187     fgSetBool("/sim/signals/exit", true);
 188
 189     if (fgGetBool("/sim/startup/save-on-exit")) {
 190 #ifdef _WIN32
 191         char* envp = ::getenv( "APPDATA" );
 192         if ( envp != NULL ) {
 193             SGPath config( envp );
 194             config.append( "flightgear.org" );
 195 #else
 196         if ( homedir != NULL ) {
 197             SGPath config( homedir );
 198             config.append( ".fgfs" );
 199 #endif
 200             config.append( "autosave.xml" );
 201             config.create_dir( 0700 );
 202             SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << config.str());
 203             try {
 204                 writeProperties(config.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
 205             } catch (const sg_exception &e) {
 206                 guiErrorMessage("Error writing autosave.xml: ", e);
 207             }
 208
 209             SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
 210         }
 211     }
 212
 213     fgOSExit(arg->getIntValue("status", 0));
 214     return true;
 215 }
 216
 217
 218 /**
 219  * Reset FlightGear (Shift-Escape or Menu->File->Reset)
 220  */
 221 static bool
 222 do_reset (const SGPropertyNode * arg)
 223 {
 224     fgReInitSubsystems();
 225     return true;
 226 }
 227
 228
 229 /**
 230  * Built-in command: reinitialize one or more subsystems.
 231  *
 232  * subsystem[*]: the name(s) of the subsystem(s) to reinitialize; if
 233  * none is specified, reinitialize all of them.
 234  */
 235 static bool
 236 do_reinit (const SGPropertyNode * arg)
 237 {
 238     bool result = true;
 239
 240     vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
 241     if (subsystems.size() == 0) {
 242         globals->get_subsystem_mgr()->reinit();
 243     } else {
 244         for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
 245             const char * name = subsystems[i]->getStringValue();
 246             SGSubsystem * subsystem = globals->get_subsystem(name);
 247             if (subsystem == 0) {
 248                 result = false;
 249                 SG_LOG( SG_GENERAL, SG_ALERT,
 250                         "Subsystem " << name << " not found" );
 251             } else {
 252                 subsystem->reinit();
 253             }
 254         }
 255     }
 256
 257     globals->get_event_mgr()->reinit();
 258
 259     return result;
 260 }
 261
 262 #if 0
 263   //
 264   // these routines look useful ??? but are never used in the code ???
 265   //
 266
 267 /**
 268  * Built-in command: suspend one or more subsystems.
 269  *
 270  * subsystem[*] - the name(s) of the subsystem(s) to suspend.
 271  */
 272 static bool
 273 do_suspend (const SGPropertyNode * arg)
 274 {
 275     bool result = true;
 276
 277     vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
 278     for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
 279         const char * name = subsystems[i]->getStringValue();
 280         SGSubsystem * subsystem = globals->get_subsystem(name);
 281         if (subsystem == 0) {
 282             result = false;
 283             SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << " not found");
 284         } else {
 285             subsystem->suspend();
 286         }
 287     }
 288     return result;
 289 }
 290
 291 /**
 292  * Built-in command: suspend one or more subsystems.
 293  *
 294  * subsystem[*] - the name(s) of the subsystem(s) to suspend.
 295  */
 296 static bool
 297 do_resume (const SGPropertyNode * arg)
 298 {
 299     bool result = true;
 300
 301     vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
 302     for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
 303         const char * name = subsystems[i]->getStringValue();
 304         SGSubsystem * subsystem = globals->get_subsystem(name);
 305         if (subsystem == 0) {
 306             result = false;
 307             SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << " not found");
 308         } else {
 309             subsystem->resume();
 310         }
 311     }
 312     return result;
 313 }
 314
 315 #endif
 316
 317 static bool
 318 do_pause (const SGPropertyNode * arg)
 319 {
 320     bool paused = fgGetBool("/sim/freeze/master",true) || fgGetBool("/sim/freeze/clock",true);
 321     fgSetBool("/sim/freeze/master",!paused);
 322     fgSetBool("/sim/freeze/clock",!paused);
 323     if (fgGetBool("/sim/freeze/replay-state",false))
 324         fgSetBool("/sim/replay/disable",true);
 325     return true;
 326 }
 327
 328 /**
 329  * Built-in command: load flight.
 330  *
 331  * file (optional): the name of the file to load (relative to current
 332  *   directory).  Defaults to "fgfs.sav"
 333  */
 334 static bool
 335 do_load (const SGPropertyNode * arg)
 336 {
 337     string file = arg->getStringValue("file", "fgfs.sav");
 338     if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
 339         file += ".sav";
 340
 341     if (!fgValidatePath(file.c_str(), false)) {
 342         SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
 343                 "(unauthorized access)");
 344         return false;
 345     }
 346
 347     ifstream input(file.c_str());
 348     if (input.good() && fgLoadFlight(input)) {
 349         input.close();
 350         SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
 351         return true;
 352     } else {
 353         SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
 354         return false;
 355     }
 356 }
 357
 358
 359 /**
 360  * Built-in command: save flight.
 361  *
 362  * file (optional): the name of the file to save (relative to the
 363  * current directory).  Defaults to "fgfs.sav".
 364  */
 365 static bool
 366 do_save (const SGPropertyNode * arg)
 367 {
 368     string file = arg->getStringValue("file", "fgfs.sav");
 369     if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
 370         file += ".sav";
 371
 372     if (!fgValidatePath(file.c_str(), false)) {
 373         SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
 374                 "(unauthorized access)");
 375         return false;
 376     }
 377
 378     bool write_all = arg->getBoolValue("write-all", false);
 379     SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
 380     ofstream output(file.c_str());
 381     if (output.good() && fgSaveFlight(output, write_all)) {
 382         output.close();
 383         SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
 384         return true;
 385     } else {
 386         SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
 387         return false;
 388     }
 389 }
 390
 391
 392 /**
 393  * Built-in command: (re)load the panel.
 394  *
 395  * path (optional): the file name to load the panel from
 396  * (relative to FG_ROOT).  Defaults to the value of /sim/panel/path,
 397  * and if that's unspecified, to "Panels/Default/default.xml".
 398  */
 399 static bool
 400 do_panel_load (const SGPropertyNode * arg)
 401 {
 402   string panel_path =
 403     arg->getStringValue("path", fgGetString("/sim/panel/path"));
 404   if (panel_path.empty()) {
 405     return false;
 406   }
 407
 408   FGPanel * new_panel = fgReadPanel(panel_path);
 409   if (new_panel == 0) {
 410     SG_LOG(SG_INPUT, SG_ALERT,
 411            "Error reading new panel from " << panel_path);
 412     return false;
 413   }
 414   SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
 415   globals->get_current_panel()->unbind();
 416   delete globals->get_current_panel();
 417   globals->set_current_panel( new_panel );
 418   globals->get_current_panel()->bind();
 419   return true;
 420 }
 421
 422
 423 /**
 424  * Built-in command: pass a mouse click to the panel.
 425  *
 426  * button: the mouse button number, zero-based.
 427  * is-down: true if the button is down, false if it is up.
 428  * x-pos: the x position of the mouse click.
 429  * y-pos: the y position of the mouse click.
 430  */
 431 static bool
 432 do_panel_mouse_click (const SGPropertyNode * arg)
 433 {
 434   if (globals->get_current_panel() != 0)
 435     return globals->get_current_panel()
 436       ->doMouseAction(arg->getIntValue("button"),
 437                       arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
 438                       arg->getIntValue("x-pos"),
 439                       arg->getIntValue("y-pos"));
 440   else
 441     return false;
 442 }
 443
 444
 445 /**
 446  * Built-in command: (re)load preferences.
 447  *
 448  * path (optional): the file name to load the panel from (relative
 449  * to FG_ROOT). Defaults to "preferences.xml".
 450  */
 451 static bool
 452 do_preferences_load (const SGPropertyNode * arg)
 453 {
 454   try {
 455     fgLoadProps(arg->getStringValue("path", "preferences.xml"),
 456                 globals->get_props());
 457   } catch (const sg_exception &e) {
 458     guiErrorMessage("Error reading global preferences: ", e);
 459     return false;
 460   }
 461   SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
 462   return true;
 463 }
 464
 465 static void
 466 do_view_next( bool )
 467 {
 468     globals->get_current_view()->setHeadingOffset_deg(0.0);
 469     globals->get_viewmgr()->next_view();
 470 }
 471
 472 static void
 473 do_view_prev( bool )
 474 {
 475     globals->get_current_view()->setHeadingOffset_deg(0.0);
 476     globals->get_viewmgr()->prev_view();
 477 }
 478
 479 /**
 480  * Built-in command: cycle view.
 481  */
 482 static bool
 483 do_view_cycle (const SGPropertyNode * arg)
 484 {
 485   globals->get_current_view()->setHeadingOffset_deg(0.0);
 486   globals->get_viewmgr()->next_view();
 487   return true;
 488 }
 489
 490 /**
 491  * Built-in command: capture screen.
 492  */
 493 static bool
 494 do_screen_capture (const SGPropertyNode * arg)
 495 {
 496   return fgDumpSnapShot();
 497 }
 498
 499 static bool
 500 do_reload_shaders (const SGPropertyNode*)
 501 {
 502     simgear::reload_shaders();
 503     return true;
 504 }
 505
 506 static bool
 507 do_dump_scene_graph (const SGPropertyNode*)
 508 {
 509     fgDumpSceneGraph();
 510     return true;
 511 }
 512
 513 static bool
 514 do_dump_terrain_branch (const SGPropertyNode*)
 515 {
 516     fgDumpTerrainBranch();
 517
 518     double lon_deg = fgGetDouble("/position/longitude-deg");
 519     double lat_deg = fgGetDouble("/position/latitude-deg");
 520     SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
 521     SGVec3d zero = SGVec3d::fromGeod(geodPos);
 522
 523     SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
 524     SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
 525     SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
 526
 527     return true;
 528 }
 529
 530 static bool
 531 do_print_visible_scene_info(const SGPropertyNode*)
 532 {
 533     fgPrintVisibleSceneInfoCommand();
 534     return true;
 535 }
 536
 537 /**
 538  * Built-in command: hires capture screen.
 539  */
 540 static bool
 541 do_hires_screen_capture (const SGPropertyNode * arg)
 542 {
 543   fgHiResDump();
 544   return true;
 545 }
 546
 547
 548 /**
 549  * Reload the tile cache.
 550  */
 551 static bool
 552 do_tile_cache_reload (const SGPropertyNode * arg)
 553 {
 554     static const SGPropertyNode *master_freeze
 555         = fgGetNode("/sim/freeze/master");
 556     bool freeze = master_freeze->getBoolValue();
 557     SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
 558     if ( !freeze ) {
 559         fgSetBool("/sim/freeze/master", true);
 560     }
 561
 562     globals->get_subsystem("tile-manager")->reinit();
 563
 564     if ( !freeze ) {
 565         fgSetBool("/sim/freeze/master", false);
 566     }
 567     return true;
 568 }
 569
 570
 571 #if 0
 572 These do_set_(some-environment-parameters) are deprecated and no longer
 573 useful/functional - Torsten Dreyer, January 2011
 574 /**
 575  * Set the sea level outside air temperature and assigning that to all
 576  * boundary and aloft environment layers.
 577  */
 578 static bool
 579 do_set_sea_level_degc ( double temp_sea_level_degc)
 580 {
 581     SGPropertyNode *node, *child;
 582
 583     // boundary layers
 584     node = fgGetNode( "/environment/config/boundary" );
 585     if ( node != NULL ) {
 586       int i = 0;
 587       while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
 588         child->setDoubleValue( "temperature-sea-level-degc",
 589                                temp_sea_level_degc );
 590         ++i;
 591       }
 592     }
 593
 594     // aloft layers
 595     node = fgGetNode( "/environment/config/aloft" );
 596     if ( node != NULL ) {
 597       int i = 0;
 598       while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
 599         child->setDoubleValue( "temperature-sea-level-degc",
 600                                temp_sea_level_degc );
 601         ++i;
 602       }
 603     }
 604
 605     return true;
 606 }
 607
 608 static bool
 609 do_set_sea_level_degc (const SGPropertyNode * arg)
 610 {
 611     return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
 612 }
 613
 614
 615 /**
 616  * Set the outside air temperature at the "current" altitude by first
 617  * calculating the corresponding sea level temp, and assigning that to
 618  * all boundary and aloft environment layers.
 619  */
 620 static bool
 621 do_set_oat_degc (const SGPropertyNode * arg)
 622 {
 623     double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
 624     // check for an altitude specified in the arguments, otherwise use
 625     // current aircraft altitude.
 626     const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
 627     if ( altitude_ft == NULL ) {
 628         altitude_ft = fgGetNode("/position/altitude-ft");
 629     }
 630
 631     FGEnvironment dummy;        // instantiate a dummy so we can leech a method
 632     dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
 633     dummy.set_temperature_degc( oat_degc );
 634     return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
 635 }
 636
 637 /**
 638  * Set the sea level outside air dewpoint and assigning that to all
 639  * boundary and aloft environment layers.
 640  */
 641 static bool
 642 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
 643 {
 644
 645     SGPropertyNode *node, *child;
 646
 647     // boundary layers
 648     node = fgGetNode( "/environment/config/boundary" );
 649     if ( node != NULL ) {
 650       int i = 0;
 651       while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
 652         child->setDoubleValue( "dewpoint-sea-level-degc",
 653                                dewpoint_sea_level_degc );
 654         ++i;
 655       }
 656     }
 657
 658     // aloft layers
 659     node = fgGetNode( "/environment/config/aloft" );
 660     if ( node != NULL ) {
 661       int i = 0;
 662       while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
 663         child->setDoubleValue( "dewpoint-sea-level-degc",
 664                                dewpoint_sea_level_degc );
 665         ++i;
 666       }
 667     }
 668
 669     return true;
 670 }
 671
 672 static bool
 673 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
 674 {
 675     return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
 676 }
 677
 678 /**
 679  * Set the outside air dewpoint at the "current" altitude by first
 680  * calculating the corresponding sea level dewpoint, and assigning
 681  * that to all boundary and aloft environment layers.
 682  */
 683 static bool
 684 do_set_dewpoint_degc (const SGPropertyNode * arg)
 685 {
 686     double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
 687
 688     // check for an altitude specified in the arguments, otherwise use
 689     // current aircraft altitude.
 690     const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
 691     if ( altitude_ft == NULL ) {
 692         altitude_ft = fgGetNode("/position/altitude-ft");
 693     }
 694
 695     FGEnvironment dummy;        // instantiate a dummy so we can leech a method
 696     dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
 697     dummy.set_dewpoint_degc( dewpoint_degc );
 698     return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
 699 }
 700 #endif
 701 /**
 702  * Update the lighting manually.
 703  */
 704 static bool
 705 do_timeofday (const SGPropertyNode * arg)
 706 {
 707     const string &offset_type = arg->getStringValue("timeofday", "noon");
 708
 709     static const SGPropertyNode *longitude
 710         = fgGetNode("/position/longitude-deg");
 711     static const SGPropertyNode *latitude
 712         = fgGetNode("/position/latitude-deg");
 713
 714     int orig_warp = globals->get_warp();
 715     SGTime *t = globals->get_time_params();
 716     time_t cur_time = t->get_cur_time();
 717     // cout << "cur_time = " << cur_time << endl;
 718     // cout << "orig_warp = " << orig_warp << endl;
 719
 720     int warp = 0;
 721     if ( offset_type == "real" ) {
 722         warp = -orig_warp;
 723     } else if ( offset_type == "dawn" ) {
 724         warp = fgTimeSecondsUntilSunAngle( cur_time,
 725                                            longitude->getDoubleValue()
 726                                              * SGD_DEGREES_TO_RADIANS,
 727                                            latitude->getDoubleValue()
 728                                              * SGD_DEGREES_TO_RADIANS,
 729                                            90.0, true );
 730     } else if ( offset_type == "morning" ) {
 731         warp = fgTimeSecondsUntilSunAngle( cur_time,
 732                                            longitude->getDoubleValue()
 733                                              * SGD_DEGREES_TO_RADIANS,
 734                                            latitude->getDoubleValue()
 735                                              * SGD_DEGREES_TO_RADIANS,
 736                                            75.0, true );
 737     } else if ( offset_type == "noon" ) {
 738         warp = fgTimeSecondsUntilSunAngle( cur_time,
 739                                            longitude->getDoubleValue()
 740                                              * SGD_DEGREES_TO_RADIANS,
 741                                            latitude->getDoubleValue()
 742                                              * SGD_DEGREES_TO_RADIANS,
 743                                            0.0, true );
 744     } else if ( offset_type == "afternoon" ) {
 745         warp = fgTimeSecondsUntilSunAngle( cur_time,
 746                                            longitude->getDoubleValue()
 747                                              * SGD_DEGREES_TO_RADIANS,
 748                                            latitude->getDoubleValue()
 749                                              * SGD_DEGREES_TO_RADIANS,
 750                                            60.0, false );
 751      } else if ( offset_type == "dusk" ) {
 752         warp = fgTimeSecondsUntilSunAngle( cur_time,
 753                                            longitude->getDoubleValue()
 754                                              * SGD_DEGREES_TO_RADIANS,
 755                                            latitude->getDoubleValue()
 756                                              * SGD_DEGREES_TO_RADIANS,
 757                                            90.0, false );
 758      } else if ( offset_type == "evening" ) {
 759         warp = fgTimeSecondsUntilSunAngle( cur_time,
 760                                            longitude->getDoubleValue()
 761                                              * SGD_DEGREES_TO_RADIANS,
 762                                            latitude->getDoubleValue()
 763                                              * SGD_DEGREES_TO_RADIANS,
 764                                            100.0, false );
 765     } else if ( offset_type == "midnight" ) {
 766         warp = fgTimeSecondsUntilSunAngle( cur_time,
 767                                            longitude->getDoubleValue()
 768                                              * SGD_DEGREES_TO_RADIANS,
 769                                            latitude->getDoubleValue()
 770                                              * SGD_DEGREES_TO_RADIANS,
 771                                            180.0, false );
 772     }
 773
 774
 775     fgSetInt("/sim/time/warp", orig_warp + warp);
 776
 777     return true;
 778 }
 779
 780
 781 /**
 782  * Built-in command: toggle a bool property value.
 783  *
 784  * property: The name of the property to toggle.
 785  */
 786 static bool
 787 do_property_toggle (const SGPropertyNode * arg)
 788 {
 789   SGPropertyNode * prop = get_prop(arg);
 790   return prop->setBoolValue(!prop->getBoolValue());
 791 }
 792
 793
 794 /**
 795  * Built-in command: assign a value to a property.
 796  *
 797  * property: the name of the property to assign.
 798  * value: the value to assign; or
 799  * property[1]: the property to copy from.
 800  */
 801 static bool
 802 do_property_assign (const SGPropertyNode * arg)
 803 {
 804   SGPropertyNode * prop = get_prop(arg);
 805   const SGPropertyNode * prop2 = get_prop2(arg);
 806   const SGPropertyNode * value = arg->getNode("value");
 807
 808   if (value != 0)
 809       return prop->setUnspecifiedValue(value->getStringValue());
 810   else if (prop2)
 811       return prop->setUnspecifiedValue(prop2->getStringValue());
 812   else
 813       return false;
 814 }
 815
 816
 817 /**
 818  * Built-in command: increment or decrement a property value.
 819  *
 820  * If the 'step' argument is present, it will be used; otherwise,
 821  * the command uses 'offset' and 'factor', usually from the mouse.
 822  *
 823  * property: the name of the property to increment or decrement.
 824  * step: the amount of the increment or decrement (default: 0).
 825  * offset: offset from the current setting (used for the mouse; multiplied
 826  *         by factor)
 827  * factor: scaling amount for the offset (defaults to 1).
 828  * min: the minimum allowed value (default: no minimum).
 829  * max: the maximum allowed value (default: no maximum).
 830  * mask: 'integer' to apply only to the left of the decimal point,
 831  *       'decimal' to apply only to the right of the decimal point,
 832  *       or 'all' to apply to the whole number (the default).
 833  * wrap: true if the value should be wrapped when it passes min or max;
 834  *       both min and max must be present for this to work (default:
 835  *       false).
 836  */
 837 static bool
 838 do_property_adjust (const SGPropertyNode * arg)
 839 {
 840   SGPropertyNode * prop = get_prop(arg);
 841
 842   double amount = 0;
 843   if (arg->hasValue("step"))
 844       amount = arg->getDoubleValue("step");
 845   else
 846       amount = (arg->getDoubleValue("factor", 1)
 847                 * arg->getDoubleValue("offset"));
 848
 849   double unmodifiable, modifiable;
 850   split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
 851               &unmodifiable, &modifiable);
 852   modifiable += amount;
 853   limit_value(&modifiable, arg);
 854
 855   prop->setDoubleValue(unmodifiable + modifiable);
 856
 857   return true;
 858 }
 859
 860
 861 /**
 862  * Built-in command: multiply a property value.
 863  *
 864  * property: the name of the property to multiply.
 865  * factor: the amount by which to multiply.
 866  * min: the minimum allowed value (default: no minimum).
 867  * max: the maximum allowed value (default: no maximum).
 868  * mask: 'integer' to apply only to the left of the decimal point,
 869  *       'decimal' to apply only to the right of the decimal point,
 870  *       or 'all' to apply to the whole number (the default).
 871  * wrap: true if the value should be wrapped when it passes min or max;
 872  *       both min and max must be present for this to work (default:
 873  *       false).
 874  */
 875 static bool
 876 do_property_multiply (const SGPropertyNode * arg)
 877 {
 878   SGPropertyNode * prop = get_prop(arg);
 879   double factor = arg->getDoubleValue("factor", 1);
 880
 881   double unmodifiable, modifiable;
 882   split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
 883               &unmodifiable, &modifiable);
 884   modifiable *= factor;
 885   limit_value(&modifiable, arg);
 886
 887   prop->setDoubleValue(unmodifiable + modifiable);
 888
 889   return true;
 890 }
 891
 892
 893 /**
 894  * Built-in command: swap two property values.
 895  *
 896  * property[0]: the name of the first property.
 897  * property[1]: the name of the second property.
 898  */
 899 static bool
 900 do_property_swap (const SGPropertyNode * arg)
 901 {
 902   SGPropertyNode * prop1 = get_prop(arg);
 903   SGPropertyNode * prop2 = get_prop2(arg);
 904
 905                                 // FIXME: inefficient
 906   const string & tmp = prop1->getStringValue();
 907   return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
 908           prop2->setUnspecifiedValue(tmp.c_str()));
 909 }
 910
 911
 912 /**
 913  * Built-in command: Set a property to an axis or other moving input.
 914  *
 915  * property: the name of the property to set.
 916  * setting: the current input setting, usually between -1.0 and 1.0.
 917  * offset: the offset to shift by, before applying the factor.
 918  * factor: the factor to multiply by (use negative to reverse).
 919  */
 920 static bool
 921 do_property_scale (const SGPropertyNode * arg)
 922 {
 923   SGPropertyNode * prop = get_prop(arg);
 924   double setting = arg->getDoubleValue("setting");
 925   double offset = arg->getDoubleValue("offset", 0.0);
 926   double factor = arg->getDoubleValue("factor", 1.0);
 927   bool squared = arg->getBoolValue("squared", false);
 928   int power = arg->getIntValue("power", (squared ? 2 : 1));
 929
 930   int sign = (setting < 0 ? -1 : 1);
 931
 932   switch (power) {
 933   case 1:
 934       break;
 935   case 2:
 936       setting = setting * setting * sign;
 937       break;
 938   case 3:
 939       setting = setting * setting * setting;
 940       break;
 941   case 4:
 942       setting = setting * setting * setting * setting * sign;
 943       break;
 944   default:
 945       setting =  pow(setting, power);
 946       if ((power % 2) == 0)
 947           setting *= sign;
 948       break;
 949   }
 950
 951   return prop->setDoubleValue((setting + offset) * factor);
 952 }
 953
 954
 955 /**
 956  * Built-in command: cycle a property through a set of values.
 957  *
 958  * If the current value isn't in the list, the cycle will
 959  * (re)start from the beginning.
 960  *
 961  * property: the name of the property to cycle.
 962  * value[*]: the list of values to cycle through.
 963  */
 964 static bool
 965 do_property_cycle (const SGPropertyNode * arg)
 966 {
 967     SGPropertyNode * prop = get_prop(arg);
 968     vector<SGPropertyNode_ptr> values = arg->getChildren("value");
 969     int selection = -1;
 970     int nSelections = values.size();
 971
 972     if (nSelections < 1) {
 973         SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
 974         return false;
 975     }
 976
 977                                 // Try to find the current selection
 978     for (int i = 0; i < nSelections; i++) {
 979         if (compare_values(prop, values[i])) {
 980             selection = i + 1;
 981             break;
 982         }
 983     }
 984
 985                                 // Default or wrap to the first selection
 986     if (selection < 0 || selection >= nSelections)
 987         selection = 0;
 988
 989     prop->setUnspecifiedValue(values[selection]->getStringValue());
 990     return true;
 991 }
 992
 993
 994 /**
 995  * Built-in command: randomize a numeric property value.
 996  *
 997  * property: the name of the property value to randomize.
 998  * min: the minimum allowed value.
 999  * max: the maximum allowed value.
1000  */
1001 static bool
1002 do_property_randomize (const SGPropertyNode * arg)
1003 {
1004     SGPropertyNode * prop = get_prop(arg);
1005     double min = arg->getDoubleValue("min", DBL_MIN);
1006     double max = arg->getDoubleValue("max", DBL_MAX);
1007     prop->setDoubleValue(sg_random() * (max - min) + min);
1008     return true;
1009 }
1010
1011
1012 /**
1013  * Built-in command: reinit the data logging system based on the
1014  * current contents of the /logger tree.
1015  */
1016 static bool
1017 do_data_logging_commit (const SGPropertyNode * arg)
1018 {
1019     FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
1020     log->reinit();
1021     return true;
1022 }
1023
1024 /**
1025  * Built-in command: Add a dialog to the GUI system.  Does *not*
1026  * display the dialog.  The property node should have the same format
1027  * as a dialog XML configuration.  It must include:
1028  *
1029  * name: the name of the GUI dialog for future reference.
1030  */
1031 static bool
1032 do_dialog_new (const SGPropertyNode * arg)
1033 {
1034     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1035
1036     // Note the casting away of const: this is *real*.  Doing a
1037     // "dialog-apply" command later on will mutate this property node.
1038     // I'm not convinced that this isn't the Right Thing though; it
1039     // allows client to create a node, pass it to dialog-new, and get
1040     // the values back from the dialog by reading the same node.
1041     // Perhaps command arguments are not as "const" as they would
1042     // seem?
1043     gui->newDialog((SGPropertyNode*)arg);
1044     return true;
1045 }
1046
1047 /**
1048  * Built-in command: Show an XML-configured dialog.
1049  *
1050  * dialog-name: the name of the GUI dialog to display.
1051  */
1052 static bool
1053 do_dialog_show (const SGPropertyNode * arg)
1054 {
1055     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1056     gui->showDialog(arg->getStringValue("dialog-name"));
1057     return true;
1058 }
1059
1060
1061 /**
1062  * Built-in Command: Hide the active XML-configured dialog.
1063  */
1064 static bool
1065 do_dialog_close (const SGPropertyNode * arg)
1066 {
1067     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1068     if(arg->hasValue("dialog-name"))
1069         return gui->closeDialog(arg->getStringValue("dialog-name"));
1070     return gui->closeActiveDialog();
1071 }
1072
1073
1074 /**
1075  * Update a value in the active XML-configured dialog.
1076  *
1077  * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1078  */
1079 static bool
1080 do_dialog_update (const SGPropertyNode * arg)
1081 {
1082     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1083     FGDialog * dialog;
1084     if (arg->hasValue("dialog-name"))
1085         dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1086     else
1087         dialog = gui->getActiveDialog();
1088
1089     if (dialog != 0) {
1090         dialog->updateValues(arg->getStringValue("object-name"));
1091         return true;
1092     } else {
1093         return false;
1094     }
1095 }
1096
1097
1098 /**
1099  * Apply a value in the active XML-configured dialog.
1100  *
1101  * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1102  */
1103 static bool
1104 do_dialog_apply (const SGPropertyNode * arg)
1105 {
1106     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1107     FGDialog * dialog;
1108     if (arg->hasValue("dialog-name"))
1109         dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1110     else
1111         dialog = gui->getActiveDialog();
1112
1113     if (dialog != 0) {
1114         dialog->applyValues(arg->getStringValue("object-name"));
1115         return true;
1116     } else {
1117         return false;
1118     }
1119 }
1120
1121
1122 /**
1123  * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1124  * unlike reinit().
1125  */
1126 static bool
1127 do_gui_redraw (const SGPropertyNode * arg)
1128 {
1129     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1130     gui->redraw();
1131     return true;
1132 }
1133
1134
1135 /**
1136  * Adds model to the scenery. The path to the added branch (/models/model[*])
1137  * is returned in property "property".
1138  */
1139 static bool
1140 do_add_model (const SGPropertyNode * arg)
1141 {
1142     SGPropertyNode * model = fgGetNode("models", true);
1143     for (int i = 0;; i++) {
1144         if (i < 0)
1145             return false;
1146         if (!model->getChild("model", i, false)) {
1147             model = model->getChild("model", i, true);
1148             break;
1149         }
1150     }
1151     copyProperties(arg, model);
1152     if (model->hasValue("elevation-m"))
1153         model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1154                 * SG_METER_TO_FEET);
1155     model->getNode("load", true);
1156     model->removeChildren("load");
1157     const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1158     return true;
1159 }
1160
1161
1162 /**
1163  * Set mouse cursor coordinates and cursor shape.
1164  */
1165 static bool
1166 do_set_cursor (const SGPropertyNode * arg)
1167 {
1168     if (arg->hasValue("x") || arg->hasValue("y")) {
1169         SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1170         SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1171         int x = arg->getIntValue("x", mx->getIntValue());
1172         int y = arg->getIntValue("y", my->getIntValue());
1173         fgWarpMouse(x, y);
1174         mx->setIntValue(x);
1175         my->setIntValue(y);
1176     }
1177
1178     SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1179     if (cursor->getType() != simgear::props::NONE)
1180         fgSetMouseCursor(cursor->getIntValue());
1181
1182     cursor->setIntValue(fgGetMouseCursor());
1183     return true;
1184 }
1185
1186
1187 /**
1188  * Built-in command: play an audio message (i.e. a wav file) This is
1189  * fire and forget.  Call this once per message and it will get dumped
1190  * into a queue.  Messages are played sequentially so they do not
1191  * overlap.
1192  */
1193 static bool
1194 do_play_audio_sample (const SGPropertyNode * arg)
1195 {
1196     string path = arg->getStringValue("path");
1197     string file = arg->getStringValue("file");
1198     float volume = arg->getFloatValue("volume");
1199     // cout << "playing " << path << " / " << file << endl;
1200     try {
1201         static FGSampleQueue *queue = 0;
1202         if ( !queue ) {
1203            SGSoundMgr *smgr = globals->get_soundmgr();
1204            queue = new FGSampleQueue(smgr, "chatter");
1205            queue->tie_to_listener();
1206         }
1207
1208         SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1209         msg->set_volume( volume );
1210         queue->add( msg );
1211
1212         return true;
1213
1214     } catch (const sg_io_exception&) {
1215         SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1216                 "failed to load" << path << '/' << file);
1217         return false;
1218     }
1219 }
1220
1221 /**
1222  * Built-in command: commit presets (read from in /sim/presets/)
1223  */
1224 static bool
1225 do_presets_commit (const SGPropertyNode * arg)
1226 {
1227     if (fgGetBool("/sim/initialized", false)) {
1228       fgReInitSubsystems();
1229     } else {
1230       // Nasal can trigger this during initial init, which confuses
1231       // the logic in ReInitSubsystems, since initial state has not been
1232       // saved at that time. Short-circuit everything here.
1233       fgInitPosition();
1234     }
1235
1236     return true;
1237 }
1238
1239 /**
1240  * Built-in command: set log level (0 ... 7)
1241  */
1242 static bool
1243 do_log_level (const SGPropertyNode * arg)
1244 {
1245    sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1246
1247    return true;
1248 }
1249
1250 /**
1251  * Built-in command: replay the FDR buffer
1252  */
1253 static bool
1254 do_replay (const SGPropertyNode * arg)
1255 {
1256     // freeze the fdm, resume from sim pause
1257     fgSetInt( "/sim/freeze/replay-state", 1 );
1258     fgSetBool("/sim/freeze/master", 0 );
1259     fgSetBool("/sim/freeze/clock", 0 );
1260     fgSetDouble( "/sim/replay/time", -1 );
1261
1262     // cout << "start = " << r->get_start_time()
1263     //      << "  end = " << r->get_end_time() << endl;
1264
1265     return true;
1266 }
1267
1268 /*
1269 static bool
1270 do_decrease_visibility (const SGPropertyNode * arg)
1271 {
1272     Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1273     return true;
1274 }
1275
1276 static bool
1277 do_increase_visibility (const SGPropertyNode * arg)
1278 {
1279     Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1280     return true;
1281 }
1282 */
1283 /**
1284  * An fgcommand to allow loading of xml files via nasal,
1285  * the xml file's structure will be made available within
1286  * a property tree node defined under argument "targetnode",
1287  * or in the given argument tree under "data" otherwise.
1288  *
1289  * @param filename a string to hold the complete path & filename of an XML file
1290  * @param targetnode a string pointing to a location within the property tree
1291  * where to store the parsed XML file. If <targetnode> is undefined, then the
1292  * file contents are stored under a node <data> in the argument tree.
1293  */
1294
1295 static bool
1296 do_load_xml_to_proptree(const SGPropertyNode * arg)
1297 {
1298     SGPath file(arg->getStringValue("filename"));
1299     if (file.str().empty())
1300         return false;
1301
1302     if (file.extension() != "xml")
1303         file.concat(".xml");
1304
1305     if (file.isRelative()) {
1306       file = globals->resolve_maybe_aircraft_path(file.str());
1307     }
1308
1309     if (!fgValidatePath(file.c_str(), false)) {
1310         SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1311                 "(unauthorized access)");
1312         return false;
1313     }
1314
1315     SGPropertyNode *targetnode;
1316     if (arg->hasValue("targetnode"))
1317         targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1318     else
1319         targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1320
1321     try {
1322         readProperties(file.c_str(), targetnode, true);
1323     } catch (const sg_exception &e) {
1324         SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1325         return false;
1326     }
1327
1328     return true;
1329 }
1330
1331
1332 /**
1333  * An fgcommand to allow saving of xml files via nasal,
1334  * the file's structure will be determined based on what's
1335  * encountered in the passed (source) property tree node
1336  *
1337  * @param filename a string to hold the complete path & filename of the (new)
1338  * XML file
1339  * @param sourcenode a string pointing to a location within the property tree
1340  * where to find the nodes that should be written recursively into an XML file
1341  * @param data if no sourcenode is given, then the file contents are taken from
1342  * the argument tree's "data" node.
1343  */
1344
1345 static bool
1346 do_save_xml_from_proptree(const SGPropertyNode * arg)
1347 {
1348     SGPath file(arg->getStringValue("filename"));
1349     if (file.str().empty())
1350         return false;
1351
1352     if (file.extension() != "xml")
1353         file.concat(".xml");
1354
1355     if (!fgValidatePath(file.c_str(), true)) {
1356         SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1357                 "(unauthorized access)");
1358         return false;
1359     }
1360
1361     SGPropertyNode *sourcenode;
1362     if (arg->hasValue("sourcenode"))
1363         sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1364     else if (arg->getNode("data", false))
1365         sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1366     else
1367         return false;
1368
1369     try {
1370         writeProperties (file.c_str(), sourcenode, true);
1371     } catch (const sg_exception &e) {
1372         SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1373         return false;
1374     }
1375
1376     return true;
1377 }
1378
1379 static bool
1380 do_press_cockpit_button (const SGPropertyNode *arg)
1381 {
1382   const char *prefix = arg->getStringValue("prefix");
1383
1384   if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1385     return true;
1386
1387   string prop = string(prefix) + "-button";
1388   double value;
1389
1390   if (arg->getBoolValue("latching"))
1391     value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1392   else
1393     value = 1;
1394
1395   fgSetDouble(prop.c_str(), value);
1396   fgSetBool(arg->getStringValue("discrete"), value > 0);
1397
1398   return true;
1399 }
1400
1401 static bool
1402 do_release_cockpit_button (const SGPropertyNode *arg)
1403 {
1404   const char *prefix = arg->getStringValue("prefix");
1405
1406   if (arg->getBoolValue("guarded")) {
1407     string prop = string(prefix) + "-guard";
1408     if (fgGetDouble(prop.c_str()) < 1) {
1409       fgSetDouble(prop.c_str(), 1);
1410       return true;
1411     }
1412   }
1413
1414   if (! arg->getBoolValue("latching")) {
1415     fgSetDouble((string(prefix) + "-button").c_str(), 0);
1416     fgSetBool(arg->getStringValue("discrete"), false);
1417   }
1418
1419   return true;
1420 }
1421
1422
1423 ////////////////////////////////////////////////////////////////////////
1424 // Command setup.
1425 ////////////////////////////////////////////////////////////////////////
1426
1427
1428 /**
1429  * Table of built-in commands.
1430  *
1431  * New commands do not have to be added here; any module in the application
1432  * can add a new command using globals->get_commands()->addCommand(...).
1433  */
1434 static struct {
1435   const char * name;
1436   SGCommandMgr::command_t command;
1437 } built_ins [] = {
1438     { "null", do_null },
1439     { "nasal", do_nasal },
1440     { "exit", do_exit },
1441     { "reset", do_reset },
1442     { "reinit", do_reinit },
1443     { "suspend", do_reinit },
1444     { "resume", do_reinit },
1445     { "pause", do_pause },
1446     { "load", do_load },
1447     { "save", do_save },
1448     { "panel-load", do_panel_load },
1449     { "panel-mouse-click", do_panel_mouse_click },
1450     { "preferences-load", do_preferences_load },
1451     { "view-cycle", do_view_cycle },
1452     { "screen-capture", do_screen_capture },
1453     { "hires-screen-capture", do_hires_screen_capture },
1454     { "tile-cache-reload", do_tile_cache_reload },
1455     /*
1456     { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1457     { "set-outside-air-temp-degc", do_set_oat_degc },
1458     { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1459     { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1460     */
1461     { "timeofday", do_timeofday },
1462     { "property-toggle", do_property_toggle },
1463     { "property-assign", do_property_assign },
1464     { "property-adjust", do_property_adjust },
1465     { "property-multiply", do_property_multiply },
1466     { "property-swap", do_property_swap },
1467     { "property-scale", do_property_scale },
1468     { "property-cycle", do_property_cycle },
1469     { "property-randomize", do_property_randomize },
1470     { "data-logging-commit", do_data_logging_commit },
1471     { "dialog-new", do_dialog_new },
1472     { "dialog-show", do_dialog_show },
1473     { "dialog-close", do_dialog_close },
1474     { "dialog-update", do_dialog_update },
1475     { "dialog-apply", do_dialog_apply },
1476     { "gui-redraw", do_gui_redraw },
1477     { "add-model", do_add_model },
1478     { "set-cursor", do_set_cursor },
1479     { "play-audio-sample", do_play_audio_sample },
1480     { "presets-commit", do_presets_commit },
1481     { "log-level", do_log_level },
1482     { "replay", do_replay },
1483     /*
1484     { "decrease-visibility", do_decrease_visibility },
1485     { "increase-visibility", do_increase_visibility },
1486     */
1487     { "loadxml", do_load_xml_to_proptree},
1488     { "savexml", do_save_xml_from_proptree },
1489     { "press-cockpit-button", do_press_cockpit_button },
1490     { "release-cockpit-button", do_release_cockpit_button },
1491     { "dump-scenegraph", do_dump_scene_graph },
1492     { "dump-terrainbranch", do_dump_terrain_branch },
1493     { "print-visible-scene", do_print_visible_scene_info },
1494     { "reload-shaders", do_reload_shaders },
1495     { 0, 0 }                    // zero-terminated
1496 };
1497
1498
1499 /**
1500  * Initialize the default built-in commands.
1501  *
1502  * Other commands may be added by other parts of the application.
1503  */
1504 void
1505 fgInitCommands ()
1506 {
1507   SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1508   for (int i = 0; built_ins[i].name != 0; i++) {
1509     SG_LOG(SG_GENERAL, SG_BULK, "  " << built_ins[i].name);
1510     globals->get_commands()->addCommand(built_ins[i].name,
1511                                         built_ins[i].command);
1512   }
1513
1514   typedef bool (*dummy)();
1515   fgTie( "/command/view/next", dummy(0), do_view_next );
1516   fgTie( "/command/view/prev", dummy(0), do_view_prev );
1517 }
1518
1519 // end of fg_commands.cxx