#endif
#include <vector>
+#include <string>
+#include <iostream>
+#include <sstream>
+#include <typeinfo>
+#include <simgear/compiler.h>
#if PROPS_STANDALONE
+// taken from: boost/utility/enable_if.hpp
+#ifndef SG_LOG
+# define SG_GENERAL 0
+# define SG_ALERT 0
+# define SG_WARN 1
+# define SG_LOG(type, level, message) (type) ? (std::cerr <<message << endl) : (std::cout <<message << endl)
+#endif
+namespace boost {
+ template <bool B, class T = void>
+ struct enable_if_c {
+ typedef T type;
+ };
-#include <string>
-#include <iostream>
+ template <class T>
+ struct enable_if_c<false, T> {};
-using std::string;
-using std::vector;
-using std::istream;
-using std::ostream;
+ template <class Cond, class T = void>
+ struct enable_if : public enable_if_c<Cond::value, T> {};
-#else
+ template <bool B, class T = void>
+ struct disable_if_c {
+ typedef T type;
+ };
-#include <simgear/compiler.h>
-#include <simgear/debug/logstream.hxx>
-#include STL_STRING
-#include STL_IOSTREAM
-SG_USING_STD(string);
-SG_USING_STD(vector);
-SG_USING_STD(istream);
-SG_USING_STD(ostream);
+ template <class T>
+ struct disable_if_c<true, T> {};
+
+ template <class Cond, class T = void>
+ struct disable_if : public disable_if_c<Cond::value, T> {};
+}
+#else
+# include <boost/utility.hpp>
+# include <boost/type_traits/is_enum.hpp>
+# include <simgear/debug/logstream.hxx>
+# include <simgear/math/SGMathFwd.hxx>
+# include <simgear/math/sg_types.hxx>
#endif
+#include <simgear/structure/SGReferenced.hxx>
+#include <simgear/structure/SGSharedPtr.hxx>
+// XXX This whole file should be in the simgear namespace, but I don't
+// have the guts yet...
+
+using namespace std;
+
+namespace simgear
+{
+
+ class PropertyInterpolationMgr;
+
+template<typename T>
+std::istream& readFrom(std::istream& stream, T& result)
+{
+ stream >> result;
+ return stream;
+}
+
+/**
+ * Parse a string as an object of a given type.
+ * XXX no error behavior yet.
+ *
+ * @tparam T the return type
+ * @param str the string
+ * @return the object.
+ */
+template<typename T>
+inline T parseString(const std::string& str)
+{
+ std::istringstream stream(str);
+ T result;
+ readFrom(stream, result);
+ return result;
+}
+
+/**
+ * Property value types.
+ */
#ifdef NONE
#pragma warn A sloppy coder has defined NONE as a macro!
#undef STRING
#endif
+namespace props
+{
+/**
+ * The possible types of an SGPropertyNode. Types that appear after
+ * EXTENDED are not stored in the SGPropertyNode itself.
+ */
+enum Type {
+ NONE = 0, /**< The node hasn't been assigned a value yet. */
+ ALIAS, /**< The node "points" to another node. */
+ BOOL,
+ INT,
+ LONG,
+ FLOAT,
+ DOUBLE,
+ STRING,
+ UNSPECIFIED,
+ EXTENDED, /**< The node's value is not stored in the property;
+ * the actual value and type is retrieved from an
+ * SGRawValue node. This type is never returned by @see
+ * SGPropertyNode::getType.
+ */
+ // Extended properties
+ VEC3D,
+ VEC4D
+};
+
+template<typename T> struct PropertyTraits;
+
+#define DEFINTERNALPROP(TYPE, PROP) \
+template<> \
+struct PropertyTraits<TYPE> \
+{ \
+ static const Type type_tag = PROP; \
+ enum { Internal = 1 }; \
+}
+
+DEFINTERNALPROP(bool, BOOL);
+DEFINTERNALPROP(int, INT);
+DEFINTERNALPROP(long, LONG);
+DEFINTERNALPROP(float, FLOAT);
+DEFINTERNALPROP(double, DOUBLE);
+DEFINTERNALPROP(const char *, STRING);
+DEFINTERNALPROP(const char[], STRING);
+#undef DEFINTERNALPROP
+
+}
+}
+
+
-\f
////////////////////////////////////////////////////////////////////////
// A raw value.
//
// a small performance hit for that.
////////////////////////////////////////////////////////////////////////
+/**
+ * Base class for SGRawValue classes that holds no type
+ * information. This allows some generic manipulation of the
+ * SGRawValue object.
+ */
+class SGRaw
+{
+public:
+ /**
+ * Get the type enumeration for the raw value.
+ *
+ * @return the type.
+ */
+ virtual simgear::props::Type getType() const = 0;
+ virtual ~SGRaw() {}
+
+ /**
+ * Create a new deep copy of this raw value.
+ *
+ * The copy will contain its own version of the underlying value
+ * as well, and will be the same type.
+ *
+ * @return A deep copy of the current object.
+ */
+ virtual SGRaw* clone() const = 0;
+
+};
+
+class SGRawExtended : public SGRaw
+{
+public:
+ /**
+ * Make an SGRawValueContainer from the SGRawValue.
+ *
+ * This is a virtual function of SGRawExtended so that
+ * SGPropertyNode::untie doesn't need to know the type of an
+ * extended property.
+ */
+ virtual SGRawExtended* makeContainer() const = 0;
+ /**
+ * Write value out to a stream
+ */
+ virtual std::ostream& printOn(std::ostream& stream) const = 0;
+ /**
+ * Read value from a stream and store it.
+ */
+ virtual std::istream& readFrom(std::istream& stream) = 0;
+};
+
+// Choose between different base classes based on whether the value is
+// stored internal to the property node. This frees us from defining
+// the virtual functions in the SGRawExtended interface where they
+// don't make sense, e.g. readFrom for the const char* type.
+template<typename T, int internal = simgear::props::PropertyTraits<T>::Internal>
+class SGRawBase;
+
+template<typename T>
+class SGRawBase<T, 1> : public SGRaw
+{
+};
+
+template<typename T>
+class SGRawBase<T, 0> : public SGRawExtended
+{
+ virtual SGRawExtended* makeContainer() const;
+ virtual std::ostream& printOn(std::ostream& stream) const;
+ virtual std::istream& readFrom(std::istream& stream);
+};
/**
* Abstract base class for a raw value.
*
- * <p>The property manager is implemented in two layers. The {@link
- * SGPropertyNode} is the highest and most abstract layer,
- * representing an LValue/RValue pair: it records the position of the
- * property in the property tree and contains facilities for
- * navigation to other nodes. It is guaranteed to be persistent: the
- * {@link SGPropertyNode} will not change during a session, even if
- * the property is bound and unbound multiple times.</p>
+ * The property manager is implemented in two layers. The SGPropertyNode is the
+ * highest and most abstract layer, representing an LValue/RValue pair: it
+ * records the position of the property in the property tree and contains
+ * facilities for navigation to other nodes. It is guaranteed to be persistent:
+ * the SGPropertyNode will not change during a session, even if the property is
+ * bound and unbound multiple times.
*
- * <p>When the property value is not managed internally in the
+ * When the property value is not managed internally in the
* SGPropertyNode, the SGPropertyNode will contain a reference to an
* SGRawValue (this class), which provides an abstract way to get,
* set, and clone the underlying value. The SGRawValue may change
* frequently during a session as a value is retyped or bound and
* unbound to various data source, but the abstract SGPropertyNode
- * layer insulates the application from those changes. The raw value
- * contains no facilities for data binding or for type conversion: it
- * is simply the abstraction of a primitive data type (or a compound
- * data type, in the case of a string).</p>
+ * layer insulates the application from those changes.
*
- * <p>The SGPropertyNode class always keeps a *copy* of a raw value,
- * not the original one passed to it; if you override a derived class
- * but do not replace the {@link #clone} method, strange things will
- * happen.</p>
+ * The SGPropertyNode class always keeps a *copy* of a raw value, not the
+ * original one passed to it; if you override a derived class but do not replace
+ * the {@link SGRaw::clone clone()} method, strange things will happen.
*
- * <p>All derived SGRawValue classes must implement {@link #getValue},
- * {@link #setValue}, and {@link #clone} for the appropriate type.</p>
+ * All derived SGRawValue classes must implement getValue(), setValue(), and
+ * {@link SGRaw::clone clone()} for the appropriate type.
*
* @see SGPropertyNode
* @see SGRawValuePointer
* @see SGRawValueFunctionsIndexed
* @see SGRawValueMethods
* @see SGRawValueMethodsIndexed
+ * @see SGRawValueContainer
*/
template <class T>
-class SGRawValue
+class SGRawValue : public SGRawBase<T>
{
public:
* may need different kinds of default values (such as epoch for a
* date type). The default value is used when creating new values.
*/
- static const T DefaultValue; // Default for this kind of raw value.
+ static T DefaultValue()
+ {
+ return T();
+ }
/**
/**
- * Create a new deep copy of this raw value.
- *
- * The copy will contain its own version of the underlying value
- * as well.
- *
- * @return A deep copy of the current object.
+ * Return the type tag for this raw value type.
*/
- virtual SGRawValue * clone () const = 0;
+ virtual simgear::props::Type getType() const
+ {
+ return simgear::props::PropertyTraits<T>::type_tag;
+ }
};
+
+////////////////////////////////////////////////////////////////////////
+// Default values for every type.
+////////////////////////////////////////////////////////////////////////
+
+template<> inline bool SGRawValue<bool>::DefaultValue()
+{
+ return false;
+}
+
+template<> inline const char * SGRawValue<const char *>::DefaultValue()
+{
+ return "";
+}
+
/**
* A raw value bound to a pointer.
*
*
* The copy will use the same external pointer as the original.
*/
- virtual SGRawValue<T> * clone () const {
- return new SGRawValuePointer<T>(_ptr);
+ virtual SGRaw* clone () const {
+ return new SGRawValuePointer(_ptr);
}
private:
*/
virtual T getValue () const {
if (_getter) return (*_getter)();
- else return SGRawValue<T>::DefaultValue;
+ else return SGRawValue<T>::DefaultValue();
}
/**
/**
* Create a copy of this raw value, bound to the same functions.
*/
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueFunctions<T>(_getter,_setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueFunctions(_getter,_setter);
}
private:
virtual ~SGRawValueFunctionsIndexed () {}
virtual T getValue () const {
if (_getter) return (*_getter)(_index);
- else return SGRawValue<T>::DefaultValue;
+ else return SGRawValue<T>::DefaultValue();
}
virtual bool setValue (T value) {
if (_setter) { (*_setter)(_index, value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueFunctionsIndexed<T>(_index, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueFunctionsIndexed(_index, _getter, _setter);
}
private:
int _index;
virtual ~SGRawValueMethods () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(); }
- else { return SGRawValue<T>::DefaultValue; }
+ else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueMethods<C,T>(_obj, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueMethods(_obj, _getter, _setter);
}
private:
C &_obj;
virtual ~SGRawValueMethodsIndexed () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(_index); }
- else { return SGRawValue<T>::DefaultValue; }
+ else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(_index, value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueMethodsIndexed<C,T>(_obj, _index, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueMethodsIndexed(_obj, _index, _getter, _setter);
}
private:
C &_obj;
setter_t _setter;
};
-\f
/**
- * The smart pointer that manage reference counting
+ * A raw value that contains its value. This provides a way for
+ * property nodes to contain values that shouldn't be stored in the
+ * property node itself.
*/
-class SGPropertyNode;
-class SGPropertyNode_ptr
+template <class T>
+class SGRawValueContainer : public SGRawValue<T>
{
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();
+ /**
+ * Explicit constructor.
+ */
+ SGRawValueContainer(const T& obj) : _obj(obj) {}
- /**
- * Assignement operator
- */
- SGPropertyNode_ptr &operator=( const SGPropertyNode_ptr &r );
+ /**
+ * Destructor.
+ */
+ virtual ~SGRawValueContainer() {}
- /**
- * Pointer access operator
- */
- SGPropertyNode *operator->();
+ /**
+ * Get the underlying value.
+ */
+ virtual T getValue() const { return _obj; }
- /**
- * Pointer access operator (const)
- */
- const SGPropertyNode *operator->() const;
+ /**
+ * Set the underlying value.
+ *
+ * This method will dereference the pointer and change the
+ * variable's value.
+ */
+ virtual bool setValue (T value) { _obj = value; return true; }
- /**
- * Conversion to SGPropertyNode * operator
- */
- operator SGPropertyNode *();
+ /**
+ * Create a copy of this raw value.
+ */
+ virtual SGRaw* clone () const {
+ return new SGRawValueContainer(_obj);
+ }
- /**
- * Conversion to const SGPropertyNode * operator
- */
- operator const SGPropertyNode *() const;
+private:
+ T _obj;
+};
- /**
- * Return the pointer.
- */
- SGPropertyNode * ptr () { return _ptr; }
+template<typename T>
+SGRawExtended* SGRawBase<T, 0>::makeContainer() const
+{
+ return new SGRawValueContainer<T>(static_cast<const SGRawValue<T>*>(this)
+ ->getValue());
+}
- /**
- * Validity test
- */
- bool valid() const;
+template<typename T>
+std::ostream& SGRawBase<T, 0>::printOn(std::ostream& stream) const
+{
+ return stream << static_cast<SGRawValue<T>*>(this)->getValue();
+}
-private:
+template<typename T>
+std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
+{
+ T value;
+ simgear::readFrom(stream, value);
+ static_cast<SGRawValue<T>*>(this)->setValue(value);
+ return stream;
+}
- SGPropertyNode *_ptr;
-};
+/**
+ * The smart pointer that manage reference counting
+ */
+class SGPropertyNode;
+typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
+typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
+namespace simgear
+{
+typedef std::vector<SGPropertyNode_ptr> PropertyList;
+}
-\f
/**
* The property change listener interface.
*
{
public:
virtual ~SGPropertyChangeListener ();
- virtual void valueChanged (SGPropertyNode * node);
- virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child);
- virtual void childRemoved (SGPropertyNode * parent, SGPropertyNode * child);
+
+ /// Called if value of \a node has changed.
+ virtual void valueChanged(SGPropertyNode * node);
+
+ /// Called if \a child has been added to the given \a parent.
+ virtual void childAdded(SGPropertyNode * parent, SGPropertyNode * child);
+
+ /// Called if \a child has been removed from its \a parent.
+ virtual void childRemoved(SGPropertyNode * parent, SGPropertyNode * child);
protected:
friend class SGPropertyNode;
virtual void unregister_property (SGPropertyNode * node);
private:
- vector<SGPropertyNode *> _properties;
+ std::vector<SGPropertyNode *> _properties;
};
-\f
/**
* A node in a property tree.
*/
-class SGPropertyNode
+class SGPropertyNode : public SGReferenced
{
public:
MAX_STRING_LEN = 1024
};
- /**
- * Property value types.
- */
- enum Type {
- NONE = 0,
- ALIAS,
- BOOL,
- INT,
- LONG,
- FLOAT,
- DOUBLE,
- STRING,
- UNSPECIFIED
- };
-
-
/**
* Access mode attributes.
*
* whether the property should normally be saved and restored.</p>
*/
enum Attribute {
+ NO_ATTR = 0,
READ = 1,
WRITE = 2,
ARCHIVE = 4,
REMOVED = 8,
TRACE_READ = 16,
- TRACE_WRITE = 32
+ TRACE_WRITE = 32,
+ USERARCHIVE = 64,
+ PRESERVE = 128
+ // beware: if you add another attribute here,
+ // also update value of "LAST_USED_ATTRIBUTE".
};
*/
static const int LAST_USED_ATTRIBUTE;
-
/**
* Default constructor.
*/
/**
* Test whether this node contains a primitive leaf value.
*/
- bool hasValue () const { return (_type != NONE); }
+ bool hasValue () const { return (_type != simgear::props::NONE); }
/**
* Get the node's simple (XML) name.
*/
- const char * getName () const { return _name; }
+ const char * getName () const { return _name.c_str(); }
+ /**
+ * Get the node's simple name as a string.
+ */
+ const std::string& getNameString () const { return _name; }
/**
* Get the node's pretty display name, with subscript when needed.
*/
- const char * getDisplayName (bool simplify = false) const;
+ std::string getDisplayName (bool simplify = false) const;
/**
/**
* Get the number of child nodes.
*/
- int nChildren () const { return _children.size(); }
+ int nChildren () const { return (int)_children.size(); }
/**
return (getChild(name, index) != 0);
}
+ /**
+ * Test whether a named child exists.
+ */
+ bool hasChild (const std::string& name, int index = 0) const
+ {
+ return (getChild(name, index) != 0);
+ }
/**
- * Get a child node by name and index.
+ * 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 * getChild (const char * name, int index = 0,
- bool create = false);
+ 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
+ */
+ 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.
+ */
+ SGPropertyNode * getChild (const char* name, int index = 0,
+ bool create = false);
+ SGPropertyNode * getChild (const std::string& name, int index = 0,
+ bool create = false);
/**
* Get a const child node by name and index.
*/
const SGPropertyNode * getChild (const char * name, int index = 0) const;
+ /**
+ * Get a const child node by name and index.
+ */
+ const SGPropertyNode * getChild (const std::string& name, int index = 0) const
+ { return getChild(name.c_str(), index); }
+
+
+ /**
+ * Get a vector of all children with the specified name.
+ */
+ simgear::PropertyList getChildren (const char * name) const;
/**
* Get a vector of all children with the specified name.
*/
- vector<SGPropertyNode_ptr> getChildren (const char * name) const;
+ simgear::PropertyList getChildren (const std::string& name) const
+ { return getChildren(name.c_str()); }
+
+ /**
+ * Remove child by pointer (if it is a child of this node).
+ *
+ * @return true, if the node was deleted.
+ */
+ bool removeChild(SGPropertyNode* node);
+
+ // TODO do we need the removeXXX methods to return the deleted nodes?
+ /**
+ * Remove child by position.
+ */
+ SGPropertyNode_ptr removeChild(int pos);
/**
* Remove a child node
*/
- SGPropertyNode_ptr removeChild (const char * name, int index = 0,
- bool keep = true);
+ SGPropertyNode_ptr removeChild(const char * name, int index = 0);
+ /**
+ * Remove a child node
+ */
+ SGPropertyNode_ptr removeChild(const std::string& name, int index = 0)
+ { return removeChild(name.c_str(), index); }
+
+ /**
+ * Remove all children with the specified name.
+ */
+ simgear::PropertyList removeChildren(const char * name);
+
+ /**
+ * Remove all children with the specified name.
+ */
+ simgear::PropertyList removeChildren(const std::string& name)
+ { return removeChildren(name.c_str()); }
+
+ /**
+ * Remove all children (does not change the value of the node)
+ */
+ void removeAllChildren();
//
// Alias support.
*/
bool alias (const char * path);
+ /**
+ * Alias this node's leaf value to another's by relative path.
+ */
+ bool alias (const std::string& path)
+ { return alias(path.c_str()); }
+
/**
* Remove any alias for this node.
/**
* Test whether the node's leaf value is aliased to another's.
*/
- bool isAlias () const { return (_type == ALIAS); }
+ bool isAlias () const { return (_type == simgear::props::ALIAS); }
/**
/**
* Get the path to this node from the root.
*/
- const char * getPath (bool simplify = false) const;
+ std::string getPath (bool simplify = false) const;
/**
*/
SGPropertyNode * getNode (const char * relative_path, bool create = false);
+ /**
+ * Get a pointer to another node by relative path.
+ */
+ SGPropertyNode * getNode (const std::string& relative_path, bool create = false)
+ { return getNode(relative_path.c_str(), create); }
/**
* Get a pointer to another node by relative path.
SGPropertyNode * getNode (const char * relative_path, int index,
bool create = false);
+ /**
+ * Get a pointer to another node by relative path.
+ *
+ * This method leaves the index off the last member of the path,
+ * so that the user can specify it separately (and save some
+ * string building). For example, getNode("/bar[1]/foo", 3) is
+ * exactly equivalent to getNode("bar[1]/foo[3]"). The index
+ * provided overrides any given in the path itself for the last
+ * component.
+ */
+ SGPropertyNode * getNode (const std::string& relative_path, int index,
+ bool create = false)
+ { return getNode(relative_path.c_str(), index, create); }
/**
* Get a const pointer to another node by relative path.
*/
const SGPropertyNode * getNode (const char * relative_path) const;
+ /**
+ * Get a const pointer to another node by relative path.
+ */
+ const SGPropertyNode * getNode (const std::string& relative_path) const
+ { return getNode(relative_path.c_str()); }
+
/**
* Get a const pointer to another node by relative path.
const SGPropertyNode * getNode (const char * relative_path,
int index) const;
+ /**
+ * Get a const pointer to another node by relative path.
+ *
+ * This method leaves the index off the last member of the path,
+ * so that the user can specify it separate.
+ */
+ const SGPropertyNode * getNode (const std::string& relative_path,
+ int index) const
+ { return getNode(relative_path.c_str(), index); }
//
// Access Mode.
/**
* Get the type of leaf value, if any, for this node.
*/
- Type getType () const;
+ simgear::props::Type getType () const;
/**
*/
const char * getStringValue () const;
+ /**
+ * Get a value from a node. If the actual type of the node doesn't
+ * match the desired type, a conversion isn't guaranteed.
+ */
+ template<typename T>
+ T getValue(typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0) const;
+ // Getter for extended property
+ template<typename T>
+ 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.
*/
bool setStringValue (const char * value);
+ /**
+ * Set a string value for this node.
+ */
+ bool setStringValue (const std::string& value)
+ { return setStringValue(value.c_str()); }
+
/**
* Set a value of unspecified type for this node.
*/
bool setUnspecifiedValue (const char * value);
+ template<typename T>
+ bool setValue(const T& val,
+ typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0);
- //
- // Data binding.
- //
-
+ template<typename T>
+ bool setValue(const T& val,
+ typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0);
+ template<int N>
+ bool setValue(const char (&val)[N])
+ {
+ return setValue(&val[0]);
+ }
+
/**
- * Test whether this node is bound to an external data source.
+ * Set relative node to given value and afterwards make read only.
+ *
+ * @param relative_path Path to node
+ * @param value Value to set
+ *
+ * @return whether value could be set
*/
- bool isTied () const { return _tied; }
-
+ template<typename T>
+ bool setValueReadOnly(const std::string& relative_path, const T& value)
+ {
+ SGPropertyNode* node = getNode(relative_path, true);
+ bool ret = node->setValue(value);
+ node->setAttributes(READ);
+ return ret;
+ }
+#if !PROPS_STANDALONE
/**
- * Bind this node to an external bool source.
+ * Interpolate current value to target value within given time.
+ *
+ * @param type Type of interpolation ("numeric", "color", etc.)
+ * @param target Node containing target value
+ * @param duration Duration of interpolation (in seconds)
+ * @param easing Easing function (http://easings.net/)
*/
- bool tie (const SGRawValue<bool> &rawValue, bool useDefault = true);
-
+ bool interpolate( const std::string& type,
+ const SGPropertyNode& target,
+ double duration = 0.6,
+ const std::string& easing = "swing" );
/**
- * Bind this node to an external int source.
+ * Interpolate current value to a series of values within given durations.
+ *
+ * @param type Type of interpolation ("numeric", "color", etc.)
+ * @param values Nodes containing intermediate and target values
+ * @param deltas Durations for each interpolation step (in seconds)
+ * @param easing Easing function (http://easings.net/)
*/
- bool tie (const SGRawValue<int> &rawValue, bool useDefault = true);
-
+ bool interpolate( const std::string& type,
+ const simgear::PropertyList& values,
+ const double_list& deltas,
+ const std::string& easing = "swing" );
/**
- * Bind this node to an external long int source.
+ * Set the interpolation manager used by the interpolate methods.
*/
- bool tie (const SGRawValue<long> &rawValue, bool useDefault = true);
-
+ static void setInterpolationMgr(simgear::PropertyInterpolationMgr* mgr);
/**
- * Bind this node to an external float source.
+ * Get the interpolation manager
*/
- bool tie (const SGRawValue<float> &rawValue, bool useDefault = true);
-
+ static simgear::PropertyInterpolationMgr* getInterpolationMgr();
+#endif
/**
- * Bind this node to an external double source.
+ * Print the value of the property to a stream.
*/
- bool tie (const SGRawValue<double> &rawValue, bool useDefault = true);
+ std::ostream& printOn(std::ostream& stream) const;
+
+ //
+ // Data binding.
+ //
/**
- * Bind this node to an external string source.
+ * Test whether this node is bound to an external data source.
*/
- bool tie (const SGRawValue<const char *> &rawValue, bool useDefault = true);
+ bool isTied () const { return _tied; }
+ /**
+ * Bind this node to an external source.
+ */
+ template<typename T>
+ bool tie(const SGRawValue<T> &rawValue, bool useDefault = true);
/**
* Unbind this node from any external data source.
/**
* Get another node's type.
*/
- Type getType (const char * relative_path) const;
+ simgear::props::Type getType (const char * relative_path) const;
+ /**
+ * Get another node's type.
+ */
+ simgear::props::Type getType (const std::string& relative_path) const
+ { return getType(relative_path.c_str()); }
/**
* Test whether another node has a leaf value.
*/
bool hasValue (const char * relative_path) const;
+ /**
+ * Test whether another node has a leaf value.
+ */
+ bool hasValue (const std::string& relative_path) const
+ { return hasValue(relative_path.c_str()); }
/**
* Get another node's value as a bool.
bool getBoolValue (const char * relative_path,
bool defaultValue = false) const;
+ /**
+ * Get another node's value as a bool.
+ */
+ bool getBoolValue (const std::string& relative_path,
+ bool defaultValue = false) const
+ { return getBoolValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as an int.
int getIntValue (const char * relative_path,
int defaultValue = 0) const;
+ /**
+ * Get another node's value as an int.
+ */
+ int getIntValue (const std::string& relative_path,
+ int defaultValue = 0) const
+ { return getIntValue(relative_path.c_str(), defaultValue); }
+
/**
* Get another node's value as a long int.
long getLongValue (const char * relative_path,
long defaultValue = 0L) const;
+ /**
+ * Get another node's value as a long int.
+ */
+ long getLongValue (const std::string& relative_path,
+ long defaultValue = 0L) const
+ { return getLongValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a float.
*/
float getFloatValue (const char * relative_path,
- float defaultValue = 0.0) const;
+ float defaultValue = 0.0f) const;
+
+ /**
+ * Get another node's value as a float.
+ */
+ float getFloatValue (const std::string& relative_path,
+ float defaultValue = 0.0f) const
+ { return getFloatValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a double.
*/
double getDoubleValue (const char * relative_path,
- double defaultValue = 0.0L) const;
+ double defaultValue = 0.0) const;
+ /**
+ * Get another node's value as a double.
+ */
+ double getDoubleValue (const std::string& relative_path,
+ double defaultValue = 0.0) const
+ { return getDoubleValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a string.
const char * defaultValue = "") const;
+ /**
+ * Get another node's value as a string.
+ */
+ const char * getStringValue (const std::string& relative_path,
+ const char * defaultValue = "") const
+ { return getStringValue(relative_path.c_str(), defaultValue); }
+
+
/**
* Set another node's value as a bool.
*/
bool setBoolValue (const char * relative_path, bool value);
+ /**
+ * Set another node's value as a bool.
+ */
+ bool setBoolValue (const std::string& relative_path, bool value)
+ { return setBoolValue(relative_path.c_str(), value); }
+
/**
* Set another node's value as an int.
*/
bool setIntValue (const char * relative_path, int value);
+ /**
+ * Set another node's value as an int.
+ */
+ bool setIntValue (const std::string& relative_path, int value)
+ { return setIntValue(relative_path.c_str(), value); }
+
/**
* Set another node's value as a long int.
*/
bool setLongValue (const char * relative_path, long value);
+ /**
+ * Set another node's value as a long int.
+ */
+ bool setLongValue (const std::string& relative_path, long value)
+ { return setLongValue(relative_path.c_str(), value); }
+
/**
* Set another node's value as a float.
*/
bool setFloatValue (const char * relative_path, float value);
+ /**
+ * Set another node's value as a float.
+ */
+ bool setFloatValue (const std::string& relative_path, float value)
+ { return setFloatValue(relative_path.c_str(), value); }
+
/**
* Set another node's value as a double.
*/
bool setDoubleValue (const char * relative_path, double value);
+ /**
+ * Set another node's value as a double.
+ */
+ bool setDoubleValue (const std::string& relative_path, double value)
+ { return setDoubleValue(relative_path.c_str(), value); }
+
/**
* Set another node's value as a string.
*/
bool setStringValue (const char * relative_path, const char * value);
+ bool setStringValue(const char * relative_path, const std::string& value)
+ { return setStringValue(relative_path, value.c_str()); }
+ /**
+ * Set another node's value as a string.
+ */
+ bool setStringValue (const std::string& relative_path, const char * value)
+ { return setStringValue(relative_path.c_str(), value); }
+
+ bool setStringValue (const std::string& relative_path,
+ const std::string& value)
+ { return setStringValue(relative_path.c_str(), value.c_str()); }
/**
* Set another node's value with no specified type.
*/
bool isTied (const char * relative_path) const;
+ /**
+ * Test whether another node is bound to an external data source.
+ */
+ bool isTied (const std::string& relative_path) const
+ { return isTied(relative_path.c_str()); }
/**
* Bind another node to an external bool source.
bool tie (const char * relative_path, const SGRawValue<bool> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external bool source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<bool> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Bind another node to an external int source.
bool tie (const char * relative_path, const SGRawValue<int> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external int source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<int> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Bind another node to an external long int source.
bool tie (const char * relative_path, const SGRawValue<long> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external long int source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<long> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Bind another node to an external float source.
bool tie (const char * relative_path, const SGRawValue<float> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external float source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<float> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Bind another node to an external double source.
bool tie (const char * relative_path, const SGRawValue<double> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external double source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<double> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Bind another node to an external string source.
bool tie (const char * relative_path, const SGRawValue<const char *> &rawValue,
bool useDefault = true);
+ /**
+ * Bind another node to an external string source.
+ */
+ bool tie (const std::string& relative_path, const SGRawValue<const char*> &rawValue,
+ bool useDefault = true)
+ { return tie(relative_path.c_str(), rawValue, useDefault); }
+
/**
* Unbind another node from any external data source.
*/
bool untie (const char * relative_path);
+ /**
+ * Unbind another node from any external data source.
+ */
+ bool untie (const std::string& relative_path)
+ { return untie(relative_path.c_str()); }
+
/**
- * Add a change listener to the property.
+ * Add a change listener to the property. If "initial" is set call the
+ * listener initially.
*/
- void addChangeListener (SGPropertyChangeListener * listener);
+ void addChangeListener (SGPropertyChangeListener * listener,
+ bool initial = false);
/**
void removeChangeListener (SGPropertyChangeListener * listener);
+ /**
+ * Get the number of listeners.
+ */
+ int nListeners () const { return _listeners ? (int)_listeners->size() : 0; }
+
+
/**
* Fire a value change event to all listeners.
*/
*/
void fireChildAdded (SGPropertyNode * child);
+ /**
+ * Trigger a child-added and value-changed event for every child (Unlimited
+ * depth).
+ *
+ * @param fire_self Whether to trigger the events also for 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(bool fire_self = false);
/**
* 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.
+ */
+ void clearValue ();
+
+ /**
+ * Compare two property trees. The property trees are equal if: 1)
+ * They have no children, and have the same type and the values are
+ * equal, or 2) have the same number of children, and the
+ * corresponding children in each tree are equal. "corresponding"
+ * means have the same name and index.
+ *
+ * Attributes, removed children, and aliases aren't considered.
+ */
+ static bool compare (const SGPropertyNode& lhs, const SGPropertyNode& rhs);
protected:
void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child);
void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child);
+ SGPropertyNode_ptr eraseChild(simgear::PropertyList::iterator child);
+
/**
* Protected constructor for making new nodes on demand.
*/
- SGPropertyNode (const char * name, int index, SGPropertyNode * parent);
+ SGPropertyNode (const std::string& name, int index, SGPropertyNode * parent);
+ template<typename Itr>
+ SGPropertyNode (Itr begin, Itr end, int index, SGPropertyNode * parent);
+ static simgear::PropertyInterpolationMgr* _interpolation_mgr;
private:
- // Get the raw value
+ // Get the raw value
bool get_bool () const;
int get_int () const;
long get_long () const;
double get_double () const;
const char * get_string () const;
- // Set the raw value
+ // Set the raw value
bool set_bool (bool value);
bool set_int (int value);
bool set_long (long value);
bool set_string (const char * value);
- /**
- * Clear any existing value and set the type to NONE.
- */
- void clear_value ();
-
-
/**
* Get the value as a string.
*/
const char * make_string () const;
-
/**
* Trace a read access.
*/
*/
void trace_write () const;
-
- /**
- * 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;
- mutable char * _display_name;
int _index;
+ std::string _name;
+ /// To avoid cyclic reference counting loops this shall not be a reference
+ /// counted pointer
SGPropertyNode * _parent;
- vector<SGPropertyNode_ptr> _children;
- vector<SGPropertyNode_ptr> _removedChildren;
- mutable char * _path;
- hash_table * _path_cache;
- Type _type;
+ simgear::PropertyList _children;
+ mutable std::string _buffer;
+ simgear::props::Type _type;
bool _tied;
int _attr;
- int _count;
- // The right kind of pointer...
+ // The right kind of pointer...
union {
SGPropertyNode * alias;
- SGRawValue<bool> * bool_val;
- SGRawValue<int> * int_val;
- SGRawValue<long> * long_val;
- SGRawValue<float> * float_val;
- SGRawValue<double> * double_val;
- SGRawValue<const char *> * string_val;
+ SGRaw* val;
} _value;
union {
char * string_val;
} _local_val;
- vector <SGPropertyChangeListener *> * _listeners;
+ std::vector<SGPropertyChangeListener *> * _listeners;
+
+ // Pass name as a pair of iterators
+ template<typename Itr>
+ SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false);
+ // very internal method
+ template<typename Itr>
+ SGPropertyNode* getExistingChild (Itr begin, Itr end, int index);
+ // very internal path parsing function
+ template<typename SplitItr>
+ friend SGPropertyNode* find_node_aux(SGPropertyNode * current, SplitItr& itr,
+ bool create, int last_index);
+ // For boost
+ friend size_t hash_value(const SGPropertyNode& node);
+};
+
+// Convenience functions for use in templates
+template<typename T>
+#if PROPS_STANDALONE
+T
+#else
+typename boost::disable_if<boost::is_enum<T>, T>::type
+#endif
+getValue(const SGPropertyNode*);
+
+template<>
+inline bool getValue<bool>(const SGPropertyNode* node) { return node->getBoolValue(); }
+
+template<>
+inline int getValue<int>(const SGPropertyNode* node) { return node->getIntValue(); }
+template<>
+inline long getValue<long>(const SGPropertyNode* node) { return node->getLongValue(); }
-\f
+template<>
+inline float getValue<float>(const SGPropertyNode* node)
+{
+ return node->getFloatValue();
+}
+
+template<>
+inline double getValue<double>(const SGPropertyNode* node)
+{
+ return node->getDoubleValue();
+}
+
+template<>
+inline const char * getValue<const char*>(const SGPropertyNode* node)
+{
+ return node->getStringValue ();
+}
+
+template<>
+inline std::string getValue<std::string>(const SGPropertyNode* node)
+{
+ return node->getStringValue();
+}
+
+namespace simgear
+{
/**
- * A very simple hash table with no remove functionality.
+ * Default trait for extracting enum values from SGPropertyNode. Create your
+ * own specialization for specific enum types to enable validation of values.
*/
- class hash_table {
- public:
-
+ template<class T>
+ struct enum_traits
+ {
/**
- * An entry in a bucket in a hash table.
+ * Typename of the enum
*/
- 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;
- };
+ static const char* name() { return typeid(T).name(); }
+ /**
+ * @return Default value (will be used if validation fails)
+ */
+ static T defVal() { return T(); }
/**
- * A bucket in a hash table.
+ * @return Whether the given integer value has an enum value defined
*/
- 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;
+ static bool validate(int) { return true; }
};
+} // namespace simgear
+/** Extract enum from SGPropertyNode */
+template<typename T>
+#if PROPS_STANDALONE
+inline T
+#else
+inline typename boost::enable_if<boost::is_enum<T>, T>::type
+#endif
+getValue(const SGPropertyNode* node)
+{
+ typedef simgear::enum_traits<T> Traits;
+ int val = node->getIntValue();
+ if( !Traits::validate(val) )
+ {
+ SG_LOG
+ (
+ SG_GENERAL,
+ SG_WARN,
+ "Invalid value for enum (" << Traits::name() << ", val = " << val << ")"
+ );
+ return Traits::defVal();
+ }
+ return static_cast<T>(node->getIntValue());
+}
+
+inline bool setValue(SGPropertyNode* node, bool value)
+{
+ return node->setBoolValue(value);
+}
+
+inline bool setValue(SGPropertyNode* node, int value)
+{
+ return node->setIntValue(value);
+}
+
+inline bool setValue(SGPropertyNode* node, long value)
+{
+ return node->setLongValue(value);
+}
+
+inline bool setValue(SGPropertyNode* node, float value)
+{
+ return node->setFloatValue(value);
+}
+
+inline bool setValue(SGPropertyNode* node, double value)
+{
+ return node->setDoubleValue(value);
+}
+
+inline bool setValue(SGPropertyNode* node, const char* value)
+{
+ return node->setStringValue(value);
+}
+
+inline bool setValue (SGPropertyNode* node, const std::string& value)
+{
+ return node->setStringValue(value.c_str());
+}
+
+template<typename T>
+bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
+{
+ using namespace simgear::props;
+ if (_type == ALIAS || _tied)
+ return false;
+
+ useDefault = useDefault && hasValue();
+ T old_val = SGRawValue<T>::DefaultValue();
+ if (useDefault)
+ old_val = getValue<T>(this);
+ clearValue();
+ if (PropertyTraits<T>::Internal)
+ _type = PropertyTraits<T>::type_tag;
+ else
+ _type = EXTENDED;
+ _tied = true;
+ _value.val = rawValue.clone();
+ if (useDefault) {
+ int save_attributes = getAttributes();
+ setAttribute( WRITE, true );
+ setValue(old_val);
+ setAttributes( save_attributes );
+ }
+ return true;
+}
+
+template<>
+bool SGPropertyNode::tie (const SGRawValue<const char *> &rawValue,
+ bool useDefault);
+
+template<typename T>
+T SGPropertyNode::getValue(typename boost::disable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy) const
+{
+ using namespace simgear::props;
+ if (_attr == (READ|WRITE) && _type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag) {
+ return static_cast<SGRawValue<T>*>(_value.val)->getValue();
+ }
+ if (getAttribute(TRACE_READ))
+ trace_read();
+ if (!getAttribute(READ))
+ return SGRawValue<T>::DefaultValue();
+ switch (_type) {
+ case EXTENDED:
+ if (_value.val->getType() == PropertyTraits<T>::type_tag)
+ return static_cast<SGRawValue<T>*>(_value.val)->getValue();
+ break;
+ case STRING:
+ case UNSPECIFIED:
+ return simgear::parseString<T>(make_string());
+ break;
+ default: // avoid compiler warning
+ break;
+ }
+ return SGRawValue<T>::DefaultValue();
+}
+
+template<typename T>
+inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy) const
+{
+ 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
+ ::PropertyTraits<T>::Internal>::type* dummy)
+{
+ using namespace simgear::props;
+ if (_attr == (READ|WRITE) && _type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag) {
+ static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
+ return true;
+ }
+ if (getAttribute(WRITE)
+ && ((_type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag)
+ || _type == NONE || _type == UNSPECIFIED)) {
+ if (_type == NONE || _type == UNSPECIFIED) {
+ clearValue();
+ _type = EXTENDED;
+ _value.val = new SGRawValueContainer<T>(val);
+ } else {
+ static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
+ }
+ if (getAttribute(TRACE_WRITE))
+ trace_write();
+ return true;
+ }
+ return false;
+}
+
+template<typename T>
+inline bool SGPropertyNode::setValue(const T& val,
+ typename boost::enable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy)
+{
+ return ::setValue(this, val);
+}
+
+/**
+ * Utility function for creation of a child property node.
+ */
+inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name,
+ int index = 0)
+{
+ return parent->getChild(name, index, true);
+}
+
+/**
+ * Utility function for creation of a child property node using a
+ * relative path.
+ */
+namespace simgear
+{
+template<typename StringType>
+inline SGPropertyNode* makeNode(SGPropertyNode* parent, const StringType& name)
+{
+ return parent->getNode(name, true);
+}
+}
+
+// For boost::hash
+size_t hash_value(const SGPropertyNode& node);
+
+// Helper comparison and hash functions for common cases
+
+namespace simgear
+{
+namespace props
+{
+struct Compare
+{
+ bool operator()(const SGPropertyNode* lhs, const SGPropertyNode* rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(SGPropertyNode_ptr lhs, const SGPropertyNode* rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(const SGPropertyNode* lhs, SGPropertyNode_ptr rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(SGPropertyNode_ptr lhs, SGPropertyNode_ptr rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+};
+
+struct Hash
+{
+ size_t operator()(const SGPropertyNode* node) const
+ {
+ return hash_value(*node);
+ }
+ size_t operator()(SGPropertyNode_ptr node) const
+ {
+ return hash_value(*node);
+ }
+};
+}
+}
+
+/** 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);
+ }
+
+ SGPropertyChangeCallback(const SGPropertyChangeCallback<T>& other) :
+ _obj(other._obj), _callback(other._callback), _property(other._property)
+ {
+ _property->addChangeListener(this,false);
+ }
+
+ 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
projects / simgear.git / blobdiff