1 // Copyright (C) 2010 James Turner - zakalawe@mac.com
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Library General Public
5 // License as published by the Free Software Foundation; either
6 // version 2 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Library General Public License for more details.
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software
15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 #ifndef SG_PROPERTY_OBJECT
19 #define SG_PROPERTY_OBJECT
21 #include <simgear/props/props.hxx>
26 class PropertyObjectBase
29 static void setDefaultRoot(SGPropertyNode* aRoot);
33 PropertyObjectBase(const PropertyObjectBase& aOther);
35 PropertyObjectBase(const char* aChild);
37 PropertyObjectBase(SGPropertyNode* aNode, const char* aChild = NULL);
39 SGPropertyNode* node(bool aCreate) const;
42 * Resolve the property node, or throw an exception if it could not
45 SGPropertyNode* getOrThrow() const;
47 mutable const char* _path;
50 * Important - if _path is NULL, this is the actual prop.
51 * If path is non-NULL, this is the parent which path should be resolved
52 * against (or NULL, if _path is absolute). Use node() instead of accessing
53 * this directly, and the above is handled automatically.
55 mutable SGPropertyNode* _prop;
59 class PropertyObject : PropertyObjectBase
65 * Create from path relative to the default root, and option default value
67 PropertyObject(const char* aChild) :
68 PropertyObjectBase(aChild)
72 * Create from a node, with optional relative path
74 PropertyObject(SGPropertyNode* aNode, const char* aChild = NULL) :
75 PropertyObjectBase(aNode, aChild)
81 PropertyObject(const PropertyObject<T>& aOther) :
82 PropertyObjectBase(aOther)
86 // create() form creates the property immediately
87 static PropertyObject<T> create(const char* aPath, T aValue)
89 PropertyObject<T> p(aPath);
94 static PropertyObject<T> create(SGPropertyNode* aNode, T aValue)
96 PropertyObject<T> p(aNode);
101 static PropertyObject<T> create(SGPropertyNode* aNode, const char* aChild, T aValue)
103 PropertyObject<T> p(aNode, aChild);
108 // conversion operators
111 return getOrThrow()->template getValue<T>();
114 T operator=(const T& aValue)
116 SGPropertyNode* n = PropertyObjectBase::node(true);
121 n->setValue<T>(aValue);
125 SGPropertyNode* node() const
127 return PropertyObjectBase::node(false);
129 }; // of template PropertyObject
132 // specialization for const char* / std::string
135 class PropertyObject<std::string> : PropertyObjectBase
138 PropertyObject(const char* aChild) :
139 PropertyObjectBase(aChild)
144 PropertyObject(SGPropertyNode* aNode, const char* aChild = NULL) :
145 PropertyObjectBase(aNode, aChild)
151 PropertyObject(const PropertyObject<std::string>& aOther) :
152 PropertyObjectBase(aOther)
157 static PropertyObject<std::string> create(const char* aPath, const std::string& aValue)
159 PropertyObject<std::string> p(aPath);
164 static PropertyObject<std::string> create(SGPropertyNode* aNode, const std::string& aValue)
166 PropertyObject<std::string> p(aNode);
171 static PropertyObject<std::string> create(SGPropertyNode* aNode, const char* aChild, const std::string& aValue)
173 PropertyObject<std::string> p(aNode, aChild);
179 operator std::string () const
181 return getOrThrow()->getStringValue();
184 const char* operator=(const char* aValue)
186 SGPropertyNode* n = PropertyObjectBase::node(true);
191 n->setStringValue(aValue);
195 std::string operator=(const std::string& aValue)
197 SGPropertyNode* n = PropertyObjectBase::node(true);
202 n->setStringValue(aValue);
206 bool operator==(const char* value) const
208 std::string s(*this);
212 bool operator==(const std::string& value) const
214 std::string s(*this);
218 SGPropertyNode* node() const
220 return PropertyObjectBase::node(false);
225 } // of namespace simgear
227 typedef simgear::PropertyObject<double> SGPropObjDouble;
228 typedef simgear::PropertyObject<bool> SGPropObjBool;
229 typedef simgear::PropertyObject<std::string> SGPropObjString;
230 typedef simgear::PropertyObject<long> SGPropObjInt;