#include <vector>
#include <string>
+#include <iostream>
+#include <sstream>
+
+#include <boost/utility.hpp>
#if PROPS_STANDALONE
#else
#endif
-
+#include <simgear/math/SGMathFwd.hxx>
#include <simgear/structure/SGReferenced.hxx>
#include <simgear/structure/SGSharedPtr.hxx>
namespace simgear
{
+template<typename T>
+std::istream& readFrom(std::istream& stream, T& result)
+{
+ stream >> result;
+ return stream;
+}
+
+/**
+ * Parse a string as an object of a given type.
+ * XXX no error behavior yet.
+ *
+ * @tparam T the return type
+ * @param str the string
+ * @return the object.
+ */
+template<typename T>
+inline T parseString(const std::string& str)
+{
+ std::istringstream stream(str);
+ T result;
+ readFrom(stream, result);
+ return result;
+}
+
+// Extended properties
+template<>
+std::istream& readFrom<SGVec3d>(std::istream& stream, SGVec3d& result);
+template<>
+std::istream& readFrom<SGVec4d>(std::istream& stream, SGVec4d& result);
+
+
/**
* Property value types.
*/
namespace props
{
+/**
+ * The possible types of an SGPropertyNode. Types that appear after
+ * EXTENDED are not stored in the SGPropertyNode itself.
+ */
enum Type {
- NONE = 0,
- ALIAS,
+ NONE = 0, /**< The node hasn't been assigned a value yet. */
+ ALIAS, /**< The node "points" to another node. */
BOOL,
INT,
LONG,
FLOAT,
DOUBLE,
STRING,
- UNSPECIFIED
+ UNSPECIFIED,
+ EXTENDED, /**< The node's value is not stored in the property;
+ * the actual value and type is retrieved from an
+ * SGRawValue node. This type is never returned by @see
+ * SGPropertyNode::getType.
+ */
+ // Extended properties
+ VEC3D,
+ VEC4D
};
+template<typename T> struct PropertyTraits;
-template<typename T>
-struct PropertyTraits
-{
- static const Type type_tag = NONE;
-};
-
-template<>
-struct PropertyTraits<bool>
-{
- static const Type type_tag = BOOL;
-};
-
-template<>
-struct PropertyTraits<int>
-{
- static const Type type_tag = INT;
-};
+#define DEFINTERNALPROP(TYPE, PROP) \
+template<> \
+struct PropertyTraits<TYPE> \
+{ \
+ static const Type type_tag = PROP; \
+ enum { Internal = 1 }; \
+}
-template<>
-struct PropertyTraits<long>
-{
- static const Type type_tag = LONG;
-};
+DEFINTERNALPROP(bool, BOOL);
+DEFINTERNALPROP(int, INT);
+DEFINTERNALPROP(long, LONG);
+DEFINTERNALPROP(float, FLOAT);
+DEFINTERNALPROP(double, DOUBLE);
+DEFINTERNALPROP(const char *, STRING);
+DEFINTERNALPROP(const char[], STRING);
+#undef DEFINTERNALPROP
template<>
-struct PropertyTraits<float>
+struct PropertyTraits<SGVec3d>
{
- static const Type type_tag = FLOAT;
+ static const Type type_tag = VEC3D;
+ enum { Internal = 0 };
};
template<>
-struct PropertyTraits<double>
+struct PropertyTraits<SGVec4d>
{
- static const Type type_tag = DOUBLE;
-};
-
-template<>
-struct PropertyTraits<const char *>
-{
- static const Type type_tag = STRING;
+ static const Type type_tag = VEC4D;
+ enum { Internal = 0 };
};
}
}
// a small performance hit for that.
////////////////////////////////////////////////////////////////////////
-/** Base for virtual destructor
+/**
+ * Base class for SGRawValue classes that holds no type
+ * information. This allows some generic manipulation of the
+ * SGRawValue object.
*/
-class SGRawBase
+class SGRaw
+{
+public:
+ /**
+ * Get the type enumeration for the raw value.
+ *
+ * @return the type.
+ */
+ virtual simgear::props::Type getType() const = 0;
+ virtual ~SGRaw() {}
+
+ /**
+ * Create a new deep copy of this raw value.
+ *
+ * The copy will contain its own version of the underlying value
+ * as well, and will be the same type.
+ *
+ * @return A deep copy of the current object.
+ */
+ virtual SGRaw* clone() const = 0;
+
+};
+
+class SGRawExtended : public SGRaw
{
public:
- virtual ~SGRawBase() {}
+ /**
+ * Make an SGRawValueContainer from the SGRawValue.
+ *
+ * This is a virtual function of SGRawExtended so that
+ * SGPropertyNode::untie doesn't need to know the type of an
+ * extended property.
+ */
+ virtual SGRawExtended* makeContainer() const = 0;
+ /**
+ * Write value out to a stream
+ */
+ virtual std::ostream& printOn(std::ostream& stream) const = 0;
+ /**
+ * Read value from a stream and store it.
+ */
+ virtual std::istream& readFrom(std::istream& stream) = 0;
+};
+
+// Choose between different base classes based on whether the value is
+// stored internal to the property node. This frees us from defining
+// the virtual functions in the SGRawExtended interface where they
+// don't make sense, e.g. readFrom for the const char* type.
+template<typename T, int internal = simgear::props::PropertyTraits<T>::Internal>
+class SGRawBase;
+
+template<typename T>
+class SGRawBase<T, 1> : public SGRaw
+{
+};
+
+template<typename T>
+class SGRawBase<T, 0> : public SGRawExtended
+{
+ virtual SGRawExtended* makeContainer() const;
+ virtual std::ostream& printOn(std::ostream& stream) const;
+ virtual std::istream& readFrom(std::istream& stream);
};
/**
* set, and clone the underlying value. The SGRawValue may change
* frequently during a session as a value is retyped or bound and
* unbound to various data source, but the abstract SGPropertyNode
- * layer insulates the application from those changes. The raw value
- * contains no facilities for data binding or for type conversion: it
- * is simply the abstraction of a primitive data type (or a compound
- * data type, in the case of a string).</p>
+ * layer insulates the application from those changes.
*
* <p>The SGPropertyNode class always keeps a *copy* of a raw value,
* not the original one passed to it; if you override a derived class
* @see SGRawValueFunctionsIndexed
* @see SGRawValueMethods
* @see SGRawValueMethodsIndexed
+ * @see SGRawValueContainer
*/
template <class T>
-class SGRawValue : public SGRawBase
+class SGRawValue : public SGRawBase<T>
{
public:
* may need different kinds of default values (such as epoch for a
* date type). The default value is used when creating new values.
*/
- static const T DefaultValue; // Default for this kind of raw value.
+ static T DefaultValue()
+ {
+ return T();
+ }
/**
/**
- * Create a new deep copy of this raw value.
- *
- * The copy will contain its own version of the underlying value
- * as well.
- *
- * @return A deep copy of the current object.
+ * Return the type tag for this raw value type.
*/
- virtual SGRawValue * clone () const = 0;
+ virtual simgear::props::Type getType() const
+ {
+ return simgear::props::PropertyTraits<T>::type_tag;
+ }
};
+
+
////////////////////////////////////////////////////////////////////////
// Default values for every type.
////////////////////////////////////////////////////////////////////////
-template<> 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.
*
* The copy will use the same external pointer as the original.
*/
- virtual SGRawValue<T> * clone () const {
- return new SGRawValuePointer<T>(_ptr);
+ virtual SGRaw* clone () const {
+ return new SGRawValuePointer(_ptr);
}
private:
*/
virtual T getValue () const {
if (_getter) return (*_getter)();
- else return SGRawValue<T>::DefaultValue;
+ else return SGRawValue<T>::DefaultValue();
}
/**
/**
* Create a copy of this raw value, bound to the same functions.
*/
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueFunctions<T>(_getter,_setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueFunctions(_getter,_setter);
}
private:
virtual ~SGRawValueFunctionsIndexed () {}
virtual T getValue () const {
if (_getter) return (*_getter)(_index);
- else return SGRawValue<T>::DefaultValue;
+ else return SGRawValue<T>::DefaultValue();
}
virtual bool setValue (T value) {
if (_setter) { (*_setter)(_index, value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueFunctionsIndexed<T>(_index, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueFunctionsIndexed(_index, _getter, _setter);
}
private:
int _index;
virtual ~SGRawValueMethods () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(); }
- else { return SGRawValue<T>::DefaultValue; }
+ else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueMethods<C,T>(_obj, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueMethods(_obj, _getter, _setter);
}
private:
C &_obj;
virtual ~SGRawValueMethodsIndexed () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(_index); }
- else { return SGRawValue<T>::DefaultValue; }
+ else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(_index, value); return true; }
else return false;
}
- virtual SGRawValue<T> * clone () const {
- return new SGRawValueMethodsIndexed<C,T>(_obj, _index, _getter, _setter);
+ virtual SGRaw* clone () const {
+ return new SGRawValueMethodsIndexed(_obj, _index, _getter, _setter);
}
private:
C &_obj;
setter_t _setter;
};
+/**
+ * A raw value that contains its value. This provides a way for
+ * property nodes to contain values that shouldn't be stored in the
+ * property node itself.
+ */
+template <class T>
+class SGRawValueContainer : public SGRawValue<T>
+{
+public:
+
+ /**
+ * Explicit constructor.
+ */
+ SGRawValueContainer(const T& obj) : _obj(obj) {}
+
+ /**
+ * Destructor.
+ */
+ virtual ~SGRawValueContainer() {}
+
+ /**
+ * Get the underlying value.
+ */
+ virtual T getValue() const { return _obj; }
+
+ /**
+ * Set the underlying value.
+ *
+ * This method will dereference the pointer and change the
+ * variable's value.
+ */
+ virtual bool setValue (T value) { _obj = value; return true; }
+
+ /**
+ * Create a copy of this raw value.
+ */
+ virtual SGRaw* clone () const {
+ return new SGRawValueContainer(_obj);
+ }
+
+private:
+ T _obj;
+};
+
+template<typename T>
+SGRawExtended* SGRawBase<T, 0>::makeContainer() const
+{
+ return new SGRawValueContainer<T>(static_cast<const SGRawValue<T>*>(this)
+ ->getValue());
+}
+
+template<typename T>
+std::ostream& SGRawBase<T, 0>::printOn(std::ostream& stream) const
+{
+ return stream << static_cast<SGRawValue<T>*>(this)->getValue();
+}
+
+template<typename T>
+std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
+{
+ T value;
+ simgear::readFrom(stream, value);
+ static_cast<SGRawValue<T>*>(this)->setValue(value);
+ return stream;
+}
+
+template<>
+std::ostream& SGRawBase<SGVec3d>::printOn(std::ostream& stream) const;
+template<>
+std::ostream& SGRawBase<SGVec4d>::printOn(std::ostream& stream) const;
+
\f
/**
* The smart pointer that manage reference counting
typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
+namespace simgear
+{
+typedef std::vector<SGPropertyNode_ptr> PropertyList;
+}
+
\f
/**
* The property change listener interface.
*/
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(); }
/**
/**
* Get a child node by name and index.
*/
- SGPropertyNode * getChild (const char * name, int index = 0,
- bool create = false);
-
- /**
- * 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()); }
/**
/**
* Remove all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> removeChildren (const char * name,
- bool keep = true);
-
+ simgear::PropertyList removeChildren (const char * name, bool keep = true);
/**
* Remove all children with the specified name.
*/
- std::vector<SGPropertyNode_ptr> removeChildren (const std::string& name,
- bool keep = true)
+ simgear::PropertyList removeChildren (const std::string& name,
+ bool keep = true)
{ return removeChildren(name.c_str(), keep); }
//
*/
const char * getStringValue () const;
-
+ /**
+ * Get a value from a node. If the actual type of the node doesn't
+ * match the desired type, a conversion isn't guaranteed.
+ */
+ template<typename T>
+ T getValue(typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0) const;
+ // Getter for extended property
+ template<typename T>
+ T getValue(typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0) const;
/**
* Set a bool value for this node.
*/
bool setUnspecifiedValue (const char * value);
+ template<typename T>
+ bool setValue(const T& val,
+ typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0);
+
+ template<typename T>
+ bool setValue(const T& val,
+ typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
+ ::type* dummy = 0);
+ template<int N>
+ bool setValue(const char (&val)[N])
+ {
+ return setValue(&val[0]);
+ }
+
+ /**
+ * Print the value of the property to a stream.
+ */
+ std::ostream& printOn(std::ostream& stream) const;
+
//
// Data binding.
//
*/
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 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);
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);
*/
const char * make_string () const;
-
/**
* Trace a read access.
*/
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;
+ simgear::PropertyList _children;
+ simgear::PropertyList _removedChildren;
std::vector<hash_table *> _linkedNodes;
mutable std::string _path;
mutable std::string _buffer;
bool _tied;
int _attr;
- // The right kind of pointer...
+ // The right kind of pointer...
union {
SGPropertyNode * alias;
- SGRawBase* val;
+ SGRaw* val;
} _value;
union {
/**
- * Register/unregister node that links to this node in its path cache.
- */
+ * 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);
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, bool create);
+ // 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>
bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
{
- if (_type == simgear::props::ALIAS || _tied)
+ using namespace simgear::props;
+ if (_type == ALIAS || _tied)
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 = simgear::props::PropertyTraits<T>::type_tag;
+ if (PropertyTraits<T>::Internal)
+ _type = PropertyTraits<T>::type_tag;
+ else
+ _type = EXTENDED;
_tied = true;
_value.val = rawValue.clone();
-
if (useDefault)
- setValue(this, old_val);
-
+ setValue(old_val);
return true;
}
bool SGPropertyNode::tie (const SGRawValue<const char *> &rawValue,
bool useDefault);
+template<typename T>
+T SGPropertyNode::getValue(typename boost::disable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy) const
+{
+ using namespace simgear::props;
+ if (_attr == (READ|WRITE) && _type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag) {
+ return static_cast<SGRawValue<T>*>(_value.val)->getValue();
+ }
+ if (getAttribute(TRACE_READ))
+ trace_read();
+ if (!getAttribute(READ))
+ return SGRawValue<T>::DefaultValue();
+ switch (_type) {
+ case EXTENDED:
+ if (_value.val->getType() == PropertyTraits<T>::type_tag)
+ return static_cast<SGRawValue<T>*>(_value.val)->getValue();
+ break;
+ case STRING:
+ case UNSPECIFIED:
+ return simgear::parseString<T>(make_string());
+ break;
+ default: // avoid compiler warning
+ break;
+ }
+ return SGRawValue<T>::DefaultValue();
+}
+
+template<typename T>
+inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy) const
+{
+ return ::getValue<T>(this);
+}
+
+template<typename T>
+bool SGPropertyNode::setValue(const T& val,
+ typename boost::disable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy)
+{
+ using namespace simgear::props;
+ if (_attr == (READ|WRITE) && _type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag) {
+ static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
+ return true;
+ }
+ if (getAttribute(WRITE)
+ && ((_type == EXTENDED
+ && _value.val->getType() == PropertyTraits<T>::type_tag)
+ || _type == NONE || _type == UNSPECIFIED)) {
+ if (_type == NONE || _type == UNSPECIFIED) {
+ clearValue();
+ _type = EXTENDED;
+ _value.val = new SGRawValueContainer<T>(val);
+ } else {
+ static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
+ }
+ if (getAttribute(TRACE_WRITE))
+ trace_write();
+ return true;
+ }
+ return false;
+}
+
+template<typename T>
+inline bool SGPropertyNode::setValue(const T& val,
+ typename boost::enable_if_c<simgear::props
+ ::PropertyTraits<T>::Internal>::type* dummy)
+{
+ return ::setValue(this, val);
+}
+
+/**
+ * Utility function for creation of a child property node.
+ */
+inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name,
+ int index = 0)
+{
+ return parent->getChild(name, index, true);
+}
+
+/**
+ * Utility function for creation of a child property node using a
+ * relative path.
+ */
+namespace simgear
+{
+template<typename StringType>
+inline SGPropertyNode* makeNode(SGPropertyNode* parent, const StringType& name)
+{
+ return parent->getNode(name, true);
+}
+}
+
+// For boost::hash
+size_t hash_value(const SGPropertyNode& node);
+
+// Helper comparison and hash functions for common cases
+
+namespace simgear
+{
+namespace props
+{
+struct Compare
+{
+ bool operator()(const SGPropertyNode* lhs, const SGPropertyNode* rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(SGPropertyNode_ptr lhs, const SGPropertyNode* rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(const SGPropertyNode* lhs, SGPropertyNode_ptr rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+ bool operator()(SGPropertyNode_ptr lhs, SGPropertyNode_ptr rhs) const
+ {
+ return SGPropertyNode::compare(*lhs, *rhs);
+ }
+};
+
+struct Hash
+{
+ size_t operator()(const SGPropertyNode* node) const
+ {
+ return hash_value(*node);
+ }
+ size_t operator()(SGPropertyNode_ptr node) const
+ {
+ return hash_value(*node);
+ }
+};
+}
+}
#endif // __PROPS_HXX
// end of props.hxx
projects / simgear.git / blobdiff