src/Main/fg_commands.cxx

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