src/Main/fg_commands.cxx

   1 // fg_commands.cxx - internal FGFS commands.
   2
   3 #include <string.h>             // strcmp()
   4
   5 #include <simgear/compiler.h>
   6 #include <simgear/misc/exception.hxx>
   7
   8 #include STL_STRING
   9 #include STL_FSTREAM
  10
  11 #include <simgear/debug/logstream.hxx>
  12 #include <simgear/misc/commands.hxx>
  13 #include <simgear/misc/props.hxx>
  14
  15 #include <GUI/gui.h>
  16 #include <Cockpit/panel.hxx>
  17 #include <Cockpit/panel_io.hxx>
  18 #include <Scenery/tilemgr.hxx>
  19 #include <Time/tmp.hxx>
  20
  21 #include "fg_commands.hxx"
  22
  23 SG_USING_STD(string);
  24 #if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
  25 SG_USING_STD(ifstream);
  26 SG_USING_STD(ofstream);
  27 #endif
  28
  29 #include "fg_props.hxx"
  30 #include "fg_io.hxx"
  31 #include "globals.hxx"
  32 #include "viewmgr.hxx"
  33
  34
  35 \f
  36 ////////////////////////////////////////////////////////////////////////
  37 // Saved command states.
  38 ////////////////////////////////////////////////////////////////////////
  39
  40
  41 /**
  42  * Base saved state for property commands.
  43  *
  44  * Since this class isn't publicly visible, it is simply an aggregate
  45  * of all the stuff any property command needs.
  46  */
  47 class PropertyCommandState : public SGCommandState
  48 {
  49 public:
  50   PropertyCommandState (const SGPropertyNode * arg);
  51   virtual SGPropertyNode * getProp () const { return _prop; }
  52   virtual SGPropertyNode * getProp2 () const { return _prop2; }
  53   virtual const SGPropertyNode * getValue () const
  54     { return _value ? _value : &_dummy_0; }
  55   virtual const bool hasStep () const { return _step != 0; }
  56   virtual const SGPropertyNode * getStep () const
  57     { return _step ? _step : &_dummy_0; }
  58   virtual const SGPropertyNode * getMin () const { return _min; }
  59   virtual const SGPropertyNode * getMax () const { return _max; }
  60   virtual const SGPropertyNode * getWrap () const
  61     { return _wrap ? _wrap : &_dummy_0; }
  62   virtual const SGPropertyNode * getFactor () const
  63     { return _factor ? _factor : &_dummy_1; }
  64   virtual const SGPropertyNode * getSquared () const
  65     { return _squared ? _squared : &_dummy_1; }
  66   virtual const SGPropertyNode * getSetting () const
  67     { return _setting ? _setting : &_dummy_0; }
  68   virtual const SGPropertyNode * getOffset () const
  69     { return _offset ? _offset : &_dummy_0; }
  70 private:
  71   static SGPropertyNode _dummy_0;
  72   static SGPropertyNode _dummy_1;
  73   mutable SGPropertyNode * _prop;
  74   mutable SGPropertyNode * _prop2;
  75   const SGPropertyNode * _value;
  76   const SGPropertyNode * _step;
  77   const SGPropertyNode * _min;
  78   const SGPropertyNode * _max;
  79   const SGPropertyNode * _wrap;
  80   const SGPropertyNode * _factor;
  81   const SGPropertyNode * _squared;
  82   const SGPropertyNode * _setting;
  83   const SGPropertyNode * _offset;
  84 };
  85
  86 SGPropertyNode PropertyCommandState::_dummy_0;
  87 SGPropertyNode PropertyCommandState::_dummy_1;
  88
  89 PropertyCommandState::PropertyCommandState (const SGPropertyNode * arg)
  90   : SGCommandState(arg),
  91     _prop(fgGetNode(arg->getStringValue("property[0]", "/null"), true)),
  92     _prop2(fgGetNode(arg->getStringValue("property[1]", "/null"), true)),
  93     _value(arg->getNode("value")),
  94     _step(arg->getNode("step")),
  95     _min(arg->getNode("min")),
  96     _max(arg->getNode("max")),
  97     _wrap(arg->getNode("wrap")),
  98     _factor(arg->getNode("factor")),
  99     _squared(arg->getNode("squared")),
 100     _setting(arg->getNode("setting")),
 101     _offset(arg->getNode("offset"))
 102 {
 103                                 // It would be better not to do this
 104                                 // every time, but it's not that big
 105                                 // a deal.  I don't know enough about
 106                                 // C++ static initialization to fix it.
 107   _dummy_1.setDoubleValue(1.0);
 108 }
 109
 110
 111
 112 \f
 113 ////////////////////////////////////////////////////////////////////////
 114 // Command implementations.
 115 ////////////////////////////////////////////////////////////////////////
 116
 117
 118 /**
 119  * Built-in command: do nothing.
 120  */
 121 static bool
 122 do_null (const SGPropertyNode * arg, SGCommandState ** state)
 123 {
 124   return true;
 125 }
 126
 127
 128 /**
 129  * Built-in command: exit FlightGear.
 130  *
 131  * TODO: show a confirm dialog.
 132  */
 133 static bool
 134 do_exit (const SGPropertyNode * arg, SGCommandState ** state)
 135 {
 136   SG_LOG(SG_INPUT, SG_ALERT, "Program exit requested.");
 137   ConfirmExitDialog();
 138   return true;
 139 }
 140
 141
 142 /**
 143  * Built-in command: load flight.
 144  *
 145  * file (optional): the name of the file to load (relative to current
 146  * directory).  Defaults to "fgfs.sav".
 147  */
 148 static bool
 149 do_load (const SGPropertyNode * arg, SGCommandState ** state)
 150 {
 151   const string &file = arg->getStringValue("file", "fgfs.sav");
 152   ifstream input(file.c_str());
 153   if (input.good() && fgLoadFlight(input)) {
 154     input.close();
 155     SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
 156     return true;
 157   } else {
 158     SG_LOG(SG_INPUT, SG_ALERT, "Cannot load flight from " << file);
 159     return false;
 160   }
 161 }
 162
 163
 164 /**
 165  * Built-in command: save flight.
 166  *
 167  * file (optional): the name of the file to save (relative to the
 168  * current directory).  Defaults to "fgfs.sav".
 169  */
 170 static bool
 171 do_save (const SGPropertyNode * arg, SGCommandState ** state)
 172 {
 173   const string &file = arg->getStringValue("file", "fgfs.sav");
 174   bool write_all = arg->getBoolValue("write-all", false);
 175   SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
 176   ofstream output(file.c_str());
 177   if (output.good() && fgSaveFlight(output, write_all)) {
 178     output.close();
 179     SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
 180     return true;
 181   } else {
 182     SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
 183     return false;
 184   }
 185 }
 186
 187
 188 /**
 189  * Built-in command: (re)load the panel.
 190  *
 191  * path (optional): the file name to load the panel from
 192  * (relative to FG_ROOT).  Defaults to the value of /sim/panel/path,
 193  * and if that's unspecified, to "Panels/Default/default.xml".
 194  */
 195 static bool
 196 do_panel_load (const SGPropertyNode * arg, SGCommandState ** state)
 197 {
 198   string panel_path =
 199     arg->getStringValue("path",
 200                         fgGetString("/sim/panel/path",
 201                                     "Panels/Default/default.xml"));
 202   FGPanel * new_panel = fgReadPanel(panel_path);
 203   if (new_panel == 0) {
 204     SG_LOG(SG_INPUT, SG_ALERT,
 205            "Error reading new panel from " << panel_path);
 206     return false;
 207   }
 208   SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
 209   current_panel->unbind();
 210   delete current_panel;
 211   current_panel = new_panel;
 212   current_panel->bind();
 213   return true;
 214 }
 215
 216
 217 /**
 218  * Built-in command: pass a mouse click to the panel.
 219  *
 220  * button: the mouse button number, zero-based.
 221  * is-down: true if the button is down, false if it is up.
 222  * x-pos: the x position of the mouse click.
 223  * y-pos: the y position of the mouse click.
 224  */
 225 static bool
 226 do_panel_mouse_click (const SGPropertyNode * arg, SGCommandState ** state)
 227 {
 228   if (current_panel != 0)
 229     return current_panel
 230       ->doMouseAction(arg->getIntValue("button"),
 231                       arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
 232                       arg->getIntValue("x-pos"),
 233                       arg->getIntValue("y-pos"));
 234   else
 235     return false;
 236 }
 237
 238
 239 /**
 240  * Built-in command: (re)load preferences.
 241  *
 242  * path (optional): the file name to load the panel from (relative
 243  * to FG_ROOT). Defaults to "preferences.xml".
 244  */
 245 static bool
 246 do_preferences_load (const SGPropertyNode * arg, SGCommandState ** state)
 247 {
 248   const string &path = arg->getStringValue("path", "preferences.xml");
 249   SGPath props_path(globals->get_fg_root());
 250   props_path.append(path);
 251   SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences from "
 252          << props_path.str());
 253   try {
 254     readProperties(props_path.str(), globals->get_props());
 255   } catch (const sg_exception &e) {
 256     guiErrorMessage("Error reading global preferences: ", e);
 257     return false;
 258   }
 259   SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
 260   return true;
 261 }
 262
 263
 264 /**
 265  * Built-in command: cycle view.
 266  */
 267 static bool
 268 do_view_cycle (const SGPropertyNode * arg, SGCommandState ** state)
 269 {
 270   globals->get_current_view()->setHeadingOffset_deg(0.0);
 271   globals->get_viewmgr()->next_view();
 272   if ( !strcmp(fgGetString("/sim/flight-model"), "ada") ) {
 273       globals->get_props()->setBoolValue( "/sim/hud/visibility", true );
 274       if ( globals->get_viewmgr()->get_current() == 1 ) {
 275           globals->get_props()->setBoolValue( "/sim/hud/visibility", false );
 276       }
 277   }
 278   global_tile_mgr.refresh_view_timestamps();
 279 //   fgReshape(fgGetInt("/sim/startup/xsize"), fgGetInt("/sim/startup/ysize"));
 280   return true;
 281 }
 282
 283
 284 /**
 285  * Built-in command: capture screen.
 286  */
 287 static bool
 288 do_screen_capture (const SGPropertyNode * arg, SGCommandState ** state)
 289 {
 290   fgDumpSnapShot();
 291   return true;
 292 }
 293
 294
 295 /**
 296  * Reload the tile cache.
 297  */
 298 static bool
 299 do_tile_cache_reload (const SGPropertyNode * arg, SGCommandState ** state)
 300 {
 301     static const SGPropertyNode *master_freeze
 302         = fgGetNode("/sim/freeze/master");
 303     bool freeze = master_freeze->getBoolValue();
 304     SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
 305     if ( !freeze ) {
 306         fgSetBool("/sim/freeze/master", true);
 307     }
 308     // BusyCursor(0);
 309     if ( global_tile_mgr.init() ) {
 310         // Load the local scenery data
 311         double visibility_meters = fgGetDouble("/environment/visibility-m");
 312         global_tile_mgr.update(fgGetDouble("/position/longitude-deg"),
 313                                fgGetDouble("/position/latitude-deg"),
 314                                visibility_meters);
 315     } else {
 316         SG_LOG( SG_GENERAL, SG_ALERT,
 317                 "Error in Tile Manager initialization!" );
 318         exit(-1);
 319     }
 320     // BusyCursor(1);
 321     if ( !freeze ) {
 322         fgSetBool("/sim/freeze/master", false);
 323     }
 324     return true;
 325 }
 326
 327
 328 /**
 329  * Update the lighting manually.
 330  */
 331 static bool
 332 do_lighting_update (const SGPropertyNode * arg, SGCommandState ** state)
 333 {
 334   fgUpdateSkyAndLightingParams();
 335   return true;
 336 }
 337
 338
 339 /**
 340  * Built-in command: toggle a bool property value.
 341  *
 342  * property: The name of the property to toggle.
 343  */
 344 static bool
 345 do_property_toggle (const SGPropertyNode * arg, SGCommandState ** state)
 346 {
 347   if (*state == 0)
 348     *state = new PropertyCommandState(arg);
 349   SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
 350   return prop->setBoolValue(!prop->getBoolValue());
 351 }
 352
 353
 354 /**
 355  * Built-in command: assign a value to a property.
 356  *
 357  * property: the name of the property to assign.
 358  * value: the value to assign.
 359  */
 360 static bool
 361 do_property_assign (const SGPropertyNode * arg, SGCommandState ** state)
 362 {
 363   if (*state == 0)
 364     *state = new PropertyCommandState(arg);
 365   SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
 366   const SGPropertyNode * value =
 367     ((PropertyCommandState *)(*state))->getValue();
 368
 369   switch (prop->getType()) {
 370   case SGPropertyNode::BOOL:
 371     return prop->setBoolValue(value->getBoolValue());
 372   case SGPropertyNode::INT:
 373     return prop->setIntValue(value->getIntValue());
 374   case SGPropertyNode::LONG:
 375     return prop->setLongValue(value->getLongValue());
 376   case SGPropertyNode::FLOAT:
 377     return prop->setFloatValue(value->getFloatValue());
 378   case SGPropertyNode::DOUBLE:
 379     return prop->setDoubleValue(value->getDoubleValue());
 380   case SGPropertyNode::STRING:
 381     return prop->setStringValue(value->getStringValue());
 382   default:
 383     return prop->setUnspecifiedValue(value->getStringValue());
 384   }
 385 }
 386
 387
 388 /**
 389  * Built-in command: increment or decrement a property value.
 390  *
 391  * property: the name of the property to increment or decrement.
 392  * step: the amount of the increment or decrement (default: 0).
 393  * offset: a normalized amount to offset by (if step is not present).
 394  * factor: the amount by which to multiply the offset (if step is not present).
 395  * min: the minimum allowed value (default: no minimum).
 396  * max: the maximum allowed value (default: no maximum).
 397  * wrap: true if the value should be wrapped when it passes min or max;
 398  *       both min and max must be present for this to work (default:
 399  *       false).
 400  */
 401 static bool
 402 do_property_adjust (const SGPropertyNode * arg, SGCommandState ** state)
 403 {
 404   if (*state == 0)
 405     *state = new PropertyCommandState(arg);
 406   bool hasStep = ((PropertyCommandState *)(*state))->hasStep();
 407   SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
 408   const SGPropertyNode * step = ((PropertyCommandState *)(*state))->getStep();
 409   const SGPropertyNode * offset =
 410     ((PropertyCommandState *)(*state))->getOffset();
 411   const SGPropertyNode * factor =
 412     ((PropertyCommandState *)(*state))->getFactor();
 413   const SGPropertyNode * min = ((PropertyCommandState *)(*state))->getMin();
 414   const SGPropertyNode * max = ((PropertyCommandState *)(*state))->getMax();
 415   bool wrap = ((PropertyCommandState *)(*state))->getWrap()->getBoolValue();
 416
 417   double amount = 0;
 418   if (!hasStep) {
 419     amount = offset->getDoubleValue() * factor->getDoubleValue();
 420   }
 421
 422
 423   switch (prop->getType()) {
 424   case SGPropertyNode::BOOL:
 425     bool value;
 426     if (hasStep)
 427       value = step->getBoolValue();
 428     else
 429       value = (0.0 != amount);
 430     if (value)
 431       return prop->setBoolValue(!prop->getBoolValue());
 432     else
 433       return true;
 434   case SGPropertyNode::INT: {
 435     int value;
 436     if (hasStep)
 437       value = prop->getIntValue() + step->getIntValue();
 438     else
 439       value = prop->getIntValue() + int(amount);
 440     if (min && (value < min->getIntValue())) {
 441       if (wrap && max)
 442         value = max->getIntValue();
 443       else
 444         value = min->getIntValue();
 445     }
 446     if (max && value > max->getIntValue()) {
 447       if (wrap && min)
 448         value = min->getIntValue();
 449       else
 450         value = max->getIntValue();
 451     }
 452     return prop->setIntValue(value);
 453   }
 454   case SGPropertyNode::LONG: {
 455     long value;
 456     if (hasStep)
 457       value = prop->getLongValue() + step->getLongValue();
 458     else
 459       value = prop->getLongValue() + long(amount);
 460     if (min && (value < min->getLongValue())) {
 461       if (wrap && max)
 462         value = max->getLongValue();
 463       else
 464         value = min->getLongValue();
 465     }
 466     if (max && value > max->getLongValue()) {
 467       if (wrap && min)
 468         value = min->getLongValue();
 469       else
 470         value = max->getLongValue();
 471     }
 472     return prop->setLongValue(value);
 473   }
 474   case SGPropertyNode::FLOAT: {
 475     float value;
 476     if (hasStep)
 477       value = prop->getFloatValue() + step->getFloatValue();
 478     else
 479       value = prop->getFloatValue() + float(amount);
 480     if (min && (value < min->getFloatValue())) {
 481       if (wrap && max)
 482         value = max->getFloatValue();
 483       else
 484         value = min->getFloatValue();
 485     }
 486     if (max && value > max->getFloatValue()) {
 487       if (wrap && min)
 488         value = min->getFloatValue();
 489       else
 490         value = max->getFloatValue();
 491     }
 492     return prop->setFloatValue(value);
 493   }
 494   case SGPropertyNode::DOUBLE:
 495   case SGPropertyNode::UNSPECIFIED:
 496   case SGPropertyNode::NONE: {
 497     double value;
 498     if (hasStep)
 499       value = prop->getDoubleValue() + step->getDoubleValue();
 500     else
 501       value = prop->getDoubleValue() + amount;
 502     if (min && (value < min->getDoubleValue())) {
 503       if (wrap && max)
 504         value = max->getDoubleValue();
 505       else
 506         value = min->getDoubleValue();
 507     }
 508     if (max && value > max->getDoubleValue()) {
 509       if (wrap && min)
 510         value = min->getDoubleValue();
 511       else
 512         value = max->getDoubleValue();
 513     }
 514     return prop->setDoubleValue(value);
 515   }
 516   case SGPropertyNode::STRING: // doesn't make sense with strings
 517     SG_LOG(SG_INPUT, SG_ALERT, "Cannot adjust a string value");
 518     return false;
 519   default:
 520     SG_LOG(SG_INPUT, SG_ALERT, "Unknown value type");
 521     return false;
 522   }
 523 }
 524
 525
 526 /**
 527  * Built-in command: multiply a property value.
 528  *
 529  * property: the name of the property to multiply.
 530  * factor: the amount by which to multiply.
 531  */
 532 static bool
 533 do_property_multiply (const SGPropertyNode * arg, SGCommandState ** state)
 534 {
 535   if (*state == 0)
 536     *state = new PropertyCommandState(arg);
 537   SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
 538   const SGPropertyNode * factor =
 539     ((PropertyCommandState *)(*state))->getFactor();
 540
 541   switch (prop->getType()) {
 542   case SGPropertyNode::BOOL:
 543     return prop->setBoolValue(prop->getBoolValue() &&
 544                               factor->getBoolValue());
 545   case SGPropertyNode::INT:
 546     return prop->setIntValue(int(prop->getIntValue()
 547                                  * factor->getDoubleValue()));
 548   case SGPropertyNode::LONG:
 549     return prop->setLongValue(long(prop->getLongValue()
 550                                    * factor->getDoubleValue()));
 551   case SGPropertyNode::FLOAT:
 552     return prop->setFloatValue(float(prop->getFloatValue()
 553                                      * factor->getDoubleValue()));
 554   case SGPropertyNode::DOUBLE:
 555   case SGPropertyNode::UNSPECIFIED:
 556   case SGPropertyNode::NONE:
 557     return prop->setDoubleValue(prop->getDoubleValue()
 558                                 * factor->getDoubleValue());
 559   default:                      // doesn't make sense with strings
 560     return false;
 561   }
 562 }
 563
 564
 565 /**
 566  * Built-in command: swap two property values.
 567  *
 568  * property[0]: the name of the first property.
 569  * property[1]: the name of the second property.
 570  */
 571 static bool
 572 do_property_swap (const SGPropertyNode * arg, SGCommandState ** state)
 573 {
 574   if (*state == 0)
 575     *state = new PropertyCommandState(arg);
 576   SGPropertyNode * prop1 = ((PropertyCommandState *)(*state))->getProp();
 577   SGPropertyNode * prop2 = ((PropertyCommandState *)(*state))->getProp2();
 578
 579                                 // FIXME: inefficient
 580   const string & tmp = prop1->getStringValue();
 581   return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
 582           prop2->setUnspecifiedValue(tmp.c_str()));
 583 }
 584
 585
 586 /**
 587  * Set a property to an axis or other moving input.
 588  *
 589  * property: the name of the property to set.
 590  * setting: the current input setting, usually between -1.0 and 1.0.
 591  * offset: the offset to shift by, before applying the factor.
 592  * factor: the factor to multiply by (use negative to reverse).
 593  */
 594 static bool
 595 do_property_scale (const SGPropertyNode * arg, SGCommandState ** state)
 596 {
 597   if (*state == 0)
 598     *state = new PropertyCommandState(arg);
 599   SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
 600   double setting =
 601     ((PropertyCommandState *)(*state))->getSetting()->getDoubleValue();
 602   double offset =
 603     ((PropertyCommandState *)(*state))->getOffset()->getDoubleValue();
 604   double factor =
 605     ((PropertyCommandState *)(*state))->getFactor()->getDoubleValue();
 606   bool squared =
 607     ((PropertyCommandState *)(*state))->getSquared()->getBoolValue();
 608
 609   if (squared)
 610     setting = (setting < 0 ? -1 : 1) * setting * setting;
 611   double result = (setting + offset) * factor;
 612
 613   return prop->setDoubleValue(result);
 614 }
 615
 616
 617 \f
 618 ////////////////////////////////////////////////////////////////////////
 619 // Command setup.
 620 ////////////////////////////////////////////////////////////////////////
 621
 622
 623 /**
 624  * Table of built-in commands.
 625  *
 626  * New commands do not have to be added here; any module in the application
 627  * can add a new command using globals->get_commands()->addCommand(...).
 628  */
 629 static struct {
 630   const char * name;
 631   SGCommandMgr::command_t command;
 632 } built_ins [] = {
 633     { "null", do_null },
 634     { "exit", do_exit },
 635     { "load", do_load },
 636     { "save", do_save },
 637     { "panel-load", do_panel_load },
 638     { "panel-mouse-click", do_panel_mouse_click },
 639     { "preferences-load", do_preferences_load },
 640     { "view-cycle", do_view_cycle },
 641     { "screen-capture", do_screen_capture },
 642     { "tile-cache-reload", do_tile_cache_reload },
 643     { "lighting-update", do_lighting_update },
 644     { "property-toggle", do_property_toggle },
 645     { "property-assign", do_property_assign },
 646     { "property-adjust", do_property_adjust },
 647     { "property-multiply", do_property_multiply },
 648     { "property-swap", do_property_swap },
 649     { "property-scale", do_property_scale },
 650     { 0, 0 }                    // zero-terminated
 651 };
 652
 653
 654 /**
 655  * Initialize the default built-in commands.
 656  *
 657  * Other commands may be added by other parts of the application.
 658  */
 659 void
 660 fgInitCommands ()
 661 {
 662   SG_LOG(SG_GENERAL, SG_INFO, "Initializing basic built-in commands:");
 663   for (int i = 0; built_ins[i].name != 0; i++) {
 664     SG_LOG(SG_GENERAL, SG_INFO, "  " << built_ins[i].name);
 665     globals->get_commands()->addCommand(built_ins[i].name,
 666                                         built_ins[i].command);
 667   }
 668 }
 669
 670 // end of fg_commands.cxx