3 * Interface definition for a property list.
4 * Started Fall 2000 by David Megginson, david@megginson.com
5 * This code is released into the Public Domain.
7 * See props.html for documentation [replace with URL when available].
15 #ifndef PROPS_STANDALONE
16 #define PROPS_STANDALONE 0
25 #include <boost/utility.hpp>
26 #include <boost/type_traits/is_enum.hpp>
30 #include <simgear/compiler.h>
31 #include <simgear/debug/logstream.hxx>
35 #include <simgear/math/SGMathFwd.hxx>
36 #include <simgear/math/sg_types.hxx>
37 #include <simgear/structure/SGReferenced.hxx>
38 #include <simgear/structure/SGSharedPtr.hxx>
40 // XXX This whole file should be in the simgear namespace, but I don't
41 // have the guts yet...
46 class PropertyInterpolationMgr;
49 std::istream& readFrom(std::istream& stream, T& result)
56 * Parse a string as an object of a given type.
57 * XXX no error behavior yet.
59 * @tparam T the return type
60 * @param str the string
64 inline T parseString(const std::string& str)
66 std::istringstream stream(str);
68 readFrom(stream, result);
73 * Property value types.
77 #pragma warn A sloppy coder has defined NONE as a macro!
82 #pragma warn A sloppy coder has defined ALIAS as a macro!
87 #pragma warn A sloppy coder has defined UNSPECIFIED as a macro!
92 #pragma warn A sloppy coder has defined BOOL as a macro!
97 #pragma warn A sloppy coder has defined INT as a macro!
102 #pragma warn A sloppy coder has defined LONG as a macro!
107 #pragma warn A sloppy coder has defined FLOAT as a macro!
112 #pragma warn A sloppy coder has defined DOUBLE as a macro!
117 #pragma warn A sloppy coder has defined STRING as a macro!
124 * The possible types of an SGPropertyNode. Types that appear after
125 * EXTENDED are not stored in the SGPropertyNode itself.
128 NONE = 0, /**< The node hasn't been assigned a value yet. */
129 ALIAS, /**< The node "points" to another node. */
137 EXTENDED, /**< The node's value is not stored in the property;
138 * the actual value and type is retrieved from an
139 * SGRawValue node. This type is never returned by @see
140 * SGPropertyNode::getType.
142 // Extended properties
147 template<typename T> struct PropertyTraits;
149 #define DEFINTERNALPROP(TYPE, PROP) \
151 struct PropertyTraits<TYPE> \
153 static const Type type_tag = PROP; \
154 enum { Internal = 1 }; \
157 DEFINTERNALPROP(bool, BOOL);
158 DEFINTERNALPROP(int, INT);
159 DEFINTERNALPROP(long, LONG);
160 DEFINTERNALPROP(float, FLOAT);
161 DEFINTERNALPROP(double, DOUBLE);
162 DEFINTERNALPROP(const char *, STRING);
163 DEFINTERNALPROP(const char[], STRING);
164 #undef DEFINTERNALPROP
171 ////////////////////////////////////////////////////////////////////////
174 // This is the mechanism that information-providing routines can
175 // use to link their own values to the property manager. Any
176 // SGValue can be tied to a raw value and then untied again.
178 // Note: we are forced to use inlined methods here to ensure
179 // that the templates will be instantiated. We're probably taking
180 // a small performance hit for that.
181 ////////////////////////////////////////////////////////////////////////
184 * Base class for SGRawValue classes that holds no type
185 * information. This allows some generic manipulation of the
192 * Get the type enumeration for the raw value.
196 virtual simgear::props::Type getType() const = 0;
200 * Create a new deep copy of this raw value.
202 * The copy will contain its own version of the underlying value
203 * as well, and will be the same type.
205 * @return A deep copy of the current object.
207 virtual SGRaw* clone() const = 0;
211 class SGRawExtended : public SGRaw
215 * Make an SGRawValueContainer from the SGRawValue.
217 * This is a virtual function of SGRawExtended so that
218 * SGPropertyNode::untie doesn't need to know the type of an
221 virtual SGRawExtended* makeContainer() const = 0;
223 * Write value out to a stream
225 virtual std::ostream& printOn(std::ostream& stream) const = 0;
227 * Read value from a stream and store it.
229 virtual std::istream& readFrom(std::istream& stream) = 0;
232 // Choose between different base classes based on whether the value is
233 // stored internal to the property node. This frees us from defining
234 // the virtual functions in the SGRawExtended interface where they
235 // don't make sense, e.g. readFrom for the const char* type.
236 template<typename T, int internal = simgear::props::PropertyTraits<T>::Internal>
240 class SGRawBase<T, 1> : public SGRaw
245 class SGRawBase<T, 0> : public SGRawExtended
247 virtual SGRawExtended* makeContainer() const;
248 virtual std::ostream& printOn(std::ostream& stream) const;
249 virtual std::istream& readFrom(std::istream& stream);
253 * Abstract base class for a raw value.
255 * <p>The property manager is implemented in two layers. The {@link
256 * SGPropertyNode} is the highest and most abstract layer,
257 * representing an LValue/RValue pair: it records the position of the
258 * property in the property tree and contains facilities for
259 * navigation to other nodes. It is guaranteed to be persistent: the
260 * {@link SGPropertyNode} will not change during a session, even if
261 * the property is bound and unbound multiple times.</p>
263 * <p>When the property value is not managed internally in the
264 * SGPropertyNode, the SGPropertyNode will contain a reference to an
265 * SGRawValue (this class), which provides an abstract way to get,
266 * set, and clone the underlying value. The SGRawValue may change
267 * frequently during a session as a value is retyped or bound and
268 * unbound to various data source, but the abstract SGPropertyNode
269 * layer insulates the application from those changes.
271 * <p>The SGPropertyNode class always keeps a *copy* of a raw value,
272 * not the original one passed to it; if you override a derived class
273 * but do not replace the {@link #clone} method, strange things will
276 * <p>All derived SGRawValue classes must implement {@link #getValue},
277 * {@link #setValue}, and {@link #clone} for the appropriate type.</p>
279 * @see SGPropertyNode
280 * @see SGRawValuePointer
281 * @see SGRawValueFunctions
282 * @see SGRawValueFunctionsIndexed
283 * @see SGRawValueMethods
284 * @see SGRawValueMethodsIndexed
285 * @see SGRawValueContainer
288 class SGRawValue : public SGRawBase<T>
293 * The default underlying value for this type.
295 * Every raw value has a default; the default is false for a
296 * boolean, 0 for the various numeric values, and "" for a string.
297 * If additional types of raw values are added in the future, they
298 * may need different kinds of default values (such as epoch for a
299 * date type). The default value is used when creating new values.
301 static T DefaultValue()
310 * Use the default value for this type.
318 virtual ~SGRawValue () {}
322 * Return the underlying value.
324 * @return The actual value for the property.
327 virtual T getValue () const = 0;
331 * Assign a new underlying value.
333 * If the new value cannot be set (because this is a read-only
334 * raw value, or because the new value is not acceptable for
335 * some reason) this method returns false and leaves the original
338 * @param value The actual value for the property.
339 * @return true if the value was set successfully, false otherwise.
342 virtual bool setValue (T value) = 0;
346 * Return the type tag for this raw value type.
348 virtual simgear::props::Type getType() const
350 return simgear::props::PropertyTraits<T>::type_tag;
356 ////////////////////////////////////////////////////////////////////////
357 // Default values for every type.
358 ////////////////////////////////////////////////////////////////////////
360 template<> inline bool SGRawValue<bool>::DefaultValue()
365 template<> inline const char * SGRawValue<const char *>::DefaultValue()
371 * A raw value bound to a pointer.
373 * This is the most efficient way to tie an external value, but also
374 * the most dangerous, because there is no way for the supplier to
375 * perform bounds checking and derived calculations except by polling
376 * the variable to see if it has changed. There is no default
377 * constructor, because this class would be meaningless without a
381 class SGRawValuePointer : public SGRawValue<T>
386 * Explicit pointer constructor.
388 * Create a new raw value bound to the value of the variable
389 * referenced by the pointer.
391 * @param ptr The pointer to the variable to which this raw value
394 SGRawValuePointer (T * ptr) : _ptr(ptr) {}
399 virtual ~SGRawValuePointer () {}
402 * Get the underlying value.
404 * This method will dereference the pointer and return the
407 virtual T getValue () const { return *_ptr; }
410 * Set the underlying value.
412 * This method will dereference the pointer and change the
415 virtual bool setValue (T value) { *_ptr = value; return true; }
418 * Create a copy of this raw value.
420 * The copy will use the same external pointer as the original.
422 virtual SGRaw* clone () const {
423 return new SGRawValuePointer(_ptr);
432 * A value managed through static functions.
434 * A read-only value will not have a setter; a write-only value will
438 class SGRawValueFunctions : public SGRawValue<T>
443 * The template type of a static getter function.
445 typedef T (*getter_t)();
448 * The template type of a static setter function.
450 typedef void (*setter_t)(T);
453 * Explicit constructor.
455 * Create a new raw value bound to the getter and setter supplied.
457 * @param getter A static function for getting a value, or 0
458 * to read-disable the value.
459 * @param setter A static function for setting a value, or 0
460 * to write-disable the value.
462 SGRawValueFunctions (getter_t getter = 0, setter_t setter = 0)
463 : _getter(getter), _setter(setter) {}
468 virtual ~SGRawValueFunctions () {}
471 * Get the underlying value.
473 * This method will invoke the getter function to get a value.
474 * If no getter function was supplied, this method will always
475 * return the default value for the type.
477 virtual T getValue () const {
478 if (_getter) return (*_getter)();
479 else return SGRawValue<T>::DefaultValue();
483 * Set the underlying value.
485 * This method will invoke the setter function to change the
486 * underlying value. If no setter function was supplied, this
487 * method will return false.
489 virtual bool setValue (T value) {
490 if (_setter) { (*_setter)(value); return true; }
495 * Create a copy of this raw value, bound to the same functions.
497 virtual SGRaw* clone () const {
498 return new SGRawValueFunctions(_getter,_setter);
508 * An indexed value bound to static functions.
510 * A read-only value will not have a setter; a write-only value will
511 * not have a getter. An indexed value is useful for binding one
512 * of a list of possible values (such as multiple engines for a
513 * plane). The index is hard-coded at creation time.
518 class SGRawValueFunctionsIndexed : public SGRawValue<T>
521 typedef T (*getter_t)(int);
522 typedef void (*setter_t)(int,T);
523 SGRawValueFunctionsIndexed (int index, getter_t getter = 0, setter_t setter = 0)
524 : _index(index), _getter(getter), _setter(setter) {}
525 virtual ~SGRawValueFunctionsIndexed () {}
526 virtual T getValue () const {
527 if (_getter) return (*_getter)(_index);
528 else return SGRawValue<T>::DefaultValue();
530 virtual bool setValue (T value) {
531 if (_setter) { (*_setter)(_index, value); return true; }
534 virtual SGRaw* clone () const {
535 return new SGRawValueFunctionsIndexed(_index, _getter, _setter);
545 * A value managed through an object and access methods.
547 * A read-only value will not have a setter; a write-only value will
550 template <class C, class T>
551 class SGRawValueMethods : public SGRawValue<T>
554 typedef T (C::*getter_t)() const;
555 typedef void (C::*setter_t)(T);
556 SGRawValueMethods (C &obj, getter_t getter = 0, setter_t setter = 0)
557 : _obj(obj), _getter(getter), _setter(setter) {}
558 virtual ~SGRawValueMethods () {}
559 virtual T getValue () const {
560 if (_getter) { return (_obj.*_getter)(); }
561 else { return SGRawValue<T>::DefaultValue(); }
563 virtual bool setValue (T value) {
564 if (_setter) { (_obj.*_setter)(value); return true; }
567 virtual SGRaw* clone () const {
568 return new SGRawValueMethods(_obj, _getter, _setter);
578 * An indexed value managed through an object and access methods.
580 * A read-only value will not have a setter; a write-only value will
583 template <class C, class T>
584 class SGRawValueMethodsIndexed : public SGRawValue<T>
587 typedef T (C::*getter_t)(int) const;
588 typedef void (C::*setter_t)(int, T);
589 SGRawValueMethodsIndexed (C &obj, int index,
590 getter_t getter = 0, setter_t setter = 0)
591 : _obj(obj), _index(index), _getter(getter), _setter(setter) {}
592 virtual ~SGRawValueMethodsIndexed () {}
593 virtual T getValue () const {
594 if (_getter) { return (_obj.*_getter)(_index); }
595 else { return SGRawValue<T>::DefaultValue(); }
597 virtual bool setValue (T value) {
598 if (_setter) { (_obj.*_setter)(_index, value); return true; }
601 virtual SGRaw* clone () const {
602 return new SGRawValueMethodsIndexed(_obj, _index, _getter, _setter);
612 * A raw value that contains its value. This provides a way for
613 * property nodes to contain values that shouldn't be stored in the
614 * property node itself.
617 class SGRawValueContainer : public SGRawValue<T>
622 * Explicit constructor.
624 SGRawValueContainer(const T& obj) : _obj(obj) {}
629 virtual ~SGRawValueContainer() {}
632 * Get the underlying value.
634 virtual T getValue() const { return _obj; }
637 * Set the underlying value.
639 * This method will dereference the pointer and change the
642 virtual bool setValue (T value) { _obj = value; return true; }
645 * Create a copy of this raw value.
647 virtual SGRaw* clone () const {
648 return new SGRawValueContainer(_obj);
656 SGRawExtended* SGRawBase<T, 0>::makeContainer() const
658 return new SGRawValueContainer<T>(static_cast<const SGRawValue<T>*>(this)
663 std::ostream& SGRawBase<T, 0>::printOn(std::ostream& stream) const
665 return stream << static_cast<SGRawValue<T>*>(this)->getValue();
669 std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
672 simgear::readFrom(stream, value);
673 static_cast<SGRawValue<T>*>(this)->setValue(value);
678 * The smart pointer that manage reference counting
680 class SGPropertyNode;
681 typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
682 typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
686 typedef std::vector<SGPropertyNode_ptr> PropertyList;
690 * The property change listener interface.
692 * <p>Any class that needs to listen for property changes must implement
693 * this interface.</p>
695 class SGPropertyChangeListener
698 virtual ~SGPropertyChangeListener ();
699 virtual void valueChanged (SGPropertyNode * node);
700 virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child);
701 virtual void childRemoved (SGPropertyNode * parent, SGPropertyNode * child);
704 friend class SGPropertyNode;
705 virtual void register_property (SGPropertyNode * node);
706 virtual void unregister_property (SGPropertyNode * node);
709 std::vector<SGPropertyNode *> _properties;
714 * A node in a property tree.
716 class SGPropertyNode : public SGReferenced
724 MAX_STRING_LEN = 1024
728 * Access mode attributes.
730 * <p>The ARCHIVE attribute is strictly advisory, and controls
731 * whether the property should normally be saved and restored.</p>
742 // beware: if you add another attribute here,
743 // also update value of "LAST_USED_ATTRIBUTE".
748 * Last used attribute
749 * Update as needed when enum Attribute is changed
751 static const int LAST_USED_ATTRIBUTE;
754 * Default constructor.
762 SGPropertyNode (const SGPropertyNode &node);
768 virtual ~SGPropertyNode ();
777 * Test whether this node contains a primitive leaf value.
779 bool hasValue () const { return (_type != simgear::props::NONE); }
783 * Get the node's simple (XML) name.
785 const char * getName () const { return _name.c_str(); }
788 * Get the node's simple name as a string.
790 const std::string& getNameString () const { return _name; }
793 * Get the node's pretty display name, with subscript when needed.
795 std::string getDisplayName (bool simplify = false) const;
799 * Get the node's integer index.
801 int getIndex () const { return _index; }
805 * Get a non-const pointer to the node's parent.
807 SGPropertyNode * getParent () { return _parent; }
811 * Get a const pointer to the node's parent.
813 const SGPropertyNode * getParent () const { return _parent; }
822 * Get the number of child nodes.
824 int nChildren () const { return (int)_children.size(); }
828 * Get a child node by position (*NOT* index).
830 SGPropertyNode * getChild (int position);
834 * Get a const child node by position (*NOT* index).
836 const SGPropertyNode * getChild (int position) const;
840 * Test whether a named child exists.
842 bool hasChild (const char * name, int index = 0) const
844 return (getChild(name, index) != 0);
848 * Test whether a named child exists.
850 bool hasChild (const std::string& name, int index = 0) const
852 return (getChild(name, index) != 0);
856 * Create a new child node with the given name and an unused index
858 * @param min_index Minimal index for new node (skips lower indices)
859 * @param append Whether to simply use the index after the last used index
860 * or use a lower, unused index if it exists
862 SGPropertyNode * addChild ( const char* name,
864 bool append = true );
865 SGPropertyNode * addChild ( const std::string& name,
868 { return addChild(name.c_str(), min_index, append); }
871 * Create multiple child nodes with the given name an unused indices
873 * @param count The number of nodes create
874 * @param min_index Minimal index for new nodes (skips lower indices)
875 * @param append Whether to simply use the index after the last used index
876 * or use a lower, unused index if it exists
878 simgear::PropertyList addChildren ( const std::string& name,
881 bool append = true );
884 * Get a child node by name and index.
886 SGPropertyNode * getChild (const char* name, int index = 0,
887 bool create = false);
888 SGPropertyNode * getChild (const std::string& name, int index = 0,
889 bool create = false);
891 * Get a const child node by name and index.
893 const SGPropertyNode * getChild (const char * name, int index = 0) const;
896 * Get a const child node by name and index.
898 const SGPropertyNode * getChild (const std::string& name, int index = 0) const
899 { return getChild(name.c_str(), index); }
903 * Get a vector of all children with the specified name.
905 simgear::PropertyList getChildren (const char * name) const;
908 * Get a vector of all children with the specified name.
910 simgear::PropertyList getChildren (const std::string& name) const
911 { return getChildren(name.c_str()); }
913 // TODO do we need the removeXXX methods to return the deleted nodes?
915 * Remove child by position.
917 SGPropertyNode_ptr removeChild (int pos, bool keep = true);
921 * Remove a child node
923 SGPropertyNode_ptr removeChild (const char * name, int index = 0,
927 * Remove a child node
929 SGPropertyNode_ptr removeChild (const std::string& name, int index = 0,
931 { return removeChild(name.c_str(), index, keep); }
934 * Remove all children with the specified name.
936 simgear::PropertyList removeChildren (const char * name, bool keep = true);
939 * Remove all children with the specified name.
941 simgear::PropertyList removeChildren (const std::string& name,
943 { return removeChildren(name.c_str(), keep); }
946 * Remove all children (does not change the value of the node)
948 void removeAllChildren();
956 * Alias this node's leaf value to another's.
958 bool alias (SGPropertyNode * target);
962 * Alias this node's leaf value to another's by relative path.
964 bool alias (const char * path);
967 * Alias this node's leaf value to another's by relative path.
969 bool alias (const std::string& path)
970 { return alias(path.c_str()); }
974 * Remove any alias for this node.
980 * Test whether the node's leaf value is aliased to another's.
982 bool isAlias () const { return (_type == simgear::props::ALIAS); }
986 * Get a non-const pointer to the current alias target, if any.
988 SGPropertyNode * getAliasTarget ();
992 * Get a const pointer to the current alias target, if any.
994 const SGPropertyNode * getAliasTarget () const;
1003 * Get the path to this node from the root.
1005 std::string getPath (bool simplify = false) const;
1009 * Get a pointer to the root node.
1011 SGPropertyNode * getRootNode ();
1015 * Get a const pointer to the root node.
1017 const SGPropertyNode * getRootNode () const;
1021 * Get a pointer to another node by relative path.
1023 SGPropertyNode * getNode (const char * relative_path, bool create = false);
1026 * Get a pointer to another node by relative path.
1028 SGPropertyNode * getNode (const std::string& relative_path, bool create = false)
1029 { return getNode(relative_path.c_str(), create); }
1032 * Get a pointer to another node by relative path.
1034 * This method leaves the index off the last member of the path,
1035 * so that the user can specify it separately (and save some
1036 * string building). For example, getNode("/bar[1]/foo", 3) is
1037 * exactly equivalent to getNode("bar[1]/foo[3]"). The index
1038 * provided overrides any given in the path itself for the last
1041 SGPropertyNode * getNode (const char * relative_path, int index,
1042 bool create = false);
1045 * Get a pointer to another node by relative path.
1047 * This method leaves the index off the last member of the path,
1048 * so that the user can specify it separately (and save some
1049 * string building). For example, getNode("/bar[1]/foo", 3) is
1050 * exactly equivalent to getNode("bar[1]/foo[3]"). The index
1051 * provided overrides any given in the path itself for the last
1054 SGPropertyNode * getNode (const std::string& relative_path, int index,
1055 bool create = false)
1056 { return getNode(relative_path.c_str(), index, create); }
1059 * Get a const pointer to another node by relative path.
1061 const SGPropertyNode * getNode (const char * relative_path) const;
1064 * Get a const pointer to another node by relative path.
1066 const SGPropertyNode * getNode (const std::string& relative_path) const
1067 { return getNode(relative_path.c_str()); }
1071 * Get a const pointer to another node by relative path.
1073 * This method leaves the index off the last member of the path,
1074 * so that the user can specify it separate.
1076 const SGPropertyNode * getNode (const char * relative_path,
1080 * Get a const pointer to another node by relative path.
1082 * This method leaves the index off the last member of the path,
1083 * so that the user can specify it separate.
1085 const SGPropertyNode * getNode (const std::string& relative_path,
1087 { return getNode(relative_path.c_str(), index); }
1094 * Check a single mode attribute for the property node.
1096 bool getAttribute (Attribute attr) const { return ((_attr & attr) != 0); }
1100 * Set a single mode attribute for the property node.
1102 void setAttribute (Attribute attr, bool state) {
1103 (state ? _attr |= attr : _attr &= ~attr);
1108 * Get all of the mode attributes for the property node.
1110 int getAttributes () const { return _attr; }
1114 * Set all of the mode attributes for the property node.
1116 void setAttributes (int attr) { _attr = attr; }
1120 // Leaf Value (primitive).
1125 * Get the type of leaf value, if any, for this node.
1127 simgear::props::Type getType () const;
1131 * Get a bool value for this node.
1133 bool getBoolValue () const;
1137 * Get an int value for this node.
1139 int getIntValue () const;
1143 * Get a long int value for this node.
1145 long getLongValue () const;
1149 * Get a float value for this node.
1151 float getFloatValue () const;
1155 * Get a double value for this node.
1157 double getDoubleValue () const;
1161 * Get a string value for this node.
1163 const char * getStringValue () const;
1166 * Get a value from a node. If the actual type of the node doesn't
1167 * match the desired type, a conversion isn't guaranteed.
1169 template<typename T>
1170 T getValue(typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
1171 ::type* dummy = 0) const;
1172 // Getter for extended property
1173 template<typename T>
1174 T getValue(typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
1175 ::type* dummy = 0) const;
1178 * Get a list of values from all children with the given name
1180 template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
1181 std::vector<T> getChildValues(const std::string& name) const;
1184 * Get a list of values from all children with the given name
1186 template<typename T>
1187 std::vector<T> getChildValues(const std::string& name) const;
1190 * Set a bool value for this node.
1192 bool setBoolValue (bool value);
1196 * Set an int value for this node.
1198 bool setIntValue (int value);
1202 * Set a long int value for this node.
1204 bool setLongValue (long value);
1208 * Set a float value for this node.
1210 bool setFloatValue (float value);
1214 * Set a double value for this node.
1216 bool setDoubleValue (double value);
1220 * Set a string value for this node.
1222 bool setStringValue (const char * value);
1225 * Set a string value for this node.
1227 bool setStringValue (const std::string& value)
1228 { return setStringValue(value.c_str()); }
1232 * Set a value of unspecified type for this node.
1234 bool setUnspecifiedValue (const char * value);
1236 template<typename T>
1237 bool setValue(const T& val,
1238 typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
1241 template<typename T>
1242 bool setValue(const T& val,
1243 typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
1247 bool setValue(const char (&val)[N])
1249 return setValue(&val[0]);
1253 * Set relative node to given value and afterwards make read only.
1255 * @param relative_path Path to node
1256 * @param value Value to set
1258 * @return whether value could be set
1260 template<typename T>
1261 bool setValueReadOnly(const std::string& relative_path, const T& value)
1263 SGPropertyNode* node = getNode(relative_path, true);
1264 bool ret = node->setValue(value);
1265 node->setAttributes(READ);
1270 * Interpolate current value to target value within given time.
1272 * @param type Type of interpolation ("numeric", "color", etc.)
1273 * @param target Node containing target value
1274 * @param duration Duration of interpolation (in seconds)
1275 * @param easing Easing function (http://easings.net/)
1277 bool interpolate( const std::string& type,
1278 const SGPropertyNode& target,
1279 double duration = 0.6,
1280 const std::string& easing = "swing" );
1283 * Interpolate current value to a series of values within given durations.
1285 * @param type Type of interpolation ("numeric", "color", etc.)
1286 * @param values Nodes containing intermediate and target values
1287 * @param duration Durations for each interpolation step (in seconds)
1288 * @param easing Easing function (http://easings.net/)
1290 bool interpolate( const std::string& type,
1291 const simgear::PropertyList& values,
1292 const double_list& deltas,
1293 const std::string& easing = "swing" );
1296 * Set the interpolation manager used by the interpolate methods.
1298 static void setInterpolationMgr(simgear::PropertyInterpolationMgr* mgr);
1301 * Print the value of the property to a stream.
1303 std::ostream& printOn(std::ostream& stream) const;
1311 * Test whether this node is bound to an external data source.
1313 bool isTied () const { return _tied; }
1316 * Bind this node to an external source.
1318 template<typename T>
1319 bool tie(const SGRawValue<T> &rawValue, bool useDefault = true);
1322 * Unbind this node from any external data source.
1328 // Convenience methods using paths.
1329 // TODO: add attribute methods
1334 * Get another node's type.
1336 simgear::props::Type getType (const char * relative_path) const;
1339 * Get another node's type.
1341 simgear::props::Type getType (const std::string& relative_path) const
1342 { return getType(relative_path.c_str()); }
1345 * Test whether another node has a leaf value.
1347 bool hasValue (const char * relative_path) const;
1350 * Test whether another node has a leaf value.
1352 bool hasValue (const std::string& relative_path) const
1353 { return hasValue(relative_path.c_str()); }
1356 * Get another node's value as a bool.
1358 bool getBoolValue (const char * relative_path,
1359 bool defaultValue = false) const;
1362 * Get another node's value as a bool.
1364 bool getBoolValue (const std::string& relative_path,
1365 bool defaultValue = false) const
1366 { return getBoolValue(relative_path.c_str(), defaultValue); }
1369 * Get another node's value as an int.
1371 int getIntValue (const char * relative_path,
1372 int defaultValue = 0) const;
1375 * Get another node's value as an int.
1377 int getIntValue (const std::string& relative_path,
1378 int defaultValue = 0) const
1379 { return getIntValue(relative_path.c_str(), defaultValue); }
1383 * Get another node's value as a long int.
1385 long getLongValue (const char * relative_path,
1386 long defaultValue = 0L) const;
1389 * Get another node's value as a long int.
1391 long getLongValue (const std::string& relative_path,
1392 long defaultValue = 0L) const
1393 { return getLongValue(relative_path.c_str(), defaultValue); }
1396 * Get another node's value as a float.
1398 float getFloatValue (const char * relative_path,
1399 float defaultValue = 0.0f) const;
1402 * Get another node's value as a float.
1404 float getFloatValue (const std::string& relative_path,
1405 float defaultValue = 0.0f) const
1406 { return getFloatValue(relative_path.c_str(), defaultValue); }
1410 * Get another node's value as a double.
1412 double getDoubleValue (const char * relative_path,
1413 double defaultValue = 0.0) const;
1416 * Get another node's value as a double.
1418 double getDoubleValue (const std::string& relative_path,
1419 double defaultValue = 0.0) const
1420 { return getDoubleValue(relative_path.c_str(), defaultValue); }
1423 * Get another node's value as a string.
1425 const char * getStringValue (const char * relative_path,
1426 const char * defaultValue = "") const;
1430 * Get another node's value as a string.
1432 const char * getStringValue (const std::string& relative_path,
1433 const char * defaultValue = "") const
1434 { return getStringValue(relative_path.c_str(), defaultValue); }
1438 * Set another node's value as a bool.
1440 bool setBoolValue (const char * relative_path, bool value);
1443 * Set another node's value as a bool.
1445 bool setBoolValue (const std::string& relative_path, bool value)
1446 { return setBoolValue(relative_path.c_str(), value); }
1450 * Set another node's value as an int.
1452 bool setIntValue (const char * relative_path, int value);
1455 * Set another node's value as an int.
1457 bool setIntValue (const std::string& relative_path, int value)
1458 { return setIntValue(relative_path.c_str(), value); }
1462 * Set another node's value as a long int.
1464 bool setLongValue (const char * relative_path, long value);
1467 * Set another node's value as a long int.
1469 bool setLongValue (const std::string& relative_path, long value)
1470 { return setLongValue(relative_path.c_str(), value); }
1474 * Set another node's value as a float.
1476 bool setFloatValue (const char * relative_path, float value);
1479 * Set another node's value as a float.
1481 bool setFloatValue (const std::string& relative_path, float value)
1482 { return setFloatValue(relative_path.c_str(), value); }
1486 * Set another node's value as a double.
1488 bool setDoubleValue (const char * relative_path, double value);
1491 * Set another node's value as a double.
1493 bool setDoubleValue (const std::string& relative_path, double value)
1494 { return setDoubleValue(relative_path.c_str(), value); }
1498 * Set another node's value as a string.
1500 bool setStringValue (const char * relative_path, const char * value);
1502 bool setStringValue(const char * relative_path, const std::string& value)
1503 { return setStringValue(relative_path, value.c_str()); }
1505 * Set another node's value as a string.
1507 bool setStringValue (const std::string& relative_path, const char * value)
1508 { return setStringValue(relative_path.c_str(), value); }
1510 bool setStringValue (const std::string& relative_path,
1511 const std::string& value)
1512 { return setStringValue(relative_path.c_str(), value.c_str()); }
1515 * Set another node's value with no specified type.
1517 bool setUnspecifiedValue (const char * relative_path, const char * value);
1521 * Test whether another node is bound to an external data source.
1523 bool isTied (const char * relative_path) const;
1526 * Test whether another node is bound to an external data source.
1528 bool isTied (const std::string& relative_path) const
1529 { return isTied(relative_path.c_str()); }
1532 * Bind another node to an external bool source.
1534 bool tie (const char * relative_path, const SGRawValue<bool> &rawValue,
1535 bool useDefault = true);
1538 * Bind another node to an external bool source.
1540 bool tie (const std::string& relative_path, const SGRawValue<bool> &rawValue,
1541 bool useDefault = true)
1542 { return tie(relative_path.c_str(), rawValue, useDefault); }
1546 * Bind another node to an external int source.
1548 bool tie (const char * relative_path, const SGRawValue<int> &rawValue,
1549 bool useDefault = true);
1552 * Bind another node to an external int source.
1554 bool tie (const std::string& relative_path, const SGRawValue<int> &rawValue,
1555 bool useDefault = true)
1556 { return tie(relative_path.c_str(), rawValue, useDefault); }
1560 * Bind another node to an external long int source.
1562 bool tie (const char * relative_path, const SGRawValue<long> &rawValue,
1563 bool useDefault = true);
1566 * Bind another node to an external long int source.
1568 bool tie (const std::string& relative_path, const SGRawValue<long> &rawValue,
1569 bool useDefault = true)
1570 { return tie(relative_path.c_str(), rawValue, useDefault); }
1574 * Bind another node to an external float source.
1576 bool tie (const char * relative_path, const SGRawValue<float> &rawValue,
1577 bool useDefault = true);
1580 * Bind another node to an external float source.
1582 bool tie (const std::string& relative_path, const SGRawValue<float> &rawValue,
1583 bool useDefault = true)
1584 { return tie(relative_path.c_str(), rawValue, useDefault); }
1588 * Bind another node to an external double source.
1590 bool tie (const char * relative_path, const SGRawValue<double> &rawValue,
1591 bool useDefault = true);
1594 * Bind another node to an external double source.
1596 bool tie (const std::string& relative_path, const SGRawValue<double> &rawValue,
1597 bool useDefault = true)
1598 { return tie(relative_path.c_str(), rawValue, useDefault); }
1602 * Bind another node to an external string source.
1604 bool tie (const char * relative_path, const SGRawValue<const char *> &rawValue,
1605 bool useDefault = true);
1608 * Bind another node to an external string source.
1610 bool tie (const std::string& relative_path, const SGRawValue<const char*> &rawValue,
1611 bool useDefault = true)
1612 { return tie(relative_path.c_str(), rawValue, useDefault); }
1616 * Unbind another node from any external data source.
1618 bool untie (const char * relative_path);
1621 * Unbind another node from any external data source.
1623 bool untie (const std::string& relative_path)
1624 { return untie(relative_path.c_str()); }
1628 * Add a change listener to the property. If "initial" is set call the
1629 * listener initially.
1631 void addChangeListener (SGPropertyChangeListener * listener,
1632 bool initial = false);
1636 * Remove a change listener from the property.
1638 void removeChangeListener (SGPropertyChangeListener * listener);
1642 * Get the number of listeners.
1644 int nListeners () const { return _listeners ? (int)_listeners->size() : 0; }
1648 * Fire a value change event to all listeners.
1650 void fireValueChanged ();
1654 * Fire a child-added event to all listeners.
1656 void fireChildAdded (SGPropertyNode * child);
1659 * Trigger a child-added and value-changed event for every child (Unlimited
1662 * @param fire_self Whether to trigger the events also for the node itself.
1664 * It can be used to simulating the creation of a property tree, eg. for
1665 * (re)initializing a subsystem which is controlled through the property tree.
1667 void fireCreatedRecursive(bool fire_self = false);
1670 * Fire a child-removed event to all listeners.
1672 void fireChildRemoved (SGPropertyNode * child);
1675 * Fire a child-removed event for every child of this node (Unlimited depth)
1677 * Upon removal of a child node only for this single node a child-removed
1678 * event is triggered. If eg. resource cleanup relies on receiving a
1679 * child-removed event for every child this method can be used.
1681 void fireChildrenRemovedRecursive();
1685 * Clear any existing value and set the type to NONE.
1690 * Compare two property trees. The property trees are equal if: 1)
1691 * They have no children, and have the same type and the values are
1692 * equal, or 2) have the same number of children, and the
1693 * corresponding children in each tree are equal. "corresponding"
1694 * means have the same name and index.
1696 * Attributes, removed children, and aliases aren't considered.
1698 static bool compare (const SGPropertyNode& lhs, const SGPropertyNode& rhs);
1702 void fireValueChanged (SGPropertyNode * node);
1703 void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child);
1704 void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child);
1707 * Protected constructor for making new nodes on demand.
1709 SGPropertyNode (const std::string& name, int index, SGPropertyNode * parent);
1710 template<typename Itr>
1711 SGPropertyNode (Itr begin, Itr end, int index, SGPropertyNode * parent);
1713 static simgear::PropertyInterpolationMgr* _interpolation_mgr;
1717 // Get the raw value
1718 bool get_bool () const;
1719 int get_int () const;
1720 long get_long () const;
1721 float get_float () const;
1722 double get_double () const;
1723 const char * get_string () const;
1725 // Set the raw value
1726 bool set_bool (bool value);
1727 bool set_int (int value);
1728 bool set_long (long value);
1729 bool set_float (float value);
1730 bool set_double (double value);
1731 bool set_string (const char * value);
1735 * Get the value as a string.
1737 const char * make_string () const;
1740 * Trace a read access.
1742 void trace_read () const;
1746 * Trace a write access.
1748 void trace_write () const;
1752 /// To avoid cyclic reference counting loops this shall not be a reference
1754 SGPropertyNode * _parent;
1755 simgear::PropertyList _children;
1756 simgear::PropertyList _removedChildren;
1757 mutable std::string _buffer;
1758 simgear::props::Type _type;
1762 // The right kind of pointer...
1764 SGPropertyNode * alias;
1777 std::vector<SGPropertyChangeListener *> * _listeners;
1779 // Pass name as a pair of iterators
1780 template<typename Itr>
1781 SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false);
1782 // very internal method
1783 template<typename Itr>
1784 SGPropertyNode* getExistingChild (Itr begin, Itr end, int index, bool create);
1785 // very internal path parsing function
1786 template<typename SplitItr>
1787 friend SGPropertyNode* find_node_aux(SGPropertyNode * current, SplitItr& itr,
1788 bool create, int last_index);
1790 friend size_t hash_value(const SGPropertyNode& node);
1793 // Convenience functions for use in templates
1794 template<typename T>
1795 typename boost::disable_if<boost::is_enum<T>, T>::type
1796 getValue(const SGPropertyNode*);
1799 inline bool getValue<bool>(const SGPropertyNode* node) { return node->getBoolValue(); }
1802 inline int getValue<int>(const SGPropertyNode* node) { return node->getIntValue(); }
1805 inline long getValue<long>(const SGPropertyNode* node) { return node->getLongValue(); }
1808 inline float getValue<float>(const SGPropertyNode* node)
1810 return node->getFloatValue();
1814 inline double getValue<double>(const SGPropertyNode* node)
1816 return node->getDoubleValue();
1820 inline const char * getValue<const char*>(const SGPropertyNode* node)
1822 return node->getStringValue ();
1826 inline std::string getValue<std::string>(const SGPropertyNode* node)
1828 return node->getStringValue();
1834 * Default trait for extracting enum values from SGPropertyNode. Create your
1835 * own specialization for specific enum types to enable validation of values.
1841 * Typename of the enum
1843 static const char* name() { return typeid(T).name(); }
1846 * @return Default value (will be used if validation fails)
1848 static T defVal() { return T(); }
1851 * @return Whether the given integer value has an enum value defined
1853 static bool validate(int) { return true; }
1855 } // namespace simgear
1857 /** Extract enum from SGPropertyNode */
1858 template<typename T>
1859 inline typename boost::enable_if<boost::is_enum<T>, T>::type
1860 getValue(const SGPropertyNode* node)
1862 typedef simgear::enum_traits<T> Traits;
1863 int val = node->getIntValue();
1864 if( !Traits::validate(val) )
1870 "Invalid value for enum (" << Traits::name() << ", val = " << val << ")"
1872 return Traits::defVal();
1874 return static_cast<T>(node->getIntValue());
1877 inline bool setValue(SGPropertyNode* node, bool value)
1879 return node->setBoolValue(value);
1882 inline bool setValue(SGPropertyNode* node, int value)
1884 return node->setIntValue(value);
1887 inline bool setValue(SGPropertyNode* node, long value)
1889 return node->setLongValue(value);
1892 inline bool setValue(SGPropertyNode* node, float value)
1894 return node->setFloatValue(value);
1897 inline bool setValue(SGPropertyNode* node, double value)
1899 return node->setDoubleValue(value);
1902 inline bool setValue(SGPropertyNode* node, const char* value)
1904 return node->setStringValue(value);
1907 inline bool setValue (SGPropertyNode* node, const std::string& value)
1909 return node->setStringValue(value.c_str());
1912 template<typename T>
1913 bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
1915 using namespace simgear::props;
1916 if (_type == ALIAS || _tied)
1919 useDefault = useDefault && hasValue();
1920 T old_val = SGRawValue<T>::DefaultValue();
1922 old_val = getValue<T>(this);
1924 if (PropertyTraits<T>::Internal)
1925 _type = PropertyTraits<T>::type_tag;
1929 _value.val = rawValue.clone();
1931 int save_attributes = getAttributes();
1932 setAttribute( WRITE, true );
1934 setAttributes( save_attributes );
1940 bool SGPropertyNode::tie (const SGRawValue<const char *> &rawValue,
1943 template<typename T>
1944 T SGPropertyNode::getValue(typename boost::disable_if_c<simgear::props
1945 ::PropertyTraits<T>::Internal>::type* dummy) const
1947 using namespace simgear::props;
1948 if (_attr == (READ|WRITE) && _type == EXTENDED
1949 && _value.val->getType() == PropertyTraits<T>::type_tag) {
1950 return static_cast<SGRawValue<T>*>(_value.val)->getValue();
1952 if (getAttribute(TRACE_READ))
1954 if (!getAttribute(READ))
1955 return SGRawValue<T>::DefaultValue();
1958 if (_value.val->getType() == PropertyTraits<T>::type_tag)
1959 return static_cast<SGRawValue<T>*>(_value.val)->getValue();
1963 return simgear::parseString<T>(make_string());
1965 default: // avoid compiler warning
1968 return SGRawValue<T>::DefaultValue();
1971 template<typename T>
1972 inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
1973 ::PropertyTraits<T>::Internal>::type* dummy) const
1975 return ::getValue<T>(this);
1978 template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
1979 std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
1981 const simgear::PropertyList& props = getChildren(name);
1982 std::vector<T> values( props.size() );
1984 for( size_t i = 0; i < props.size(); ++i )
1985 values[i] = props[i]->getValue<T_get>();
1990 template<typename T>
1992 std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
1994 return getChildValues<T, T>(name);
1997 template<typename T>
1998 bool SGPropertyNode::setValue(const T& val,
1999 typename boost::disable_if_c<simgear::props
2000 ::PropertyTraits<T>::Internal>::type* dummy)
2002 using namespace simgear::props;
2003 if (_attr == (READ|WRITE) && _type == EXTENDED
2004 && _value.val->getType() == PropertyTraits<T>::type_tag) {
2005 static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
2008 if (getAttribute(WRITE)
2009 && ((_type == EXTENDED
2010 && _value.val->getType() == PropertyTraits<T>::type_tag)
2011 || _type == NONE || _type == UNSPECIFIED)) {
2012 if (_type == NONE || _type == UNSPECIFIED) {
2015 _value.val = new SGRawValueContainer<T>(val);
2017 static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
2019 if (getAttribute(TRACE_WRITE))
2026 template<typename T>
2027 inline bool SGPropertyNode::setValue(const T& val,
2028 typename boost::enable_if_c<simgear::props
2029 ::PropertyTraits<T>::Internal>::type* dummy)
2031 return ::setValue(this, val);
2035 * Utility function for creation of a child property node.
2037 inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name,
2040 return parent->getChild(name, index, true);
2044 * Utility function for creation of a child property node using a
2049 template<typename StringType>
2050 inline SGPropertyNode* makeNode(SGPropertyNode* parent, const StringType& name)
2052 return parent->getNode(name, true);
2057 size_t hash_value(const SGPropertyNode& node);
2059 // Helper comparison and hash functions for common cases
2067 bool operator()(const SGPropertyNode* lhs, const SGPropertyNode* rhs) const
2069 return SGPropertyNode::compare(*lhs, *rhs);
2071 bool operator()(SGPropertyNode_ptr lhs, const SGPropertyNode* rhs) const
2073 return SGPropertyNode::compare(*lhs, *rhs);
2075 bool operator()(const SGPropertyNode* lhs, SGPropertyNode_ptr rhs) const
2077 return SGPropertyNode::compare(*lhs, *rhs);
2079 bool operator()(SGPropertyNode_ptr lhs, SGPropertyNode_ptr rhs) const
2081 return SGPropertyNode::compare(*lhs, *rhs);
2087 size_t operator()(const SGPropertyNode* node) const
2089 return hash_value(*node);
2091 size_t operator()(SGPropertyNode_ptr node) const
2093 return hash_value(*node);
2099 /** Convenience class for change listener callbacks without
2100 * creating a derived class implementing a "valueChanged" method.
2101 * Also removes listener on destruction automatically.
2104 class SGPropertyChangeCallback
2105 : public SGPropertyChangeListener
2108 SGPropertyChangeCallback(T* obj, void (T::*method)(SGPropertyNode*),
2109 SGPropertyNode_ptr property,bool initial=false)
2110 : _obj(obj), _callback(method), _property(property)
2112 _property->addChangeListener(this,initial);
2115 SGPropertyChangeCallback(const SGPropertyChangeCallback<T>& other) :
2116 _obj(other._obj), _callback(other._callback), _property(other._property)
2118 _property->addChangeListener(this,false);
2121 virtual ~SGPropertyChangeCallback()
2123 _property->removeChangeListener(this);
2125 void valueChanged (SGPropertyNode * node)
2127 (_obj->*_callback)(node);
2131 void (T::*_callback)(SGPropertyNode*);
2132 SGPropertyNode_ptr _property;
2135 #endif // __PROPS_HXX