1 // props.cxx - implementation of a property list.
2 // Started Fall 2000 by David Megginson, david@megginson.com
3 // This code is released into the Public Domain.
5 // See props.html for documentation [replace with URL when available].
21 #include <simgear/compiler.h>
22 #include <simgear/debug/logstream.hxx>
24 #if ( _MSC_VER == 1200 )
25 // MSVC 6 is buggy, and needs something strange here
26 using std::vector<SGPropertyNode_ptr>;
27 using std::vector<SGPropertyChangeListener *>;
28 using std::vector<SGPropertyNode *>;
40 using std::stringstream;
44 ////////////////////////////////////////////////////////////////////////
46 ////////////////////////////////////////////////////////////////////////
49 * Comparator class for sorting by index.
54 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
55 return (n1->getIndex() < n2->getIndex());
61 ////////////////////////////////////////////////////////////////////////
62 // Convenience macros for value access.
63 ////////////////////////////////////////////////////////////////////////
65 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
66 #define TEST_WRITE if (!getAttribute(WRITE)) return false
70 ////////////////////////////////////////////////////////////////////////
71 // Default values for every type.
72 ////////////////////////////////////////////////////////////////////////
74 template<> const bool SGRawValue<bool>::DefaultValue = false;
75 template<> const int SGRawValue<int>::DefaultValue = 0;
76 template<> const long SGRawValue<long>::DefaultValue = 0L;
77 template<> const float SGRawValue<float>::DefaultValue = 0.0;
78 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
79 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
83 ////////////////////////////////////////////////////////////////////////
84 // Local path normalization code.
85 ////////////////////////////////////////////////////////////////////////
88 * A component in a path.
97 * Parse the name for a path component.
99 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
101 static inline const string
102 parse_name (const string &path, int &i)
105 int max = path.size();
107 if (path[i] == '.') {
109 if (i < max && path[i] == '.') {
115 if (i < max && path[i] != '/')
116 throw string("illegal character after " + name);
119 else if (isalpha(path[i]) || path[i] == '_') {
123 // The rules inside a name are a little
126 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
127 path[i] == '-' || path[i] == '.') {
129 } else if (path[i] == '[' || path[i] == '/') {
132 throw string("name may contain only ._- and alphanumeric characters");
139 if (name.size() == 0)
140 throw string("name must begin with alpha or '_'");
148 * Parse the optional integer index for a path component.
150 * Index: "[" [0-9]+ "]"
153 parse_index (const string &path, int &i)
162 for (int max = path.size(); i < max; i++) {
163 if (isdigit(path[i])) {
164 index = (index * 10) + (path[i] - '0');
165 } else if (path[i] == ']') {
173 throw string("unterminated index (looking for ']')");
178 * Parse a single path component.
180 * Component: Name Index?
182 static inline PathComponent
183 parse_component (const string &path, int &i)
185 PathComponent component;
186 component.name = parse_name(path, i);
187 if (component.name[0] != '.')
188 component.index = parse_index(path, i);
190 component.index = -1;
196 * Parse a path into its components.
199 parse_path (const string &path, vector<PathComponent> &components)
202 int max = path.size();
204 // Check for initial '/'
205 if (path[pos] == '/') {
209 components.push_back(root);
211 while (pos < max && path[pos] == '/')
216 components.push_back(parse_component(path, pos));
217 while (pos < max && path[pos] == '/')
224 ////////////////////////////////////////////////////////////////////////
225 // Other static utility functions.
226 ////////////////////////////////////////////////////////////////////////
230 copy_string (const char * s)
232 unsigned long int slen = strlen(s);
233 char * copy = new char[slen + 1];
235 // the source string length is known so no need to check for '\0'
236 // when copying every single character
237 memcpy(copy, s, slen);
238 *(copy + slen) = '\0';
243 compare_strings (const char * s1, const char * s2)
245 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
249 * Locate a child node by name and index.
252 find_child (const char * name, int index, const vector<SGPropertyNode_ptr>& nodes)
254 int nNodes = nodes.size();
255 for (int i = 0; i < nNodes; i++) {
256 SGPropertyNode * node = nodes[i];
258 // searching for a mathing index is a lot less time consuming than
259 // comparing two strings so do that first.
260 if (node->getIndex() == index && compare_strings(node->getName(), name))
267 * Locate the child node with the highest index of the same name
270 find_last_child (const char * name, const vector<SGPropertyNode_ptr>& nodes)
272 int nNodes = nodes.size();
275 for (int i = 0; i < nNodes; i++) {
276 SGPropertyNode * node = nodes[i];
277 if (compare_strings(node->getName(), name))
279 int idx = node->getIndex();
280 if (idx > index) index = idx;
288 * Locate another node, given a relative path.
290 static SGPropertyNode *
291 find_node (SGPropertyNode * current,
292 const vector<PathComponent> &components,
296 // Run off the end of the list
301 // Success! This is the one we want.
302 else if (position >= (int)components.size()) {
303 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
306 // Empty component means root.
307 else if (components[position].name == "") {
308 return find_node(current->getRootNode(), components, position + 1, create);
311 // . means current directory
312 else if (components[position].name == ".") {
313 return find_node(current, components, position + 1, create);
316 // .. means parent directory
317 else if (components[position].name == "..") {
318 SGPropertyNode * parent = current->getParent();
320 throw string("attempt to move past root with '..'");
322 return find_node(parent, components, position + 1, create);
325 // Otherwise, a child name
327 SGPropertyNode * child =
328 current->getChild(components[position].name.c_str(),
329 components[position].index,
331 return find_node(child, components, position + 1, create);
337 ////////////////////////////////////////////////////////////////////////
338 // Private methods from SGPropertyNode (may be inlined for speed).
339 ////////////////////////////////////////////////////////////////////////
342 SGPropertyNode::get_bool () const
345 return _value.bool_val->getValue();
347 return _local_val.bool_val;
351 SGPropertyNode::get_int () const
354 return _value.int_val->getValue();
356 return _local_val.int_val;
360 SGPropertyNode::get_long () const
363 return _value.long_val->getValue();
365 return _local_val.long_val;
369 SGPropertyNode::get_float () const
372 return _value.float_val->getValue();
374 return _local_val.float_val;
378 SGPropertyNode::get_double () const
381 return _value.double_val->getValue();
383 return _local_val.double_val;
387 SGPropertyNode::get_string () const
390 return _value.string_val->getValue();
392 return _local_val.string_val;
396 SGPropertyNode::set_bool (bool val)
399 if (_value.bool_val->setValue(val)) {
406 _local_val.bool_val = val;
413 SGPropertyNode::set_int (int val)
416 if (_value.int_val->setValue(val)) {
423 _local_val.int_val = val;
430 SGPropertyNode::set_long (long val)
433 if (_value.long_val->setValue(val)) {
440 _local_val.long_val = val;
447 SGPropertyNode::set_float (float val)
450 if (_value.float_val->setValue(val)) {
457 _local_val.float_val = val;
464 SGPropertyNode::set_double (double val)
467 if (_value.double_val->setValue(val)) {
474 _local_val.double_val = val;
481 SGPropertyNode::set_string (const char * val)
484 if (_value.string_val->setValue(val)) {
491 delete [] _local_val.string_val;
492 _local_val.string_val = copy_string(val);
499 SGPropertyNode::clearValue ()
510 delete _value.bool_val;
513 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
517 delete _value.int_val;
520 _local_val.int_val = SGRawValue<int>::DefaultValue;
524 delete _value.long_val;
525 _value.long_val = 0L;
527 _local_val.long_val = SGRawValue<long>::DefaultValue;
531 delete _value.float_val;
532 _value.float_val = 0;
534 _local_val.float_val = SGRawValue<float>::DefaultValue;
538 delete _value.double_val;
539 _value.double_val = 0;
541 _local_val.double_val = SGRawValue<double>::DefaultValue;
546 delete _value.string_val;
547 _value.string_val = 0;
549 delete [] _local_val.string_val;
551 _local_val.string_val = 0;
560 * Get the value as a string.
563 SGPropertyNode::make_string () const
565 if (!getAttribute(READ))
570 return _value.alias->getStringValue();
580 _buffer = sstr.str();
581 return _buffer.c_str();
587 _buffer = sstr.str();
588 return _buffer.c_str();
594 _buffer = sstr.str();
595 return _buffer.c_str();
600 sstr.precision( 10 );
601 sstr << get_double();
602 _buffer = sstr.str();
603 return _buffer.c_str();
615 * Trace a write access for a property.
618 SGPropertyNode::trace_write () const
621 cerr << "TRACE: Write node " << getPath () << ", value \""
622 << make_string() << '"' << endl;
624 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Write node " << getPath()
625 << ", value \"" << make_string() << '"');
630 * Trace a read access for a property.
633 SGPropertyNode::trace_read () const
636 cerr << "TRACE: Write node " << getPath () << ", value \""
637 << make_string() << '"' << endl;
639 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Read node " << getPath()
640 << ", value \"" << make_string() << '"');
645 ////////////////////////////////////////////////////////////////////////
646 // Public methods from SGPropertyNode.
647 ////////////////////////////////////////////////////////////////////////
650 * Last used attribute
651 * Update as needed when enum Attribute is changed
653 const int SGPropertyNode::LAST_USED_ATTRIBUTE = USERARCHIVE;
656 * Default constructor: always creates a root node.
658 SGPropertyNode::SGPropertyNode ()
667 _local_val.string_val = 0;
674 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
675 : _index(node._index),
677 _parent(0), // don't copy the parent
682 _listeners(0) // CHECK!!
684 _local_val.string_val = 0;
689 _value.alias = node._value.alias;
696 _value.bool_val = node._value.bool_val->clone();
699 set_bool(node.get_bool());
705 _value.int_val = node._value.int_val->clone();
708 set_int(node.get_int());
714 _value.long_val = node._value.long_val->clone();
717 set_long(node.get_long());
723 _value.float_val = node._value.float_val->clone();
726 set_float(node.get_float());
732 _value.double_val = node._value.double_val->clone();
735 set_double(node.get_double());
742 _value.string_val = node._value.string_val->clone();
745 set_string(node.get_string());
753 * Convenience constructor.
755 SGPropertyNode::SGPropertyNode (const char * name,
757 SGPropertyNode * parent)
767 _name = parse_name(name, i);
768 if (i != int(strlen(name)) || name[0] == '.')
769 throw string("plain name expected instead of '") + name + '\'';
771 _local_val.string_val = 0;
778 SGPropertyNode::~SGPropertyNode ()
780 // zero out all parent pointers, else they might be dangling
781 for (unsigned i = 0; i < _children.size(); ++i)
782 _children[i]->_parent = 0;
783 for (unsigned i = 0; i < _removedChildren.size(); ++i)
784 _removedChildren[i]->_parent = 0;
789 vector<SGPropertyChangeListener*>::iterator it;
790 for (it = _listeners->begin(); it != _listeners->end(); ++it)
791 (*it)->unregister_property(this);
798 * Alias to another node.
801 SGPropertyNode::alias (SGPropertyNode * target)
803 if (target == 0 || _type == ALIAS || _tied)
807 _value.alias = target;
814 * Alias to another node by path.
817 SGPropertyNode::alias (const char * path)
819 return alias(getNode(path, true));
827 SGPropertyNode::unalias ()
837 * Get the target of an alias.
840 SGPropertyNode::getAliasTarget ()
842 return (_type == ALIAS ? _value.alias : 0);
846 const SGPropertyNode *
847 SGPropertyNode::getAliasTarget () const
849 return (_type == ALIAS ? _value.alias : 0);
853 * create a non-const child by name after the last node with the same name.
856 SGPropertyNode::addChild (const char * name)
858 int pos = find_last_child(name, _children)+1;
860 SGPropertyNode_ptr node;
861 node = new SGPropertyNode(name, pos, this);
862 _children.push_back(node);
863 fireChildAdded(node);
869 * Get a non-const child by index.
872 SGPropertyNode::getChild (int position)
874 if (position >= 0 && position < nChildren())
875 return _children[position];
882 * Get a const child by index.
884 const SGPropertyNode *
885 SGPropertyNode::getChild (int position) const
887 if (position >= 0 && position < nChildren())
888 return _children[position];
895 * Get a non-const child by name and index, creating if necessary.
898 SGPropertyNode::getChild (const char * name, int index, bool create)
900 int pos = find_child(name, index, _children);
902 return _children[pos];
904 SGPropertyNode_ptr node;
905 pos = find_child(name, index, _removedChildren);
907 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
909 node = _removedChildren[pos];
910 _removedChildren.erase(it);
911 node->setAttribute(REMOVED, false);
913 node = new SGPropertyNode(name, index, this);
915 _children.push_back(node);
916 fireChildAdded(node);
925 * Get a const child by name and index.
927 const SGPropertyNode *
928 SGPropertyNode::getChild (const char * name, int index) const
930 int pos = find_child(name, index, _children);
932 return _children[pos];
939 * Get all children with the same name (but different indices).
941 vector<SGPropertyNode_ptr>
942 SGPropertyNode::getChildren (const char * name) const
944 vector<SGPropertyNode_ptr> children;
945 int max = _children.size();
947 for (int i = 0; i < max; i++)
948 if (compare_strings(_children[i]->getName(), name))
949 children.push_back(_children[i]);
951 sort(children.begin(), children.end(), CompareIndices());
957 * Remove this node and all children from nodes that link to them
958 * in their path cache.
961 SGPropertyNode::remove_from_path_caches ()
963 for (unsigned int i = 0; i < _children.size(); ++i)
964 _children[i]->remove_from_path_caches();
966 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
967 _linkedNodes[i]->erase(this);
968 _linkedNodes.clear();
973 * Remove child by position.
976 SGPropertyNode::removeChild (int pos, bool keep)
978 SGPropertyNode_ptr node;
979 if (pos < 0 || pos >= (int)_children.size())
982 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
984 node = _children[pos];
987 _removedChildren.push_back(node);
990 node->remove_from_path_caches();
991 node->setAttribute(REMOVED, true);
993 fireChildRemoved(node);
999 * Remove a child node
1002 SGPropertyNode::removeChild (const char * name, int index, bool keep)
1004 SGPropertyNode_ptr ret;
1005 int pos = find_child(name, index, _children);
1007 ret = removeChild(pos, keep);
1013 * Remove all children with the specified name.
1015 vector<SGPropertyNode_ptr>
1016 SGPropertyNode::removeChildren (const char * name, bool keep)
1018 vector<SGPropertyNode_ptr> children;
1020 for (int pos = _children.size() - 1; pos >= 0; pos--)
1021 if (compare_strings(_children[pos]->getName(), name))
1022 children.push_back(removeChild(pos, keep));
1024 sort(children.begin(), children.end(), CompareIndices());
1030 * Remove a linked node.
1033 SGPropertyNode::remove_linked_node (hash_table * node)
1035 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
1036 if (_linkedNodes[i] == node) {
1037 vector<hash_table *>::iterator it = _linkedNodes.begin();
1039 _linkedNodes.erase(it);
1048 SGPropertyNode::getDisplayName (bool simplify) const
1050 _display_name = _name;
1051 if (_index != 0 || !simplify) {
1053 sstr << '[' << _index << ']';
1054 _display_name += sstr.str();
1056 return _display_name.c_str();
1061 SGPropertyNode::getPath (bool simplify) const
1063 // Calculate the complete path only once.
1064 if (_parent != 0 && _path.empty()) {
1065 _path = _parent->getPath(simplify);
1067 _path += getDisplayName(simplify);
1070 return _path.c_str();
1073 SGPropertyNode::Type
1074 SGPropertyNode::getType () const
1077 return _value.alias->getType();
1084 SGPropertyNode::getBoolValue () const
1086 // Shortcut for common case
1087 if (_attr == (READ|WRITE) && _type == BOOL)
1090 if (getAttribute(TRACE_READ))
1092 if (!getAttribute(READ))
1093 return SGRawValue<bool>::DefaultValue;
1096 return _value.alias->getBoolValue();
1100 return get_int() == 0 ? false : true;
1102 return get_long() == 0L ? false : true;
1104 return get_float() == 0.0 ? false : true;
1106 return get_double() == 0.0L ? false : true;
1109 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1112 return SGRawValue<bool>::DefaultValue;
1117 SGPropertyNode::getIntValue () const
1119 // Shortcut for common case
1120 if (_attr == (READ|WRITE) && _type == INT)
1123 if (getAttribute(TRACE_READ))
1125 if (!getAttribute(READ))
1126 return SGRawValue<int>::DefaultValue;
1129 return _value.alias->getIntValue();
1131 return int(get_bool());
1135 return int(get_long());
1137 return int(get_float());
1139 return int(get_double());
1142 return atoi(get_string());
1145 return SGRawValue<int>::DefaultValue;
1150 SGPropertyNode::getLongValue () const
1152 // Shortcut for common case
1153 if (_attr == (READ|WRITE) && _type == LONG)
1156 if (getAttribute(TRACE_READ))
1158 if (!getAttribute(READ))
1159 return SGRawValue<long>::DefaultValue;
1162 return _value.alias->getLongValue();
1164 return long(get_bool());
1166 return long(get_int());
1170 return long(get_float());
1172 return long(get_double());
1175 return strtol(get_string(), 0, 0);
1178 return SGRawValue<long>::DefaultValue;
1183 SGPropertyNode::getFloatValue () const
1185 // Shortcut for common case
1186 if (_attr == (READ|WRITE) && _type == FLOAT)
1189 if (getAttribute(TRACE_READ))
1191 if (!getAttribute(READ))
1192 return SGRawValue<float>::DefaultValue;
1195 return _value.alias->getFloatValue();
1197 return float(get_bool());
1199 return float(get_int());
1201 return float(get_long());
1205 return float(get_double());
1208 return atof(get_string());
1211 return SGRawValue<float>::DefaultValue;
1216 SGPropertyNode::getDoubleValue () const
1218 // Shortcut for common case
1219 if (_attr == (READ|WRITE) && _type == DOUBLE)
1220 return get_double();
1222 if (getAttribute(TRACE_READ))
1224 if (!getAttribute(READ))
1225 return SGRawValue<double>::DefaultValue;
1229 return _value.alias->getDoubleValue();
1231 return double(get_bool());
1233 return double(get_int());
1235 return double(get_long());
1237 return double(get_float());
1239 return get_double();
1242 return strtod(get_string(), 0);
1245 return SGRawValue<double>::DefaultValue;
1250 SGPropertyNode::getStringValue () const
1252 // Shortcut for common case
1253 if (_attr == (READ|WRITE) && _type == STRING)
1254 return get_string();
1256 if (getAttribute(TRACE_READ))
1258 if (!getAttribute(READ))
1259 return SGRawValue<const char *>::DefaultValue;
1260 return make_string();
1264 SGPropertyNode::setBoolValue (bool value)
1266 // Shortcut for common case
1267 if (_attr == (READ|WRITE) && _type == BOOL)
1268 return set_bool(value);
1270 bool result = false;
1272 if (_type == NONE || _type == UNSPECIFIED) {
1280 result = _value.alias->setBoolValue(value);
1283 result = set_bool(value);
1286 result = set_int(int(value));
1289 result = set_long(long(value));
1292 result = set_float(float(value));
1295 result = set_double(double(value));
1299 result = set_string(value ? "true" : "false");
1306 if (getAttribute(TRACE_WRITE))
1312 SGPropertyNode::setIntValue (int value)
1314 // Shortcut for common case
1315 if (_attr == (READ|WRITE) && _type == INT)
1316 return set_int(value);
1318 bool result = false;
1320 if (_type == NONE || _type == UNSPECIFIED) {
1323 _local_val.int_val = 0;
1328 result = _value.alias->setIntValue(value);
1331 result = set_bool(value == 0 ? false : true);
1334 result = set_int(value);
1337 result = set_long(long(value));
1340 result = set_float(float(value));
1343 result = set_double(double(value));
1348 sprintf(buf, "%d", value);
1349 result = set_string(buf);
1357 if (getAttribute(TRACE_WRITE))
1363 SGPropertyNode::setLongValue (long value)
1365 // Shortcut for common case
1366 if (_attr == (READ|WRITE) && _type == LONG)
1367 return set_long(value);
1369 bool result = false;
1371 if (_type == NONE || _type == UNSPECIFIED) {
1374 _local_val.long_val = 0L;
1379 result = _value.alias->setLongValue(value);
1382 result = set_bool(value == 0L ? false : true);
1385 result = set_int(int(value));
1388 result = set_long(value);
1391 result = set_float(float(value));
1394 result = set_double(double(value));
1399 sprintf(buf, "%ld", value);
1400 result = set_string(buf);
1408 if (getAttribute(TRACE_WRITE))
1414 SGPropertyNode::setFloatValue (float value)
1416 // Shortcut for common case
1417 if (_attr == (READ|WRITE) && _type == FLOAT)
1418 return set_float(value);
1420 bool result = false;
1422 if (_type == NONE || _type == UNSPECIFIED) {
1425 _local_val.float_val = 0;
1430 result = _value.alias->setFloatValue(value);
1433 result = set_bool(value == 0.0 ? false : true);
1436 result = set_int(int(value));
1439 result = set_long(long(value));
1442 result = set_float(value);
1445 result = set_double(double(value));
1450 sprintf(buf, "%f", value);
1451 result = set_string(buf);
1459 if (getAttribute(TRACE_WRITE))
1465 SGPropertyNode::setDoubleValue (double value)
1467 // Shortcut for common case
1468 if (_attr == (READ|WRITE) && _type == DOUBLE)
1469 return set_double(value);
1471 bool result = false;
1473 if (_type == NONE || _type == UNSPECIFIED) {
1475 _local_val.double_val = value;
1481 result = _value.alias->setDoubleValue(value);
1484 result = set_bool(value == 0.0L ? false : true);
1487 result = set_int(int(value));
1490 result = set_long(long(value));
1493 result = set_float(float(value));
1496 result = set_double(value);
1501 sprintf(buf, "%f", value);
1502 result = set_string(buf);
1510 if (getAttribute(TRACE_WRITE))
1516 SGPropertyNode::setStringValue (const char * value)
1518 // Shortcut for common case
1519 if (_attr == (READ|WRITE) && _type == STRING)
1520 return set_string(value);
1522 bool result = false;
1524 if (_type == NONE || _type == UNSPECIFIED) {
1531 result = _value.alias->setStringValue(value);
1534 result = set_bool((compare_strings(value, "true")
1535 || atoi(value)) ? true : false);
1538 result = set_int(atoi(value));
1541 result = set_long(strtol(value, 0, 0));
1544 result = set_float(atof(value));
1547 result = set_double(strtod(value, 0));
1551 result = set_string(value);
1558 if (getAttribute(TRACE_WRITE))
1564 SGPropertyNode::setUnspecifiedValue (const char * value)
1566 bool result = false;
1568 if (_type == NONE) {
1570 _type = UNSPECIFIED;
1575 result = _value.alias->setUnspecifiedValue(value);
1578 result = set_bool((compare_strings(value, "true")
1579 || atoi(value)) ? true : false);
1582 result = set_int(atoi(value));
1585 result = set_long(strtol(value, 0, 0));
1588 result = set_float(atof(value));
1591 result = set_double(strtod(value, 0));
1595 result = set_string(value);
1602 if (getAttribute(TRACE_WRITE))
1608 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1610 if (_type == ALIAS || _tied)
1613 useDefault = useDefault && hasValue();
1614 bool old_val = false;
1616 old_val = getBoolValue();
1621 _value.bool_val = rawValue.clone();
1624 setBoolValue(old_val);
1630 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1632 if (_type == ALIAS || _tied)
1635 useDefault = useDefault && hasValue();
1638 old_val = getIntValue();
1643 _value.int_val = rawValue.clone();
1646 setIntValue(old_val);
1652 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1654 if (_type == ALIAS || _tied)
1657 useDefault = useDefault && hasValue();
1660 old_val = getLongValue();
1665 _value.long_val = rawValue.clone();
1668 setLongValue(old_val);
1674 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1676 if (_type == ALIAS || _tied)
1679 useDefault = useDefault && hasValue();
1680 float old_val = 0.0;
1682 old_val = getFloatValue();
1687 _value.float_val = rawValue.clone();
1690 setFloatValue(old_val);
1696 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1698 if (_type == ALIAS || _tied)
1701 useDefault = useDefault && hasValue();
1702 double old_val = 0.0;
1704 old_val = getDoubleValue();
1709 _value.double_val = rawValue.clone();
1712 setDoubleValue(old_val);
1719 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1721 if (_type == ALIAS || _tied)
1724 useDefault = useDefault && hasValue();
1727 old_val = getStringValue();
1732 _value.string_val = rawValue.clone();
1735 setStringValue(old_val.c_str());
1741 SGPropertyNode::untie ()
1748 bool val = getBoolValue();
1751 _local_val.bool_val = val;
1755 int val = getIntValue();
1758 _local_val.int_val = val;
1762 long val = getLongValue();
1765 _local_val.long_val = val;
1769 float val = getFloatValue();
1772 _local_val.float_val = val;
1776 double val = getDoubleValue();
1779 _local_val.double_val = val;
1784 string val = getStringValue();
1787 _local_val.string_val = copy_string(val.c_str());
1800 SGPropertyNode::getRootNode ()
1805 return _parent->getRootNode();
1808 const SGPropertyNode *
1809 SGPropertyNode::getRootNode () const
1814 return _parent->getRootNode();
1818 SGPropertyNode::getNode (const char * relative_path, bool create)
1820 if (_path_cache == 0)
1821 _path_cache = new hash_table;
1823 SGPropertyNode * result = _path_cache->get(relative_path);
1825 vector<PathComponent> components;
1826 parse_path(relative_path, components);
1827 result = find_node(this, components, 0, create);
1829 _path_cache->put(relative_path, result);
1836 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1838 vector<PathComponent> components;
1839 parse_path(relative_path, components);
1840 if (components.size() > 0)
1841 components.back().index = index;
1842 return find_node(this, components, 0, create);
1845 const SGPropertyNode *
1846 SGPropertyNode::getNode (const char * relative_path) const
1848 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1851 const SGPropertyNode *
1852 SGPropertyNode::getNode (const char * relative_path, int index) const
1854 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1858 ////////////////////////////////////////////////////////////////////////
1859 // Convenience methods using relative paths.
1860 ////////////////////////////////////////////////////////////////////////
1864 * Test whether another node has a value attached.
1867 SGPropertyNode::hasValue (const char * relative_path) const
1869 const SGPropertyNode * node = getNode(relative_path);
1870 return (node == 0 ? false : node->hasValue());
1875 * Get the value type for another node.
1877 SGPropertyNode::Type
1878 SGPropertyNode::getType (const char * relative_path) const
1880 const SGPropertyNode * node = getNode(relative_path);
1881 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1886 * Get a bool value for another node.
1889 SGPropertyNode::getBoolValue (const char * relative_path,
1890 bool defaultValue) const
1892 const SGPropertyNode * node = getNode(relative_path);
1893 return (node == 0 ? defaultValue : node->getBoolValue());
1898 * Get an int value for another node.
1901 SGPropertyNode::getIntValue (const char * relative_path,
1902 int defaultValue) const
1904 const SGPropertyNode * node = getNode(relative_path);
1905 return (node == 0 ? defaultValue : node->getIntValue());
1910 * Get a long value for another node.
1913 SGPropertyNode::getLongValue (const char * relative_path,
1914 long defaultValue) const
1916 const SGPropertyNode * node = getNode(relative_path);
1917 return (node == 0 ? defaultValue : node->getLongValue());
1922 * Get a float value for another node.
1925 SGPropertyNode::getFloatValue (const char * relative_path,
1926 float defaultValue) const
1928 const SGPropertyNode * node = getNode(relative_path);
1929 return (node == 0 ? defaultValue : node->getFloatValue());
1934 * Get a double value for another node.
1937 SGPropertyNode::getDoubleValue (const char * relative_path,
1938 double defaultValue) const
1940 const SGPropertyNode * node = getNode(relative_path);
1941 return (node == 0 ? defaultValue : node->getDoubleValue());
1946 * Get a string value for another node.
1949 SGPropertyNode::getStringValue (const char * relative_path,
1950 const char * defaultValue) const
1952 const SGPropertyNode * node = getNode(relative_path);
1953 return (node == 0 ? defaultValue : node->getStringValue());
1958 * Set a bool value for another node.
1961 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1963 return getNode(relative_path, true)->setBoolValue(value);
1968 * Set an int value for another node.
1971 SGPropertyNode::setIntValue (const char * relative_path, int value)
1973 return getNode(relative_path, true)->setIntValue(value);
1978 * Set a long value for another node.
1981 SGPropertyNode::setLongValue (const char * relative_path, long value)
1983 return getNode(relative_path, true)->setLongValue(value);
1988 * Set a float value for another node.
1991 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1993 return getNode(relative_path, true)->setFloatValue(value);
1998 * Set a double value for another node.
2001 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
2003 return getNode(relative_path, true)->setDoubleValue(value);
2008 * Set a string value for another node.
2011 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
2013 return getNode(relative_path, true)->setStringValue(value);
2018 * Set an unknown value for another node.
2021 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
2024 return getNode(relative_path, true)->setUnspecifiedValue(value);
2029 * Test whether another node is tied.
2032 SGPropertyNode::isTied (const char * relative_path) const
2034 const SGPropertyNode * node = getNode(relative_path);
2035 return (node == 0 ? false : node->isTied());
2040 * Tie a node reached by a relative path, creating it if necessary.
2043 SGPropertyNode::tie (const char * relative_path,
2044 const SGRawValue<bool> &rawValue,
2047 return getNode(relative_path, true)->tie(rawValue, useDefault);
2052 * Tie a node reached by a relative path, creating it if necessary.
2055 SGPropertyNode::tie (const char * relative_path,
2056 const SGRawValue<int> &rawValue,
2059 return getNode(relative_path, true)->tie(rawValue, useDefault);
2064 * Tie a node reached by a relative path, creating it if necessary.
2067 SGPropertyNode::tie (const char * relative_path,
2068 const SGRawValue<long> &rawValue,
2071 return getNode(relative_path, true)->tie(rawValue, useDefault);
2076 * Tie a node reached by a relative path, creating it if necessary.
2079 SGPropertyNode::tie (const char * relative_path,
2080 const SGRawValue<float> &rawValue,
2083 return getNode(relative_path, true)->tie(rawValue, useDefault);
2088 * Tie a node reached by a relative path, creating it if necessary.
2091 SGPropertyNode::tie (const char * relative_path,
2092 const SGRawValue<double> &rawValue,
2095 return getNode(relative_path, true)->tie(rawValue, useDefault);
2100 * Tie a node reached by a relative path, creating it if necessary.
2103 SGPropertyNode::tie (const char * relative_path,
2104 const SGRawValue<const char *> &rawValue,
2107 return getNode(relative_path, true)->tie(rawValue, useDefault);
2112 * Attempt to untie another node reached by a relative path.
2115 SGPropertyNode::untie (const char * relative_path)
2117 SGPropertyNode * node = getNode(relative_path);
2118 return (node == 0 ? false : node->untie());
2122 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2125 if (_listeners == 0)
2126 _listeners = new vector<SGPropertyChangeListener*>;
2127 _listeners->push_back(listener);
2128 listener->register_property(this);
2130 listener->valueChanged(this);
2134 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2136 vector<SGPropertyChangeListener*>::iterator it =
2137 find(_listeners->begin(), _listeners->end(), listener);
2138 if (it != _listeners->end()) {
2139 _listeners->erase(it);
2140 listener->unregister_property(this);
2141 if (_listeners->empty()) {
2142 vector<SGPropertyChangeListener*>* tmp = _listeners;
2150 SGPropertyNode::fireValueChanged ()
2152 fireValueChanged(this);
2156 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2158 fireChildAdded(this, child);
2162 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2164 fireChildRemoved(this, child);
2168 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2170 if (_listeners != 0) {
2171 for (unsigned int i = 0; i < _listeners->size(); i++) {
2172 (*_listeners)[i]->valueChanged(node);
2176 _parent->fireValueChanged(node);
2180 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2181 SGPropertyNode * child)
2183 if (_listeners != 0) {
2184 for (unsigned int i = 0; i < _listeners->size(); i++) {
2185 (*_listeners)[i]->childAdded(parent, child);
2189 _parent->fireChildAdded(parent, child);
2193 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2194 SGPropertyNode * child)
2196 if (_listeners != 0) {
2197 for (unsigned int i = 0; i < _listeners->size(); i++) {
2198 (*_listeners)[i]->childRemoved(parent, child);
2202 _parent->fireChildRemoved(parent, child);
2207 ////////////////////////////////////////////////////////////////////////
2208 // Simplified hash table for caching paths.
2209 ////////////////////////////////////////////////////////////////////////
2211 #define HASH_TABLE_SIZE 199
2213 SGPropertyNode::hash_table::entry::entry ()
2218 SGPropertyNode::hash_table::entry::~entry ()
2220 // Don't delete the value; we don't own
2225 SGPropertyNode::hash_table::entry::set_key (const char * key)
2231 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2236 SGPropertyNode::hash_table::bucket::bucket ()
2242 SGPropertyNode::hash_table::bucket::~bucket ()
2244 for (int i = 0; i < _length; i++)
2249 SGPropertyNode::hash_table::entry *
2250 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2253 for (i = 0; i < _length; i++) {
2254 if (!strcmp(_entries[i]->get_key(), key))
2258 entry ** new_entries = new entry*[_length+1];
2259 for (i = 0; i < _length; i++) {
2260 new_entries[i] = _entries[i];
2263 _entries = new_entries;
2264 _entries[_length] = new entry;
2265 _entries[_length]->set_key(key);
2267 return _entries[_length - 1];
2274 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2276 for (int i = 0; i < _length; i++) {
2277 if (_entries[i]->get_value() == node) {
2279 for (++i; i < _length; i++) {
2280 _entries[i-1] = _entries[i];
2290 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2292 for (int i = 0; i < _length; i++) {
2293 SGPropertyNode * node = _entries[i]->get_value();
2295 node->remove_linked_node(owner);
2299 SGPropertyNode::hash_table::hash_table ()
2305 SGPropertyNode::hash_table::~hash_table ()
2307 for (unsigned int i = 0; i < _data_length; i++) {
2309 _data[i]->clear(this);
2317 SGPropertyNode::hash_table::get (const char * key)
2319 if (_data_length == 0)
2321 unsigned int index = hashcode(key) % _data_length;
2322 if (_data[index] == 0)
2324 entry * e = _data[index]->get_entry(key);
2328 return e->get_value();
2332 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2334 if (_data_length == 0) {
2335 _data = new bucket*[HASH_TABLE_SIZE];
2336 _data_length = HASH_TABLE_SIZE;
2337 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2340 unsigned int index = hashcode(key) % _data_length;
2341 if (_data[index] == 0) {
2342 _data[index] = new bucket;
2344 entry * e = _data[index]->get_entry(key, true);
2345 e->set_value(value);
2346 value->add_linked_node(this);
2350 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2352 for (unsigned int i = 0; i < _data_length; i++)
2353 if (_data[i] && _data[i]->erase(node))
2360 SGPropertyNode::hash_table::hashcode (const char * key)
2362 unsigned int hash = 0;
2364 hash = 31 * hash + *key;
2372 ////////////////////////////////////////////////////////////////////////
2373 // Implementation of SGPropertyChangeListener.
2374 ////////////////////////////////////////////////////////////////////////
2376 SGPropertyChangeListener::~SGPropertyChangeListener ()
2378 for (int i = _properties.size() - 1; i >= 0; i--)
2379 _properties[i]->removeChangeListener(this);
2383 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2389 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2390 SGPropertyNode * child)
2396 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2397 SGPropertyNode * child)
2403 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2405 _properties.push_back(node);
2409 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2411 vector<SGPropertyNode *>::iterator it =
2412 find(_properties.begin(), _properties.end(), node);
2413 if (it != _properties.end())
2414 _properties.erase(it);