Refactor Canvas and add some helpers.

[simgear.git] / simgear / props / props.hxx

diff --git a/simgear/props/props.hxx b/simgear/props/props.hxx
index ff174c392505be037a6047426cf575a20bf15ab2..f2692710de76cf13d9043d68c8132d8a9944b9d1 100644 (file)
--- a/simgear/props/props.hxx
+++ b/simgear/props/props.hxx
@@ -162,7 +162,6 @@ DEFINTERNALPROP(const char[], STRING);
 
 
 
-\f
 ////////////////////////////////////////////////////////////////////////
 // A raw value.
 //
@@ -669,7 +668,6 @@ std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
     return stream;
 }
 
-\f
 /**
  * The smart pointer that manage reference counting
  */
@@ -682,7 +680,6 @@ namespace simgear
 typedef std::vector<SGPropertyNode_ptr> PropertyList;
 }
 
-\f
 /**
  * The property change listener interface.
  *
@@ -707,7 +704,6 @@ private:
 };
 
 
-\f
 /**
  * A node in a property tree.
  */
@@ -748,7 +744,6 @@ public:
    */
   static const int LAST_USED_ATTRIBUTE;
 
-
   /**
    * Default constructor.
    */
@@ -852,9 +847,32 @@ public:
   }
 
   /**
-   * Create a child node after the last node with the same name.
+   * Create a new child node with the given name and an unused index
+   *
+   * @param min_index Minimal index for new node (skips lower indices)
+   * @param append    Whether to simply use the index after the last used index
+   *                  or use a lower, unused index if it exists
+   */
+  SGPropertyNode * addChild ( const char* name,
+                              int min_index = 0,
+                              bool append = true );
+  SGPropertyNode * addChild ( const std::string& name,
+                              int min_index = 0,
+                              bool append = true )
+  { return addChild(name.c_str(), min_index, append); }
+
+  /**
+   * Create multiple child nodes with the given name an unused indices
+   *
+   * @param count     The number of nodes create
+   * @param min_index Minimal index for new nodes (skips lower indices)
+   * @param append    Whether to simply use the index after the last used index
+   *                  or use a lower, unused index if it exists
    */
-  SGPropertyNode * addChild (const char * name);
+  simgear::PropertyList addChildren ( const std::string& name,
+                                      size_t count,
+                                      int min_index = 0,
+                                      bool append = true );
 
   /**
    * Get a child node by name and index.
@@ -1144,6 +1162,18 @@ public:
   T getValue(typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
              ::type* dummy = 0) const;
 
+  /**
+   * Get a list of values from all children with the given name
+   */
+  template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
+  std::vector<T> getChildValues(const std::string& name) const;
+
+  /**
+   * Get a list of values from all children with the given name
+   */
+  template<typename T>
+  std::vector<T> getChildValues(const std::string& name) const;
+
   /**
    * Set a bool value for this node.
    */
@@ -1565,12 +1595,29 @@ public:
    */
   void fireChildAdded (SGPropertyNode * child);
 
+  /**
+   * Trigger a child-added and value-changed event for every child (Unlimited
+   * depth) and the node itself.
+   *
+   * It can be used to simulating the creation of a property tree, eg. for
+   * (re)initializing a subsystem which is controlled through the property tree.
+   */
+  void fireCreatedRecursive();
 
   /**
    * Fire a child-removed event to all listeners.
    */
   void fireChildRemoved (SGPropertyNode * child);
 
+  /**
+   * Fire a child-removed event for every child of this node (Unlimited depth)
+   *
+   * Upon removal of a child node only for this single node a child-removed
+   * event is triggered. If eg. resource cleanup relies on receiving a
+   * child-removed event for every child this method can be used.
+   */
+  void fireChildrenRemovedRecursive();
+
 
   /**
    * Clear any existing value and set the type to NONE.
@@ -1665,7 +1712,6 @@ private:
 
   std::vector<SGPropertyChangeListener *> * _listeners;
 
-\f
   // Pass name as a pair of iterators
   template<typename Itr>
   SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false);
@@ -1812,6 +1858,25 @@ inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
   return ::getValue<T>(this);
 }
 
+template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
+std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
+{
+  const simgear::PropertyList& props = getChildren(name);
+  std::vector<T> values( props.size() );
+
+  for( size_t i = 0; i < props.size(); ++i )
+    values[i] = props[i]->getValue<T_get>();
+
+  return values;
+}
+
+template<typename T>
+inline
+std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
+{
+  return getChildValues<T, T>(name);
+}
+
 template<typename T>
 bool SGPropertyNode::setValue(const T& val,
                               typename boost::disable_if_c<simgear::props