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
24 #include <boost/utility.hpp>
28 #include <simgear/compiler.h>
29 #include <simgear/debug/logstream.hxx>
33 #include <simgear/math/SGMathFwd.hxx>
34 #include <simgear/structure/SGReferenced.hxx>
35 #include <simgear/structure/SGSharedPtr.hxx>
37 // XXX This whole file should be in the simgear namespace, but I don't
38 // have the guts yet...
43 std::istream& readFrom(std::istream& stream, T& result)
50 * Parse a string as an object of a given type.
51 * XXX no error behavior yet.
53 * @tparam T the return type
54 * @param str the string
58 inline T parseString(const std::string& str)
60 std::istringstream stream(str);
62 readFrom(stream, result);
66 // Extended properties
68 std::istream& readFrom<SGVec3d>(std::istream& stream, SGVec3d& result);
70 std::istream& readFrom<SGVec4d>(std::istream& stream, SGVec4d& result);
74 * Property value types.
78 #pragma warn A sloppy coder has defined NONE as a macro!
83 #pragma warn A sloppy coder has defined ALIAS as a macro!
88 #pragma warn A sloppy coder has defined UNSPECIFIED as a macro!
93 #pragma warn A sloppy coder has defined BOOL as a macro!
98 #pragma warn A sloppy coder has defined INT as a macro!
103 #pragma warn A sloppy coder has defined LONG as a macro!
108 #pragma warn A sloppy coder has defined FLOAT as a macro!
113 #pragma warn A sloppy coder has defined DOUBLE as a macro!
118 #pragma warn A sloppy coder has defined STRING as a macro!
125 * The possible types of an SGPropertyNode. Types that appear after
126 * EXTENDED are not stored in the SGPropertyNode itself.
129 NONE = 0, /**< The node hasn't been assigned a value yet. */
130 ALIAS, /**< The node "points" to another node. */
138 EXTENDED, /**< The node's value is not stored in the property;
139 * the actual value and type is retrieved from an
140 * SGRawValue node. This type is never returned by @see
141 * SGPropertyNode::getType.
143 // Extended properties
148 template<typename T> struct PropertyTraits;
150 #define DEFINTERNALPROP(TYPE, PROP) \
152 struct PropertyTraits<TYPE> \
154 static const Type type_tag = PROP; \
155 enum { Internal = 1 }; \
158 DEFINTERNALPROP(bool, BOOL);
159 DEFINTERNALPROP(int, INT);
160 DEFINTERNALPROP(long, LONG);
161 DEFINTERNALPROP(float, FLOAT);
162 DEFINTERNALPROP(double, DOUBLE);
163 DEFINTERNALPROP(const char *, STRING);
164 #undef DEFINTERNALPROP
167 struct PropertyTraits<SGVec3d>
169 static const Type type_tag = VEC3D;
170 enum { Internal = 0 };
174 struct PropertyTraits<SGVec4d>
176 static const Type type_tag = VEC4D;
177 enum { Internal = 0 };
185 ////////////////////////////////////////////////////////////////////////
188 // This is the mechanism that information-providing routines can
189 // use to link their own values to the property manager. Any
190 // SGValue can be tied to a raw value and then untied again.
192 // Note: we are forced to use inlined methods here to ensure
193 // that the templates will be instantiated. We're probably taking
194 // a small performance hit for that.
195 ////////////////////////////////////////////////////////////////////////
198 * Base class for SGRawValue classes that holds no type
199 * information. This allows some generic manipulation of the
206 * Get the type enumeration for the raw value.
210 virtual simgear::props::Type getType() const = 0;
214 * Create a new deep copy of this raw value.
216 * The copy will contain its own version of the underlying value
217 * as well, and will be the same type.
219 * @return A deep copy of the current object.
221 virtual SGRaw* clone() const = 0;
225 class SGRawExtended : public SGRaw
229 * Make an SGRawValueContainer from the SGRawValue.
231 * This is a virtual function of SGRawExtended so that
232 * SGPropertyNode::untie doesn't need to know the type of an
235 virtual SGRawExtended* makeContainer() const = 0;
237 * Write value out to a stream
239 virtual std::ostream& printOn(std::ostream& stream) const = 0;
241 * Read value from a stream and store it.
243 virtual std::istream& readFrom(std::istream& stream) = 0;
246 // Choose between different base classes based on whether the value is
247 // stored internal to the property node. This frees us from defining
248 // the virtual functions in the SGRawExtended interface where they
249 // don't make sense, e.g. readFrom for the const char* type.
250 template<typename T, int internal = simgear::props::PropertyTraits<T>::Internal>
254 class SGRawBase<T, 1> : public SGRaw
259 class SGRawBase<T, 0> : public SGRawExtended
261 virtual SGRawExtended* makeContainer() const;
262 virtual std::ostream& printOn(std::ostream& stream) const;
263 virtual std::istream& readFrom(std::istream& stream);
267 * Abstract base class for a raw value.
269 * <p>The property manager is implemented in two layers. The {@link
270 * SGPropertyNode} is the highest and most abstract layer,
271 * representing an LValue/RValue pair: it records the position of the
272 * property in the property tree and contains facilities for
273 * navigation to other nodes. It is guaranteed to be persistent: the
274 * {@link SGPropertyNode} will not change during a session, even if
275 * the property is bound and unbound multiple times.</p>
277 * <p>When the property value is not managed internally in the
278 * SGPropertyNode, the SGPropertyNode will contain a reference to an
279 * SGRawValue (this class), which provides an abstract way to get,
280 * set, and clone the underlying value. The SGRawValue may change
281 * frequently during a session as a value is retyped or bound and
282 * unbound to various data source, but the abstract SGPropertyNode
283 * layer insulates the application from those changes.
285 * <p>The SGPropertyNode class always keeps a *copy* of a raw value,
286 * not the original one passed to it; if you override a derived class
287 * but do not replace the {@link #clone} method, strange things will
290 * <p>All derived SGRawValue classes must implement {@link #getValue},
291 * {@link #setValue}, and {@link #clone} for the appropriate type.</p>
293 * @see SGPropertyNode
294 * @see SGRawValuePointer
295 * @see SGRawValueFunctions
296 * @see SGRawValueFunctionsIndexed
297 * @see SGRawValueMethods
298 * @see SGRawValueMethodsIndexed
299 * @see SGRawValueContainer
302 class SGRawValue : public SGRawBase<T>
307 * The default underlying value for this type.
309 * Every raw value has a default; the default is false for a
310 * boolean, 0 for the various numeric values, and "" for a string.
311 * If additional types of raw values are added in the future, they
312 * may need different kinds of default values (such as epoch for a
313 * date type). The default value is used when creating new values.
315 static T DefaultValue()
324 * Use the default value for this type.
332 virtual ~SGRawValue () {}
336 * Return the underlying value.
338 * @return The actual value for the property.
341 virtual T getValue () const = 0;
345 * Assign a new underlying value.
347 * If the new value cannot be set (because this is a read-only
348 * raw value, or because the new value is not acceptable for
349 * some reason) this method returns false and leaves the original
352 * @param value The actual value for the property.
353 * @return true if the value was set successfully, false otherwise.
356 virtual bool setValue (T value) = 0;
360 * Return the type tag for this raw value type.
362 virtual simgear::props::Type getType() const
364 return simgear::props::PropertyTraits<T>::type_tag;
370 ////////////////////////////////////////////////////////////////////////
371 // Default values for every type.
372 ////////////////////////////////////////////////////////////////////////
374 template<> inline bool SGRawValue<bool>::DefaultValue()
379 template<> inline const char * SGRawValue<const char *>::DefaultValue()
385 * A raw value bound to a pointer.
387 * This is the most efficient way to tie an external value, but also
388 * the most dangerous, because there is no way for the supplier to
389 * perform bounds checking and derived calculations except by polling
390 * the variable to see if it has changed. There is no default
391 * constructor, because this class would be meaningless without a
395 class SGRawValuePointer : public SGRawValue<T>
400 * Explicit pointer constructor.
402 * Create a new raw value bound to the value of the variable
403 * referenced by the pointer.
405 * @param ptr The pointer to the variable to which this raw value
408 SGRawValuePointer (T * ptr) : _ptr(ptr) {}
413 virtual ~SGRawValuePointer () {}
416 * Get the underlying value.
418 * This method will dereference the pointer and return the
421 virtual T getValue () const { return *_ptr; }
424 * Set the underlying value.
426 * This method will dereference the pointer and change the
429 virtual bool setValue (T value) { *_ptr = value; return true; }
432 * Create a copy of this raw value.
434 * The copy will use the same external pointer as the original.
436 virtual SGRaw* clone () const {
437 return new SGRawValuePointer(_ptr);
446 * A value managed through static functions.
448 * A read-only value will not have a setter; a write-only value will
452 class SGRawValueFunctions : public SGRawValue<T>
457 * The template type of a static getter function.
459 typedef T (*getter_t)();
462 * The template type of a static setter function.
464 typedef void (*setter_t)(T);
467 * Explicit constructor.
469 * Create a new raw value bound to the getter and setter supplied.
471 * @param getter A static function for getting a value, or 0
472 * to read-disable the value.
473 * @param setter A static function for setting a value, or 0
474 * to write-disable the value.
476 SGRawValueFunctions (getter_t getter = 0, setter_t setter = 0)
477 : _getter(getter), _setter(setter) {}
482 virtual ~SGRawValueFunctions () {}
485 * Get the underlying value.
487 * This method will invoke the getter function to get a value.
488 * If no getter function was supplied, this method will always
489 * return the default value for the type.
491 virtual T getValue () const {
492 if (_getter) return (*_getter)();
493 else return SGRawValue<T>::DefaultValue();
497 * Set the underlying value.
499 * This method will invoke the setter function to change the
500 * underlying value. If no setter function was supplied, this
501 * method will return false.
503 virtual bool setValue (T value) {
504 if (_setter) { (*_setter)(value); return true; }
509 * Create a copy of this raw value, bound to the same functions.
511 virtual SGRaw* clone () const {
512 return new SGRawValueFunctions(_getter,_setter);
522 * An indexed value bound to static functions.
524 * A read-only value will not have a setter; a write-only value will
525 * not have a getter. An indexed value is useful for binding one
526 * of a list of possible values (such as multiple engines for a
527 * plane). The index is hard-coded at creation time.
532 class SGRawValueFunctionsIndexed : public SGRawValue<T>
535 typedef T (*getter_t)(int);
536 typedef void (*setter_t)(int,T);
537 SGRawValueFunctionsIndexed (int index, getter_t getter = 0, setter_t setter = 0)
538 : _index(index), _getter(getter), _setter(setter) {}
539 virtual ~SGRawValueFunctionsIndexed () {}
540 virtual T getValue () const {
541 if (_getter) return (*_getter)(_index);
542 else return SGRawValue<T>::DefaultValue();
544 virtual bool setValue (T value) {
545 if (_setter) { (*_setter)(_index, value); return true; }
548 virtual SGRaw* clone () const {
549 return new SGRawValueFunctionsIndexed(_index, _getter, _setter);
559 * A value managed through an object and access methods.
561 * A read-only value will not have a setter; a write-only value will
564 template <class C, class T>
565 class SGRawValueMethods : public SGRawValue<T>
568 typedef T (C::*getter_t)() const;
569 typedef void (C::*setter_t)(T);
570 SGRawValueMethods (C &obj, getter_t getter = 0, setter_t setter = 0)
571 : _obj(obj), _getter(getter), _setter(setter) {}
572 virtual ~SGRawValueMethods () {}
573 virtual T getValue () const {
574 if (_getter) { return (_obj.*_getter)(); }
575 else { return SGRawValue<T>::DefaultValue(); }
577 virtual bool setValue (T value) {
578 if (_setter) { (_obj.*_setter)(value); return true; }
581 virtual SGRaw* clone () const {
582 return new SGRawValueMethods(_obj, _getter, _setter);
592 * An indexed value managed through an object and access methods.
594 * A read-only value will not have a setter; a write-only value will
597 template <class C, class T>
598 class SGRawValueMethodsIndexed : public SGRawValue<T>
601 typedef T (C::*getter_t)(int) const;
602 typedef void (C::*setter_t)(int, T);
603 SGRawValueMethodsIndexed (C &obj, int index,
604 getter_t getter = 0, setter_t setter = 0)
605 : _obj(obj), _index(index), _getter(getter), _setter(setter) {}
606 virtual ~SGRawValueMethodsIndexed () {}
607 virtual T getValue () const {
608 if (_getter) { return (_obj.*_getter)(_index); }
609 else { return SGRawValue<T>::DefaultValue(); }
611 virtual bool setValue (T value) {
612 if (_setter) { (_obj.*_setter)(_index, value); return true; }
615 virtual SGRaw* clone () const {
616 return new SGRawValueMethodsIndexed(_obj, _index, _getter, _setter);
626 * A raw value that contains its value. This provides a way for
627 * property nodes to contain values that shouldn't be stored in the
628 * property node itself.
631 class SGRawValueContainer : public SGRawValue<T>
636 * Explicit constructor.
638 SGRawValueContainer(const T& obj) : _obj(obj) {}
643 virtual ~SGRawValueContainer() {}
646 * Get the underlying value.
648 virtual T getValue() const { return _obj; }
651 * Set the underlying value.
653 * This method will dereference the pointer and change the
656 virtual bool setValue (T value) { _obj = value; return true; }
659 * Create a copy of this raw value.
661 virtual SGRaw* clone () const {
662 return new SGRawValueContainer(_obj);
670 SGRawExtended* SGRawBase<T, 0>::makeContainer() const
672 return new SGRawValueContainer<T>(static_cast<const SGRawValue<T>*>(this)
677 std::ostream& SGRawBase<T, 0>::printOn(std::ostream& stream) const
679 return stream << static_cast<SGRawValue<T>*>(this)->getValue();
683 std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
686 simgear::readFrom(stream, value);
687 static_cast<SGRawValue<T>*>(this)->setValue(value);
692 std::ostream& SGRawBase<SGVec3d>::printOn(std::ostream& stream) const;
694 std::ostream& SGRawBase<SGVec4d>::printOn(std::ostream& stream) const;
698 * The smart pointer that manage reference counting
700 class SGPropertyNode;
701 typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
702 typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
706 typedef std::vector<SGPropertyNode_ptr> PropertyList;
711 * The property change listener interface.
713 * <p>Any class that needs to listen for property changes must implement
714 * this interface.</p>
716 class SGPropertyChangeListener
719 virtual ~SGPropertyChangeListener ();
720 virtual void valueChanged (SGPropertyNode * node);
721 virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child);
722 virtual void childRemoved (SGPropertyNode * parent, SGPropertyNode * child);
725 friend class SGPropertyNode;
726 virtual void register_property (SGPropertyNode * node);
727 virtual void unregister_property (SGPropertyNode * node);
730 std::vector<SGPropertyNode *> _properties;
736 * A node in a property tree.
738 class SGPropertyNode : public SGReferenced
746 MAX_STRING_LEN = 1024
750 * Access mode attributes.
752 * <p>The ARCHIVE attribute is strictly advisory, and controls
753 * whether the property should normally be saved and restored.</p>
767 * Last used attribute
768 * Update as needed when enum Attribute is changed
770 static const int LAST_USED_ATTRIBUTE;
774 * Default constructor.
782 SGPropertyNode (const SGPropertyNode &node);
788 virtual ~SGPropertyNode ();
797 * Test whether this node contains a primitive leaf value.
799 bool hasValue () const { return (_type != simgear::props::NONE); }
803 * Get the node's simple (XML) name.
805 const char * getName () const { return _name.c_str(); }
808 * Get the node's pretty display name, with subscript when needed.
810 std::string getDisplayName (bool simplify = false) const;
814 * Get the node's integer index.
816 int getIndex () const { return _index; }
820 * Get a non-const pointer to the node's parent.
822 SGPropertyNode * getParent () { return _parent; }
826 * Get a const pointer to the node's parent.
828 const SGPropertyNode * getParent () const { return _parent; }
837 * Get the number of child nodes.
839 int nChildren () const { return (int)_children.size(); }
843 * Get a child node by position (*NOT* index).
845 SGPropertyNode * getChild (int position);
849 * Get a const child node by position (*NOT* index).
851 const SGPropertyNode * getChild (int position) const;
855 * Test whether a named child exists.
857 bool hasChild (const char * name, int index = 0) const
859 return (getChild(name, index) != 0);
863 * Test whether a named child exists.
865 bool hasChild (const std::string& name, int index = 0) const
867 return (getChild(name, index) != 0);
871 * Create a child node after the last node with the same name.
873 SGPropertyNode * addChild (const char * name);
876 * Get a child node by name and index.
878 SGPropertyNode * getChild (const char * name, int index = 0,
879 bool create = false);
882 * Get a child node by name and index.
884 SGPropertyNode * getChild (const std::string& name, int index = 0,
886 { return getChild(name.c_str(), index, create); }
890 * Get a const child node by name and index.
892 const SGPropertyNode * getChild (const char * name, int index = 0) const;
895 * Get a const child node by name and index.
897 const SGPropertyNode * getChild (const std::string& name, int index = 0) const
898 { return getChild(name.c_str(), index); }
902 * Get a vector of all children with the specified name.
904 simgear::PropertyList getChildren (const char * name) const;
907 * Get a vector of all children with the specified name.
909 simgear::PropertyList getChildren (const std::string& name) const
910 { return getChildren(name.c_str()); }
913 * Remove child by position.
915 SGPropertyNode_ptr removeChild (int pos, bool keep = true);
919 * Remove a child node
921 SGPropertyNode_ptr removeChild (const char * name, int index = 0,
925 * Remove a child node
927 SGPropertyNode_ptr removeChild (const std::string& name, int index = 0,
929 { return removeChild(name.c_str(), index, keep); }
932 * Remove all children with the specified name.
934 simgear::PropertyList removeChildren (const char * name, bool keep = true);
937 * Remove all children with the specified name.
939 simgear::PropertyList removeChildren (const std::string& name,
941 { return removeChildren(name.c_str(), keep); }
949 * Alias this node's leaf value to another's.
951 bool alias (SGPropertyNode * target);
955 * Alias this node's leaf value to another's by relative path.
957 bool alias (const char * path);
960 * Alias this node's leaf value to another's by relative path.
962 bool alias (const std::string& path)
963 { return alias(path.c_str()); }
967 * Remove any alias for this node.
973 * Test whether the node's leaf value is aliased to another's.
975 bool isAlias () const { return (_type == simgear::props::ALIAS); }
979 * Get a non-const pointer to the current alias target, if any.
981 SGPropertyNode * getAliasTarget ();
985 * Get a const pointer to the current alias target, if any.
987 const SGPropertyNode * getAliasTarget () const;
996 * Get the path to this node from the root.
998 const char * getPath (bool simplify = false) const;
1002 * Get a pointer to the root node.
1004 SGPropertyNode * getRootNode ();
1008 * Get a const pointer to the root node.
1010 const SGPropertyNode * getRootNode () const;
1014 * Get a pointer to another node by relative path.
1016 SGPropertyNode * getNode (const char * relative_path, bool create = false);
1019 * Get a pointer to another node by relative path.
1021 SGPropertyNode * getNode (const std::string& relative_path, bool create = false)
1022 { return getNode(relative_path.c_str(), create); }
1025 * Get a pointer to another node by relative path.
1027 * This method leaves the index off the last member of the path,
1028 * so that the user can specify it separately (and save some
1029 * string building). For example, getNode("/bar[1]/foo", 3) is
1030 * exactly equivalent to getNode("bar[1]/foo[3]"). The index
1031 * provided overrides any given in the path itself for the last
1034 SGPropertyNode * getNode (const char * relative_path, int index,
1035 bool create = false);
1038 * Get a pointer to another node by relative path.
1040 * This method leaves the index off the last member of the path,
1041 * so that the user can specify it separately (and save some
1042 * string building). For example, getNode("/bar[1]/foo", 3) is
1043 * exactly equivalent to getNode("bar[1]/foo[3]"). The index
1044 * provided overrides any given in the path itself for the last
1047 SGPropertyNode * getNode (const std::string& relative_path, int index,
1048 bool create = false)
1049 { return getNode(relative_path.c_str(), index, create); }
1052 * Get a const pointer to another node by relative path.
1054 const SGPropertyNode * getNode (const char * relative_path) const;
1057 * Get a const pointer to another node by relative path.
1059 const SGPropertyNode * getNode (const std::string& relative_path) const
1060 { return getNode(relative_path.c_str()); }
1064 * Get a const pointer to another node by relative path.
1066 * This method leaves the index off the last member of the path,
1067 * so that the user can specify it separate.
1069 const SGPropertyNode * getNode (const char * relative_path,
1073 * Get a const pointer to another node by relative path.
1075 * This method leaves the index off the last member of the path,
1076 * so that the user can specify it separate.
1078 const SGPropertyNode * getNode (const std::string& relative_path,
1080 { return getNode(relative_path.c_str(), index); }
1087 * Check a single mode attribute for the property node.
1089 bool getAttribute (Attribute attr) const { return ((_attr & attr) != 0); }
1093 * Set a single mode attribute for the property node.
1095 void setAttribute (Attribute attr, bool state) {
1096 (state ? _attr |= attr : _attr &= ~attr);
1101 * Get all of the mode attributes for the property node.
1103 int getAttributes () const { return _attr; }
1107 * Set all of the mode attributes for the property node.
1109 void setAttributes (int attr) { _attr = attr; }
1113 // Leaf Value (primitive).
1118 * Get the type of leaf value, if any, for this node.
1120 simgear::props::Type getType () const;
1124 * Get a bool value for this node.
1126 bool getBoolValue () const;
1130 * Get an int value for this node.
1132 int getIntValue () const;
1136 * Get a long int value for this node.
1138 long getLongValue () const;
1142 * Get a float value for this node.
1144 float getFloatValue () const;
1148 * Get a double value for this node.
1150 double getDoubleValue () const;
1154 * Get a string value for this node.
1156 const char * getStringValue () const;
1159 * Get a value from a node. If the actual type of the node doesn't
1160 * match the desired type, a conversion isn't guaranteed.
1162 template<typename T>
1163 T getValue(typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
1164 ::type* dummy = 0) const;
1165 // Getter for extended property
1166 template<typename T>
1167 T getValue(typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
1168 ::type* dummy = 0) const;
1171 * Set a bool value for this node.
1173 bool setBoolValue (bool value);
1177 * Set an int value for this node.
1179 bool setIntValue (int value);
1183 * Set a long int value for this node.
1185 bool setLongValue (long value);
1189 * Set a float value for this node.
1191 bool setFloatValue (float value);
1195 * Set a double value for this node.
1197 bool setDoubleValue (double value);
1201 * Set a string value for this node.
1203 bool setStringValue (const char * value);
1206 * Set a string value for this node.
1208 bool setStringValue (const std::string& value)
1209 { return setStringValue(value.c_str()); }
1213 * Set a value of unspecified type for this node.
1215 bool setUnspecifiedValue (const char * value);
1217 template<typename T>
1218 bool setValue(const T& val,
1219 typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
1222 template<typename T>
1223 bool setValue(const T& val,
1224 typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
1228 * Print the value of the property to a stream.
1230 std::ostream& printOn(std::ostream& stream) const;
1238 * Test whether this node is bound to an external data source.
1240 bool isTied () const { return _tied; }
1243 * Bind this node to an external source.
1245 template<typename T>
1246 bool tie(const SGRawValue<T> &rawValue, bool useDefault = true);
1249 * Unbind this node from any external data source.
1255 // Convenience methods using paths.
1256 // TODO: add attribute methods
1261 * Get another node's type.
1263 simgear::props::Type getType (const char * relative_path) const;
1266 * Get another node's type.
1268 simgear::props::Type getType (const std::string& relative_path) const
1269 { return getType(relative_path.c_str()); }
1272 * Test whether another node has a leaf value.
1274 bool hasValue (const char * relative_path) const;
1277 * Test whether another node has a leaf value.
1279 bool hasValue (const std::string& relative_path) const
1280 { return hasValue(relative_path.c_str()); }
1283 * Get another node's value as a bool.
1285 bool getBoolValue (const char * relative_path,
1286 bool defaultValue = false) const;
1289 * Get another node's value as a bool.
1291 bool getBoolValue (const std::string& relative_path,
1292 bool defaultValue = false) const
1293 { return getBoolValue(relative_path.c_str(), defaultValue); }
1296 * Get another node's value as an int.
1298 int getIntValue (const char * relative_path,
1299 int defaultValue = 0) const;
1302 * Get another node's value as an int.
1304 int getIntValue (const std::string& relative_path,
1305 int defaultValue = 0) const
1306 { return getIntValue(relative_path.c_str(), defaultValue); }
1310 * Get another node's value as a long int.
1312 long getLongValue (const char * relative_path,
1313 long defaultValue = 0L) const;
1316 * Get another node's value as a long int.
1318 long getLongValue (const std::string& relative_path,
1319 long defaultValue = 0L) const
1320 { return getLongValue(relative_path.c_str(), defaultValue); }
1323 * Get another node's value as a float.
1325 float getFloatValue (const char * relative_path,
1326 float defaultValue = 0.0f) const;
1329 * Get another node's value as a float.
1331 float getFloatValue (const std::string& relative_path,
1332 float defaultValue = 0.0f) const
1333 { return getFloatValue(relative_path.c_str(), defaultValue); }
1337 * Get another node's value as a double.
1339 double getDoubleValue (const char * relative_path,
1340 double defaultValue = 0.0) const;
1343 * Get another node's value as a double.
1345 double getDoubleValue (const std::string& relative_path,
1346 double defaultValue = 0.0) const
1347 { return getDoubleValue(relative_path.c_str(), defaultValue); }
1350 * Get another node's value as a string.
1352 const char * getStringValue (const char * relative_path,
1353 const char * defaultValue = "") const;
1357 * Get another node's value as a string.
1359 const char * getStringValue (const std::string& relative_path,
1360 const char * defaultValue = "") const
1361 { return getStringValue(relative_path.c_str(), defaultValue); }
1365 * Set another node's value as a bool.
1367 bool setBoolValue (const char * relative_path, bool value);
1370 * Set another node's value as a bool.
1372 bool setBoolValue (const std::string& relative_path, bool value)
1373 { return setBoolValue(relative_path.c_str(), value); }
1377 * Set another node's value as an int.
1379 bool setIntValue (const char * relative_path, int value);
1382 * Set another node's value as an int.
1384 bool setIntValue (const std::string& relative_path, int value)
1385 { return setIntValue(relative_path.c_str(), value); }
1389 * Set another node's value as a long int.
1391 bool setLongValue (const char * relative_path, long value);
1394 * Set another node's value as a long int.
1396 bool setLongValue (const std::string& relative_path, long value)
1397 { return setLongValue(relative_path.c_str(), value); }
1401 * Set another node's value as a float.
1403 bool setFloatValue (const char * relative_path, float value);
1406 * Set another node's value as a float.
1408 bool setFloatValue (const std::string& relative_path, float value)
1409 { return setFloatValue(relative_path.c_str(), value); }
1413 * Set another node's value as a double.
1415 bool setDoubleValue (const char * relative_path, double value);
1418 * Set another node's value as a double.
1420 bool setDoubleValue (const std::string& relative_path, double value)
1421 { return setDoubleValue(relative_path.c_str(), value); }
1425 * Set another node's value as a string.
1427 bool setStringValue (const char * relative_path, const char * value);
1429 bool setStringValue(const char * relative_path, const std::string& value)
1430 { return setStringValue(relative_path, value.c_str()); }
1432 * Set another node's value as a string.
1434 bool setStringValue (const std::string& relative_path, const char * value)
1435 { return setStringValue(relative_path.c_str(), value); }
1437 bool setStringValue (const std::string& relative_path,
1438 const std::string& value)
1439 { return setStringValue(relative_path.c_str(), value.c_str()); }
1442 * Set another node's value with no specified type.
1444 bool setUnspecifiedValue (const char * relative_path, const char * value);
1448 * Test whether another node is bound to an external data source.
1450 bool isTied (const char * relative_path) const;
1453 * Test whether another node is bound to an external data source.
1455 bool isTied (const std::string& relative_path) const
1456 { return isTied(relative_path.c_str()); }
1459 * Bind another node to an external bool source.
1461 bool tie (const char * relative_path, const SGRawValue<bool> &rawValue,
1462 bool useDefault = true);
1465 * Bind another node to an external bool source.
1467 bool tie (const std::string& relative_path, const SGRawValue<bool> &rawValue,
1468 bool useDefault = true)
1469 { return tie(relative_path.c_str(), rawValue, useDefault); }
1473 * Bind another node to an external int source.
1475 bool tie (const char * relative_path, const SGRawValue<int> &rawValue,
1476 bool useDefault = true);
1479 * Bind another node to an external int source.
1481 bool tie (const std::string& relative_path, const SGRawValue<int> &rawValue,
1482 bool useDefault = true)
1483 { return tie(relative_path.c_str(), rawValue, useDefault); }
1487 * Bind another node to an external long int source.
1489 bool tie (const char * relative_path, const SGRawValue<long> &rawValue,
1490 bool useDefault = true);
1493 * Bind another node to an external long int source.
1495 bool tie (const std::string& relative_path, const SGRawValue<long> &rawValue,
1496 bool useDefault = true)
1497 { return tie(relative_path.c_str(), rawValue, useDefault); }
1501 * Bind another node to an external float source.
1503 bool tie (const char * relative_path, const SGRawValue<float> &rawValue,
1504 bool useDefault = true);
1507 * Bind another node to an external float source.
1509 bool tie (const std::string& relative_path, const SGRawValue<float> &rawValue,
1510 bool useDefault = true)
1511 { return tie(relative_path.c_str(), rawValue, useDefault); }
1515 * Bind another node to an external double source.
1517 bool tie (const char * relative_path, const SGRawValue<double> &rawValue,
1518 bool useDefault = true);
1521 * Bind another node to an external double source.
1523 bool tie (const std::string& relative_path, const SGRawValue<double> &rawValue,
1524 bool useDefault = true)
1525 { return tie(relative_path.c_str(), rawValue, useDefault); }
1529 * Bind another node to an external string source.
1531 bool tie (const char * relative_path, const SGRawValue<const char *> &rawValue,
1532 bool useDefault = true);
1535 * Bind another node to an external string source.
1537 bool tie (const std::string& relative_path, const SGRawValue<const char*> &rawValue,
1538 bool useDefault = true)
1539 { return tie(relative_path.c_str(), rawValue, useDefault); }
1543 * Unbind another node from any external data source.
1545 bool untie (const char * relative_path);
1548 * Unbind another node from any external data source.
1550 bool untie (const std::string& relative_path)
1551 { return untie(relative_path.c_str()); }
1555 * Add a change listener to the property. If "initial" is set call the
1556 * listener initially.
1558 void addChangeListener (SGPropertyChangeListener * listener,
1559 bool initial = false);
1563 * Remove a change listener from the property.
1565 void removeChangeListener (SGPropertyChangeListener * listener);
1569 * Get the number of listeners.
1571 int nListeners () const { return _listeners ? (int)_listeners->size() : 0; }
1575 * Fire a value change event to all listeners.
1577 void fireValueChanged ();
1581 * Fire a child-added event to all listeners.
1583 void fireChildAdded (SGPropertyNode * child);
1587 * Fire a child-removed event to all listeners.
1589 void fireChildRemoved (SGPropertyNode * child);
1593 * Clear any existing value and set the type to NONE.
1600 void fireValueChanged (SGPropertyNode * node);
1601 void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child);
1602 void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child);
1605 * Protected constructor for making new nodes on demand.
1607 SGPropertyNode (const char * name, int index, SGPropertyNode * parent);
1612 // Get the raw value
1613 bool get_bool () const;
1614 int get_int () const;
1615 long get_long () const;
1616 float get_float () const;
1617 double get_double () const;
1618 const char * get_string () const;
1620 // Set the raw value
1621 bool set_bool (bool value);
1622 bool set_int (int value);
1623 bool set_long (long value);
1624 bool set_float (float value);
1625 bool set_double (double value);
1626 bool set_string (const char * value);
1630 * Get the value as a string.
1632 const char * make_string () const;
1635 * Trace a read access.
1637 void trace_read () const;
1641 * Trace a write access.
1643 void trace_write () const;
1647 * Remove this node from all nodes that link to it in their path cache.
1649 void remove_from_path_caches();
1656 /// To avoid cyclic reference counting loops this shall not be a reference
1658 SGPropertyNode * _parent;
1659 simgear::PropertyList _children;
1660 simgear::PropertyList _removedChildren;
1661 std::vector<hash_table *> _linkedNodes;
1662 mutable std::string _path;
1663 mutable std::string _buffer;
1664 hash_table * _path_cache;
1665 simgear::props::Type _type;
1669 // The right kind of pointer...
1671 SGPropertyNode * alias;
1684 std::vector<SGPropertyChangeListener *> * _listeners;
1688 * Register/unregister node that links to this node in its path cache.
1690 void add_linked_node (hash_table * node) { _linkedNodes.push_back(node); }
1691 bool remove_linked_node (hash_table * node);
1696 * A very simple hash table.
1702 * An entry in a bucket in a hash table.
1708 const char * get_key () { return _key.c_str(); }
1709 void set_key (const char * key);
1710 SGPropertyNode * get_value () { return _value; }
1711 void set_value (SGPropertyNode * value);
1714 SGSharedPtr<SGPropertyNode> _value;
1719 * A bucket in a hash table.
1725 entry * get_entry (const char * key, bool create = false);
1726 bool erase (SGPropertyNode * node);
1727 void clear (hash_table * owner);
1733 friend class bucket;
1737 SGPropertyNode * get (const char * key);
1738 void put (const char * key, SGPropertyNode * value);
1739 bool erase (SGPropertyNode * node);
1742 unsigned int hashcode (const char * key);
1743 unsigned int _data_length;
1749 // Convenience functions for use in templates
1750 template<typename T>
1751 T getValue(const SGPropertyNode*);
1754 inline bool getValue<bool>(const SGPropertyNode* node) { return node->getBoolValue(); }
1757 inline int getValue<int>(const SGPropertyNode* node) { return node->getIntValue(); }
1760 inline long getValue<long>(const SGPropertyNode* node) { return node->getLongValue(); }
1763 inline float getValue<float>(const SGPropertyNode* node)
1765 return node->getFloatValue();
1769 inline double getValue<double>(const SGPropertyNode* node)
1771 return node->getDoubleValue();
1775 inline const char * getValue<const char*>(const SGPropertyNode* node)
1777 return node->getStringValue ();
1780 inline bool setValue(SGPropertyNode* node, bool value)
1782 return node->setBoolValue(value);
1785 inline bool setValue(SGPropertyNode* node, int value)
1787 return node->setIntValue(value);
1790 inline bool setValue(SGPropertyNode* node, long value)
1792 return node->setLongValue(value);
1795 inline bool setValue(SGPropertyNode* node, float value)
1797 return node->setFloatValue(value);
1800 inline bool setValue(SGPropertyNode* node, double value)
1802 return node->setDoubleValue(value);
1805 inline bool setValue(SGPropertyNode* node, const char* value)
1807 return node->setStringValue(value);
1810 inline bool setValue (SGPropertyNode* node, const std::string& value)
1812 return node->setStringValue(value.c_str());
1815 template<typename T>
1816 bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
1818 using namespace simgear::props;
1819 if (_type == ALIAS || _tied)
1822 useDefault = useDefault && hasValue();
1823 T old_val = SGRawValue<T>::DefaultValue();
1825 old_val = getValue<T>(this);
1827 if (PropertyTraits<T>::Internal)
1828 _type = PropertyTraits<T>::type_tag;
1832 _value.val = rawValue.clone();
1839 bool SGPropertyNode::tie (const SGRawValue<const char *> &rawValue,
1842 template<typename T>
1843 T SGPropertyNode::getValue(typename boost::disable_if_c<simgear::props
1844 ::PropertyTraits<T>::Internal>::type* dummy) const
1846 using namespace simgear::props;
1847 if (_attr == (READ|WRITE) && _type == EXTENDED
1848 && _value.val->getType() == PropertyTraits<T>::type_tag) {
1849 return static_cast<SGRawValue<T>*>(_value.val)->getValue();
1851 if (getAttribute(TRACE_READ))
1853 if (!getAttribute(READ))
1854 return SGRawValue<T>::DefaultValue();
1857 if (_value.val->getType() == PropertyTraits<T>::type_tag)
1858 return static_cast<SGRawValue<T>*>(_value.val)->getValue();
1862 return simgear::parseString<T>(make_string());
1864 default: // avoid compiler warning
1867 return SGRawValue<T>::DefaultValue();
1870 template<typename T>
1871 inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
1872 ::PropertyTraits<T>::Internal>::type* dummy) const
1874 return ::getValue<T>(this);
1877 template<typename T>
1878 bool SGPropertyNode::setValue(const T& val,
1879 typename boost::disable_if_c<simgear::props
1880 ::PropertyTraits<T>::Internal>::type* dummy)
1882 using namespace simgear::props;
1883 if (_attr == (READ|WRITE) && _type == EXTENDED
1884 && _value.val->getType() == PropertyTraits<T>::type_tag) {
1885 static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
1888 if (getAttribute(WRITE)
1889 && ((_type == EXTENDED
1890 && _value.val->getType() == PropertyTraits<T>::type_tag)
1891 || _type == NONE || _type == UNSPECIFIED)) {
1892 if (_type == NONE || _type == UNSPECIFIED) {
1895 _value.val = new SGRawValueContainer<T>(val);
1897 static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
1899 if (getAttribute(TRACE_WRITE))
1906 template<typename T>
1907 inline bool SGPropertyNode::setValue(const T& val,
1908 typename boost::enable_if_c<simgear::props
1909 ::PropertyTraits<T>::Internal>::type* dummy)
1911 return ::setValue(this, val);
1915 * Utility function for creation of a child property node
1917 inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name,
1920 return parent->getChild(name, index, true);
1922 #endif // __PROPS_HXX