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].
24 using std::stringstream;
28 #include <simgear/compiler.h>
29 #include <simgear/debug/logstream.hxx>
34 SG_USING_STD(stringstream);
36 #if ( _MSC_VER == 1200 )
37 // MSVC 6 is buggy, and needs something strange here
38 SG_USING_STD(vector<SGPropertyNode_ptr>);
39 SG_USING_STD(vector<SGPropertyChangeListener *>);
40 SG_USING_STD(vector<SGPropertyNode *>);
47 ////////////////////////////////////////////////////////////////////////
49 ////////////////////////////////////////////////////////////////////////
52 * Comparator class for sorting by index.
57 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
58 return (n1->getIndex() < n2->getIndex());
64 ////////////////////////////////////////////////////////////////////////
65 // Convenience macros for value access.
66 ////////////////////////////////////////////////////////////////////////
68 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
69 #define TEST_WRITE if (!getAttribute(WRITE)) return false
73 ////////////////////////////////////////////////////////////////////////
74 // Default values for every type.
75 ////////////////////////////////////////////////////////////////////////
77 template<> const bool SGRawValue<bool>::DefaultValue = false;
78 template<> const int SGRawValue<int>::DefaultValue = 0;
79 template<> const long SGRawValue<long>::DefaultValue = 0L;
80 template<> const float SGRawValue<float>::DefaultValue = 0.0;
81 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
82 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
86 ////////////////////////////////////////////////////////////////////////
87 // Local path normalization code.
88 ////////////////////////////////////////////////////////////////////////
91 * A component in a path.
100 * Parse the name for a path component.
102 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
104 static inline const string
105 parse_name (const string &path, int &i)
108 int max = path.size();
110 if (path[i] == '.') {
112 if (i < max && path[i] == '.') {
118 if (i < max && path[i] != '/')
119 throw string("Illegal character after " + name);
122 else if (isalpha(path[i]) || path[i] == '_') {
126 // The rules inside a name are a little
129 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
130 path[i] == '-' || path[i] == '.') {
132 } else if (path[i] == '[' || path[i] == '/') {
135 throw string("name may contain only ._- and alphanumeric characters");
142 if (name.size() == 0)
143 throw string("name must begin with alpha or '_'");
151 * Parse the optional integer index for a path component.
153 * Index: "[" [0-9]+ "]"
156 parse_index (const string &path, int &i)
165 for (int max = path.size(); i < max; i++) {
166 if (isdigit(path[i])) {
167 index = (index * 10) + (path[i] - '0');
168 } else if (path[i] == ']') {
176 throw string("unterminated index (looking for ']')");
181 * Parse a single path component.
183 * Component: Name Index?
185 static inline PathComponent
186 parse_component (const string &path, int &i)
188 PathComponent component;
189 component.name = parse_name(path, i);
190 if (component.name[0] != '.')
191 component.index = parse_index(path, i);
193 component.index = -1;
199 * Parse a path into its components.
202 parse_path (const string &path, vector<PathComponent> &components)
205 int max = path.size();
207 // Check for initial '/'
208 if (path[pos] == '/') {
212 components.push_back(root);
214 while (pos < max && path[pos] == '/')
219 components.push_back(parse_component(path, pos));
220 while (pos < max && path[pos] == '/')
227 ////////////////////////////////////////////////////////////////////////
228 // Other static utility functions.
229 ////////////////////////////////////////////////////////////////////////
233 copy_string (const char * s)
235 // FIXME: potential buffer overflow.
236 // For some reason, strnlen and
237 // strncpy cause all kinds of crashes.
238 char * copy = new char[strlen(s) + 1];
244 compare_strings (const char * s1, const char * s2)
246 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
250 * Locate a child node by name and index.
253 find_child (const char * name, int index, vector<SGPropertyNode_ptr> nodes)
255 int nNodes = nodes.size();
256 for (int i = 0; i < nNodes; i++) {
257 SGPropertyNode * node = nodes[i];
258 if (compare_strings(node->getName(), name) && node->getIndex() == index)
266 * Locate another node, given a relative path.
268 static SGPropertyNode *
269 find_node (SGPropertyNode * current,
270 const vector<PathComponent> &components,
274 // Run off the end of the list
279 // Success! This is the one we want.
280 else if (position >= (int)components.size()) {
281 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
284 // Empty component means root.
285 else if (components[position].name == "") {
286 return find_node(current->getRootNode(), components, position + 1, create);
289 // . means current directory
290 else if (components[position].name == ".") {
291 return find_node(current, components, position + 1, create);
294 // .. means parent directory
295 else if (components[position].name == "..") {
296 SGPropertyNode * parent = current->getParent();
298 throw string("Attempt to move past root with '..'");
300 return find_node(parent, components, position + 1, create);
303 // Otherwise, a child name
305 SGPropertyNode * child =
306 current->getChild(components[position].name.c_str(),
307 components[position].index,
309 return find_node(child, components, position + 1, create);
315 ////////////////////////////////////////////////////////////////////////
316 // Private methods from SGPropertyNode (may be inlined for speed).
317 ////////////////////////////////////////////////////////////////////////
320 SGPropertyNode::get_bool () const
323 return _value.bool_val->getValue();
325 return _local_val.bool_val;
329 SGPropertyNode::get_int () const
332 return _value.int_val->getValue();
334 return _local_val.int_val;
338 SGPropertyNode::get_long () const
341 return _value.long_val->getValue();
343 return _local_val.long_val;
347 SGPropertyNode::get_float () const
350 return _value.float_val->getValue();
352 return _local_val.float_val;
356 SGPropertyNode::get_double () const
359 return _value.double_val->getValue();
361 return _local_val.double_val;
365 SGPropertyNode::get_string () const
368 return _value.string_val->getValue();
370 return _local_val.string_val;
374 SGPropertyNode::set_bool (bool val)
377 if (_value.bool_val->setValue(val)) {
384 _local_val.bool_val = val;
391 SGPropertyNode::set_int (int val)
394 if (_value.int_val->setValue(val)) {
401 _local_val.int_val = val;
408 SGPropertyNode::set_long (long val)
411 if (_value.long_val->setValue(val)) {
418 _local_val.long_val = val;
425 SGPropertyNode::set_float (float val)
428 if (_value.float_val->setValue(val)) {
435 _local_val.float_val = val;
442 SGPropertyNode::set_double (double val)
445 if (_value.double_val->setValue(val)) {
452 _local_val.double_val = val;
459 SGPropertyNode::set_string (const char * val)
462 if (_value.string_val->setValue(val)) {
469 delete [] _local_val.string_val;
470 _local_val.string_val = copy_string(val);
477 SGPropertyNode::clearValue ()
487 delete _value.bool_val;
490 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
494 delete _value.int_val;
497 _local_val.int_val = SGRawValue<int>::DefaultValue;
501 delete _value.long_val;
502 _value.long_val = 0L;
504 _local_val.long_val = SGRawValue<long>::DefaultValue;
508 delete _value.float_val;
509 _value.float_val = 0;
511 _local_val.float_val = SGRawValue<float>::DefaultValue;
515 delete _value.double_val;
516 _value.double_val = 0;
518 _local_val.double_val = SGRawValue<double>::DefaultValue;
523 delete _value.string_val;
524 _value.string_val = 0;
526 delete [] _local_val.string_val;
528 _local_val.string_val = 0;
537 * Get the value as a string.
540 SGPropertyNode::make_string () const
542 if (!getAttribute(READ))
547 return _value.alias->getStringValue();
557 _buffer = sstr.str();
558 return _buffer.c_str();
564 _buffer = sstr.str();
565 return _buffer.c_str();
571 _buffer = sstr.str();
572 return _buffer.c_str();
577 sstr << get_double();
578 _buffer = sstr.str();
579 return _buffer.c_str();
591 * Trace a write access for a property.
594 SGPropertyNode::trace_write () const
597 cerr << "TRACE: Write node " << getPath () << ", value\""
598 << make_string() << '"' << endl;
600 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
601 << ", value\"" << make_string() << '"');
606 * Trace a read access for a property.
609 SGPropertyNode::trace_read () const
612 cerr << "TRACE: Write node " << getPath () << ", value \""
613 << make_string() << '"' << endl;
615 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
616 << ", value \"" << make_string() << '"');
621 ////////////////////////////////////////////////////////////////////////
622 // Public methods from SGPropertyNode.
623 ////////////////////////////////////////////////////////////////////////
626 * Last used attribute
627 * Update as needed when enum Attribute is changed
629 const int SGPropertyNode::LAST_USED_ATTRIBUTE = TRACE_WRITE;
632 * Default constructor: always creates a root node.
634 SGPropertyNode::SGPropertyNode ()
643 _local_val.string_val = 0;
650 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
651 : _index(node._index),
653 _parent(0), // don't copy the parent
658 _listeners(0) // CHECK!!
660 _local_val.string_val = 0;
665 _value.alias = node._value.alias;
671 _value.bool_val = node._value.bool_val->clone();
674 set_bool(node.get_bool());
680 _value.int_val = node._value.int_val->clone();
683 set_int(node.get_int());
689 _value.long_val = node._value.long_val->clone();
692 set_long(node.get_long());
698 _value.float_val = node._value.float_val->clone();
701 set_float(node.get_float());
707 _value.double_val = node._value.double_val->clone();
710 set_double(node.get_double());
717 _value.string_val = node._value.string_val->clone();
720 set_string(node.get_string());
728 * Convenience constructor.
730 SGPropertyNode::SGPropertyNode (const char * name,
732 SGPropertyNode * parent)
742 _local_val.string_val = 0;
749 SGPropertyNode::~SGPropertyNode ()
758 * Alias to another node.
761 SGPropertyNode::alias (SGPropertyNode * target)
763 if (target == 0 || _type == ALIAS || _tied)
766 _value.alias = target;
773 * Alias to another node by path.
776 SGPropertyNode::alias (const char * path)
778 return alias(getNode(path, true));
786 SGPropertyNode::unalias ()
797 * Get the target of an alias.
800 SGPropertyNode::getAliasTarget ()
802 return (_type == ALIAS ? _value.alias : 0);
806 const SGPropertyNode *
807 SGPropertyNode::getAliasTarget () const
809 return (_type == ALIAS ? _value.alias : 0);
814 * Get a non-const child by index.
817 SGPropertyNode::getChild (int position)
819 if (position >= 0 && position < nChildren())
820 return _children[position];
827 * Get a const child by index.
829 const SGPropertyNode *
830 SGPropertyNode::getChild (int position) const
832 if (position >= 0 && position < nChildren())
833 return _children[position];
840 * Get a non-const child by name and index, creating if necessary.
843 SGPropertyNode::getChild (const char * name, int index, bool create)
845 int pos = find_child(name, index, _children);
847 return _children[pos];
849 SGPropertyNode_ptr node;
850 pos = find_child(name, index, _removedChildren);
852 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
854 node = _removedChildren[pos];
855 _removedChildren.erase(it);
856 node->setAttribute(REMOVED, false);
858 node = new SGPropertyNode(name, index, this);
860 _children.push_back(node);
861 fireChildAdded(node);
870 * Get a const child by name and index.
872 const SGPropertyNode *
873 SGPropertyNode::getChild (const char * name, int index) const
875 int pos = find_child(name, index, _children);
877 return _children[pos];
884 * Get all children with the same name (but different indices).
886 vector<SGPropertyNode_ptr>
887 SGPropertyNode::getChildren (const char * name) const
889 vector<SGPropertyNode_ptr> children;
890 int max = _children.size();
892 for (int i = 0; i < max; i++)
893 if (compare_strings(_children[i]->getName(), name))
894 children.push_back(_children[i]);
896 sort(children.begin(), children.end(), CompareIndices());
902 * Remove child by position.
905 SGPropertyNode::removeChild (int pos, bool keep)
907 SGPropertyNode_ptr node;
908 if (pos < 0 || pos >= _children.size())
911 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
913 node = _children[pos];
916 _removedChildren.push_back(node);
919 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
920 node->setAttribute(REMOVED, true);
922 fireChildRemoved(node);
928 * Remove a child node
931 SGPropertyNode::removeChild (const char * name, int index, bool keep)
933 SGPropertyNode_ptr ret;
934 int pos = find_child(name, index, _children);
936 ret = removeChild(pos, keep);
942 * Remove all children with the specified name.
944 vector<SGPropertyNode_ptr>
945 SGPropertyNode::removeChildren (const char * name, bool keep)
947 vector<SGPropertyNode_ptr> children;
949 for (int pos = _children.size() - 1; pos >= 0; pos--)
950 if (compare_strings(_children[pos]->getName(), name))
951 children.push_back(removeChild(pos, keep));
953 sort(children.begin(), children.end(), CompareIndices());
959 SGPropertyNode::getDisplayName (bool simplify) const
961 _display_name = _name;
962 if (_index != 0 || !simplify) {
964 sstr << '[' << _index << ']';
965 _display_name += sstr.str();
967 return _display_name.c_str();
972 SGPropertyNode::getPath (bool simplify) const
974 // Calculate the complete path only once.
975 if (_parent != 0 && _path.empty()) {
976 _path = _parent->getPath(simplify);
978 _path += getDisplayName(simplify);
981 return _path.c_str();
985 SGPropertyNode::getType () const
988 return _value.alias->getType();
995 SGPropertyNode::getBoolValue () const
997 // Shortcut for common case
998 if (_attr == (READ|WRITE) && _type == BOOL)
1001 if (getAttribute(TRACE_READ))
1003 if (!getAttribute(READ))
1004 return SGRawValue<bool>::DefaultValue;
1007 return _value.alias->getBoolValue();
1011 return get_int() == 0 ? false : true;
1013 return get_long() == 0L ? false : true;
1015 return get_float() == 0.0 ? false : true;
1017 return get_double() == 0.0L ? false : true;
1020 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1023 return SGRawValue<bool>::DefaultValue;
1028 SGPropertyNode::getIntValue () const
1030 // Shortcut for common case
1031 if (_attr == (READ|WRITE) && _type == INT)
1034 if (getAttribute(TRACE_READ))
1036 if (!getAttribute(READ))
1037 return SGRawValue<int>::DefaultValue;
1040 return _value.alias->getIntValue();
1042 return int(get_bool());
1046 return int(get_long());
1048 return int(get_float());
1050 return int(get_double());
1053 return atoi(get_string());
1056 return SGRawValue<int>::DefaultValue;
1061 SGPropertyNode::getLongValue () const
1063 // Shortcut for common case
1064 if (_attr == (READ|WRITE) && _type == LONG)
1067 if (getAttribute(TRACE_READ))
1069 if (!getAttribute(READ))
1070 return SGRawValue<long>::DefaultValue;
1073 return _value.alias->getLongValue();
1075 return long(get_bool());
1077 return long(get_int());
1081 return long(get_float());
1083 return long(get_double());
1086 return strtol(get_string(), 0, 0);
1089 return SGRawValue<long>::DefaultValue;
1094 SGPropertyNode::getFloatValue () const
1096 // Shortcut for common case
1097 if (_attr == (READ|WRITE) && _type == FLOAT)
1100 if (getAttribute(TRACE_READ))
1102 if (!getAttribute(READ))
1103 return SGRawValue<float>::DefaultValue;
1106 return _value.alias->getFloatValue();
1108 return float(get_bool());
1110 return float(get_int());
1112 return float(get_long());
1116 return float(get_double());
1119 return atof(get_string());
1122 return SGRawValue<float>::DefaultValue;
1127 SGPropertyNode::getDoubleValue () const
1129 // Shortcut for common case
1130 if (_attr == (READ|WRITE) && _type == DOUBLE)
1131 return get_double();
1133 if (getAttribute(TRACE_READ))
1135 if (!getAttribute(READ))
1136 return SGRawValue<double>::DefaultValue;
1140 return _value.alias->getDoubleValue();
1142 return double(get_bool());
1144 return double(get_int());
1146 return double(get_long());
1148 return double(get_float());
1150 return get_double();
1153 return strtod(get_string(), 0);
1156 return SGRawValue<double>::DefaultValue;
1161 SGPropertyNode::getStringValue () const
1163 // Shortcut for common case
1164 if (_attr == (READ|WRITE) && _type == STRING)
1165 return get_string();
1167 if (getAttribute(TRACE_READ))
1169 if (!getAttribute(READ))
1170 return SGRawValue<const char *>::DefaultValue;
1171 return make_string();
1175 SGPropertyNode::setBoolValue (bool value)
1177 // Shortcut for common case
1178 if (_attr == (READ|WRITE) && _type == BOOL)
1179 return set_bool(value);
1181 bool result = false;
1183 if (_type == NONE || _type == UNSPECIFIED) {
1191 result = _value.alias->setBoolValue(value);
1194 result = set_bool(value);
1197 result = set_int(int(value));
1200 result = set_long(long(value));
1203 result = set_float(float(value));
1206 result = set_double(double(value));
1210 result = set_string(value ? "true" : "false");
1217 if (getAttribute(TRACE_WRITE))
1223 SGPropertyNode::setIntValue (int value)
1225 // Shortcut for common case
1226 if (_attr == (READ|WRITE) && _type == INT)
1227 return set_int(value);
1229 bool result = false;
1231 if (_type == NONE || _type == UNSPECIFIED) {
1234 _local_val.int_val = 0;
1239 result = _value.alias->setIntValue(value);
1242 result = set_bool(value == 0 ? false : true);
1245 result = set_int(value);
1248 result = set_long(long(value));
1251 result = set_float(float(value));
1254 result = set_double(double(value));
1259 sprintf(buf, "%d", value);
1260 result = set_string(buf);
1268 if (getAttribute(TRACE_WRITE))
1274 SGPropertyNode::setLongValue (long value)
1276 // Shortcut for common case
1277 if (_attr == (READ|WRITE) && _type == LONG)
1278 return set_long(value);
1280 bool result = false;
1282 if (_type == NONE || _type == UNSPECIFIED) {
1285 _local_val.long_val = 0L;
1290 result = _value.alias->setLongValue(value);
1293 result = set_bool(value == 0L ? false : true);
1296 result = set_int(int(value));
1299 result = set_long(value);
1302 result = set_float(float(value));
1305 result = set_double(double(value));
1310 sprintf(buf, "%ld", value);
1311 result = set_string(buf);
1319 if (getAttribute(TRACE_WRITE))
1325 SGPropertyNode::setFloatValue (float value)
1327 // Shortcut for common case
1328 if (_attr == (READ|WRITE) && _type == FLOAT)
1329 return set_float(value);
1331 bool result = false;
1333 if (_type == NONE || _type == UNSPECIFIED) {
1336 _local_val.float_val = 0;
1341 result = _value.alias->setFloatValue(value);
1344 result = set_bool(value == 0.0 ? false : true);
1347 result = set_int(int(value));
1350 result = set_long(long(value));
1353 result = set_float(value);
1356 result = set_double(double(value));
1361 sprintf(buf, "%f", value);
1362 result = set_string(buf);
1370 if (getAttribute(TRACE_WRITE))
1376 SGPropertyNode::setDoubleValue (double value)
1378 // Shortcut for common case
1379 if (_attr == (READ|WRITE) && _type == DOUBLE)
1380 return set_double(value);
1382 bool result = false;
1384 if (_type == NONE || _type == UNSPECIFIED) {
1386 _local_val.double_val = value;
1392 result = _value.alias->setDoubleValue(value);
1395 result = set_bool(value == 0.0L ? false : true);
1398 result = set_int(int(value));
1401 result = set_long(long(value));
1404 result = set_float(float(value));
1407 result = set_double(value);
1412 sprintf(buf, "%f", value);
1413 result = set_string(buf);
1421 if (getAttribute(TRACE_WRITE))
1427 SGPropertyNode::setStringValue (const char * value)
1429 // Shortcut for common case
1430 if (_attr == (READ|WRITE) && _type == STRING)
1431 return set_string(value);
1433 bool result = false;
1435 if (_type == NONE || _type == UNSPECIFIED) {
1442 result = _value.alias->setStringValue(value);
1445 result = set_bool((compare_strings(value, "true")
1446 || atoi(value)) ? true : false);
1449 result = set_int(atoi(value));
1452 result = set_long(strtol(value, 0, 0));
1455 result = set_float(atof(value));
1458 result = set_double(strtod(value, 0));
1462 result = set_string(value);
1469 if (getAttribute(TRACE_WRITE))
1475 SGPropertyNode::setUnspecifiedValue (const char * value)
1477 bool result = false;
1479 if (_type == NONE) {
1481 _type = UNSPECIFIED;
1486 result = _value.alias->setUnspecifiedValue(value);
1489 result = set_bool((compare_strings(value, "true")
1490 || atoi(value)) ? true : false);
1493 result = set_int(atoi(value));
1496 result = set_long(strtol(value, 0, 0));
1499 result = set_float(atof(value));
1502 result = set_double(strtod(value, 0));
1506 result = set_string(value);
1513 if (getAttribute(TRACE_WRITE))
1519 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1521 if (_type == ALIAS || _tied)
1524 useDefault = useDefault && hasValue();
1525 bool old_val = false;
1527 old_val = getBoolValue();
1532 _value.bool_val = rawValue.clone();
1535 setBoolValue(old_val);
1541 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1543 if (_type == ALIAS || _tied)
1546 useDefault = useDefault && hasValue();
1549 old_val = getIntValue();
1554 _value.int_val = rawValue.clone();
1557 setIntValue(old_val);
1563 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1565 if (_type == ALIAS || _tied)
1568 useDefault = useDefault && hasValue();
1571 old_val = getLongValue();
1576 _value.long_val = rawValue.clone();
1579 setLongValue(old_val);
1585 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1587 if (_type == ALIAS || _tied)
1590 useDefault = useDefault && hasValue();
1591 float old_val = 0.0;
1593 old_val = getFloatValue();
1598 _value.float_val = rawValue.clone();
1601 setFloatValue(old_val);
1607 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1609 if (_type == ALIAS || _tied)
1612 useDefault = useDefault && hasValue();
1613 double old_val = 0.0;
1615 old_val = getDoubleValue();
1620 _value.double_val = rawValue.clone();
1623 setDoubleValue(old_val);
1630 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1632 if (_type == ALIAS || _tied)
1635 useDefault = useDefault && hasValue();
1638 old_val = getStringValue();
1643 _value.string_val = rawValue.clone();
1646 setStringValue(old_val.c_str());
1652 SGPropertyNode::untie ()
1659 bool val = getBoolValue();
1662 _local_val.bool_val = val;
1666 int val = getIntValue();
1669 _local_val.int_val = val;
1673 long val = getLongValue();
1676 _local_val.long_val = val;
1680 float val = getFloatValue();
1683 _local_val.float_val = val;
1687 double val = getDoubleValue();
1690 _local_val.double_val = val;
1695 string val = getStringValue();
1698 _local_val.string_val = copy_string(val.c_str());
1711 SGPropertyNode::getRootNode ()
1716 return _parent->getRootNode();
1719 const SGPropertyNode *
1720 SGPropertyNode::getRootNode () const
1725 return _parent->getRootNode();
1729 SGPropertyNode::getNode (const char * relative_path, bool create)
1731 if (_path_cache == 0)
1732 _path_cache = new hash_table;
1734 SGPropertyNode * result = _path_cache->get(relative_path);
1736 vector<PathComponent> components;
1737 parse_path(relative_path, components);
1738 result = find_node(this, components, 0, create);
1740 _path_cache->put(relative_path, result);
1747 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1749 vector<PathComponent> components;
1750 parse_path(relative_path, components);
1751 if (components.size() > 0)
1752 components.back().index = index;
1753 return find_node(this, components, 0, create);
1756 const SGPropertyNode *
1757 SGPropertyNode::getNode (const char * relative_path) const
1759 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1762 const SGPropertyNode *
1763 SGPropertyNode::getNode (const char * relative_path, int index) const
1765 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1769 ////////////////////////////////////////////////////////////////////////
1770 // Convenience methods using relative paths.
1771 ////////////////////////////////////////////////////////////////////////
1775 * Test whether another node has a value attached.
1778 SGPropertyNode::hasValue (const char * relative_path) const
1780 const SGPropertyNode * node = getNode(relative_path);
1781 return (node == 0 ? false : node->hasValue());
1786 * Get the value type for another node.
1788 SGPropertyNode::Type
1789 SGPropertyNode::getType (const char * relative_path) const
1791 const SGPropertyNode * node = getNode(relative_path);
1792 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1797 * Get a bool value for another node.
1800 SGPropertyNode::getBoolValue (const char * relative_path,
1801 bool defaultValue) const
1803 const SGPropertyNode * node = getNode(relative_path);
1804 return (node == 0 ? defaultValue : node->getBoolValue());
1809 * Get an int value for another node.
1812 SGPropertyNode::getIntValue (const char * relative_path,
1813 int defaultValue) const
1815 const SGPropertyNode * node = getNode(relative_path);
1816 return (node == 0 ? defaultValue : node->getIntValue());
1821 * Get a long value for another node.
1824 SGPropertyNode::getLongValue (const char * relative_path,
1825 long defaultValue) const
1827 const SGPropertyNode * node = getNode(relative_path);
1828 return (node == 0 ? defaultValue : node->getLongValue());
1833 * Get a float value for another node.
1836 SGPropertyNode::getFloatValue (const char * relative_path,
1837 float defaultValue) const
1839 const SGPropertyNode * node = getNode(relative_path);
1840 return (node == 0 ? defaultValue : node->getFloatValue());
1845 * Get a double value for another node.
1848 SGPropertyNode::getDoubleValue (const char * relative_path,
1849 double defaultValue) const
1851 const SGPropertyNode * node = getNode(relative_path);
1852 return (node == 0 ? defaultValue : node->getDoubleValue());
1857 * Get a string value for another node.
1860 SGPropertyNode::getStringValue (const char * relative_path,
1861 const char * defaultValue) const
1863 const SGPropertyNode * node = getNode(relative_path);
1864 return (node == 0 ? defaultValue : node->getStringValue());
1869 * Set a bool value for another node.
1872 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1874 return getNode(relative_path, true)->setBoolValue(value);
1879 * Set an int value for another node.
1882 SGPropertyNode::setIntValue (const char * relative_path, int value)
1884 return getNode(relative_path, true)->setIntValue(value);
1889 * Set a long value for another node.
1892 SGPropertyNode::setLongValue (const char * relative_path, long value)
1894 return getNode(relative_path, true)->setLongValue(value);
1899 * Set a float value for another node.
1902 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1904 return getNode(relative_path, true)->setFloatValue(value);
1909 * Set a double value for another node.
1912 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1914 return getNode(relative_path, true)->setDoubleValue(value);
1919 * Set a string value for another node.
1922 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1924 return getNode(relative_path, true)->setStringValue(value);
1929 * Set an unknown value for another node.
1932 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1935 return getNode(relative_path, true)->setUnspecifiedValue(value);
1940 * Test whether another node is tied.
1943 SGPropertyNode::isTied (const char * relative_path) const
1945 const SGPropertyNode * node = getNode(relative_path);
1946 return (node == 0 ? false : node->isTied());
1951 * Tie a node reached by a relative path, creating it if necessary.
1954 SGPropertyNode::tie (const char * relative_path,
1955 const SGRawValue<bool> &rawValue,
1958 return getNode(relative_path, true)->tie(rawValue, useDefault);
1963 * Tie a node reached by a relative path, creating it if necessary.
1966 SGPropertyNode::tie (const char * relative_path,
1967 const SGRawValue<int> &rawValue,
1970 return getNode(relative_path, true)->tie(rawValue, useDefault);
1975 * Tie a node reached by a relative path, creating it if necessary.
1978 SGPropertyNode::tie (const char * relative_path,
1979 const SGRawValue<long> &rawValue,
1982 return getNode(relative_path, true)->tie(rawValue, useDefault);
1987 * Tie a node reached by a relative path, creating it if necessary.
1990 SGPropertyNode::tie (const char * relative_path,
1991 const SGRawValue<float> &rawValue,
1994 return getNode(relative_path, true)->tie(rawValue, useDefault);
1999 * Tie a node reached by a relative path, creating it if necessary.
2002 SGPropertyNode::tie (const char * relative_path,
2003 const SGRawValue<double> &rawValue,
2006 return getNode(relative_path, true)->tie(rawValue, useDefault);
2011 * Tie a node reached by a relative path, creating it if necessary.
2014 SGPropertyNode::tie (const char * relative_path,
2015 const SGRawValue<const char *> &rawValue,
2018 return getNode(relative_path, true)->tie(rawValue, useDefault);
2023 * Attempt to untie another node reached by a relative path.
2026 SGPropertyNode::untie (const char * relative_path)
2028 SGPropertyNode * node = getNode(relative_path);
2029 return (node == 0 ? false : node->untie());
2033 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2036 if (_listeners == 0)
2037 _listeners = new vector<SGPropertyChangeListener*>;
2038 _listeners->push_back(listener);
2039 listener->register_property(this);
2041 listener->valueChanged(this);
2045 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2047 vector<SGPropertyChangeListener*>::iterator it =
2048 find(_listeners->begin(), _listeners->end(), listener);
2049 if (it != _listeners->end()) {
2050 _listeners->erase(it);
2051 listener->unregister_property(this);
2052 if (_listeners->empty()) {
2053 vector<SGPropertyChangeListener*>* tmp = _listeners;
2061 SGPropertyNode::fireValueChanged ()
2063 fireValueChanged(this);
2067 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2069 fireChildAdded(this, child);
2073 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2075 fireChildRemoved(this, child);
2079 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2081 if (_listeners != 0) {
2082 for (unsigned int i = 0; i < _listeners->size(); i++) {
2083 (*_listeners)[i]->valueChanged(node);
2087 _parent->fireValueChanged(node);
2091 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2092 SGPropertyNode * child)
2094 if (_listeners != 0) {
2095 for (unsigned int i = 0; i < _listeners->size(); i++) {
2096 (*_listeners)[i]->childAdded(parent, child);
2100 _parent->fireChildAdded(parent, child);
2104 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2105 SGPropertyNode * child)
2107 if (_listeners != 0) {
2108 for (unsigned int i = 0; i < _listeners->size(); i++) {
2109 (*_listeners)[i]->childRemoved(parent, child);
2113 _parent->fireChildRemoved(parent, child);
2118 ////////////////////////////////////////////////////////////////////////
2119 // Simplified hash table for caching paths.
2120 ////////////////////////////////////////////////////////////////////////
2122 #define HASH_TABLE_SIZE 199
2124 SGPropertyNode::hash_table::entry::entry ()
2129 SGPropertyNode::hash_table::entry::~entry ()
2131 // Don't delete the value; we don't own
2136 SGPropertyNode::hash_table::entry::set_key (const char * key)
2142 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2147 SGPropertyNode::hash_table::bucket::bucket ()
2153 SGPropertyNode::hash_table::bucket::~bucket ()
2155 for (int i = 0; i < _length; i++)
2160 SGPropertyNode::hash_table::entry *
2161 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2164 for (i = 0; i < _length; i++) {
2165 if (!strcmp(_entries[i]->get_key(), key))
2169 entry ** new_entries = new entry*[_length+1];
2170 for (i = 0; i < _length; i++) {
2171 new_entries[i] = _entries[i];
2174 _entries = new_entries;
2175 _entries[_length] = new entry;
2176 _entries[_length]->set_key(key);
2178 return _entries[_length - 1];
2185 SGPropertyNode::hash_table::bucket::erase (const char * key)
2188 for (i = 0; i < _length; i++) {
2189 if (!strcmp(_entries[i]->get_key(), key))
2194 for (++i; i < _length; i++) {
2195 _entries[i-1] = _entries[i];
2202 SGPropertyNode::hash_table::hash_table ()
2208 SGPropertyNode::hash_table::~hash_table ()
2210 for (unsigned int i = 0; i < _data_length; i++)
2216 SGPropertyNode::hash_table::get (const char * key)
2218 if (_data_length == 0)
2220 unsigned int index = hashcode(key) % _data_length;
2221 if (_data[index] == 0)
2223 entry * e = _data[index]->get_entry(key);
2227 return e->get_value();
2231 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2233 if (_data_length == 0) {
2234 _data = new bucket*[HASH_TABLE_SIZE];
2235 _data_length = HASH_TABLE_SIZE;
2236 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2239 unsigned int index = hashcode(key) % _data_length;
2240 if (_data[index] == 0) {
2241 _data[index] = new bucket;
2243 entry * e = _data[index]->get_entry(key, true);
2244 e->set_value(value);
2248 SGPropertyNode::hash_table::erase (const char * key)
2250 if (_data_length == 0)
2252 unsigned int index = hashcode(key) % _data_length;
2253 if (_data[index] == 0)
2255 _data[index]->erase(key);
2259 SGPropertyNode::hash_table::hashcode (const char * key)
2261 unsigned int hash = 0;
2263 hash = 31 * hash + *key;
2271 ////////////////////////////////////////////////////////////////////////
2272 // Implementation of SGPropertyChangeListener.
2273 ////////////////////////////////////////////////////////////////////////
2275 SGPropertyChangeListener::~SGPropertyChangeListener ()
2277 // This will come back and remove
2278 // the current item each time. Is
2280 vector<SGPropertyNode *>::iterator it;
2281 for (it = _properties.begin(); it != _properties.end(); it++)
2282 (*it)->removeChangeListener(this);
2286 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2292 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2293 SGPropertyNode * child)
2299 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2300 SGPropertyNode * child)
2306 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2308 _properties.push_back(node);
2312 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2314 vector<SGPropertyNode *>::iterator it =
2315 find(_properties.begin(), _properties.end(), node);
2316 if (it != _properties.end())
2317 _properties.erase(it);