]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/fg_commands.cxx
- modified to take advantage of SGCommandState to cache property nodes
[flightgear.git] / src / Main / fg_commands.cxx
index b544f79cb2eb03a2bfd19afcacc450009bb5736f..9072d0f751a175f316e3df752b55d678a043513b 100644 (file)
 // fg_commands.cxx - internal FGFS commands.
 
-#include "fg_commands.hxx"
+#include <simgear/compiler.h>
+
+#include STL_STRING
+#include STL_FSTREAM
 
 #include <simgear/debug/logstream.hxx>
 #include <simgear/misc/commands.hxx>
 #include <simgear/misc/props.hxx>
 
 #include <GUI/gui.h>
+#include <Cockpit/panel.hxx>
+#include <Cockpit/panel_io.hxx>
+#include <Scenery/tilemgr.hxx>
+#include <Time/tmp.hxx>
+
+#include "fg_commands.hxx"
+
+SG_USING_STD(string);
+#if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
+SG_USING_STD(ifstream);
+SG_USING_STD(ofstream);
+#endif
 
 #include "fg_props.hxx"
 #include "fg_io.hxx"
 #include "globals.hxx"
 
 
+\f
+////////////////////////////////////////////////////////////////////////
+// Saved command states.
+////////////////////////////////////////////////////////////////////////
+
+
+/**
+ * Base saved state for property commands.
+ *
+ * Since this class isn't publicly visible, it is simply an aggregate
+ * of all the stuff any property command needs.
+ */
+class PropertyCommandState : public SGCommandState
+{
+public:
+  PropertyCommandState (const SGPropertyNode * arg);
+  virtual SGPropertyNode * getProp () const { return _prop; }
+  virtual SGPropertyNode * getProp2 () const { return _prop2; }
+  virtual const SGPropertyNode * getValue () const
+    { return _value ? _value : &_dummy_0; }
+  virtual const SGPropertyNode * getStep () const 
+    { return _step ? _step : &_dummy_0; }
+  virtual const SGPropertyNode * getFactor () const 
+    { return _factor ? _factor : &_dummy_1; }
+  virtual const SGPropertyNode * getSetting () const 
+    { return _setting ? _setting : &_dummy_0; }
+  virtual const SGPropertyNode * getOffset () const
+    { return _offset ? _offset : &_dummy_0; }
+private:
+  static SGPropertyNode _dummy_0;
+  static SGPropertyNode _dummy_1;
+  mutable SGPropertyNode * _prop;
+  mutable SGPropertyNode * _prop2;
+  const SGPropertyNode * _value;
+  const SGPropertyNode * _step;
+  const SGPropertyNode * _factor;
+  const SGPropertyNode * _setting;
+  const SGPropertyNode * _offset;
+};
+
+SGPropertyNode PropertyCommandState::_dummy_0;
+SGPropertyNode PropertyCommandState::_dummy_1;
+
+PropertyCommandState::PropertyCommandState (const SGPropertyNode * arg)
+  : SGCommandState(arg),
+    _prop(fgGetNode(arg->getStringValue("property[0]", "/null"), true)),
+    _prop2(fgGetNode(arg->getStringValue("property[1]", "/null"), true)),
+    _value(arg->getNode("value")),
+    _step(arg->getNode("step")),
+    _factor(arg->getNode("factor")),
+    _setting(arg->getNode("setting")),
+    _offset(arg->getNode("offset"))
+{
+                               // It would be better not to do this
+                               // every time, but it's not that big
+                               // a deal.  I don't know enough about
+                               // C++ static initialization to fix it.
+  _dummy_1.setDoubleValue(1.0);
+}
+
+
+
+\f
+////////////////////////////////////////////////////////////////////////
+// Command implementations.
+////////////////////////////////////////////////////////////////////////
+
+
+/**
+ * Built-in command: do nothing.
+ */
+static bool
+do_null (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  return true;
+}
+
+
 /**
  * Built-in command: exit FlightGear.
  *
  * TODO: show a confirm dialog.
  */
 static bool
-do_exit (const SGPropertyNode * arg)
+do_exit (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  SG_LOG(SG_INPUT, SG_ALERT, "Program exit requested.");
+  ConfirmExitDialog();
+  return true;
+}
+
+
+/**
+ * Built-in command: load flight.
+ *
+ * file (optional): the name of the file to load (relative to current
+ * directory).  Defaults to "fgfs.sav".
+ */
+static bool
+do_load (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  const string &file = arg->getStringValue("file", "fgfs.sav");
+  ifstream input(file.c_str());
+  if (input.good() && fgLoadFlight(input)) {
+    input.close();
+    SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
+    return true;
+  } else {
+    SG_LOG(SG_INPUT, SG_ALERT, "Cannot load flight from " << file);
+    return false;
+  }
+}
+
+
+/**
+ * Built-in command: save flight.
+ *
+ * file (optional): the name of the file to save (relative to the
+ * current directory).  Defaults to "fgfs.sav".
+ */
+static bool
+do_save (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  const string &file = arg->getStringValue("file", "fgfs.sav");
+  SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
+  ofstream output(file.c_str());
+  if (output.good() && fgSaveFlight(output)) {
+    output.close();
+    SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
+    return true;
+  } else {
+    SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
+    return false;
+  }
+}
+
+
+/**
+ * Built-in command: (re)load the panel.
+ *
+ * path (optional): the file name to load the panel from 
+ * (relative to FG_ROOT).  Defaults to the value of /sim/panel/path,
+ * and if that's unspecified, to "Panels/Default/default.xml".
+ */
+static bool
+do_panel_load (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  fgIOShutdownAll();
-  exit(0);
+  string panel_path =
+    arg->getStringValue("path",
+                       fgGetString("/sim/panel/path",
+                                   "Panels/Default/default.xml"));
+  FGPanel * new_panel = fgReadPanel(panel_path);
+  if (new_panel == 0) {
+    SG_LOG(SG_INPUT, SG_ALERT,
+          "Error reading new panel from " << panel_path);
+    return false;
+  }
+  SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
+  current_panel->unbind();
+  delete current_panel;
+  current_panel = new_panel;
+  current_panel->bind();
   return true;
 }
 
 
+/**
+ * Built-in command: (re)load preferences.
+ *
+ * path (optional): the file name to load the panel from (relative
+ * to FG_ROOT). Defaults to "preferences.xml".
+ */
+static bool
+do_preferences_load (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  const string &path = arg->getStringValue("path", "preferences.xml");
+  SGPath props_path(globals->get_fg_root());
+  props_path.append(path);
+  SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences from "
+        << props_path.str());
+  if (!readProperties(props_path.str(), globals->get_props())) {
+    SG_LOG(SG_INPUT, SG_ALERT, "Failed to reread global preferences");
+    return false;
+  } else {
+    SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
+    return true;
+  }
+}
+
+
 /**
  * Built-in command: cycle view.
  */
 static bool
-do_view_cycle (const SGPropertyNode * arg)
+do_view_cycle (const SGPropertyNode * arg, SGCommandState ** state)
 {
   globals->get_current_view()->set_view_offset(0.0);
   globals->set_current_view(globals->get_viewmgr()->next_view());
@@ -44,27 +235,63 @@ do_view_cycle (const SGPropertyNode * arg)
  * Built-in command: capture screen.
  */
 static bool
-do_screen_capture (const SGPropertyNode * arg)
+do_screen_capture (const SGPropertyNode * arg, SGCommandState ** state)
 {
   fgDumpSnapShot();
   return true;
 }
 
 
+/**
+ * Reload the tile cache.
+ */
+static bool
+do_tile_cache_reload (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  bool freeze = globals->get_freeze();
+  SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
+  if ( !freeze ) 
+    globals->set_freeze( true );
+  BusyCursor(0);
+  if ( global_tile_mgr.init() ) {
+    // Load the local scenery data
+    global_tile_mgr.update(fgGetDouble("/position/longitude-deg"),
+                          fgGetDouble("/position/latitude-deg"));
+  } else {
+    SG_LOG( SG_GENERAL, SG_ALERT, 
+           "Error in Tile Manager initialization!" );
+    exit(-1);
+  }
+  BusyCursor(1);
+  if ( !freeze )
+    globals->set_freeze( false );
+  return true;
+}
+
+
+/**
+ * Update the lighting manually.
+ */
+static bool
+do_lighting_update (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  fgUpdateSkyAndLightingParams();
+  return true;
+}
+
+
 /**
  * Built-in command: toggle a bool property value.
  *
  * property: The name of the property to toggle.
  */
 static bool
-do_property_toggle (const SGPropertyNode * arg)
+do_property_toggle (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  string propname = arg->getStringValue("property", "");
-  if (propname == "")
-    return false;
-
-  SGPropertyNode * node = fgGetNode(propname);
-  return node->setBoolValue(!node->getBoolValue());
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  return prop->setBoolValue(!prop->getBoolValue());
 }
 
 
@@ -75,29 +302,29 @@ do_property_toggle (const SGPropertyNode * arg)
  * value: the value to assign.
  */
 static bool
-do_property_assign (const SGPropertyNode * arg)
+do_property_assign (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  string propname = arg->getStringValue("property", "");
-  if (propname == "")
-    return false;
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  const SGPropertyNode * value =
+    ((PropertyCommandState *)(*state))->getValue();
 
-  SGPropertyNode * node = fgGetNode(propname, true);
-
-  switch (node->getType()) {
-  case SGValue::BOOL:
-    return node->setBoolValue(arg->getBoolValue("value"));
-  case SGValue::INT:
-    return node->setIntValue(arg->getIntValue("value"));
-  case SGValue::LONG:
-    return node->setLongValue(arg->getLongValue("value"));
-  case SGValue::FLOAT:
-    return node->setFloatValue(arg->getFloatValue("value"));
-  case SGValue::DOUBLE:
-    return node->setDoubleValue(arg->getDoubleValue("value"));
-  case SGValue::STRING:
-    return node->setStringValue(arg->getStringValue("value"));
+  switch (prop->getType()) {
+  case SGPropertyNode::BOOL:
+    return prop->setBoolValue(value->getBoolValue());
+  case SGPropertyNode::INT:
+    return prop->setIntValue(value->getIntValue());
+  case SGPropertyNode::LONG:
+    return prop->setLongValue(value->getLongValue());
+  case SGPropertyNode::FLOAT:
+    return prop->setFloatValue(value->getFloatValue());
+  case SGPropertyNode::DOUBLE:
+    return prop->setDoubleValue(value->getDoubleValue());
+  case SGPropertyNode::STRING:
+    return prop->setStringValue(value->getStringValue());
   default:
-    return node->setUnknownValue(arg->getStringValue("value"));
+    return prop->setUnspecifiedValue(value->getStringValue());
   }
 }
 
@@ -109,32 +336,70 @@ do_property_assign (const SGPropertyNode * arg)
  * step: the amount of the increment or decrement.
  */
 static bool
-do_property_adjust (const SGPropertyNode * arg)
+do_property_adjust (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  string propname = arg->getStringValue("property", "");
-  if (propname == "")
-    return false;
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  const SGPropertyNode * step = ((PropertyCommandState *)(*state))->getStep();
 
-  SGPropertyNode * node = fgGetNode(propname, true);
-
-  switch (node->getType()) {
-  case SGValue::BOOL:
-    if (arg->getBoolValue("step"))
-      return node->setBoolValue(!node->getBoolValue());
+  switch (prop->getType()) {
+  case SGPropertyNode::BOOL:
+    if (step->getBoolValue())
+      return prop->setBoolValue(!prop->getBoolValue());
     else
       return true;
-  case SGValue::INT:
-    return node->setIntValue(node->getIntValue()
-                            + arg->getIntValue("step"));
-  case SGValue::LONG:
-    return node->setLongValue(node->getLongValue()
-                             + arg->getLongValue("step"));
-  case SGValue::FLOAT:
-    return node->setFloatValue(node->getFloatValue()
-                              + arg->getFloatValue("step"));
-  case SGValue::DOUBLE:
-    return node->setDoubleValue(node->getDoubleValue()
-                               + arg->getDoubleValue("step"));
+  case SGPropertyNode::INT:
+    return prop->setIntValue(prop->getIntValue()
+                            + step->getIntValue());
+  case SGPropertyNode::LONG:
+    return prop->setLongValue(prop->getLongValue()
+                             + step->getLongValue());
+  case SGPropertyNode::FLOAT:
+    return prop->setFloatValue(prop->getFloatValue()
+                              + step->getFloatValue());
+  case SGPropertyNode::DOUBLE:
+  case SGPropertyNode::UNSPECIFIED:
+    return prop->setDoubleValue(prop->getDoubleValue()
+                               + step->getDoubleValue());
+  default:                     // doesn't make sense with strings
+    return false;
+  }
+}
+
+
+/**
+ * Built-in command: multiply a property value.
+ *
+ * property: the name of the property to multiply.
+ * factor: the amount by which to multiply.
+ */
+static bool
+do_property_multiply (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  const SGPropertyNode * factor =
+    ((PropertyCommandState *)(*state))->getFactor();
+
+  switch (prop->getType()) {
+  case SGPropertyNode::BOOL:
+    return prop->setBoolValue(prop->getBoolValue() &&
+                             factor->getBoolValue());
+  case SGPropertyNode::INT:
+    return prop->setIntValue(int(prop->getIntValue()
+                                * factor->getDoubleValue()));
+  case SGPropertyNode::LONG:
+    return prop->setLongValue(long(prop->getLongValue()
+                                  * factor->getDoubleValue()));
+  case SGPropertyNode::FLOAT:
+    return prop->setFloatValue(float(prop->getFloatValue()
+                                    * factor->getDoubleValue()));
+  case SGPropertyNode::DOUBLE:
+  case SGPropertyNode::UNSPECIFIED:
+    return prop->setDoubleValue(prop->getDoubleValue()
+                               * factor->getDoubleValue());
   default:                     // doesn't make sense with strings
     return false;
   }
@@ -148,22 +413,51 @@ do_property_adjust (const SGPropertyNode * arg)
  * property[1]: the name of the second property.
  */
 static bool
-do_property_swap (const SGPropertyNode * arg)
+do_property_swap (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  string propname1 = arg->getStringValue("property[0]", "");
-  string propname2 = arg->getStringValue("property[1]", "");
-  if (propname1 == "" || propname2 == "")
-    return false;
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop1 = ((PropertyCommandState *)(*state))->getProp();
+  SGPropertyNode * prop2 = ((PropertyCommandState *)(*state))->getProp2();
+
+                               // FIXME: inefficient
+  const string & tmp = prop1->getStringValue();
+  return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
+         prop2->setUnspecifiedValue(tmp));
+}
+
+
+/**
+ * Set a property to an axis or other moving input.
+ *
+ * property: the name of the property to set.
+ * setting: the current input setting, usually between -1.0 and 1.0.
+ * offset: the offset to shift by, before applying the factor.
+ * factor: the factor to multiply by (use negative to reverse).
+ */
+static bool
+do_property_scale (const SGPropertyNode * arg, SGCommandState ** state)
+{
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  double setting =
+    ((PropertyCommandState *)(*state))->getSetting()->getDoubleValue();
+  double offset =
+    ((PropertyCommandState *)(*state))->getOffset()->getDoubleValue();
+  double factor =
+    ((PropertyCommandState *)(*state))->getFactor()->getDoubleValue();
 
-  SGPropertyNode * node1 = fgGetNode(propname1, true);
-  SGPropertyNode * node2 = fgGetNode(propname2, true);
-  string tmp = node1->getStringValue();
-  return (node1->setUnknownValue(node2->getStringValue()) &&
-         node2->setUnknownValue(tmp));
+  return prop->setDoubleValue((setting + offset) * factor);
 }
 
 
 \f
+////////////////////////////////////////////////////////////////////////
+// Command setup.
+////////////////////////////////////////////////////////////////////////
+
+
 /**
  * Table of built-in commands.
  *
@@ -174,14 +468,23 @@ static struct {
   const char * name;
   SGCommandMgr::command_t command;
 } built_ins [] = {
-  "exit", do_exit,
-  "view-cycle", do_view_cycle,
-  "screen-capture", do_screen_capture,
-  "property-toggle", do_property_toggle,
-  "property-assign", do_property_assign,
-  "property-adjust", do_property_adjust,
-  "property-swap", do_property_swap,
-  0, 0                         // zero-terminated
+    { "null", do_null },
+    { "exit", do_exit },
+    { "load", do_load },
+    { "save", do_save },
+    { "panel-load", do_panel_load },
+    { "preferences-load", do_preferences_load },
+    { "view-cycle", do_view_cycle },
+    { "screen-capture", do_screen_capture },
+    { "tile-cache-reload", do_tile_cache_reload },
+    { "lighting-update", do_lighting_update },
+    { "property-toggle", do_property_toggle },
+    { "property-assign", do_property_assign },
+    { "property-adjust", do_property_adjust },
+    { "property-multiply", do_property_multiply },
+    { "property-swap", do_property_swap },
+    { "property-scale", do_property_scale },
+    { 0, 0 }                   // zero-terminated
 };