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, const 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.precision( 10 );
578 sstr << get_double();
579 _buffer = sstr.str();
580 return _buffer.c_str();
592 * Trace a write access for a property.
595 SGPropertyNode::trace_write () const
598 cerr << "TRACE: Write node " << getPath () << ", value\""
599 << make_string() << '"' << endl;
601 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
602 << ", value\"" << make_string() << '"');
607 * Trace a read access for a property.
610 SGPropertyNode::trace_read () const
613 cerr << "TRACE: Write node " << getPath () << ", value \""
614 << make_string() << '"' << endl;
616 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
617 << ", value \"" << make_string() << '"');
622 ////////////////////////////////////////////////////////////////////////
623 // Public methods from SGPropertyNode.
624 ////////////////////////////////////////////////////////////////////////
627 * Last used attribute
628 * Update as needed when enum Attribute is changed
630 const int SGPropertyNode::LAST_USED_ATTRIBUTE = TRACE_WRITE;
633 * Default constructor: always creates a root node.
635 SGPropertyNode::SGPropertyNode ()
644 _local_val.string_val = 0;
651 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
652 : _index(node._index),
654 _parent(0), // don't copy the parent
659 _listeners(0) // CHECK!!
661 _local_val.string_val = 0;
666 _value.alias = node._value.alias;
672 _value.bool_val = node._value.bool_val->clone();
675 set_bool(node.get_bool());
681 _value.int_val = node._value.int_val->clone();
684 set_int(node.get_int());
690 _value.long_val = node._value.long_val->clone();
693 set_long(node.get_long());
699 _value.float_val = node._value.float_val->clone();
702 set_float(node.get_float());
708 _value.double_val = node._value.double_val->clone();
711 set_double(node.get_double());
718 _value.string_val = node._value.string_val->clone();
721 set_string(node.get_string());
729 * Convenience constructor.
731 SGPropertyNode::SGPropertyNode (const char * name,
733 SGPropertyNode * parent)
743 _local_val.string_val = 0;
750 SGPropertyNode::~SGPropertyNode ()
752 // zero out all parent pointers, else they might be dangling
753 for (unsigned i = 0; i < _children.size(); ++i)
754 _children[i]->_parent = 0;
755 for (unsigned i = 0; i < _removedChildren.size(); ++i)
756 _removedChildren[i]->_parent = 0;
764 * Alias to another node.
767 SGPropertyNode::alias (SGPropertyNode * target)
769 if (target == 0 || _type == ALIAS || _tied)
772 _value.alias = target;
779 * Alias to another node by path.
782 SGPropertyNode::alias (const char * path)
784 return alias(getNode(path, true));
792 SGPropertyNode::unalias ()
803 * Get the target of an alias.
806 SGPropertyNode::getAliasTarget ()
808 return (_type == ALIAS ? _value.alias : 0);
812 const SGPropertyNode *
813 SGPropertyNode::getAliasTarget () const
815 return (_type == ALIAS ? _value.alias : 0);
820 * Get a non-const child by index.
823 SGPropertyNode::getChild (int position)
825 if (position >= 0 && position < nChildren())
826 return _children[position];
833 * Get a const child by index.
835 const SGPropertyNode *
836 SGPropertyNode::getChild (int position) const
838 if (position >= 0 && position < nChildren())
839 return _children[position];
846 * Get a non-const child by name and index, creating if necessary.
849 SGPropertyNode::getChild (const char * name, int index, bool create)
851 int pos = find_child(name, index, _children);
853 return _children[pos];
855 SGPropertyNode_ptr node;
856 pos = find_child(name, index, _removedChildren);
858 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
860 node = _removedChildren[pos];
861 _removedChildren.erase(it);
862 node->setAttribute(REMOVED, false);
864 node = new SGPropertyNode(name, index, this);
866 _children.push_back(node);
867 fireChildAdded(node);
876 * Get a const child by name and index.
878 const SGPropertyNode *
879 SGPropertyNode::getChild (const char * name, int index) const
881 int pos = find_child(name, index, _children);
883 return _children[pos];
890 * Get all children with the same name (but different indices).
892 vector<SGPropertyNode_ptr>
893 SGPropertyNode::getChildren (const char * name) const
895 vector<SGPropertyNode_ptr> children;
896 int max = _children.size();
898 for (int i = 0; i < max; i++)
899 if (compare_strings(_children[i]->getName(), name))
900 children.push_back(_children[i]);
902 sort(children.begin(), children.end(), CompareIndices());
908 * Remove child by position.
911 SGPropertyNode::removeChild (int pos, bool keep)
913 SGPropertyNode_ptr node;
914 if (pos < 0 || pos >= (int)_children.size())
917 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
919 node = _children[pos];
922 _removedChildren.push_back(node);
925 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
926 node->setAttribute(REMOVED, true);
928 fireChildRemoved(node);
934 * Remove a child node
937 SGPropertyNode::removeChild (const char * name, int index, bool keep)
939 SGPropertyNode_ptr ret;
940 int pos = find_child(name, index, _children);
942 ret = removeChild(pos, keep);
948 * Remove all children with the specified name.
950 vector<SGPropertyNode_ptr>
951 SGPropertyNode::removeChildren (const char * name, bool keep)
953 vector<SGPropertyNode_ptr> children;
955 for (int pos = _children.size() - 1; pos >= 0; pos--)
956 if (compare_strings(_children[pos]->getName(), name))
957 children.push_back(removeChild(pos, keep));
959 sort(children.begin(), children.end(), CompareIndices());
965 SGPropertyNode::getDisplayName (bool simplify) const
967 _display_name = _name;
968 if (_index != 0 || !simplify) {
970 sstr << '[' << _index << ']';
971 _display_name += sstr.str();
973 return _display_name.c_str();
978 SGPropertyNode::getPath (bool simplify) const
980 // Calculate the complete path only once.
981 if (_parent != 0 && _path.empty()) {
982 _path = _parent->getPath(simplify);
984 _path += getDisplayName(simplify);
987 return _path.c_str();
991 SGPropertyNode::getType () const
994 return _value.alias->getType();
1001 SGPropertyNode::getBoolValue () const
1003 // Shortcut for common case
1004 if (_attr == (READ|WRITE) && _type == BOOL)
1007 if (getAttribute(TRACE_READ))
1009 if (!getAttribute(READ))
1010 return SGRawValue<bool>::DefaultValue;
1013 return _value.alias->getBoolValue();
1017 return get_int() == 0 ? false : true;
1019 return get_long() == 0L ? false : true;
1021 return get_float() == 0.0 ? false : true;
1023 return get_double() == 0.0L ? false : true;
1026 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1029 return SGRawValue<bool>::DefaultValue;
1034 SGPropertyNode::getIntValue () const
1036 // Shortcut for common case
1037 if (_attr == (READ|WRITE) && _type == INT)
1040 if (getAttribute(TRACE_READ))
1042 if (!getAttribute(READ))
1043 return SGRawValue<int>::DefaultValue;
1046 return _value.alias->getIntValue();
1048 return int(get_bool());
1052 return int(get_long());
1054 return int(get_float());
1056 return int(get_double());
1059 return atoi(get_string());
1062 return SGRawValue<int>::DefaultValue;
1067 SGPropertyNode::getLongValue () const
1069 // Shortcut for common case
1070 if (_attr == (READ|WRITE) && _type == LONG)
1073 if (getAttribute(TRACE_READ))
1075 if (!getAttribute(READ))
1076 return SGRawValue<long>::DefaultValue;
1079 return _value.alias->getLongValue();
1081 return long(get_bool());
1083 return long(get_int());
1087 return long(get_float());
1089 return long(get_double());
1092 return strtol(get_string(), 0, 0);
1095 return SGRawValue<long>::DefaultValue;
1100 SGPropertyNode::getFloatValue () const
1102 // Shortcut for common case
1103 if (_attr == (READ|WRITE) && _type == FLOAT)
1106 if (getAttribute(TRACE_READ))
1108 if (!getAttribute(READ))
1109 return SGRawValue<float>::DefaultValue;
1112 return _value.alias->getFloatValue();
1114 return float(get_bool());
1116 return float(get_int());
1118 return float(get_long());
1122 return float(get_double());
1125 return atof(get_string());
1128 return SGRawValue<float>::DefaultValue;
1133 SGPropertyNode::getDoubleValue () const
1135 // Shortcut for common case
1136 if (_attr == (READ|WRITE) && _type == DOUBLE)
1137 return get_double();
1139 if (getAttribute(TRACE_READ))
1141 if (!getAttribute(READ))
1142 return SGRawValue<double>::DefaultValue;
1146 return _value.alias->getDoubleValue();
1148 return double(get_bool());
1150 return double(get_int());
1152 return double(get_long());
1154 return double(get_float());
1156 return get_double();
1159 return strtod(get_string(), 0);
1162 return SGRawValue<double>::DefaultValue;
1167 SGPropertyNode::getStringValue () const
1169 // Shortcut for common case
1170 if (_attr == (READ|WRITE) && _type == STRING)
1171 return get_string();
1173 if (getAttribute(TRACE_READ))
1175 if (!getAttribute(READ))
1176 return SGRawValue<const char *>::DefaultValue;
1177 return make_string();
1181 SGPropertyNode::setBoolValue (bool value)
1183 // Shortcut for common case
1184 if (_attr == (READ|WRITE) && _type == BOOL)
1185 return set_bool(value);
1187 bool result = false;
1189 if (_type == NONE || _type == UNSPECIFIED) {
1197 result = _value.alias->setBoolValue(value);
1200 result = set_bool(value);
1203 result = set_int(int(value));
1206 result = set_long(long(value));
1209 result = set_float(float(value));
1212 result = set_double(double(value));
1216 result = set_string(value ? "true" : "false");
1223 if (getAttribute(TRACE_WRITE))
1229 SGPropertyNode::setIntValue (int value)
1231 // Shortcut for common case
1232 if (_attr == (READ|WRITE) && _type == INT)
1233 return set_int(value);
1235 bool result = false;
1237 if (_type == NONE || _type == UNSPECIFIED) {
1240 _local_val.int_val = 0;
1245 result = _value.alias->setIntValue(value);
1248 result = set_bool(value == 0 ? false : true);
1251 result = set_int(value);
1254 result = set_long(long(value));
1257 result = set_float(float(value));
1260 result = set_double(double(value));
1265 sprintf(buf, "%d", value);
1266 result = set_string(buf);
1274 if (getAttribute(TRACE_WRITE))
1280 SGPropertyNode::setLongValue (long value)
1282 // Shortcut for common case
1283 if (_attr == (READ|WRITE) && _type == LONG)
1284 return set_long(value);
1286 bool result = false;
1288 if (_type == NONE || _type == UNSPECIFIED) {
1291 _local_val.long_val = 0L;
1296 result = _value.alias->setLongValue(value);
1299 result = set_bool(value == 0L ? false : true);
1302 result = set_int(int(value));
1305 result = set_long(value);
1308 result = set_float(float(value));
1311 result = set_double(double(value));
1316 sprintf(buf, "%ld", value);
1317 result = set_string(buf);
1325 if (getAttribute(TRACE_WRITE))
1331 SGPropertyNode::setFloatValue (float value)
1333 // Shortcut for common case
1334 if (_attr == (READ|WRITE) && _type == FLOAT)
1335 return set_float(value);
1337 bool result = false;
1339 if (_type == NONE || _type == UNSPECIFIED) {
1342 _local_val.float_val = 0;
1347 result = _value.alias->setFloatValue(value);
1350 result = set_bool(value == 0.0 ? false : true);
1353 result = set_int(int(value));
1356 result = set_long(long(value));
1359 result = set_float(value);
1362 result = set_double(double(value));
1367 sprintf(buf, "%f", value);
1368 result = set_string(buf);
1376 if (getAttribute(TRACE_WRITE))
1382 SGPropertyNode::setDoubleValue (double value)
1384 // Shortcut for common case
1385 if (_attr == (READ|WRITE) && _type == DOUBLE)
1386 return set_double(value);
1388 bool result = false;
1390 if (_type == NONE || _type == UNSPECIFIED) {
1392 _local_val.double_val = value;
1398 result = _value.alias->setDoubleValue(value);
1401 result = set_bool(value == 0.0L ? false : true);
1404 result = set_int(int(value));
1407 result = set_long(long(value));
1410 result = set_float(float(value));
1413 result = set_double(value);
1418 sprintf(buf, "%f", value);
1419 result = set_string(buf);
1427 if (getAttribute(TRACE_WRITE))
1433 SGPropertyNode::setStringValue (const char * value)
1435 // Shortcut for common case
1436 if (_attr == (READ|WRITE) && _type == STRING)
1437 return set_string(value);
1439 bool result = false;
1441 if (_type == NONE || _type == UNSPECIFIED) {
1448 result = _value.alias->setStringValue(value);
1451 result = set_bool((compare_strings(value, "true")
1452 || atoi(value)) ? true : false);
1455 result = set_int(atoi(value));
1458 result = set_long(strtol(value, 0, 0));
1461 result = set_float(atof(value));
1464 result = set_double(strtod(value, 0));
1468 result = set_string(value);
1475 if (getAttribute(TRACE_WRITE))
1481 SGPropertyNode::setUnspecifiedValue (const char * value)
1483 bool result = false;
1485 if (_type == NONE) {
1487 _type = UNSPECIFIED;
1492 result = _value.alias->setUnspecifiedValue(value);
1495 result = set_bool((compare_strings(value, "true")
1496 || atoi(value)) ? true : false);
1499 result = set_int(atoi(value));
1502 result = set_long(strtol(value, 0, 0));
1505 result = set_float(atof(value));
1508 result = set_double(strtod(value, 0));
1512 result = set_string(value);
1519 if (getAttribute(TRACE_WRITE))
1525 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1527 if (_type == ALIAS || _tied)
1530 useDefault = useDefault && hasValue();
1531 bool old_val = false;
1533 old_val = getBoolValue();
1538 _value.bool_val = rawValue.clone();
1541 setBoolValue(old_val);
1547 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1549 if (_type == ALIAS || _tied)
1552 useDefault = useDefault && hasValue();
1555 old_val = getIntValue();
1560 _value.int_val = rawValue.clone();
1563 setIntValue(old_val);
1569 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1571 if (_type == ALIAS || _tied)
1574 useDefault = useDefault && hasValue();
1577 old_val = getLongValue();
1582 _value.long_val = rawValue.clone();
1585 setLongValue(old_val);
1591 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1593 if (_type == ALIAS || _tied)
1596 useDefault = useDefault && hasValue();
1597 float old_val = 0.0;
1599 old_val = getFloatValue();
1604 _value.float_val = rawValue.clone();
1607 setFloatValue(old_val);
1613 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1615 if (_type == ALIAS || _tied)
1618 useDefault = useDefault && hasValue();
1619 double old_val = 0.0;
1621 old_val = getDoubleValue();
1626 _value.double_val = rawValue.clone();
1629 setDoubleValue(old_val);
1636 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1638 if (_type == ALIAS || _tied)
1641 useDefault = useDefault && hasValue();
1644 old_val = getStringValue();
1649 _value.string_val = rawValue.clone();
1652 setStringValue(old_val.c_str());
1658 SGPropertyNode::untie ()
1665 bool val = getBoolValue();
1668 _local_val.bool_val = val;
1672 int val = getIntValue();
1675 _local_val.int_val = val;
1679 long val = getLongValue();
1682 _local_val.long_val = val;
1686 float val = getFloatValue();
1689 _local_val.float_val = val;
1693 double val = getDoubleValue();
1696 _local_val.double_val = val;
1701 string val = getStringValue();
1704 _local_val.string_val = copy_string(val.c_str());
1717 SGPropertyNode::getRootNode ()
1722 return _parent->getRootNode();
1725 const SGPropertyNode *
1726 SGPropertyNode::getRootNode () const
1731 return _parent->getRootNode();
1735 SGPropertyNode::getNode (const char * relative_path, bool create)
1737 if (_path_cache == 0)
1738 _path_cache = new hash_table;
1740 SGPropertyNode * result = _path_cache->get(relative_path);
1742 vector<PathComponent> components;
1743 parse_path(relative_path, components);
1744 result = find_node(this, components, 0, create);
1746 _path_cache->put(relative_path, result);
1753 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1755 vector<PathComponent> components;
1756 parse_path(relative_path, components);
1757 if (components.size() > 0)
1758 components.back().index = index;
1759 return find_node(this, components, 0, create);
1762 const SGPropertyNode *
1763 SGPropertyNode::getNode (const char * relative_path) const
1765 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1768 const SGPropertyNode *
1769 SGPropertyNode::getNode (const char * relative_path, int index) const
1771 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1775 ////////////////////////////////////////////////////////////////////////
1776 // Convenience methods using relative paths.
1777 ////////////////////////////////////////////////////////////////////////
1781 * Test whether another node has a value attached.
1784 SGPropertyNode::hasValue (const char * relative_path) const
1786 const SGPropertyNode * node = getNode(relative_path);
1787 return (node == 0 ? false : node->hasValue());
1792 * Get the value type for another node.
1794 SGPropertyNode::Type
1795 SGPropertyNode::getType (const char * relative_path) const
1797 const SGPropertyNode * node = getNode(relative_path);
1798 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1803 * Get a bool value for another node.
1806 SGPropertyNode::getBoolValue (const char * relative_path,
1807 bool defaultValue) const
1809 const SGPropertyNode * node = getNode(relative_path);
1810 return (node == 0 ? defaultValue : node->getBoolValue());
1815 * Get an int value for another node.
1818 SGPropertyNode::getIntValue (const char * relative_path,
1819 int defaultValue) const
1821 const SGPropertyNode * node = getNode(relative_path);
1822 return (node == 0 ? defaultValue : node->getIntValue());
1827 * Get a long value for another node.
1830 SGPropertyNode::getLongValue (const char * relative_path,
1831 long defaultValue) const
1833 const SGPropertyNode * node = getNode(relative_path);
1834 return (node == 0 ? defaultValue : node->getLongValue());
1839 * Get a float value for another node.
1842 SGPropertyNode::getFloatValue (const char * relative_path,
1843 float defaultValue) const
1845 const SGPropertyNode * node = getNode(relative_path);
1846 return (node == 0 ? defaultValue : node->getFloatValue());
1851 * Get a double value for another node.
1854 SGPropertyNode::getDoubleValue (const char * relative_path,
1855 double defaultValue) const
1857 const SGPropertyNode * node = getNode(relative_path);
1858 return (node == 0 ? defaultValue : node->getDoubleValue());
1863 * Get a string value for another node.
1866 SGPropertyNode::getStringValue (const char * relative_path,
1867 const char * defaultValue) const
1869 const SGPropertyNode * node = getNode(relative_path);
1870 return (node == 0 ? defaultValue : node->getStringValue());
1875 * Set a bool value for another node.
1878 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1880 return getNode(relative_path, true)->setBoolValue(value);
1885 * Set an int value for another node.
1888 SGPropertyNode::setIntValue (const char * relative_path, int value)
1890 return getNode(relative_path, true)->setIntValue(value);
1895 * Set a long value for another node.
1898 SGPropertyNode::setLongValue (const char * relative_path, long value)
1900 return getNode(relative_path, true)->setLongValue(value);
1905 * Set a float value for another node.
1908 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1910 return getNode(relative_path, true)->setFloatValue(value);
1915 * Set a double value for another node.
1918 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1920 return getNode(relative_path, true)->setDoubleValue(value);
1925 * Set a string value for another node.
1928 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1930 return getNode(relative_path, true)->setStringValue(value);
1935 * Set an unknown value for another node.
1938 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1941 return getNode(relative_path, true)->setUnspecifiedValue(value);
1946 * Test whether another node is tied.
1949 SGPropertyNode::isTied (const char * relative_path) const
1951 const SGPropertyNode * node = getNode(relative_path);
1952 return (node == 0 ? false : node->isTied());
1957 * Tie a node reached by a relative path, creating it if necessary.
1960 SGPropertyNode::tie (const char * relative_path,
1961 const SGRawValue<bool> &rawValue,
1964 return getNode(relative_path, true)->tie(rawValue, useDefault);
1969 * Tie a node reached by a relative path, creating it if necessary.
1972 SGPropertyNode::tie (const char * relative_path,
1973 const SGRawValue<int> &rawValue,
1976 return getNode(relative_path, true)->tie(rawValue, useDefault);
1981 * Tie a node reached by a relative path, creating it if necessary.
1984 SGPropertyNode::tie (const char * relative_path,
1985 const SGRawValue<long> &rawValue,
1988 return getNode(relative_path, true)->tie(rawValue, useDefault);
1993 * Tie a node reached by a relative path, creating it if necessary.
1996 SGPropertyNode::tie (const char * relative_path,
1997 const SGRawValue<float> &rawValue,
2000 return getNode(relative_path, true)->tie(rawValue, useDefault);
2005 * Tie a node reached by a relative path, creating it if necessary.
2008 SGPropertyNode::tie (const char * relative_path,
2009 const SGRawValue<double> &rawValue,
2012 return getNode(relative_path, true)->tie(rawValue, useDefault);
2017 * Tie a node reached by a relative path, creating it if necessary.
2020 SGPropertyNode::tie (const char * relative_path,
2021 const SGRawValue<const char *> &rawValue,
2024 return getNode(relative_path, true)->tie(rawValue, useDefault);
2029 * Attempt to untie another node reached by a relative path.
2032 SGPropertyNode::untie (const char * relative_path)
2034 SGPropertyNode * node = getNode(relative_path);
2035 return (node == 0 ? false : node->untie());
2039 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2042 if (_listeners == 0)
2043 _listeners = new vector<SGPropertyChangeListener*>;
2044 _listeners->push_back(listener);
2045 listener->register_property(this);
2047 listener->valueChanged(this);
2051 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2053 vector<SGPropertyChangeListener*>::iterator it =
2054 find(_listeners->begin(), _listeners->end(), listener);
2055 if (it != _listeners->end()) {
2056 _listeners->erase(it);
2057 listener->unregister_property(this);
2058 if (_listeners->empty()) {
2059 vector<SGPropertyChangeListener*>* tmp = _listeners;
2067 SGPropertyNode::fireValueChanged ()
2069 fireValueChanged(this);
2073 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2075 fireChildAdded(this, child);
2079 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2081 fireChildRemoved(this, child);
2085 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2087 if (_listeners != 0) {
2088 for (unsigned int i = 0; i < _listeners->size(); i++) {
2089 (*_listeners)[i]->valueChanged(node);
2093 _parent->fireValueChanged(node);
2097 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2098 SGPropertyNode * child)
2100 if (_listeners != 0) {
2101 for (unsigned int i = 0; i < _listeners->size(); i++) {
2102 (*_listeners)[i]->childAdded(parent, child);
2106 _parent->fireChildAdded(parent, child);
2110 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2111 SGPropertyNode * child)
2113 if (_listeners != 0) {
2114 for (unsigned int i = 0; i < _listeners->size(); i++) {
2115 (*_listeners)[i]->childRemoved(parent, child);
2119 _parent->fireChildRemoved(parent, child);
2124 ////////////////////////////////////////////////////////////////////////
2125 // Simplified hash table for caching paths.
2126 ////////////////////////////////////////////////////////////////////////
2128 #define HASH_TABLE_SIZE 199
2130 SGPropertyNode::hash_table::entry::entry ()
2135 SGPropertyNode::hash_table::entry::~entry ()
2137 // Don't delete the value; we don't own
2142 SGPropertyNode::hash_table::entry::set_key (const char * key)
2148 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2153 SGPropertyNode::hash_table::bucket::bucket ()
2159 SGPropertyNode::hash_table::bucket::~bucket ()
2161 for (int i = 0; i < _length; i++)
2166 SGPropertyNode::hash_table::entry *
2167 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2170 for (i = 0; i < _length; i++) {
2171 if (!strcmp(_entries[i]->get_key(), key))
2175 entry ** new_entries = new entry*[_length+1];
2176 for (i = 0; i < _length; i++) {
2177 new_entries[i] = _entries[i];
2180 _entries = new_entries;
2181 _entries[_length] = new entry;
2182 _entries[_length]->set_key(key);
2184 return _entries[_length - 1];
2191 SGPropertyNode::hash_table::bucket::erase (const char * key)
2194 for (i = 0; i < _length; i++) {
2195 if (!strcmp(_entries[i]->get_key(), key))
2200 for (++i; i < _length; i++) {
2201 _entries[i-1] = _entries[i];
2208 SGPropertyNode::hash_table::hash_table ()
2214 SGPropertyNode::hash_table::~hash_table ()
2216 for (unsigned int i = 0; i < _data_length; i++)
2222 SGPropertyNode::hash_table::get (const char * key)
2224 if (_data_length == 0)
2226 unsigned int index = hashcode(key) % _data_length;
2227 if (_data[index] == 0)
2229 entry * e = _data[index]->get_entry(key);
2233 return e->get_value();
2237 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2239 if (_data_length == 0) {
2240 _data = new bucket*[HASH_TABLE_SIZE];
2241 _data_length = HASH_TABLE_SIZE;
2242 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2245 unsigned int index = hashcode(key) % _data_length;
2246 if (_data[index] == 0) {
2247 _data[index] = new bucket;
2249 entry * e = _data[index]->get_entry(key, true);
2250 e->set_value(value);
2254 SGPropertyNode::hash_table::erase (const char * key)
2256 if (_data_length == 0)
2258 unsigned int index = hashcode(key) % _data_length;
2259 if (_data[index] == 0)
2261 _data[index]->erase(key);
2265 SGPropertyNode::hash_table::hashcode (const char * key)
2267 unsigned int hash = 0;
2269 hash = 31 * hash + *key;
2277 ////////////////////////////////////////////////////////////////////////
2278 // Implementation of SGPropertyChangeListener.
2279 ////////////////////////////////////////////////////////////////////////
2281 SGPropertyChangeListener::~SGPropertyChangeListener ()
2283 // This will come back and remove
2284 // the current item each time. Is
2286 vector<SGPropertyNode *>::iterator it;
2287 for (it = _properties.begin(); it != _properties.end(); it++)
2288 (*it)->removeChangeListener(this);
2292 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2298 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2299 SGPropertyNode * child)
2305 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2306 SGPropertyNode * child)
2312 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2314 _properties.push_back(node);
2318 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2320 vector<SGPropertyNode *>::iterator it =
2321 find(_properties.begin(), _properties.end(), node);
2322 if (it != _properties.end())
2323 _properties.erase(it);