]> git.mxchange.org Git - simgear.git/blobdiff - simgear/misc/props_io.cxx
- made getValue methods protected, so that they won't be invoked outside
[simgear.git] / simgear / misc / props_io.cxx
index 2a0196b7753592a50dd3afb893b80a0141fe2e6e..ff438fc640dbc28210977bad4eb81126e3131af8 100644 (file)
@@ -1,26 +1,34 @@
 
-#ifdef HAVE_CONFIG_H
-#  include <config.h>
-#endif
+#include <simgear/compiler.h>
 
 #include <stdlib.h>            // atof() atoi()
 
+#include <simgear/sg_inlines.h>
 #include <simgear/debug/logstream.hxx>
 #include <simgear/xml/easyxml.hxx>
 
+#include "sg_path.hxx"
 #include "props.hxx"
 
-#include <iostream>
-#include <fstream>
-#include <string>
+#include STL_IOSTREAM
+#if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
+#  include <fstream>
+#else
+#  include <fstream.h>
+#endif
+#include STL_STRING
 #include <vector>
+#include <map>
 
-using std::istream;
-using std::ifstream;
-using std::ostream;
-using std::ofstream;
-using std::string;
-using std::vector;
+#if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
+SG_USING_STD(istream);
+SG_USING_STD(ifstream);
+SG_USING_STD(ostream);
+SG_USING_STD(ofstream);
+#endif
+SG_USING_STD(string);
+SG_USING_STD(vector);
+SG_USING_STD(map);
 
 
 \f
@@ -32,7 +40,8 @@ class PropsVisitor : public XMLVisitor
 {
 public:
 
-  PropsVisitor (SGPropertyNode * root) : _ok(true), _root(root), _level(0) {}
+  PropsVisitor (SGPropertyNode * root, const string &base)
+    : _ok(true), _root(root), _level(0), _base(base) {}
 
   void startXML ();
   void endXML ();
@@ -53,6 +62,7 @@ private:
       : node(_node), type(_type) {}
     SGPropertyNode * node;
     string type;
+    map<string,int> counters;
   };
 
   State &state () { return _state_stack[_state_stack.size() - 1]; }
@@ -76,7 +86,7 @@ private:
   SGPropertyNode * _root;
   int _level;
   vector<State> _state_stack;
-
+  string _base;
 };
 
 void
@@ -96,17 +106,52 @@ PropsVisitor::endXML ()
 void
 PropsVisitor::startElement (const char * name, const XMLAttributes &atts)
 {
+  State &st = state();
+
   if (_level == 0) {
+    if (string(name) != (string)"PropertyList") {
+      SG_LOG(SG_INPUT, SG_ALERT, "Root element name is " <<
+            name << "; expected PropertyList");
+      _ok = false;
+    }
     push_state(_root, "");
   }
 
   else {
+                               // Get the index.
     const char * att_n = atts.getValue("n");
     int index = 0;
-    if (att_n != 0)
+    if (att_n != 0) {
       index = atoi(att_n);
-    push_state(state().node->getChild(name, index, true),
-              atts.getValue("type"));
+      st.counters[name] = SG_MAX2(st.counters[name], index+1);
+    } else {
+      index = st.counters[name];
+      st.counters[name]++;
+    }
+
+                               // Check for an alias.
+    SGPropertyNode * node = st.node->getChild(name, index, true);
+    const char * att_alias = atts.getValue("alias");
+    if (att_alias != 0) {
+      if (!node->alias(att_alias))
+       SG_LOG(SG_INPUT, SG_ALERT, "Failed to set alias to " << att_alias);
+    }
+
+                               // Check for an include.
+    const char * att_include = atts.getValue("include");
+    if (att_include != 0) {
+      SGPath path(SGPath(_base).dir());
+      cerr << "Base is " << _base << endl;
+      cerr << "Dir is " << SGPath(_base).dir() << endl;
+      path.append(att_include);
+      if (!readProperties(path.str(), node)) {
+       SG_LOG(SG_INPUT, SG_ALERT, "Failed to read include file "
+              << att_include);
+       _ok = false;
+      }
+    }
+
+    push_state(node, atts.getValue("type"));
   }
 }
 
@@ -116,9 +161,9 @@ PropsVisitor::endElement (const char * name)
   State &st = state();
   bool ret;
 
-                               // If there are no children, then
-                               // it is a leaf value.
-  if (st.node->nChildren() == 0) {
+                               // If there are no children and it's
+                               // not an alias, then it's a leaf value.
+  if (st.node->nChildren() == 0 && !st.node->isAlias()) {
     if (st.type == "bool") {
       if (_data == "true" || atoi(_data.c_str()) != 0)
        ret = st.node->setBoolValue(true);
@@ -126,26 +171,27 @@ PropsVisitor::endElement (const char * name)
        ret = st.node->setBoolValue(false);
     } else if (st.type == "int") {
       ret = st.node->setIntValue(atoi(_data.c_str()));
+    } else if (st.type == "long") {
+      ret = st.node->setLongValue(strtol(_data.c_str(), 0, 0));
     } else if (st.type == "float") {
       ret = st.node->setFloatValue(atof(_data.c_str()));
     } else if (st.type == "double") {
-      ret = st.node->setDoubleValue(atof(_data.c_str()));
+      ret = st.node->setDoubleValue(strtod(_data.c_str(), 0));
     } else if (st.type == "string") {
       ret = st.node->setStringValue(_data);
     } else if (st.type == "unknown") {
       ret = st.node->setUnknownValue(_data);
     } else {
-      FG_LOG(FG_INPUT, FG_ALERT, "Unknown data type " << st.type
+      SG_LOG(SG_INPUT, SG_ALERT, "Unknown data type " << st.type
             << " assuming 'unknown'");
       ret = st.node->setUnknownValue(_data);
     }
+    if (!ret)
+      SG_LOG(SG_INPUT, SG_ALERT, "readProperties: Failed to set "
+            << st.node->getPath() << " to value \""
+            << _data << "\" with type " << st.type);
   }
 
-  if (!ret)
-    FG_LOG(FG_INPUT, FG_ALERT, "readProperties: Failed to set "
-          << st.node->getPath() << " to value \""
-          << _data << " with type " << st.type);
-
   pop_state();
 }
 
@@ -159,15 +205,15 @@ PropsVisitor::data (const char * s, int length)
 void
 PropsVisitor::warning (const char * message, int line, int column)
 {
-  FG_LOG(FG_INPUT, FG_ALERT, "readProperties: warning: "
+  SG_LOG(SG_INPUT, SG_ALERT, "readProperties: warning: "
         << message << " at line " << line << ", column " << column);
 }
 
 void
 PropsVisitor::error (const char * message, int line, int column)
 {
-  FG_LOG(FG_INPUT, FG_ALERT, "readProperties: FATAL: "
-        << message << " at line " << line << ", column " << column);
+  SG_LOG(SG_INPUT, SG_ALERT, "readProperties: FATAL: " <<
+        message << " at line " << line << ", column " << column);
   _ok = false;
 }
 
@@ -177,21 +223,40 @@ PropsVisitor::error (const char * message, int line, int column)
 // Property list reader.
 ////////////////////////////////////////////////////////////////////////
 
+
+/**
+ * Read properties from an input stream.
+ *
+ * @param input The input stream containing an XML property file.
+ * @param start_node The root node for reading properties.
+ * @param base A base path for resolving external include references.
+ * @return true if the read succeeded, false otherwise.
+ */
 bool
-readProperties (istream &input, SGPropertyNode * start_node)
+readProperties (istream &input, SGPropertyNode * start_node,
+               const string &base)
 {
-  PropsVisitor visitor(start_node);
+  PropsVisitor visitor(start_node, base);
   return readXML(input, visitor) && visitor.isOK();
 }
 
+
+/**
+ * Read properties from a file.
+ *
+ * @param file A string containing the file path.
+ * @param start_node The root node for reading properties.
+ * @return true if the read succeeded, false otherwise.
+ */
 bool
 readProperties (const string &file, SGPropertyNode * start_node)
 {
+  cerr << "Reading properties from " << file << endl;
   ifstream input(file.c_str());
   if (input.good()) {
-    return readProperties(input, start_node);
+    return readProperties(input, start_node, file);
   } else {
-    FG_LOG(FG_INPUT, FG_ALERT, "Error reading property list from file "
+    SG_LOG(SG_INPUT, SG_ALERT, "Error reading property list from file "
           << file);
     return false;
   }
@@ -209,7 +274,7 @@ readProperties (const string &file, SGPropertyNode * start_node)
  * Return the type name.
  */
 static const char *
-getTypeName (SGValue::Type type)
+getTypeName (SGPropertyNode::Type type)
 {
   switch (type) {
   case SGValue::UNKNOWN:
@@ -218,6 +283,8 @@ getTypeName (SGValue::Type type)
     return "bool";
   case SGValue::INT:
     return "int";
+  case SGValue::LONG:
+    return "long";
   case SGValue::FLOAT:
     return "float";
   case SGValue::DOUBLE:
@@ -225,6 +292,9 @@ getTypeName (SGValue::Type type)
   case SGValue::STRING:
     return "string";
   }
+
+  // keep the compiler from squawking
+  return "unknown";
 }
 
 
@@ -234,7 +304,7 @@ getTypeName (SGValue::Type type)
 static void
 writeData (ostream &output, const string &data)
 {
-  for (int i = 0; i < data.size(); i++) {
+  for (int i = 0; i < (int)data.size(); i++) {
     switch (data[i]) {
     case '&':
       output << "&amp;";
@@ -272,17 +342,26 @@ writeNode (ostream &output, const SGPropertyNode * node, int indent)
                                // write it first.
   if (node->hasValue()) {
     doIndent(output, indent);
-    output << '<' << name << " n=\"" << index
-          << "\" type=\"" << getTypeName(node->getType()) << "\">";
-    writeData(output, node->getStringValue());
-    output << "</" << name << '>' << endl;;
+    output << '<' << name << " n=\"" << index << '"';
+    if (node->isAlias() && node->getAliasTarget() != 0)
+      output << " alias=\"" << node->getAliasTarget()->getPath() << "\"/>";
+    else {
+      if (node->getType() != SGPropertyNode::UNKNOWN)
+       output << " type=\"" << getTypeName(node->getType()) << '"';
+      output << '>';
+      writeData(output, node->getStringValue());
+      output << "</" << name << '>' << endl;
+    }
   }
 
                                // If there are children, write them
                                // next.
-  if (nChildren > 0) {
+  if (nChildren > 0 || node->isAlias()) {
     doIndent(output, indent);
-    output << '<' << name << " n=\"" << index << "\">" << endl;;
+    output << '<' << name << " n=\"" << index << '"';
+    if (node->isAlias() && node->getAliasTarget() != 0)
+      output << " alias=\"" << node->getAliasTarget()->getPath() << '"';
+    output << '>' << endl;
     for (int i = 0; i < nChildren; i++)
       writeNode(output, node->getChild(i), indent + INDENT_STEP);
     doIndent(output, indent);
@@ -292,14 +371,22 @@ writeNode (ostream &output, const SGPropertyNode * node, int indent)
                                // If there were no children and no
                                // value, at least note the presence
                                // of the node.
-  if (nChildren == 0 && !node->hasValue()) {
-    doIndent(output, indent);
-    output << '<' << name << " n=\"" << index << "\"/>" << endl;
-  }
+//   if (nChildren == 0 && !node->isAlias() && !node->hasValue()) {
+//     doIndent(output, indent);
+//     output << '<' << name << " n=\"" << index << "\"/>" << endl;
+//   }
 
   return true;
 }
 
+
+/**
+ * Write a property tree to an output stream in XML format.
+ *
+ * @param output The output stream.
+ * @param start_node The root node to write.
+ * @return true if the write succeeded, false otherwise.
+ */
 bool
 writeProperties (ostream &output, const SGPropertyNode * start_node)
 {
@@ -317,6 +404,14 @@ writeProperties (ostream &output, const SGPropertyNode * start_node)
   return true;
 }
 
+
+/**
+ * Write a property tree to a file in XML format.
+ *
+ * @param file The destination file.
+ * @param start_node The root node to write.
+ * @return true if the write succeeded, false otherwise.
+ */
 bool
 writeProperties (const string &file, const SGPropertyNode * start_node)
 {
@@ -324,8 +419,81 @@ writeProperties (const string &file, const SGPropertyNode * start_node)
   if (output.good()) {
     return writeProperties(output, start_node);
   } else {
-    FG_LOG(FG_INPUT, FG_ALERT, "Cannot write properties to file "
+    SG_LOG(SG_INPUT, SG_ALERT, "Cannot write properties to file "
           << file);
     return false;
   }
 }
+
+
+\f
+////////////////////////////////////////////////////////////////////////
+// Copy properties from one tree to another.
+////////////////////////////////////////////////////////////////////////
+
+
+/**
+ * Copy one property tree to another.
+ * 
+ * @param in The source property tree.
+ * @param out The destination property tree.
+ * @return true if all properties were copied, false if some failed
+ *  (for example, if the property's value is tied read-only).
+ */
+bool
+copyProperties (const SGPropertyNode *in, SGPropertyNode *out)
+{
+  bool retval = true;
+
+                               // First, copy the actual value,
+                               // if any.
+  if (in->hasValue()) {
+    switch (in->getType()) {
+    case SGValue::BOOL:
+      if (!out->setBoolValue(in->getBoolValue()))
+       retval = false;
+      break;
+    case SGValue::INT:
+      if (!out->setIntValue(in->getIntValue()))
+       retval = false;
+      break;
+    case SGValue::LONG:
+      if (!out->setLongValue(in->getLongValue()))
+       retval = false;
+      break;
+    case SGValue::FLOAT:
+      if (!out->setFloatValue(in->getFloatValue()))
+       retval = false;
+      break;
+    case SGValue::DOUBLE:
+      if (!out->setDoubleValue(in->getDoubleValue()))
+       retval = false;
+      break;
+    case SGValue::STRING:
+      if (!out->setStringValue(in->getStringValue()))
+       retval = false;
+      break;
+    case SGValue::UNKNOWN:
+      if (!out->setUnknownValue(in->getStringValue()))
+       retval = false;
+      break;
+    default:
+      throw string("Unknown SGValue type");
+    }
+  }
+
+                               // Next, copy the children.
+  int nChildren = in->nChildren();
+  for (int i = 0; i < nChildren; i++) {
+    const SGPropertyNode * in_child = in->getChild(i);
+    SGPropertyNode * out_child = out->getChild(in_child->getName(),
+                                              in_child->getIndex(),
+                                              true);
+    if (!copyProperties(in_child, out_child))
+      retval = false;
+  }
+
+  return retval;
+}
+
+// end of props_io.cxx