]> git.mxchange.org Git - simgear.git/blobdiff - simgear/props/props.hxx
Refactor Canvas and add some helpers.
[simgear.git] / simgear / props / props.hxx
index 984bb1b5717b37657b03ff9db88714910a39ca4c..f2692710de76cf13d9043d68c8132d8a9944b9d1 100644 (file)
@@ -63,13 +63,6 @@ inline T parseString(const std::string& str)
     return result;
 }
 
-// Extended properties
-template<>
-std::istream& readFrom<SGVec3d>(std::istream& stream, SGVec3d& result);
-template<>
-std::istream& readFrom<SGVec4d>(std::istream& stream, SGVec4d& result);
-
-    
 /**
  * Property value types.
  */
@@ -164,25 +157,11 @@ DEFINTERNALPROP(const char *, STRING);
 DEFINTERNALPROP(const char[], STRING);
 #undef DEFINTERNALPROP
 
-template<>
-struct PropertyTraits<SGVec3d>
-{
-    static const Type type_tag = VEC3D;
-    enum  { Internal = 0 };
-};
-
-template<>
-struct PropertyTraits<SGVec4d>
-{
-    static const Type type_tag = VEC4D;
-    enum  { Internal = 0 };
-};
 }
 }
 
 
 
-\f
 ////////////////////////////////////////////////////////////////////////
 // A raw value.
 //
@@ -689,12 +668,6 @@ std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
     return stream;
 }
 
-template<>
-std::ostream& SGRawBase<SGVec3d>::printOn(std::ostream& stream) const;
-template<>
-std::ostream& SGRawBase<SGVec4d>::printOn(std::ostream& stream) const;
-
-\f
 /**
  * The smart pointer that manage reference counting
  */
@@ -707,7 +680,6 @@ namespace simgear
 typedef std::vector<SGPropertyNode_ptr> PropertyList;
 }
 
-\f
 /**
  * The property change listener interface.
  *
@@ -732,7 +704,6 @@ private:
 };
 
 
-\f
 /**
  * A node in a property tree.
  */
@@ -760,7 +731,10 @@ public:
     REMOVED = 8,
     TRACE_READ = 16,
     TRACE_WRITE = 32,
-    USERARCHIVE = 64
+    USERARCHIVE = 64,
+    PRESERVE = 128
+    // beware: if you add another attribute here,
+    // also update value of "LAST_USED_ATTRIBUTE".
   };
 
 
@@ -770,7 +744,6 @@ public:
    */
   static const int LAST_USED_ATTRIBUTE;
 
-
   /**
    * Default constructor.
    */
@@ -874,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.
@@ -994,7 +990,7 @@ public:
   /**
    * Get the path to this node from the root.
    */
-  const char * getPath (bool simplify = false) const;
+  std::string getPath (bool simplify = false) const;
 
 
   /**
@@ -1166,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.
    */
@@ -1587,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.
@@ -1658,15 +1683,6 @@ private:
    */
   void trace_write () const;
 
-
-  /**
-   * Remove this node from all nodes that link to it in their path cache.
-   */
-  void remove_from_path_caches();
-
-
-  class hash_table;
-
   int _index;
   std::string _name;
   /// To avoid cyclic reference counting loops this shall not be a reference
@@ -1674,10 +1690,7 @@ private:
   SGPropertyNode * _parent;
   simgear::PropertyList _children;
   simgear::PropertyList _removedChildren;
-  std::vector<hash_table *> _linkedNodes;
-  mutable std::string _path;
   mutable std::string _buffer;
-  hash_table * _path_cache;
   simgear::props::Type _type;
   bool _tied;
   int _attr;
@@ -1699,66 +1712,6 @@ private:
 
   std::vector<SGPropertyChangeListener *> * _listeners;
 
-
-  /**
-   * Register/unregister node that links to this node in its path cache.
-   */
-  void add_linked_node (hash_table * node) { _linkedNodes.push_back(node); }
-  bool remove_linked_node (hash_table * node);
-
-
-\f
-  /**
-   * A very simple hash table.
-   */
-  class hash_table {
-  public:
-
-    /**
-     * An entry in a bucket in a hash table.
-     */
-    class entry {
-    public:
-      entry ();
-      ~entry ();
-      const char * get_key () { return _key.c_str(); }
-      void set_key (const char * key);
-      SGPropertyNode * get_value () { return _value; }
-      void set_value (SGPropertyNode * value);
-    private:
-      std::string _key;
-      SGSharedPtr<SGPropertyNode> _value;
-    };
-
-
-    /**
-     * A bucket in a hash table.
-     */
-    class bucket {
-    public:
-      bucket ();
-      ~bucket ();
-      entry * get_entry (const char * key, bool create = false);
-      bool erase (SGPropertyNode * node);
-      void clear (hash_table * owner);
-    private:
-      int _length;
-      entry ** _entries;
-    };
-
-    friend class bucket;
-
-    hash_table ();
-    ~hash_table ();
-    SGPropertyNode * get (const char * key);
-    void put (const char * key, SGPropertyNode * value);
-    bool erase (SGPropertyNode * node);
-
-  private:
-    unsigned int hashcode (const char * key);
-    unsigned int _data_length;
-    bucket ** _data;
-  };
   // Pass name as a pair of iterators
   template<typename Itr>
   SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false);
@@ -1857,8 +1810,12 @@ bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
         _type = EXTENDED;
     _tied = true;
     _value.val = rawValue.clone();
-    if (useDefault)
+    if (useDefault) {
+        int save_attributes = getAttributes();
+        setAttribute( WRITE, true );
         setValue(old_val);
+        setAttributes( save_attributes );
+    }
     return true;
 }
 
@@ -1901,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
@@ -2002,6 +1978,36 @@ struct Hash
 };
 }
 }
+
+/** Convenience class for change listener callbacks without
+ * creating a derived class implementing a "valueChanged" method.
+ * Also removes listener on destruction automatically.
+ */
+template<class T>
+class SGPropertyChangeCallback
+    : public SGPropertyChangeListener
+{
+public:
+    SGPropertyChangeCallback(T* obj, void (T::*method)(SGPropertyNode*),
+                             SGPropertyNode_ptr property,bool initial=false)
+        : _obj(obj), _callback(method), _property(property)
+    {
+        _property->addChangeListener(this,initial);
+    }
+    virtual ~SGPropertyChangeCallback()
+    {
+        _property->removeChangeListener(this);
+    }
+    void valueChanged (SGPropertyNode * node)
+    {
+        (_obj->*_callback)(node);
+    }
+private:
+    T* _obj;
+    void (T::*_callback)(SGPropertyNode*);
+    SGPropertyNode_ptr _property;
+};
+
 #endif // __PROPS_HXX
 
 // end of props.hxx