#include <string>
#include <iostream>
#include <sstream>
+#include <typeinfo>
#include <boost/utility.hpp>
+#include <boost/type_traits/is_enum.hpp>
#if PROPS_STANDALONE
#else
#endif
-
+#include <simgear/math/SGMathFwd.hxx>
+#include <simgear/math/sg_types.hxx>
#include <simgear/structure/SGReferenced.hxx>
#include <simgear/structure/SGSharedPtr.hxx>
namespace simgear
{
+
+ class PropertyInterpolationMgr;
+
template<typename T>
std::istream& readFrom(std::istream& stream, T& result)
{
DOUBLE,
STRING,
UNSPECIFIED,
- EXTENDED /**< The node's value is not stored in the property;
+ 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;
DEFINTERNALPROP(float, FLOAT);
DEFINTERNALPROP(double, DOUBLE);
DEFINTERNALPROP(const char *, STRING);
+DEFINTERNALPROP(const char[], STRING);
#undef DEFINTERNALPROP
}
-\f
////////////////////////////////////////////////////////////////////////
// A raw value.
//
* 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();
+ }
/**
// Default values for every type.
////////////////////////////////////////////////////////////////////////
-template<> const bool SGRawValue<bool>::DefaultValue;
-template<> const int SGRawValue<int>::DefaultValue;
-template<> const long SGRawValue<long>::DefaultValue;
-template<> const float SGRawValue<float>::DefaultValue;
-template<> const double SGRawValue<double>::DefaultValue;
-template<> const char * const SGRawValue<const char *>::DefaultValue;
+template<> inline bool SGRawValue<bool>::DefaultValue()
+{
+ return false;
+}
+
+template<> inline const char * SGRawValue<const char *>::DefaultValue()
+{
+ return "";
+}
/**
* A raw value bound to a pointer.
*/
virtual T getValue () const {
if (_getter) return (*_getter)();
- else return SGRawValue<T>::DefaultValue;
+ else return SGRawValue<T>::DefaultValue();
}
/**
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; }
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; }
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; }
static_cast<SGRawValue<T>*>(this)->setValue(value);
return stream;
}
-\f
+
/**
* The smart pointer that manage reference counting
*/
typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
-\f
+namespace simgear
+{
+typedef std::vector<SGPropertyNode_ptr> PropertyList;
+}
+
/**
* The property change listener interface.
*
};
-\f
/**
* A node in a property tree.
*/
* 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,
- USERARCHIVE = 64
+ 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.
*/
*/
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(); }
/**
}
/**
- * 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);
+ 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); }
/**
- * Get a child node by name and index.
+ * 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 * getChild (const char * name, int index = 0,
- bool create = false);
+ 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)
- { return getChild(name.c_str(), index, create); }
-
-
+ bool create = false);
/**
* Get a const child node by name and index.
*/
/**
* Get a vector of all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> getChildren (const char * name) const;
+ simgear::PropertyList getChildren (const char * name) const;
/**
* Get a vector of all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> getChildren (const std::string& name) const
+ simgear::PropertyList getChildren (const std::string& name) const
{ return getChildren(name.c_str()); }
+ // TODO do we need the removeXXX methods to return the deleted nodes?
/**
* Remove child by position.
*/
- SGPropertyNode_ptr removeChild (int pos, bool keep = true);
+ 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,
- bool keep = true)
- { return removeChild(name.c_str(), index, keep); }
+ SGPropertyNode_ptr removeChild(const std::string& name, int index = 0)
+ { return removeChild(name.c_str(), index); }
/**
* Remove all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> removeChildren (const char * name,
- bool keep = true);
-
+ simgear::PropertyList removeChildren(const char * name);
/**
* Remove all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> removeChildren (const std::string& name,
- bool keep = true)
- { return removeChildren(name.c_str(), keep); }
+ 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.
/**
* Get the path to this node from the root.
*/
- const char * getPath (bool simplify = false) const;
+ std::string getPath (bool simplify = false) const;
/**
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 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]);
+ }
+ /**
+ * 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
+ */
+ 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;
+ }
+
+ /**
+ * 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 interpolate( const std::string& type,
+ const SGPropertyNode& target,
+ double duration = 0.6,
+ const std::string& easing = "swing" );
+
+ /**
+ * 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 duration Durations for each interpolation step (in seconds)
+ * @param easing Easing function (http://easings.net/)
+ */
+ bool interpolate( const std::string& type,
+ const simgear::PropertyList& values,
+ const double_list& deltas,
+ const std::string& easing = "swing" );
+
+ /**
+ * Set the interpolation manager used by the interpolate methods.
+ */
+ static void setInterpolationMgr(simgear::PropertyInterpolationMgr* mgr);
+
/**
* Print the value of the property to a stream.
*/
*/
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.
/**
* Get the number of listeners.
*/
- int nListeners () const { return _listeners ? _listeners->size() : 0; }
+ int nListeners () const { return _listeners ? (int)_listeners->size() : 0; }
/**
*/
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:
/**
* 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);
*/
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;
- mutable std::string _display_name;
/// To avoid cyclic reference counting loops this shall not be a reference
/// counted pointer
SGPropertyNode * _parent;
- std::vector<SGPropertyNode_ptr> _children;
- std::vector<SGPropertyNode_ptr> _removedChildren;
- std::vector<hash_table *> _linkedNodes;
- mutable std::string _path;
+ simgear::PropertyList _children;
mutable std::string _buffer;
- hash_table * _path_cache;
simgear::props::Type _type;
bool _tied;
int _attr;
- // The right kind of pointer...
+ // The right kind of pointer...
union {
SGPropertyNode * alias;
SGRaw* val;
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);
+ // 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>
-T getValue(const SGPropertyNode*);
+typename boost::disable_if<boost::is_enum<T>, T>::type
+getValue(const SGPropertyNode*);
template<>
inline bool getValue<bool>(const SGPropertyNode* node) { return node->getBoolValue(); }
return node->getStringValue ();
}
+template<>
+inline std::string getValue<std::string>(const SGPropertyNode* node)
+{
+ return node->getStringValue();
+}
+
+namespace simgear
+{
+ /**
+ * Default trait for extracting enum values from SGPropertyNode. Create your
+ * own specialization for specific enum types to enable validation of values.
+ */
+ template<class T>
+ struct enum_traits
+ {
+ /**
+ * Typename of the enum
+ */
+ static const char* name() { return typeid(T).name(); }
+
+ /**
+ * @return Default value (will be used if validation fails)
+ */
+ static T defVal() { return T(); }
+
+ /**
+ * @return Whether the given integer value has an enum value defined
+ */
+ static bool validate(int) { return true; }
+ };
+} // namespace simgear
+
+/** Extract enum from SGPropertyNode */
+template<typename T>
+inline typename boost::enable_if<boost::is_enum<T>, T>::type
+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);
return false;
useDefault = useDefault && hasValue();
- T old_val = SGRawValue<T>::DefaultValue;
+ T old_val = SGRawValue<T>::DefaultValue();
if (useDefault)
old_val = getValue<T>(this);
clearValue();
_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;
}
if (getAttribute(TRACE_READ))
trace_read();
if (!getAttribute(READ))
- return SGRawValue<T>::DefaultValue;
+ return SGRawValue<T>::DefaultValue();
switch (_type) {
case EXTENDED:
if (_value.val->getType() == PropertyTraits<T>::type_tag)
case UNSPECIFIED:
return simgear::parseString<T>(make_string());
break;
+ default: // avoid compiler warning
+ break;
}
- return SGRawValue<T>::DefaultValue;
+ return SGRawValue<T>::DefaultValue();
}
template<typename T>
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
{
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
// end of props.hxx
projects / simgear.git / blobdiff