X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fprops%2Fprops.hxx;h=595e013d868585b93d4860c26830a1bef1bf37db;hb=2acac617fcf27b49a9396e9c040c8b4b437529f1;hp=60da557d87a136838eb93ad1d79672f9d49b83be;hpb=c782a32076016f2c3c01b4fd437b024dc77806e9;p=simgear.git diff --git a/simgear/props/props.hxx b/simgear/props/props.hxx index 60da557d..595e013d 100644 --- a/simgear/props/props.hxx +++ b/simgear/props/props.hxx @@ -20,25 +20,61 @@ #include #include #include +#include -#include - -#if PROPS_STANDALONE -#else #include -#include +#if PROPS_STANDALONE +// taken from: boost/utility/enable_if.hpp +#ifndef SG_LOG +# define SG_GENERAL 0 +# define SG_ALERT 0 +# define SG_WARN 1 +# define SG_LOG(type, level, message) (type) ? (std::cerr < + struct enable_if_c { + typedef T type; + }; + + template + struct enable_if_c {}; + + template + struct enable_if : public enable_if_c {}; + + template + struct disable_if_c { + typedef T type; + }; + template + struct disable_if_c {}; -#include + template + struct disable_if : public disable_if_c {}; +} +#else +# include +# include + +# include +# include +# include +#endif #include #include // XXX This whole file should be in the simgear namespace, but I don't // have the guts yet... +using namespace std; + namespace simgear { + + class PropertyInterpolationMgr; + template std::istream& readFrom(std::istream& stream, T& result) { @@ -63,13 +99,6 @@ inline T parseString(const std::string& str) return result; } -// Extended properties -template<> -std::istream& readFrom(std::istream& stream, SGVec3d& result); -template<> -std::istream& readFrom(std::istream& stream, SGVec4d& result); - - /** * Property value types. */ @@ -164,25 +193,11 @@ DEFINTERNALPROP(const char *, STRING); DEFINTERNALPROP(const char[], STRING); #undef DEFINTERNALPROP -template<> -struct PropertyTraits -{ - static const Type type_tag = VEC3D; - enum { Internal = 0 }; -}; - -template<> -struct PropertyTraits -{ - static const Type type_tag = VEC4D; - enum { Internal = 0 }; -}; } } - //////////////////////////////////////////////////////////////////////// // A raw value. // @@ -267,15 +282,14 @@ class SGRawBase : public SGRawExtended /** * Abstract base class for a raw value. * - *

The property manager is implemented in two layers. The {@link - * SGPropertyNode} is the highest and most abstract layer, - * representing an LValue/RValue pair: it records the position of the - * property in the property tree and contains facilities for - * navigation to other nodes. It is guaranteed to be persistent: the - * {@link SGPropertyNode} will not change during a session, even if - * the property is bound and unbound multiple times.

+ * The property manager is implemented in two layers. The SGPropertyNode is the + * highest and most abstract layer, representing an LValue/RValue pair: it + * records the position of the property in the property tree and contains + * facilities for navigation to other nodes. It is guaranteed to be persistent: + * the SGPropertyNode will not change during a session, even if the property is + * bound and unbound multiple times. * - *

When the property value is not managed internally in the + * When the property value is not managed internally in the * SGPropertyNode, the SGPropertyNode will contain a reference to an * SGRawValue (this class), which provides an abstract way to get, * set, and clone the underlying value. The SGRawValue may change @@ -283,13 +297,12 @@ class SGRawBase : public SGRawExtended * unbound to various data source, but the abstract SGPropertyNode * layer insulates the application from those changes. * - *

The SGPropertyNode class always keeps a *copy* of a raw value, - * not the original one passed to it; if you override a derived class - * but do not replace the {@link #clone} method, strange things will - * happen.

+ * The SGPropertyNode class always keeps a *copy* of a raw value, not the + * original one passed to it; if you override a derived class but do not replace + * the {@link SGRaw::clone clone()} method, strange things will happen. * - *

All derived SGRawValue classes must implement {@link #getValue}, - * {@link #setValue}, and {@link #clone} for the appropriate type.

+ * All derived SGRawValue classes must implement getValue(), setValue(), and + * {@link SGRaw::clone clone()} for the appropriate type. * * @see SGPropertyNode * @see SGRawValuePointer @@ -689,12 +702,6 @@ std::istream& SGRawBase::readFrom(std::istream& stream) return stream; } -template<> -std::ostream& SGRawBase::printOn(std::ostream& stream) const; -template<> -std::ostream& SGRawBase::printOn(std::ostream& stream) const; - - /** * The smart pointer that manage reference counting */ @@ -707,7 +714,6 @@ namespace simgear typedef std::vector PropertyList; } - /** * The property change listener interface. * @@ -718,9 +724,15 @@ class SGPropertyChangeListener { public: virtual ~SGPropertyChangeListener (); - virtual void valueChanged (SGPropertyNode * node); - virtual void childAdded (SGPropertyNode * parent, SGPropertyNode * child); - virtual void childRemoved (SGPropertyNode * parent, SGPropertyNode * child); + + /// Called if value of \a node has changed. + virtual void valueChanged(SGPropertyNode * node); + + /// Called if \a child has been added to the given \a parent. + virtual void childAdded(SGPropertyNode * parent, SGPropertyNode * child); + + /// Called if \a child has been removed from its \a parent. + virtual void childRemoved(SGPropertyNode * parent, SGPropertyNode * child); protected: friend class SGPropertyNode; @@ -732,7 +744,6 @@ private: }; - /** * A node in a property tree. */ @@ -754,6 +765,7 @@ public: * whether the property should normally be saved and restored.

*/ enum Attribute { + NO_ATTR = 0, READ = 1, WRITE = 2, ARCHIVE = 4, @@ -762,6 +774,8 @@ public: TRACE_WRITE = 32, USERARCHIVE = 64, PRESERVE = 128 + // beware: if you add another attribute here, + // also update value of "LAST_USED_ATTRIBUTE". }; @@ -771,7 +785,6 @@ public: */ static const int LAST_USED_ATTRIBUTE; - /** * Default constructor. */ @@ -875,9 +888,32 @@ public: } /** - * Create a child node after the last node with the same name. + * Create a new child node with the given name and an unused index + * + * @param min_index Minimal index for new node (skips lower indices) + * @param append Whether to simply use the index after the last used index + * or use a lower, unused index if it exists */ - SGPropertyNode * addChild (const char * name); + SGPropertyNode * addChild ( const char* name, + int min_index = 0, + bool append = true ); + SGPropertyNode * addChild ( const std::string& name, + int min_index = 0, + bool append = true ) + { return addChild(name.c_str(), min_index, append); } + + /** + * Create multiple child nodes with the given name an unused indices + * + * @param count The number of nodes create + * @param min_index Minimal index for new nodes (skips lower indices) + * @param append Whether to simply use the index after the last used index + * or use a lower, unused index if it exists + */ + simgear::PropertyList addChildren ( const std::string& name, + size_t count, + int min_index = 0, + bool append = true ); /** * Get a child node by name and index. @@ -909,36 +945,46 @@ public: simgear::PropertyList getChildren (const std::string& name) const { return getChildren(name.c_str()); } + /** + * Remove child by pointer (if it is a child of this node). + * + * @return true, if the node was deleted. + */ + bool removeChild(SGPropertyNode* node); + + // TODO do we need the removeXXX methods to return the deleted nodes? /** * Remove child by position. */ - SGPropertyNode_ptr removeChild (int pos, bool keep = true); + SGPropertyNode_ptr removeChild(int pos); /** * Remove a child node */ - SGPropertyNode_ptr removeChild (const char * name, int index = 0, - bool keep = true); + SGPropertyNode_ptr removeChild(const char * name, int index = 0); /** * Remove a child node */ - SGPropertyNode_ptr removeChild (const std::string& name, int index = 0, - bool keep = true) - { return removeChild(name.c_str(), index, keep); } + SGPropertyNode_ptr removeChild(const std::string& name, int index = 0) + { return removeChild(name.c_str(), index); } /** * Remove all children with the specified name. */ - simgear::PropertyList removeChildren (const char * name, bool keep = true); + simgear::PropertyList removeChildren(const char * name); /** * Remove all children with the specified name. */ - simgear::PropertyList removeChildren (const std::string& name, - bool keep = true) - { return removeChildren(name.c_str(), keep); } + simgear::PropertyList removeChildren(const std::string& name) + { return removeChildren(name.c_str()); } + + /** + * Remove all children (does not change the value of the node) + */ + void removeAllChildren(); // // Alias support. @@ -1167,6 +1213,18 @@ public: T getValue(typename boost::disable_if_c::Internal> ::type* dummy = 0) const; + /** + * Get a list of values from all children with the given name + */ + template // TODO use C++11 or traits + std::vector getChildValues(const std::string& name) const; + + /** + * Get a list of values from all children with the given name + */ + template + std::vector getChildValues(const std::string& name) const; + /** * Set a bool value for this node. */ @@ -1230,6 +1288,61 @@ public: return setValue(&val[0]); } + /** + * Set relative node to given value and afterwards make read only. + * + * @param relative_path Path to node + * @param value Value to set + * + * @return whether value could be set + */ + template + bool setValueReadOnly(const std::string& relative_path, const T& value) + { + SGPropertyNode* node = getNode(relative_path, true); + bool ret = node->setValue(value); + node->setAttributes(READ); + return ret; + } + +#if !PROPS_STANDALONE + /** + * Interpolate current value to target value within given time. + * + * @param type Type of interpolation ("numeric", "color", etc.) + * @param target Node containing target value + * @param duration Duration of interpolation (in seconds) + * @param easing Easing function (http://easings.net/) + */ + bool interpolate( const std::string& type, + const SGPropertyNode& target, + double duration = 0.6, + const std::string& easing = "swing" ); + + /** + * Interpolate current value to a series of values within given durations. + * + * @param type Type of interpolation ("numeric", "color", etc.) + * @param values Nodes containing intermediate and target values + * @param deltas Durations for each interpolation step (in seconds) + * @param easing Easing function (http://easings.net/) + */ + bool interpolate( const std::string& type, + const simgear::PropertyList& values, + const double_list& deltas, + const std::string& easing = "swing" ); + + /** + * Set the interpolation manager used by the interpolate methods. + */ + static void setInterpolationMgr(simgear::PropertyInterpolationMgr* mgr); + + /** + * Get the interpolation manager + */ + static simgear::PropertyInterpolationMgr* getInterpolationMgr(); +#endif + /** * Print the value of the property to a stream. */ @@ -1588,12 +1701,31 @@ public: */ void fireChildAdded (SGPropertyNode * child); + /** + * Trigger a child-added and value-changed event for every child (Unlimited + * depth). + * + * @param fire_self Whether to trigger the events also for the node itself. + * + * It can be used to simulating the creation of a property tree, eg. for + * (re)initializing a subsystem which is controlled through the property tree. + */ + void fireCreatedRecursive(bool fire_self = false); /** * Fire a child-removed event to all listeners. */ void fireChildRemoved (SGPropertyNode * child); + /** + * Fire a child-removed event for every child of this node (Unlimited depth) + * + * Upon removal of a child node only for this single node a child-removed + * event is triggered. If eg. resource cleanup relies on receiving a + * child-removed event for every child this method can be used. + */ + void fireChildrenRemovedRecursive(); + /** * Clear any existing value and set the type to NONE. @@ -1617,6 +1749,8 @@ protected: void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child); void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child); + SGPropertyNode_ptr eraseChild(simgear::PropertyList::iterator child); + /** * Protected constructor for making new nodes on demand. */ @@ -1624,6 +1758,8 @@ protected: template SGPropertyNode (Itr begin, Itr end, int index, SGPropertyNode * parent); + static simgear::PropertyInterpolationMgr* _interpolation_mgr; + private: // Get the raw value @@ -1665,7 +1801,6 @@ private: /// counted pointer SGPropertyNode * _parent; simgear::PropertyList _children; - simgear::PropertyList _removedChildren; mutable std::string _buffer; simgear::props::Type _type; bool _tied; @@ -1688,13 +1823,12 @@ private: std::vector * _listeners; - // Pass name as a pair of iterators template SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false); // very internal method template - SGPropertyNode* getExistingChild (Itr begin, Itr end, int index, bool create); + SGPropertyNode* getExistingChild (Itr begin, Itr end, int index); // very internal path parsing function template friend SGPropertyNode* find_node_aux(SGPropertyNode * current, SplitItr& itr, @@ -1705,7 +1839,12 @@ private: // Convenience functions for use in templates template -T getValue(const SGPropertyNode*); +#if PROPS_STANDALONE +T +#else +typename boost::disable_if, T>::type +#endif +getValue(const SGPropertyNode*); template<> inline bool getValue(const SGPropertyNode* node) { return node->getBoolValue(); } @@ -1734,6 +1873,62 @@ inline const char * getValue(const SGPropertyNode* node) return node->getStringValue (); } +template<> +inline std::string getValue(const SGPropertyNode* node) +{ + return node->getStringValue(); +} + +namespace simgear +{ + /** + * Default trait for extracting enum values from SGPropertyNode. Create your + * own specialization for specific enum types to enable validation of values. + */ + template + struct enum_traits + { + /** + * Typename of the enum + */ + static const char* name() { return typeid(T).name(); } + + /** + * @return Default value (will be used if validation fails) + */ + static T defVal() { return T(); } + + /** + * @return Whether the given integer value has an enum value defined + */ + static bool validate(int) { return true; } + }; +} // namespace simgear + +/** Extract enum from SGPropertyNode */ +template +#if PROPS_STANDALONE +inline T +#else +inline typename boost::enable_if, T>::type +#endif +getValue(const SGPropertyNode* node) +{ + typedef simgear::enum_traits Traits; + int val = node->getIntValue(); + if( !Traits::validate(val) ) + { + SG_LOG + ( + SG_GENERAL, + SG_WARN, + "Invalid value for enum (" << Traits::name() << ", val = " << val << ")" + ); + return Traits::defVal(); + } + return static_cast(node->getIntValue()); +} + inline bool setValue(SGPropertyNode* node, bool value) { return node->setBoolValue(value); @@ -1835,6 +2030,25 @@ inline T SGPropertyNode::getValue(typename boost::enable_if_c(this); } +template // TODO use C++11 or traits +std::vector SGPropertyNode::getChildValues(const std::string& name) const +{ + const simgear::PropertyList& props = getChildren(name); + std::vector values( props.size() ); + + for( size_t i = 0; i < props.size(); ++i ) + values[i] = props[i]->getValue(); + + return values; +} + +template +inline +std::vector SGPropertyNode::getChildValues(const std::string& name) const +{ + return getChildValues(name); +} + template bool SGPropertyNode::setValue(const T& val, typename boost::disable_if_c +class SGPropertyChangeCallback + : public SGPropertyChangeListener +{ +public: + SGPropertyChangeCallback(T* obj, void (T::*method)(SGPropertyNode*), + SGPropertyNode_ptr property,bool initial=false) + : _obj(obj), _callback(method), _property(property) + { + _property->addChangeListener(this,initial); + } + + SGPropertyChangeCallback(const SGPropertyChangeCallback& other) : + _obj(other._obj), _callback(other._callback), _property(other._property) + { + _property->addChangeListener(this,false); + } + + virtual ~SGPropertyChangeCallback() + { + _property->removeChangeListener(this); + } + void valueChanged (SGPropertyNode * node) + { + (_obj->*_callback)(node); + } +private: + T* _obj; + void (T::*_callback)(SGPropertyNode*); + SGPropertyNode_ptr _property; +}; + #endif // __PROPS_HXX // end of props.hxx