]> git.mxchange.org Git - simgear.git/blobdiff - simgear/misc/props.hxx
MSVC++ bug work-around from Frederic Bouvier.
[simgear.git] / simgear / misc / props.hxx
index bad1ba0fd5339980f5a7c8791fb71132d3cc34de..b4a429974c5b5ea485a10d4ed47b2f474949ccb9 100644 (file)
 #ifndef __PROPS_HXX
 #define __PROPS_HXX
 
-#include <simgear/compiler.h>
-#include <simgear/debug/logstream.hxx>
+#ifndef PROPS_STANDALONE
+#define PROPS_STANDALONE 0
+#endif
+
+#include <vector>
+
+#if PROPS_STANDALONE
+
+#include <string>
+#include <iostream>
+
+using std::string;
+using std::vector;
+using std::istream;
+using std::ostream;
 
-#include <stdio.h>
+#else
 
+#include <simgear/compiler.h>
+#include <simgear/debug/logstream.hxx>
 #include STL_STRING
-#include <vector>
-#include <map>
 #include STL_IOSTREAM
-
 SG_USING_STD(string);
 SG_USING_STD(vector);
-SG_USING_STD(map);
 #if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
 SG_USING_STD(istream);
 SG_USING_STD(ostream);
 #endif
 
+#endif
+
+
 #ifdef NONE
 #pragma warn A sloppy coder has defined NONE as a macro!
 #undef NONE
@@ -435,6 +449,100 @@ private:
   setter_t _setter;
 };
 
+\f
+/**
+ * The smart pointer that manage reference counting
+ */
+class SGPropertyNode;
+class SGPropertyNode_ptr
+{
+public:
+
+  /**
+   * Default constructor
+   */
+  SGPropertyNode_ptr();
+
+  /**
+   * Copy constructor
+   */
+  SGPropertyNode_ptr( const SGPropertyNode_ptr &r );
+
+  /**
+   * Constructor from a pointer to a node
+   */
+  SGPropertyNode_ptr( SGPropertyNode *p );
+
+  /**
+   * Destructor
+   */
+  ~SGPropertyNode_ptr();
+
+  /**
+   * Assignement operator
+   */
+  SGPropertyNode_ptr &operator=( const SGPropertyNode_ptr &r );
+
+  /**
+   * Pointer access operator
+   */
+  SGPropertyNode *operator->();
+
+  /**
+   * Pointer access operator (const)
+   */
+  const SGPropertyNode *operator->() const;
+
+  /**
+   * Conversion to SGPropertyNode * operator
+   */
+  operator SGPropertyNode *();
+
+  /**
+   * Conversion to const SGPropertyNode * operator
+   */
+  operator const SGPropertyNode *() const;
+
+  /**
+   * Return the pointer.
+   */
+  SGPropertyNode * ptr () { return _ptr; }
+
+  /**
+   * Validity test
+   */
+  bool valid() const;
+
+private:
+
+  SGPropertyNode *_ptr;
+};
+
+
+\f
+/**
+ * The property change listener interface.
+ *
+ * <p>Any class that needs to listen for property changes must implement
+ * this interface.</p>
+ */
+class SGPropertyChangeListener
+{
+public:
+  virtual ~SGPropertyChangeListener ();
+  virtual void valueChanged (SGPropertyNode * node);
+  virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child);
+  virtual void childRemoved (SGPropertyNode * parent, SGPropertyNode * child);
+
+protected:
+  friend class SGPropertyNode;
+  virtual void register_property (SGPropertyNode * node);
+  virtual void unregister_property (SGPropertyNode * node);
+
+private:
+  vector<SGPropertyNode *> _properties;
+};
+
 
 \f
 /**
@@ -444,6 +552,13 @@ class SGPropertyNode
 {
 public:
 
+  /**
+   * Public constants.
+   */
+  enum {
+    MAX_STRING_LEN = 1024
+  };
+
   /**
    * Property value types.
    */
@@ -470,11 +585,19 @@ public:
     READ = 1,
     WRITE = 2,
     ARCHIVE = 4,
-    TRACE_READ = 8,
-    TRACE_WRITE = 16
+    REMOVED = 8,
+    TRACE_READ = 16,
+    TRACE_WRITE = 32
   };
 
 
+  /**
+   * Last used attribute
+   * Update as needed when enum Attribute is changed
+   */
+  static const int LAST_USED_ATTRIBUTE;
+
+
   /**
    * Default constructor.
    */
@@ -507,13 +630,13 @@ public:
   /**
    * Get the node's simple (XML) name.
    */
-  const string &getName () const { return _name; }
+  const char * getName () const { return _name; }
 
 
   /**
    * Get the node's integer index.
    */
-  const int getIndex () const { return _index; }
+  int getIndex () const { return _index; }
 
 
   /**
@@ -536,7 +659,7 @@ public:
   /**
    * Get the number of child nodes.
    */
-  const int nChildren () const { return _children.size(); }
+  int nChildren () const { return _children.size(); }
 
 
   /**
@@ -554,26 +677,27 @@ public:
   /**
    * Get a child node by name and index.
    */
-  SGPropertyNode * getChild (const string &name, int index = 0,
+  SGPropertyNode * getChild (const char * name, int index = 0,
                             bool create = false);
 
 
   /**
    * Get a const child node by name and index.
    */
-  const SGPropertyNode * getChild (const string &name, int index = 0) const;
+  const SGPropertyNode * getChild (const char * name, int index = 0) const;
 
 
   /**
    * Get a vector of all children with the specified name.
    */
-  vector<SGPropertyNode *> getChildren (const string &name);
+  vector<SGPropertyNode_ptr> getChildren (const char * name) const;
 
 
   /**
-   * Get a vector all all children (const) with the specified name.
+   * Remove a child node
    */
-  vector<const SGPropertyNode *> getChildren (const string &name) const;
+  SGPropertyNode_ptr removeChild (const char * name, int index = 0,
+                                  bool keep = true);
 
 
   //
@@ -590,7 +714,7 @@ public:
   /**
    * Alias this node's leaf value to another's by relative path.
    */
-  bool alias (const string &path);
+  bool alias (const char * path);
 
 
   /**
@@ -625,7 +749,7 @@ public:
   /**
    * Get the path to this node from the root.
    */
-  string getPath (bool simplify = false) const;
+  const char * getPath (bool simplify = false) const;
 
 
   /**
@@ -643,7 +767,7 @@ public:
   /**
    * Get a pointer to another node by relative path.
    */
-  SGPropertyNode * getNode (const string &relative_path, bool create = false);
+  SGPropertyNode * getNode (const char * relative_path, bool create = false);
 
 
   /**
@@ -656,14 +780,14 @@ public:
    * provided overrides any given in the path itself for the last
    * component.
    */
-  SGPropertyNode * getNode (const string &relative_path, int index,
+  SGPropertyNode * getNode (const char * relative_path, int index,
                            bool create = false);
 
 
   /**
    * Get a const pointer to another node by relative path.
    */
-  const SGPropertyNode * getNode (const string &relative_path) const;
+  const SGPropertyNode * getNode (const char * relative_path) const;
 
 
   /**
@@ -672,7 +796,7 @@ public:
    * This method leaves the index off the last member of the path,
    * so that the user can specify it separate.
    */
-  const SGPropertyNode * getNode (const string &relative_path,
+  const SGPropertyNode * getNode (const char * relative_path,
                                  int index) const;
 
 
@@ -750,7 +874,7 @@ public:
   /**
    * Get a string value for this node.
    */
-  string getStringValue () const;
+  const char * getStringValue () const;
 
 
 
@@ -787,13 +911,13 @@ public:
   /**
    * Set a string value for this node.
    */
-  bool setStringValue (string value);
+  bool setStringValue (const char * value);
 
 
   /**
    * Set a value of unspecified type for this node.
    */
-  bool setUnspecifiedValue (string value);
+  bool setUnspecifiedValue (const char * value);
 
 
   //
@@ -840,7 +964,7 @@ public:
   /**
    * Bind this node to an external string source.
    */
-  bool tie (const SGRawValue<string> &rawValue, bool useDefault = true);
+  bool tie (const SGRawValue<const char *> &rawValue, bool useDefault = true);
 
 
   /**
@@ -858,160 +982,193 @@ public:
   /**
    * Get another node's type.
    */
-  Type getType (const string &relative_path) const;
+  Type getType (const char * relative_path) const;
 
 
   /**
    * Test whether another node has a leaf value.
    */
-  bool hasValue (const string &relative_path) const;
+  bool hasValue (const char * relative_path) const;
 
 
   /**
    * Get another node's value as a bool.
    */
-  bool getBoolValue (const string &relative_path,
+  bool getBoolValue (const char * relative_path,
                     bool defaultValue = false) const;
 
 
   /**
    * Get another node's value as an int.
    */
-  int getIntValue (const string &relative_path,
+  int getIntValue (const char * relative_path,
                   int defaultValue = 0) const;
 
 
   /**
    * Get another node's value as a long int.
    */
-  long getLongValue (const string &relative_path,
+  long getLongValue (const char * relative_path,
                     long defaultValue = 0L) const;
 
 
   /**
    * Get another node's value as a float.
    */
-  float getFloatValue (const string &relative_path,
+  float getFloatValue (const char * relative_path,
                       float defaultValue = 0.0) const;
 
 
   /**
    * Get another node's value as a double.
    */
-  double getDoubleValue (const string &relative_path,
+  double getDoubleValue (const char * relative_path,
                         double defaultValue = 0.0L) const;
 
 
   /**
    * Get another node's value as a string.
    */
-  string getStringValue (const string &relative_path,
-                        string defaultValue = "") const;
+  const char * getStringValue (const char * relative_path,
+                              const char * defaultValue = "") const;
 
 
   /**
    * Set another node's value as a bool.
    */
-  bool setBoolValue (const string &relative_path, bool value);
+  bool setBoolValue (const char * relative_path, bool value);
 
 
   /**
    * Set another node's value as an int.
    */
-  bool setIntValue (const string &relative_path, int value);
+  bool setIntValue (const char * relative_path, int value);
 
 
   /**
    * Set another node's value as a long int.
    */
-  bool setLongValue (const string &relative_path, long value);
+  bool setLongValue (const char * relative_path, long value);
 
 
   /**
    * Set another node's value as a float.
    */
-  bool setFloatValue (const string &relative_path, float value);
+  bool setFloatValue (const char * relative_path, float value);
 
 
   /**
    * Set another node's value as a double.
    */
-  bool setDoubleValue (const string &relative_path, double value);
+  bool setDoubleValue (const char * relative_path, double value);
 
 
   /**
    * Set another node's value as a string.
    */
-  bool setStringValue (const string &relative_path, string value);
+  bool setStringValue (const char * relative_path, const char * value);
 
 
   /**
    * Set another node's value with no specified type.
    */
-  bool setUnspecifiedValue (const string &relative_path, string value);
+  bool setUnspecifiedValue (const char * relative_path, const char * value);
 
 
   /**
    * Test whether another node is bound to an external data source.
    */
-  bool isTied (const string &relative_path) const;
+  bool isTied (const char * relative_path) const;
 
 
   /**
    * Bind another node to an external bool source.
    */
-  bool tie (const string &relative_path, const SGRawValue<bool> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<bool> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Bind another node to an external int source.
    */
-  bool tie (const string &relative_path, const SGRawValue<int> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<int> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Bind another node to an external long int source.
    */
-  bool tie (const string &relative_path, const SGRawValue<long> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<long> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Bind another node to an external float source.
    */
-  bool tie (const string &relative_path, const SGRawValue<float> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<float> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Bind another node to an external double source.
    */
-  bool tie (const string &relative_path, const SGRawValue<double> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<double> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Bind another node to an external string source.
    */
-  bool tie (const string &relative_path, const SGRawValue<string> &rawValue,
+  bool tie (const char * relative_path, const SGRawValue<const char *> &rawValue,
            bool useDefault = true);
 
 
   /**
    * Unbind another node from any external data source.
    */
-  bool untie (const string &relative_path);
+  bool untie (const char * relative_path);
+
+
+  /**
+   * Add a change listener to the property.
+   */
+  void addChangeListener (SGPropertyChangeListener * listener);
+
+
+  /**
+   * Remove a change listener from the property.
+   */
+  void removeChangeListener (SGPropertyChangeListener * listener);
+
+
+  /**
+   * Fire a value change event to all listeners.
+   */
+  void fireValueChanged ();
+
+
+  /**
+   * Fire a child-added event to all listeners.
+   */
+  void fireChildAdded (SGPropertyNode * child);
+
+
+  /**
+   * Fire a child-removed event to all listeners.
+   */
+  void fireChildRemoved (SGPropertyNode * child);
 
 
 protected:
 
+  void fireValueChanged (SGPropertyNode * node);
+  void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child);
+  void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child);
 
   /**
    * Protected constructor for making new nodes on demand.
    */
-  SGPropertyNode (const string &name, int index, SGPropertyNode * parent);
+  SGPropertyNode (const char * name, int index, SGPropertyNode * parent);
 
 
 private:
@@ -1022,7 +1179,7 @@ private:
   long get_long () const;
   float get_float () const;
   double get_double () const;
-  const string get_string () const;
+  const char * get_string () const;
 
                                // Set the raw value
   bool set_bool (bool value);
@@ -1030,7 +1187,7 @@ private:
   bool set_long (long value);
   bool set_float (float value);
   bool set_double (double value);
-  bool set_string (const string &value);
+  bool set_string (const char * value);
 
 
   /**
@@ -1042,7 +1199,7 @@ private:
   /**
    * Get the value as a string.
    */
-  string make_string () const;
+  const char * make_string () const;
 
 
   /**
@@ -1056,15 +1213,34 @@ private:
    */
   void trace_write () const;
 
-  string _name;
+
+  /**
+   * Increment reference counter
+   */
+  void incrementRef();
+
+  /**
+   * Decrement reference counter
+   */
+  int decrementRef();
+
+  friend class SGPropertyNode_ptr;
+
+
+  mutable char _buffer[MAX_STRING_LEN+1];
+
+  class hash_table;
+
+  char * _name;
   int _index;
   SGPropertyNode * _parent;
-  vector<SGPropertyNode *> _children;
-  typedef map<const string,SGPropertyNode *> cache_map;
-  cache_map * _path_cache;
+  vector<SGPropertyNode_ptr> _children;
+  vector<SGPropertyNode_ptr> _removedChildren;
+  hash_table * _path_cache;
   Type _type;
   bool _tied;
   int _attr;
+  int _count;
 
                                // The right kind of pointer...
   union {
@@ -1074,7 +1250,7 @@ private:
     SGRawValue<long> * long_val;
     SGRawValue<float> * float_val;
     SGRawValue<double> * double_val;
-    SGRawValue<string> * string_val;
+    SGRawValue<const char *> * string_val;
   } _value;
 
   union {
@@ -1083,9 +1259,61 @@ private:
     long long_val;
     float float_val;
     double double_val;
-    string * string_val;
+    char * string_val;
   } _local_val;
 
+  vector <SGPropertyChangeListener *> * _listeners;
+
+
+\f
+  /**
+   * A very simple hash table with no remove functionality.
+   */
+  class hash_table {
+  public:
+
+    /**
+     * An entry in a bucket in a hash table.
+     */
+    class entry {
+    public:
+      entry ();
+      virtual ~entry ();
+      virtual const char * get_key () { return _key; }
+      virtual void set_key (const char * key);
+      virtual SGPropertyNode * get_value () { return _value; }
+      virtual void set_value (SGPropertyNode * value);
+    private:
+      char * _key;
+      SGPropertyNode * _value;
+    };
+
+
+    /**
+     * A bucket in a hash table.
+     */
+    class bucket {
+    public:
+      bucket ();
+      virtual ~bucket ();
+      virtual entry * get_entry (const char * key, bool create = false);
+    private:
+      int _length;
+      entry ** _entries;
+    };
+
+    friend class bucket;
+
+    hash_table ();
+    virtual ~hash_table ();
+    virtual SGPropertyNode * get (const char * key);
+    virtual void put (const char * key, SGPropertyNode * value);
+
+  private:
+    unsigned int hashcode (const char * key);
+    unsigned int _data_length;
+    bucket ** _data;
+  };
 
 };