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