]> 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 9ae0129f5faeca87c3eb54ba4793bf47d4bc3741..9072d0f751a175f316e3df752b55d678a043513b 100644 (file)
@@ -28,11 +28,79 @@ SG_USING_STD(ofstream);
 #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)
+do_null (const SGPropertyNode * arg, SGCommandState ** state)
 {
   return true;
 }
@@ -44,7 +112,7 @@ do_null (const SGPropertyNode * arg)
  * 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();
@@ -59,7 +127,7 @@ do_exit (const SGPropertyNode * arg)
  * directory).  Defaults to "fgfs.sav".
  */
 static bool
-do_load (const SGPropertyNode * arg)
+do_load (const SGPropertyNode * arg, SGCommandState ** state)
 {
   const string &file = arg->getStringValue("file", "fgfs.sav");
   ifstream input(file.c_str());
@@ -81,7 +149,7 @@ do_load (const SGPropertyNode * arg)
  * current directory).  Defaults to "fgfs.sav".
  */
 static bool
-do_save (const SGPropertyNode * arg)
+do_save (const SGPropertyNode * arg, SGCommandState ** state)
 {
   const string &file = arg->getStringValue("file", "fgfs.sav");
   SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
@@ -105,7 +173,7 @@ do_save (const SGPropertyNode * arg)
  * and if that's unspecified, to "Panels/Default/default.xml".
  */
 static bool
-do_panel_load (const SGPropertyNode * arg)
+do_panel_load (const SGPropertyNode * arg, SGCommandState ** state)
 {
   string panel_path =
     arg->getStringValue("path",
@@ -133,7 +201,7 @@ do_panel_load (const SGPropertyNode * arg)
  * to FG_ROOT). Defaults to "preferences.xml".
  */
 static bool
-do_preferences_load (const SGPropertyNode * arg)
+do_preferences_load (const SGPropertyNode * arg, SGCommandState ** state)
 {
   const string &path = arg->getStringValue("path", "preferences.xml");
   SGPath props_path(globals->get_fg_root());
@@ -154,7 +222,7 @@ do_preferences_load (const SGPropertyNode * arg)
  * 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());
@@ -167,7 +235,7 @@ 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;
@@ -178,7 +246,7 @@ do_screen_capture (const SGPropertyNode * arg)
  * Reload the tile cache.
  */
 static bool
-do_tile_cache_reload (const SGPropertyNode * arg)
+do_tile_cache_reload (const SGPropertyNode * arg, SGCommandState ** state)
 {
   bool freeze = globals->get_freeze();
   SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
@@ -187,8 +255,8 @@ do_tile_cache_reload (const SGPropertyNode * arg)
   BusyCursor(0);
   if ( global_tile_mgr.init() ) {
     // Load the local scenery data
-    global_tile_mgr.update(fgGetDouble("/position/longitude"),
-                          fgGetDouble("/position/latitude"));
+    global_tile_mgr.update(fgGetDouble("/position/longitude-deg"),
+                          fgGetDouble("/position/latitude-deg"));
   } else {
     SG_LOG( SG_GENERAL, SG_ALERT, 
            "Error in Tile Manager initialization!" );
@@ -205,7 +273,7 @@ do_tile_cache_reload (const SGPropertyNode * arg)
  * Update the lighting manually.
  */
 static bool
-do_lighting_update (const SGPropertyNode * arg)
+do_lighting_update (const SGPropertyNode * arg, SGCommandState ** state)
 {
   fgUpdateSkyAndLightingParams();
   return true;
@@ -218,14 +286,12 @@ do_lighting_update (const SGPropertyNode * arg)
  * property: The name of the property to toggle.
  */
 static bool
-do_property_toggle (const SGPropertyNode * arg)
+do_property_toggle (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  const 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());
 }
 
 
@@ -236,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)
 {
-  const string & propname = arg->getStringValue("property", "");
-  if (propname == "")
-    return false;
-
-  SGPropertyNode * node = fgGetNode(propname, true);
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  const SGPropertyNode * value =
+    ((PropertyCommandState *)(*state))->getValue();
 
-  switch (node->getType()) {
+  switch (prop->getType()) {
   case SGPropertyNode::BOOL:
-    return node->setBoolValue(arg->getBoolValue("value"));
+    return prop->setBoolValue(value->getBoolValue());
   case SGPropertyNode::INT:
-    return node->setIntValue(arg->getIntValue("value"));
+    return prop->setIntValue(value->getIntValue());
   case SGPropertyNode::LONG:
-    return node->setLongValue(arg->getLongValue("value"));
+    return prop->setLongValue(value->getLongValue());
   case SGPropertyNode::FLOAT:
-    return node->setFloatValue(arg->getFloatValue("value"));
+    return prop->setFloatValue(value->getFloatValue());
   case SGPropertyNode::DOUBLE:
-    return node->setDoubleValue(arg->getDoubleValue("value"));
+    return prop->setDoubleValue(value->getDoubleValue());
   case SGPropertyNode::STRING:
-    return node->setStringValue(arg->getStringValue("value"));
+    return prop->setStringValue(value->getStringValue());
   default:
-    return node->setUnknownValue(arg->getStringValue("value"));
+    return prop->setUnspecifiedValue(value->getStringValue());
   }
 }
 
@@ -270,33 +336,32 @@ 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)
 {
-  const 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()) {
+  switch (prop->getType()) {
   case SGPropertyNode::BOOL:
-    if (arg->getBoolValue("step"))
-      return node->setBoolValue(!node->getBoolValue());
+    if (step->getBoolValue())
+      return prop->setBoolValue(!prop->getBoolValue());
     else
       return true;
   case SGPropertyNode::INT:
-    return node->setIntValue(node->getIntValue()
-                            + arg->getIntValue("step"));
+    return prop->setIntValue(prop->getIntValue()
+                            + step->getIntValue());
   case SGPropertyNode::LONG:
-    return node->setLongValue(node->getLongValue()
-                             + arg->getLongValue("step"));
+    return prop->setLongValue(prop->getLongValue()
+                             + step->getLongValue());
   case SGPropertyNode::FLOAT:
-    return node->setFloatValue(node->getFloatValue()
-                              + arg->getFloatValue("step"));
+    return prop->setFloatValue(prop->getFloatValue()
+                              + step->getFloatValue());
   case SGPropertyNode::DOUBLE:
-  case SGPropertyNode::UNKNOWN:
-    return node->setDoubleValue(node->getDoubleValue()
-                               + arg->getDoubleValue("step"));
+  case SGPropertyNode::UNSPECIFIED:
+    return prop->setDoubleValue(prop->getDoubleValue()
+                               + step->getDoubleValue());
   default:                     // doesn't make sense with strings
     return false;
   }
@@ -310,31 +375,31 @@ do_property_adjust (const SGPropertyNode * arg)
  * factor: the amount by which to multiply.
  */
 static bool
-do_property_multiply (const SGPropertyNode * arg)
+do_property_multiply (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  const string & propname = arg->getStringValue("property", "");
-  if (propname == "")
-    return false;
+  if (*state == 0)
+    *state = new PropertyCommandState(arg);
+  SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
+  const SGPropertyNode * factor =
+    ((PropertyCommandState *)(*state))->getFactor();
 
-  SGPropertyNode * node = fgGetNode(propname, true);
-
-  switch (node->getType()) {
+  switch (prop->getType()) {
   case SGPropertyNode::BOOL:
-    return node->setBoolValue(node->getBoolValue() &&
-                             arg->getBoolValue("factor"));
+    return prop->setBoolValue(prop->getBoolValue() &&
+                             factor->getBoolValue());
   case SGPropertyNode::INT:
-    return node->setIntValue(int(node->getIntValue()
-                                * arg->getDoubleValue("factor")));
+    return prop->setIntValue(int(prop->getIntValue()
+                                * factor->getDoubleValue()));
   case SGPropertyNode::LONG:
-    return node->setLongValue(long(node->getLongValue()
-                                  * arg->getDoubleValue("factor")));
+    return prop->setLongValue(long(prop->getLongValue()
+                                  * factor->getDoubleValue()));
   case SGPropertyNode::FLOAT:
-    return node->setFloatValue(float(node->getFloatValue()
-                                    * arg->getDoubleValue("factor")));
+    return prop->setFloatValue(float(prop->getFloatValue()
+                                    * factor->getDoubleValue()));
   case SGPropertyNode::DOUBLE:
-  case SGPropertyNode::UNKNOWN:
-    return node->setDoubleValue(node->getDoubleValue()
-                               * arg->getDoubleValue("factor"));
+  case SGPropertyNode::UNSPECIFIED:
+    return prop->setDoubleValue(prop->getDoubleValue()
+                               * factor->getDoubleValue());
   default:                     // doesn't make sense with strings
     return false;
   }
@@ -348,18 +413,17 @@ do_property_multiply (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)
 {
-  const string &propname1 = arg->getStringValue("property[0]", "");
-  const string &propname2 = arg->getStringValue("property[1]", "");
-  if (propname1 == "" || propname2 == "")
-    return false;
-
-  SGPropertyNode * node1 = fgGetNode(propname1, true);
-  SGPropertyNode * node2 = fgGetNode(propname2, true);
-  const string & tmp = node1->getStringValue();
-  return (node1->setUnknownValue(node2->getStringValue()) &&
-         node2->setUnknownValue(tmp));
+  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));
 }
 
 
@@ -372,17 +436,28 @@ do_property_swap (const SGPropertyNode * arg)
  * factor: the factor to multiply by (use negative to reverse).
  */
 static bool
-do_property_scale (const SGPropertyNode * arg)
+do_property_scale (const SGPropertyNode * arg, SGCommandState ** state)
 {
-  const string &propname = arg->getStringValue("property");
-  double setting = arg->getDoubleValue("setting", 0.0);
-  double offset = arg->getDoubleValue("offset", 0.0);
-  double factor = arg->getDoubleValue("factor", 1.0);
-  return fgSetDouble(propname, (setting + offset) * factor);
+  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();
+
+  return prop->setDoubleValue((setting + offset) * factor);
 }
 
 
 \f
+////////////////////////////////////////////////////////////////////////
+// Command setup.
+////////////////////////////////////////////////////////////////////////
+
+
 /**
  * Table of built-in commands.
  *