]> git.mxchange.org Git - simgear.git/blobdiff - simgear/props/props_io.cxx
Update doxgen config and some comments.
[simgear.git] / simgear / props / props_io.cxx
index c86f9d6cc7ed3183894d53ef647ad6aa3d1edf99..7a9c077f80ed829ed49fcac10e69d07e3d413696 100644 (file)
@@ -45,8 +45,10 @@ using std::endl;
 
 #define DEFAULT_MODE (SGPropertyNode::READ|SGPropertyNode::WRITE)
 
+// Name of special node containing unused attributes
+const std::string ATTR = "_attr_";
+
 
-\f
 ////////////////////////////////////////////////////////////////////////
 // Property list visitor, for XML parsing.
 ////////////////////////////////////////////////////////////////////////
@@ -84,6 +86,12 @@ private:
     State () : node(0), type(""), mode(DEFAULT_MODE), omit(false) {}
     State (SGPropertyNode * _node, const char * _type, int _mode, bool _omit)
       : node(_node), type(_type), mode(_mode), omit(_omit) {}
+    bool hasChildren() const
+    {
+      int n_children = node->nChildren();
+      return n_children > 1
+         || (n_children == 1 && node->getChild(0)->getNameString() != ATTR);
+    }
     SGPropertyNode * node;
     string type;
     int mode;
@@ -135,19 +143,20 @@ PropsVisitor::endXML ()
 
 
 /**
- * Check a yes/no flag, with default.
+ * Set/unset a yes/no flag.
  */
-static bool
-checkFlag (const char * flag, const sg_location& location,
-           bool defaultState = true)
+static void
+setFlag( int& mode,
+         int mask,
+         const std::string& flag,
+         const sg_location& location )
 {
-  if (flag == 0)
-    return defaultState;
-  else if (!strcmp(flag, "y"))
-    return true;
-  else if (!strcmp(flag, "n"))
-    return false;
-  else {
+  if( flag == "y" )
+    mode |= mask;
+  else if( flag == "n" )
+    mode &= ~mask;
+  else
+  {
     string message = "Unrecognized flag value '";
     message += flag;
     message += '\'';
@@ -170,7 +179,7 @@ PropsVisitor::startElement (const char * name, const XMLAttributes &atts)
       throw sg_io_exception(message, location, "SimGear Property Reader");
     }
 
-                               // Check for an include.
+    // Check for an include.
     attval = atts.getValue("include");
     if (attval != 0) {
       try {
@@ -193,7 +202,8 @@ PropsVisitor::startElement (const char * name, const XMLAttributes &atts)
 
   else {
     State &st = state();
-                               // Get the index.
+
+    // Get the index.
     attval = atts.getValue("n");
     int index = 0;
     string strName(name);
@@ -205,7 +215,7 @@ PropsVisitor::startElement (const char * name, const XMLAttributes &atts)
       st.counters[strName]++;
     }
 
-                               // Got the index, so grab the node.
+    // Got the index, so grab the node.
     SGPropertyNode * node = st.node->getChild(strName, index, true);
     if (!node->getAttribute(SGPropertyNode::WRITE)) {
       SG_LOG(SG_INPUT, SG_ALERT, "Not overwriting write-protected property "
@@ -213,69 +223,90 @@ PropsVisitor::startElement (const char * name, const XMLAttributes &atts)
       node = &null;
     }
 
-                               // Get the access-mode attributes,
-                               // but don't set yet (in case they
-                               // prevent us from recording the value).
-    int mode = _default_mode;
-
-    attval = atts.getValue("read");
-    if (checkFlag(attval, location, true))
-      mode |= SGPropertyNode::READ;
-    attval = atts.getValue("write");
-    if (checkFlag(attval, location, true))
-      mode |= SGPropertyNode::WRITE;
-    attval = atts.getValue("archive");
-    if (checkFlag(attval, location, false))
-      mode |= SGPropertyNode::ARCHIVE;
-    attval = atts.getValue("trace-read");
-    if (checkFlag(attval, location, false))
-      mode |= SGPropertyNode::TRACE_READ;
-    attval = atts.getValue("trace-write");
-    if (checkFlag(attval, location, false))
-      mode |= SGPropertyNode::TRACE_WRITE;
-    attval = atts.getValue("userarchive");
-    if (checkFlag(attval, location, false))
-      mode |= SGPropertyNode::USERARCHIVE;
-    attval = atts.getValue("preserve");
-    if (checkFlag(attval, location, false))
-      mode |= SGPropertyNode::PRESERVE;
-
-                               // Check for an alias.
-    attval = atts.getValue("alias");
-    if (attval != 0) {
-      if (!node->alias(attval))
-       SG_LOG(SG_INPUT, SG_ALERT, "Failed to set alias to " << attval
-               << "\n at " << location.asString());
-    }
+    // TODO use correct default mode (keep for now to match past behavior)
+    int mode = _default_mode | SGPropertyNode::READ | SGPropertyNode::WRITE;
+    int omit = false;
+    const char* type = 0;
 
-                               // Check for an include.
-    bool omit = false;
-    attval = atts.getValue("include");
-    if (attval != 0) {
-      try {
-          SGPath path = simgear::ResourceManager::instance()->findPath(attval, SGPath(_base).dir());
+    SGPropertyNode* attr_node = NULL;
+
+    for(int i = 0; i < atts.size(); ++i)
+    {
+      const std::string att_name = atts.getName(i);
+      const std::string val = atts.getValue(i);
+
+      // Get the access-mode attributes,
+      // but don't set yet (in case they
+      // prevent us from recording the value).
+      if( att_name == "read" )
+        setFlag(mode, SGPropertyNode::READ, val, location);
+      else if( att_name == "write" )
+        setFlag(mode, SGPropertyNode::WRITE, val, location);
+      else if( att_name == "archive" )
+        setFlag(mode, SGPropertyNode::ARCHIVE, val, location);
+      else if( att_name == "trace-read" )
+        setFlag(mode, SGPropertyNode::TRACE_READ, val, location);
+      else if( att_name == "trace-write" )
+        setFlag(mode, SGPropertyNode::TRACE_WRITE, val, location);
+      else if( att_name == "userarchive" )
+        setFlag(mode, SGPropertyNode::USERARCHIVE, val, location);
+      else if( att_name == "preserve" )
+        setFlag(mode, SGPropertyNode::PRESERVE, val, location);
+
+      // Check for an alias.
+      else if( att_name == "alias" )
+      {
+        if( !node->alias(val) )
+          SG_LOG
+          (
+            SG_INPUT,
+            SG_ALERT,
+            "Failed to set alias to " << val << "\n at " << location.asString()
+          );
+      }
+
+      // Check for an include.
+      else if( att_name == "include" )
+      {
+        try
+        {
+          SGPath path = simgear::ResourceManager::instance()
+                      ->findPath(val, SGPath(_base).dir());
           if (path.isNull())
           {
-              string message ="Cannot open file ";
-              message += attval;
-              throw sg_io_exception(message, location,
-                                    "SimGear Property Reader");
+            string message ="Cannot open file ";
+            message += val;
+            throw sg_io_exception(message, location, "SimGear Property Reader");
           }
           readProperties(path.str(), node, 0, _extended);
-      } catch (sg_io_exception &e) {
+        }
+        catch (sg_io_exception &e)
+        {
           setException(e);
+        }
       }
 
-      attval = atts.getValue("omit-node");
-      omit = checkFlag(attval, location, false);
-    }
+      else if( att_name == "omit-node" )
+        setFlag(omit, 1, val, location);
+      else if( att_name == "type" )
+      {
+        type = atts.getValue(i);
+
+        // if a type is given and the node is tied,
+        // don't clear the value because
+        // clearValue() unties the property
+        if( !node->isTied() )
+          node->clearValue();
+      }
+      else if( att_name != "n" )
+      {
+        // Store all additional attributes in a special node named _attr_
+        if( !attr_node )
+          attr_node = node->getChild(ATTR, 0, true);
 
-    const char *type = atts.getValue("type");
-    // if a type is given and the node is tied,
-    // don't clear the value because
-    // clearValue() unties the property
-    if (type && false == node->isTied() )
-      node->clearValue();
+        attr_node->setUnspecifiedValue(att_name.c_str(), val.c_str());
+      }
+    }
     push_state(node, type, mode, omit);
   }
 }
@@ -287,14 +318,15 @@ PropsVisitor::endElement (const char * name)
   bool ret;
   const sg_location location(getPath(), getLine(), getColumn());
 
-                               // 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 there are no children and it's
+  // not an alias, then it's a leaf value.
+  if( !st.hasChildren() && !st.node->isAlias() )
+  {
     if (st.type == "bool") {
       if (_data == "true" || atoi(_data.c_str()) != 0)
-       ret = st.node->setBoolValue(true);
+        ret = st.node->setBoolValue(true);
       else
-       ret = st.node->setBoolValue(false);
+        ret = st.node->setBoolValue(false);
     } else if (st.type == "int") {
       ret = st.node->setIntValue(atoi(_data.c_str()));
     } else if (st.type == "long") {
@@ -319,19 +351,24 @@ PropsVisitor::endElement (const char * name)
       string message = "Unrecognized data type '";
       message += st.type;
       message += '\'';
-                               // FIXME: add location information
+      // FIXME: add location information
       throw sg_io_exception(message, location, "SimGear Property Reader");
     }
-    if (!ret)
-      SG_LOG(SG_INPUT, SG_ALERT, "readProperties: Failed to set "
-            << st.node->getPath() << " to value \""
-            << _data << "\" with type " << st.type << "\n at "
-             << location.asString());
+    if( !ret )
+      SG_LOG
+      (
+        SG_INPUT,
+        SG_ALERT,
+        "readProperties: Failed to set " << st.node->getPath()
+                         << " to value \"" << _data
+                         << "\" with type " << st.type
+                         << "\n at " << location.asString()
+      );
   }
 
-                               // Set the access-mode attributes now,
-                               // once the value has already been 
-                               // assigned.
+  // Set the access-mode attributes now,
+  // once the value has already been
+  // assigned.
   st.node->setAttributes(st.mode);
 
   if (st.omit) {
@@ -345,7 +382,7 @@ PropsVisitor::endElement (const char * name)
       SGPropertyNode *dst = parent.node->getChild(name, index, true);
       copyProperties(src, dst);
     }
-    parent.node->removeChild(st.node->getName(), st.node->getIndex(), false);
+    parent.node->removeChild(st.node->getName(), st.node->getIndex());
   }
   pop_state();
 }
@@ -353,7 +390,7 @@ PropsVisitor::endElement (const char * name)
 void
 PropsVisitor::data (const char * s, int length)
 {
-  if (state().node->nChildren() == 0)
+  if( !state().hasChildren() )
     _data.append(string(s, length));
 }
 
@@ -365,7 +402,6 @@ PropsVisitor::warning (const char * message, int line, int column)
 }
 
 
-\f
 ////////////////////////////////////////////////////////////////////////
 // Property list reader.
 ////////////////////////////////////////////////////////////////////////
@@ -426,7 +462,7 @@ void readProperties (const char *buf, const int size,
     throw visitor.getException();
 }
 
-\f
+
 ////////////////////////////////////////////////////////////////////////
 // Property list writer.
 ////////////////////////////////////////////////////////////////////////
@@ -505,13 +541,41 @@ doIndent (ostream &output, int indent)
 
 
 static void
-writeAtts (ostream &output, const SGPropertyNode * node, bool forceindex)
+writeAtts( std::ostream &output,
+           const SGPropertyNode* node,
+           bool forceindex,
+           const SGPropertyNode* attr = NULL )
 {
   int index = node->getIndex();
 
   if (index != 0 || forceindex)
     output << " n=\"" << index << '"';
 
+  if( attr )
+    for(int i = 0; i < attr->nChildren(); ++i)
+    {
+      output << ' ' << attr->getChild(i)->getName() << "=\"";
+
+      const std::string data = attr->getChild(i)->getStringValue();
+      for(int j = 0; j < (int)data.size(); ++j)
+      {
+        switch(data[j])
+        {
+          case '"':
+            output << "\\\"";
+            break;
+          case '\\':
+            output << "\\\\";
+            break;
+          default:
+            output << data[i];
+            break;
+        }
+      }
+
+      output << '"';
+    }
+
 #if 0
   if (!node->getAttribute(SGPropertyNode::READ))
     output << " read=\"n\"";
@@ -546,31 +610,37 @@ isArchivable (const SGPropertyNode * node, SGPropertyNode::Attribute archive_fla
 
 
 static bool
-writeNode (ostream &output, const SGPropertyNode * node,
-           bool write_all, int indent, SGPropertyNode::Attribute archive_flag)
+writeNode( std::ostream &output,
+           const SGPropertyNode * node,
+           bool write_all,
+           int indent,
+           SGPropertyNode::Attribute archive_flag )
 {
-                               // Don't write the node or any of
-                               // its descendants unless it is
-                               // allowed to be archived.
+  // Don't write the node or any of
+  // its descendants unless it is
+  // allowed to be archived.
   if (!write_all && !isArchivable(node, archive_flag))
-    return true;               // Everything's OK, but we won't write.
+    return true; // Everything's OK, but we won't write.
 
   const string name = node->getName();
   int nChildren = node->nChildren();
-  bool node_has_value = false;
+  const SGPropertyNode* attr_node = node->getChild(ATTR, 0);
+  bool attr_written = false,
+       node_has_value = false;
 
-                               // If there is a literal value,
-                               // write it first.
+  // If there is a literal value,
+  // write it first.
   if (node->hasValue() && (write_all || node->getAttribute(archive_flag))) {
     doIndent(output, indent);
     output << '<' << name;
-    writeAtts(output, node, nChildren != 0);
+    writeAtts(output, node, nChildren != 0, attr_node);
+    attr_written = true;
     if (node->isAlias() && node->getAliasTarget() != 0) {
       output << " alias=\"" << node->getAliasTarget()->getPath()
-            << "\"/>" << endl;
+       << "\"/>" << endl;
     } else {
       if (node->getType() != simgear::props::UNSPECIFIED)
-       output << " type=\"" << getTypeName(node->getType()) << '"';
+        output << " type=\"" << getTypeName(node->getType()) << '"';
       output << '>';
       writeData(output, node->getStringValue());
       output << "</" << name << '>' << endl;
@@ -578,14 +648,22 @@ writeNode (ostream &output, const SGPropertyNode * node,
     node_has_value = true;
   }
 
-                               // If there are children, write them next.
-  if (nChildren > 0) {
+  // If there are children, write them next.
+  if( nChildren > (attr_node ? 1 : 0) )
+  {
     doIndent(output, indent);
     output << '<' << name;
-    writeAtts(output, node, node_has_value);
+    writeAtts(output, node, node_has_value, attr_written ? attr_node : NULL);
     output << '>' << endl;
-    for (int i = 0; i < nChildren; i++)
-      writeNode(output, node->getChild(i), write_all, indent + INDENT_STEP, archive_flag);
+    for(int i = 0; i < nChildren; i++)
+    {
+      if( node->getChild(i)->getNameString() != ATTR )
+        writeNode( output,
+                   node->getChild(i),
+                   write_all,
+                   indent + INDENT_STEP,
+                   archive_flag );
+    }
     doIndent(output, indent);
     output << "</" << name << '>' << endl;
   }
@@ -616,7 +694,7 @@ writeProperties (const string &file, const SGPropertyNode * start_node,
                  bool write_all, SGPropertyNode::Attribute archive_flag)
 {
   SGPath path(file.c_str());
-  path.create_dir(0777);
+  path.create_dir(0755);
 
   ofstream output(file.c_str());
   if (output.good()) {
@@ -634,7 +712,6 @@ writeProperties (const char* file, const SGPropertyNode * start_node)
 }
 
 
-\f
 ////////////////////////////////////////////////////////////////////////
 // Copy properties from one tree to another.
 ////////////////////////////////////////////////////////////////////////
@@ -703,16 +780,11 @@ copyPropertyValue(const SGPropertyNode *in, SGPropertyNode *out)
  * 
  * @param in The source property tree.
  * @param out The destination property tree.
- * @param attr_value Only copy properties with given attribute values.
- * @param attr_mask  Mask for attributes to be considered by attr_value
- *                   (default is 0 = attributes not considered, all
- *                   properties copied).
  * @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,
-                int attr_value, int attr_mask)
+copyProperties (const SGPropertyNode *in, SGPropertyNode *out)
 {
   using namespace simgear;
   bool retval = copyPropertyValue(in, out);
@@ -727,14 +799,7 @@ copyProperties (const SGPropertyNode *in, SGPropertyNode *out,
   int nChildren = in->nChildren();
   for (int i = 0; i < nChildren; i++) {
     const SGPropertyNode * in_child = in->getChild(i);
-    int mask = attr_mask;
-    /* attributes have no meaning for nodes without values - except
-     * the PRESERVE flag. So ignore them. */
-    if (!in_child->hasValue())
-        mask &= SGPropertyNode::PRESERVE;
-    if ((in_child->getAttributes() & mask) == (attr_value & mask))
-    {
-      SGPropertyNode * out_child = out->getChild(in_child->getNameString(),
+    SGPropertyNode * out_child = out->getChild(in_child->getNameString(),
                              in_child->getIndex(),
                              false);
       if (!out_child)
@@ -743,18 +808,9 @@ copyProperties (const SGPropertyNode *in, SGPropertyNode *out,
                                     in_child->getIndex(),
                                     true);
       }
-      else
-      {
-          mask = attr_mask;
-          if (!out_child->hasValue())
-              mask &= SGPropertyNode::PRESERVE;
-          if ((out_child->getAttributes() & mask) != (attr_value & mask))
-              out_child = NULL;
-      }
-      if (out_child &&
-          (!copyProperties(in_child, out_child, attr_value, attr_mask)))
+
+      if (out_child && !copyProperties(in_child, out_child))
           retval = false;
-    }
   }
 
   return retval;