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].
26 #include <simgear/compiler.h>
27 #include <simgear/debug/logstream.hxx>
33 #if ( _MSC_VER == 1200 )
34 // MSVC 6 is buggy, and needs something strange here
35 SG_USING_STD(vector<SGPropertyNode_ptr>);
36 SG_USING_STD(vector<SGPropertyChangeListener *>);
37 SG_USING_STD(vector<SGPropertyNode *>);
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 // FIXME: potential buffer overflow.
233 // For some reason, strnlen and
234 // strncpy cause all kinds of crashes.
235 char * copy = new char[strlen(s) + 1];
241 compare_strings (const char * s1, const char * s2)
243 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
247 * Locate a child node by name and index.
250 find_child (const char * name, int index, vector<SGPropertyNode_ptr> nodes)
252 int nNodes = nodes.size();
253 for (int i = 0; i < nNodes; i++) {
254 SGPropertyNode * node = nodes[i];
255 if (compare_strings(node->getName(), name) && node->getIndex() == index)
263 * Locate another node, given a relative path.
265 static SGPropertyNode *
266 find_node (SGPropertyNode * current,
267 const vector<PathComponent> &components,
271 // Run off the end of the list
276 // Success! This is the one we want.
277 else if (position >= (int)components.size()) {
278 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
281 // Empty component means root.
282 else if (components[position].name == "") {
283 return find_node(current->getRootNode(), components, position + 1, create);
286 // . means current directory
287 else if (components[position].name == ".") {
288 return find_node(current, components, position + 1, create);
291 // .. means parent directory
292 else if (components[position].name == "..") {
293 SGPropertyNode * parent = current->getParent();
295 throw string("Attempt to move past root with '..'");
297 return find_node(parent, components, position + 1, create);
300 // Otherwise, a child name
302 SGPropertyNode * child =
303 current->getChild(components[position].name.c_str(),
304 components[position].index,
306 return find_node(child, components, position + 1, create);
312 ////////////////////////////////////////////////////////////////////////
313 // Private methods from SGPropertyNode (may be inlined for speed).
314 ////////////////////////////////////////////////////////////////////////
317 SGPropertyNode::get_bool () const
320 return _value.bool_val->getValue();
322 return _local_val.bool_val;
326 SGPropertyNode::get_int () const
329 return _value.int_val->getValue();
331 return _local_val.int_val;
335 SGPropertyNode::get_long () const
338 return _value.long_val->getValue();
340 return _local_val.long_val;
344 SGPropertyNode::get_float () const
347 return _value.float_val->getValue();
349 return _local_val.float_val;
353 SGPropertyNode::get_double () const
356 return _value.double_val->getValue();
358 return _local_val.double_val;
362 SGPropertyNode::get_string () const
365 return _value.string_val->getValue();
367 return _local_val.string_val;
371 SGPropertyNode::set_bool (bool val)
374 if (_value.bool_val->setValue(val)) {
381 _local_val.bool_val = val;
388 SGPropertyNode::set_int (int val)
391 if (_value.int_val->setValue(val)) {
398 _local_val.int_val = val;
405 SGPropertyNode::set_long (long val)
408 if (_value.long_val->setValue(val)) {
415 _local_val.long_val = val;
422 SGPropertyNode::set_float (float val)
425 if (_value.float_val->setValue(val)) {
432 _local_val.float_val = val;
439 SGPropertyNode::set_double (double val)
442 if (_value.double_val->setValue(val)) {
449 _local_val.double_val = val;
456 SGPropertyNode::set_string (const char * val)
459 if (_value.string_val->setValue(val)) {
466 delete [] _local_val.string_val;
467 _local_val.string_val = copy_string(val);
474 SGPropertyNode::clearValue ()
484 delete _value.bool_val;
487 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
491 delete _value.int_val;
494 _local_val.int_val = SGRawValue<int>::DefaultValue;
498 delete _value.long_val;
499 _value.long_val = 0L;
501 _local_val.long_val = SGRawValue<long>::DefaultValue;
505 delete _value.float_val;
506 _value.float_val = 0;
508 _local_val.float_val = SGRawValue<float>::DefaultValue;
512 delete _value.double_val;
513 _value.double_val = 0;
515 _local_val.double_val = SGRawValue<double>::DefaultValue;
520 delete _value.string_val;
521 _value.string_val = 0;
523 delete [] _local_val.string_val;
525 _local_val.string_val = 0;
534 * Get the value as a string.
537 SGPropertyNode::make_string () const
539 if (!getAttribute(READ))
544 return _value.alias->getStringValue();
551 sprintf(_buffer, "%d", get_int());
554 sprintf(_buffer, "%ld", get_long());
557 sprintf(_buffer, "%f", get_float());
560 sprintf(_buffer, "%f", get_double());
572 * Trace a write access for a property.
575 SGPropertyNode::trace_write () const
578 cerr << "TRACE: Write node " << getPath () << ", value\""
579 << make_string() << '"' << endl;
581 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
582 << ", value\"" << make_string() << '"');
587 * Trace a read access for a property.
590 SGPropertyNode::trace_read () const
593 cerr << "TRACE: Write node " << getPath () << ", value \""
594 << make_string() << '"' << endl;
596 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
597 << ", value \"" << make_string() << '"');
602 * Increment reference counter
605 SGPropertyNode::incrementRef()
611 * Decrement reference counter
614 SGPropertyNode::decrementRef()
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 ()
635 : _name(copy_string("")),
647 _local_val.string_val = 0;
654 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
657 _parent(0), // don't copy the parent
664 _listeners(0) // CHECK!!
666 _name = copy_string(node._name);
667 _local_val.string_val = 0;
672 _value.alias = node._value.alias;
678 _value.bool_val = node._value.bool_val->clone();
681 set_bool(node.get_bool());
687 _value.int_val = node._value.int_val->clone();
690 set_int(node.get_int());
696 _value.long_val = node._value.long_val->clone();
699 set_long(node.get_long());
705 _value.float_val = node._value.float_val->clone();
708 set_float(node.get_float());
714 _value.double_val = node._value.double_val->clone();
717 set_double(node.get_double());
724 _value.string_val = node._value.string_val->clone();
727 set_string(node.get_string());
735 * Convenience constructor.
737 SGPropertyNode::SGPropertyNode (const char * name,
739 SGPropertyNode * parent)
751 _name = copy_string(name);
752 _local_val.string_val = 0;
759 SGPropertyNode::~SGPropertyNode ()
762 delete [] _display_name;
771 * Alias to another node.
774 SGPropertyNode::alias (SGPropertyNode * target)
776 if (target == 0 || _type == ALIAS || _tied)
779 _value.alias = target;
781 _value.alias->incrementRef();
787 * Alias to another node by path.
790 SGPropertyNode::alias (const char * path)
792 return alias(getNode(path, true));
800 SGPropertyNode::unalias ()
805 _value.alias->decrementRef();
812 * Get the target of an alias.
815 SGPropertyNode::getAliasTarget ()
817 return (_type == ALIAS ? _value.alias : 0);
821 const SGPropertyNode *
822 SGPropertyNode::getAliasTarget () const
824 return (_type == ALIAS ? _value.alias : 0);
829 * Get a non-const child by index.
832 SGPropertyNode::getChild (int position)
834 if (position >= 0 && position < nChildren())
835 return _children[position];
842 * Get a const child by index.
844 const SGPropertyNode *
845 SGPropertyNode::getChild (int position) const
847 if (position >= 0 && position < nChildren())
848 return _children[position];
855 * Get a non-const child by name and index, creating if necessary.
858 SGPropertyNode::getChild (const char * name, int index, bool create)
860 int pos = find_child(name, index, _children);
862 return _children[pos];
864 SGPropertyNode_ptr node;
865 pos = find_child(name, index, _removedChildren);
867 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
869 node = _removedChildren[pos];
870 _removedChildren.erase(it);
871 node->setAttribute(REMOVED, false);
873 node = new SGPropertyNode(name, index, this);
875 _children.push_back(node);
876 fireChildAdded(node);
885 * Get a const child by name and index.
887 const SGPropertyNode *
888 SGPropertyNode::getChild (const char * name, int index) const
890 int pos = find_child(name, index, _children);
892 return _children[pos];
899 * Get all children with the same name (but different indices).
901 vector<SGPropertyNode_ptr>
902 SGPropertyNode::getChildren (const char * name) const
904 vector<SGPropertyNode_ptr> children;
905 int max = _children.size();
907 for (int i = 0; i < max; i++)
908 if (compare_strings(_children[i]->getName(), name))
909 children.push_back(_children[i]);
911 sort(children.begin(), children.end(), CompareIndices());
917 * Remove a child node, and all children that aren't referenced.
918 * "keep" does only apply to the outmost item. Returns "true" if
919 * not all nodes could be removed.
922 SGPropertyNode::removeChild (const char * name, int index, bool keep)
925 int pos = find_child(name, index, _children);
927 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
929 SGPropertyNode *node = _children[pos];
930 if (node->nChildren() && node->removeChildren())
933 if (node->_count == 1 && !node->nChildren()) {
935 _removedChildren.push_back(node);
938 _path_cache->erase(name); // EMH - TODO: Take "index" into account!
940 node->setAttribute(REMOVED, true);
942 fireChildRemoved(node);
950 * Remove all children nodes, or all with a given name. Returns
951 * "true" if not all nodes could be removed.
954 SGPropertyNode::removeChildren(const char *name)
957 vector<SGPropertyNode_ptr>::iterator it = _children.end();
958 vector<SGPropertyNode_ptr>::iterator begin = _children.begin();
959 while (it-- != begin) {
960 SGPropertyNode *node = *it;
961 if (name && !compare_strings(node->getName(), name))
964 if (node->nChildren() && node->removeChildren())
967 if (node->isTied() || node->_count != 1 || node->nChildren())
971 _path_cache->erase(node->getName());
973 node->setAttribute(REMOVED, true);
975 fireChildRemoved(node);
984 SGPropertyNode::getDisplayName (bool simplify) const
986 string display = _name;
987 if (_index != 0 || !simplify) {
989 sprintf(buffer, "[%d]", _index);
992 _display_name = copy_string(display.c_str());
993 return _display_name;
998 SGPropertyNode::getPath (bool simplify) const
1000 // Calculate the complete path only once.
1006 path = _parent->getPath(simplify);
1008 path += getDisplayName(simplify);
1010 _path = copy_string(path.c_str());
1016 SGPropertyNode::Type
1017 SGPropertyNode::getType () const
1020 return _value.alias->getType();
1027 SGPropertyNode::getBoolValue () const
1029 // Shortcut for common case
1030 if (_attr == (READ|WRITE) && _type == BOOL)
1033 if (getAttribute(TRACE_READ))
1035 if (!getAttribute(READ))
1036 return SGRawValue<bool>::DefaultValue;
1039 return _value.alias->getBoolValue();
1043 return get_int() == 0 ? false : true;
1045 return get_long() == 0L ? false : true;
1047 return get_float() == 0.0 ? false : true;
1049 return get_double() == 0.0L ? false : true;
1052 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1055 return SGRawValue<bool>::DefaultValue;
1060 SGPropertyNode::getIntValue () const
1062 // Shortcut for common case
1063 if (_attr == (READ|WRITE) && _type == INT)
1066 if (getAttribute(TRACE_READ))
1068 if (!getAttribute(READ))
1069 return SGRawValue<int>::DefaultValue;
1072 return _value.alias->getIntValue();
1074 return int(get_bool());
1078 return int(get_long());
1080 return int(get_float());
1082 return int(get_double());
1085 return atoi(get_string());
1088 return SGRawValue<int>::DefaultValue;
1093 SGPropertyNode::getLongValue () const
1095 // Shortcut for common case
1096 if (_attr == (READ|WRITE) && _type == LONG)
1099 if (getAttribute(TRACE_READ))
1101 if (!getAttribute(READ))
1102 return SGRawValue<long>::DefaultValue;
1105 return _value.alias->getLongValue();
1107 return long(get_bool());
1109 return long(get_int());
1113 return long(get_float());
1115 return long(get_double());
1118 return strtol(get_string(), 0, 0);
1121 return SGRawValue<long>::DefaultValue;
1126 SGPropertyNode::getFloatValue () const
1128 // Shortcut for common case
1129 if (_attr == (READ|WRITE) && _type == FLOAT)
1132 if (getAttribute(TRACE_READ))
1134 if (!getAttribute(READ))
1135 return SGRawValue<float>::DefaultValue;
1138 return _value.alias->getFloatValue();
1140 return float(get_bool());
1142 return float(get_int());
1144 return float(get_long());
1148 return float(get_double());
1151 return atof(get_string());
1154 return SGRawValue<float>::DefaultValue;
1159 SGPropertyNode::getDoubleValue () const
1161 // Shortcut for common case
1162 if (_attr == (READ|WRITE) && _type == DOUBLE)
1163 return get_double();
1165 if (getAttribute(TRACE_READ))
1167 if (!getAttribute(READ))
1168 return SGRawValue<double>::DefaultValue;
1172 return _value.alias->getDoubleValue();
1174 return double(get_bool());
1176 return double(get_int());
1178 return double(get_long());
1180 return double(get_float());
1182 return get_double();
1185 return strtod(get_string(), 0);
1188 return SGRawValue<double>::DefaultValue;
1193 SGPropertyNode::getStringValue () const
1195 // Shortcut for common case
1196 if (_attr == (READ|WRITE) && _type == STRING)
1197 return get_string();
1199 if (getAttribute(TRACE_READ))
1201 if (!getAttribute(READ))
1202 return SGRawValue<const char *>::DefaultValue;
1203 return make_string();
1207 SGPropertyNode::setBoolValue (bool value)
1209 // Shortcut for common case
1210 if (_attr == (READ|WRITE) && _type == BOOL)
1211 return set_bool(value);
1213 bool result = false;
1215 if (_type == NONE || _type == UNSPECIFIED) {
1223 result = _value.alias->setBoolValue(value);
1226 result = set_bool(value);
1229 result = set_int(int(value));
1232 result = set_long(long(value));
1235 result = set_float(float(value));
1238 result = set_double(double(value));
1242 result = set_string(value ? "true" : "false");
1249 if (getAttribute(TRACE_WRITE))
1255 SGPropertyNode::setIntValue (int value)
1257 // Shortcut for common case
1258 if (_attr == (READ|WRITE) && _type == INT)
1259 return set_int(value);
1261 bool result = false;
1263 if (_type == NONE || _type == UNSPECIFIED) {
1266 _local_val.int_val = 0;
1271 result = _value.alias->setIntValue(value);
1274 result = set_bool(value == 0 ? false : true);
1277 result = set_int(value);
1280 result = set_long(long(value));
1283 result = set_float(float(value));
1286 result = set_double(double(value));
1291 sprintf(buf, "%d", value);
1292 result = set_string(buf);
1300 if (getAttribute(TRACE_WRITE))
1306 SGPropertyNode::setLongValue (long value)
1308 // Shortcut for common case
1309 if (_attr == (READ|WRITE) && _type == LONG)
1310 return set_long(value);
1312 bool result = false;
1314 if (_type == NONE || _type == UNSPECIFIED) {
1317 _local_val.long_val = 0L;
1322 result = _value.alias->setLongValue(value);
1325 result = set_bool(value == 0L ? false : true);
1328 result = set_int(int(value));
1331 result = set_long(value);
1334 result = set_float(float(value));
1337 result = set_double(double(value));
1342 sprintf(buf, "%ld", value);
1343 result = set_string(buf);
1351 if (getAttribute(TRACE_WRITE))
1357 SGPropertyNode::setFloatValue (float value)
1359 // Shortcut for common case
1360 if (_attr == (READ|WRITE) && _type == FLOAT)
1361 return set_float(value);
1363 bool result = false;
1365 if (_type == NONE || _type == UNSPECIFIED) {
1368 _local_val.float_val = 0;
1373 result = _value.alias->setFloatValue(value);
1376 result = set_bool(value == 0.0 ? false : true);
1379 result = set_int(int(value));
1382 result = set_long(long(value));
1385 result = set_float(value);
1388 result = set_double(double(value));
1393 sprintf(buf, "%f", value);
1394 result = set_string(buf);
1402 if (getAttribute(TRACE_WRITE))
1408 SGPropertyNode::setDoubleValue (double value)
1410 // Shortcut for common case
1411 if (_attr == (READ|WRITE) && _type == DOUBLE)
1412 return set_double(value);
1414 bool result = false;
1416 if (_type == NONE || _type == UNSPECIFIED) {
1418 _local_val.double_val = value;
1424 result = _value.alias->setDoubleValue(value);
1427 result = set_bool(value == 0.0L ? false : true);
1430 result = set_int(int(value));
1433 result = set_long(long(value));
1436 result = set_float(float(value));
1439 result = set_double(value);
1444 sprintf(buf, "%f", value);
1445 result = set_string(buf);
1453 if (getAttribute(TRACE_WRITE))
1459 SGPropertyNode::setStringValue (const char * value)
1461 // Shortcut for common case
1462 if (_attr == (READ|WRITE) && _type == STRING)
1463 return set_string(value);
1465 bool result = false;
1467 if (_type == NONE || _type == UNSPECIFIED) {
1474 result = _value.alias->setStringValue(value);
1477 result = set_bool((compare_strings(value, "true")
1478 || atoi(value)) ? true : false);
1481 result = set_int(atoi(value));
1484 result = set_long(strtol(value, 0, 0));
1487 result = set_float(atof(value));
1490 result = set_double(strtod(value, 0));
1494 result = set_string(value);
1501 if (getAttribute(TRACE_WRITE))
1507 SGPropertyNode::setUnspecifiedValue (const char * value)
1509 bool result = false;
1511 if (_type == NONE) {
1513 _type = UNSPECIFIED;
1518 result = _value.alias->setUnspecifiedValue(value);
1521 result = set_bool((compare_strings(value, "true")
1522 || atoi(value)) ? true : false);
1525 result = set_int(atoi(value));
1528 result = set_long(strtol(value, 0, 0));
1531 result = set_float(atof(value));
1534 result = set_double(strtod(value, 0));
1538 result = set_string(value);
1545 if (getAttribute(TRACE_WRITE))
1551 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1553 if (_type == ALIAS || _tied)
1556 useDefault = useDefault && hasValue();
1557 bool old_val = false;
1559 old_val = getBoolValue();
1564 _value.bool_val = rawValue.clone();
1567 setBoolValue(old_val);
1573 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1575 if (_type == ALIAS || _tied)
1578 useDefault = useDefault && hasValue();
1581 old_val = getIntValue();
1586 _value.int_val = rawValue.clone();
1589 setIntValue(old_val);
1595 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1597 if (_type == ALIAS || _tied)
1600 useDefault = useDefault && hasValue();
1603 old_val = getLongValue();
1608 _value.long_val = rawValue.clone();
1611 setLongValue(old_val);
1617 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1619 if (_type == ALIAS || _tied)
1622 useDefault = useDefault && hasValue();
1623 float old_val = 0.0;
1625 old_val = getFloatValue();
1630 _value.float_val = rawValue.clone();
1633 setFloatValue(old_val);
1639 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1641 if (_type == ALIAS || _tied)
1644 useDefault = useDefault && hasValue();
1645 double old_val = 0.0;
1647 old_val = getDoubleValue();
1652 _value.double_val = rawValue.clone();
1655 setDoubleValue(old_val);
1662 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1664 if (_type == ALIAS || _tied)
1667 useDefault = useDefault && hasValue();
1670 old_val = getStringValue();
1675 _value.string_val = rawValue.clone();
1678 setStringValue(old_val.c_str());
1684 SGPropertyNode::untie ()
1691 bool val = getBoolValue();
1694 _local_val.bool_val = val;
1698 int val = getIntValue();
1701 _local_val.int_val = val;
1705 long val = getLongValue();
1708 _local_val.long_val = val;
1712 float val = getFloatValue();
1715 _local_val.float_val = val;
1719 double val = getDoubleValue();
1722 _local_val.double_val = val;
1727 string val = getStringValue();
1730 _local_val.string_val = copy_string(val.c_str());
1743 SGPropertyNode::getRootNode ()
1748 return _parent->getRootNode();
1751 const SGPropertyNode *
1752 SGPropertyNode::getRootNode () const
1757 return _parent->getRootNode();
1761 SGPropertyNode::getNode (const char * relative_path, bool create)
1763 if (_path_cache == 0)
1764 _path_cache = new hash_table;
1766 SGPropertyNode * result = _path_cache->get(relative_path);
1768 vector<PathComponent> components;
1769 parse_path(relative_path, components);
1770 result = find_node(this, components, 0, create);
1772 _path_cache->put(relative_path, result);
1779 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1781 vector<PathComponent> components;
1782 parse_path(relative_path, components);
1783 if (components.size() > 0)
1784 components.back().index = index;
1785 return find_node(this, components, 0, create);
1788 const SGPropertyNode *
1789 SGPropertyNode::getNode (const char * relative_path) const
1791 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1794 const SGPropertyNode *
1795 SGPropertyNode::getNode (const char * relative_path, int index) const
1797 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1801 ////////////////////////////////////////////////////////////////////////
1802 // Convenience methods using relative paths.
1803 ////////////////////////////////////////////////////////////////////////
1807 * Test whether another node has a value attached.
1810 SGPropertyNode::hasValue (const char * relative_path) const
1812 const SGPropertyNode * node = getNode(relative_path);
1813 return (node == 0 ? false : node->hasValue());
1818 * Get the value type for another node.
1820 SGPropertyNode::Type
1821 SGPropertyNode::getType (const char * relative_path) const
1823 const SGPropertyNode * node = getNode(relative_path);
1824 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1829 * Get a bool value for another node.
1832 SGPropertyNode::getBoolValue (const char * relative_path,
1833 bool defaultValue) const
1835 const SGPropertyNode * node = getNode(relative_path);
1836 return (node == 0 ? defaultValue : node->getBoolValue());
1841 * Get an int value for another node.
1844 SGPropertyNode::getIntValue (const char * relative_path,
1845 int defaultValue) const
1847 const SGPropertyNode * node = getNode(relative_path);
1848 return (node == 0 ? defaultValue : node->getIntValue());
1853 * Get a long value for another node.
1856 SGPropertyNode::getLongValue (const char * relative_path,
1857 long defaultValue) const
1859 const SGPropertyNode * node = getNode(relative_path);
1860 return (node == 0 ? defaultValue : node->getLongValue());
1865 * Get a float value for another node.
1868 SGPropertyNode::getFloatValue (const char * relative_path,
1869 float defaultValue) const
1871 const SGPropertyNode * node = getNode(relative_path);
1872 return (node == 0 ? defaultValue : node->getFloatValue());
1877 * Get a double value for another node.
1880 SGPropertyNode::getDoubleValue (const char * relative_path,
1881 double defaultValue) const
1883 const SGPropertyNode * node = getNode(relative_path);
1884 return (node == 0 ? defaultValue : node->getDoubleValue());
1889 * Get a string value for another node.
1892 SGPropertyNode::getStringValue (const char * relative_path,
1893 const char * defaultValue) const
1895 const SGPropertyNode * node = getNode(relative_path);
1896 return (node == 0 ? defaultValue : node->getStringValue());
1901 * Set a bool value for another node.
1904 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1906 return getNode(relative_path, true)->setBoolValue(value);
1911 * Set an int value for another node.
1914 SGPropertyNode::setIntValue (const char * relative_path, int value)
1916 return getNode(relative_path, true)->setIntValue(value);
1921 * Set a long value for another node.
1924 SGPropertyNode::setLongValue (const char * relative_path, long value)
1926 return getNode(relative_path, true)->setLongValue(value);
1931 * Set a float value for another node.
1934 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1936 return getNode(relative_path, true)->setFloatValue(value);
1941 * Set a double value for another node.
1944 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1946 return getNode(relative_path, true)->setDoubleValue(value);
1951 * Set a string value for another node.
1954 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1956 return getNode(relative_path, true)->setStringValue(value);
1961 * Set an unknown value for another node.
1964 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1967 return getNode(relative_path, true)->setUnspecifiedValue(value);
1972 * Test whether another node is tied.
1975 SGPropertyNode::isTied (const char * relative_path) const
1977 const SGPropertyNode * node = getNode(relative_path);
1978 return (node == 0 ? false : node->isTied());
1983 * Tie a node reached by a relative path, creating it if necessary.
1986 SGPropertyNode::tie (const char * relative_path,
1987 const SGRawValue<bool> &rawValue,
1990 return getNode(relative_path, true)->tie(rawValue, useDefault);
1995 * Tie a node reached by a relative path, creating it if necessary.
1998 SGPropertyNode::tie (const char * relative_path,
1999 const SGRawValue<int> &rawValue,
2002 return getNode(relative_path, true)->tie(rawValue, useDefault);
2007 * Tie a node reached by a relative path, creating it if necessary.
2010 SGPropertyNode::tie (const char * relative_path,
2011 const SGRawValue<long> &rawValue,
2014 return getNode(relative_path, true)->tie(rawValue, useDefault);
2019 * Tie a node reached by a relative path, creating it if necessary.
2022 SGPropertyNode::tie (const char * relative_path,
2023 const SGRawValue<float> &rawValue,
2026 return getNode(relative_path, true)->tie(rawValue, useDefault);
2031 * Tie a node reached by a relative path, creating it if necessary.
2034 SGPropertyNode::tie (const char * relative_path,
2035 const SGRawValue<double> &rawValue,
2038 return getNode(relative_path, true)->tie(rawValue, useDefault);
2043 * Tie a node reached by a relative path, creating it if necessary.
2046 SGPropertyNode::tie (const char * relative_path,
2047 const SGRawValue<const char *> &rawValue,
2050 return getNode(relative_path, true)->tie(rawValue, useDefault);
2055 * Attempt to untie another node reached by a relative path.
2058 SGPropertyNode::untie (const char * relative_path)
2060 SGPropertyNode * node = getNode(relative_path);
2061 return (node == 0 ? false : node->untie());
2065 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2067 if (_listeners == 0)
2068 _listeners = new vector<SGPropertyChangeListener *>;
2069 _listeners->push_back(listener);
2070 listener->register_property(this);
2074 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2076 vector<SGPropertyChangeListener *>::iterator it =
2077 find(_listeners->begin(), _listeners->end(), listener);
2078 if (it != _listeners->end()) {
2079 _listeners->erase(it);
2080 listener->unregister_property(this);
2081 if (_listeners->empty()) {
2082 vector<SGPropertyChangeListener *> * tmp = _listeners;
2090 SGPropertyNode::fireValueChanged ()
2092 fireValueChanged(this);
2096 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2098 fireChildAdded(this, child);
2102 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2104 fireChildRemoved(this, child);
2108 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2110 if (_listeners != 0) {
2111 for (unsigned int i = 0; i < _listeners->size(); i++) {
2112 (*_listeners)[i]->valueChanged(node);
2116 _parent->fireValueChanged(node);
2120 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2121 SGPropertyNode * child)
2123 if (_listeners != 0) {
2124 for (unsigned int i = 0; i < _listeners->size(); i++) {
2125 (*_listeners)[i]->childAdded(parent, child);
2129 _parent->fireChildAdded(parent, child);
2133 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2134 SGPropertyNode * child)
2136 if (_listeners != 0) {
2137 for (unsigned int i = 0; i < _listeners->size(); i++) {
2138 (*_listeners)[i]->childRemoved(parent, child);
2142 _parent->fireChildRemoved(parent, child);
2147 ////////////////////////////////////////////////////////////////////////
2148 // Simplified hash table for caching paths.
2149 ////////////////////////////////////////////////////////////////////////
2151 #define HASH_TABLE_SIZE 199
2153 SGPropertyNode::hash_table::entry::entry ()
2159 SGPropertyNode::hash_table::entry::~entry ()
2161 // Don't delete the value; we don't own
2167 SGPropertyNode::hash_table::entry::set_key (const char * key)
2169 _key = copy_string(key);
2173 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2178 SGPropertyNode::hash_table::bucket::bucket ()
2184 SGPropertyNode::hash_table::bucket::~bucket ()
2186 for (int i = 0; i < _length; i++)
2190 SGPropertyNode::hash_table::entry *
2191 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2194 for (i = 0; i < _length; i++) {
2195 if (!strcmp(_entries[i]->get_key(), key))
2199 entry ** new_entries = new entry*[_length+1];
2200 for (i = 0; i < _length; i++) {
2201 new_entries[i] = _entries[i];
2204 _entries = new_entries;
2205 _entries[_length] = new entry;
2206 _entries[_length]->set_key(key);
2208 return _entries[_length - 1];
2215 SGPropertyNode::hash_table::bucket::erase (const char * key)
2218 for (i = 0; i < _length; i++) {
2219 if (!strcmp(_entries[i]->get_key(), key))
2224 for (++i; i < _length; i++) {
2225 _entries[i-1] = _entries[i];
2232 SGPropertyNode::hash_table::hash_table ()
2238 SGPropertyNode::hash_table::~hash_table ()
2240 for (unsigned int i = 0; i < _data_length; i++)
2245 SGPropertyNode::hash_table::get (const char * key)
2247 if (_data_length == 0)
2249 unsigned int index = hashcode(key) % _data_length;
2250 if (_data[index] == 0)
2252 entry * e = _data[index]->get_entry(key);
2256 return e->get_value();
2260 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2262 if (_data_length == 0) {
2263 _data = new bucket*[HASH_TABLE_SIZE];
2264 _data_length = HASH_TABLE_SIZE;
2265 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2268 unsigned int index = hashcode(key) % _data_length;
2269 if (_data[index] == 0) {
2270 _data[index] = new bucket;
2272 entry * e = _data[index]->get_entry(key, true);
2273 e->set_value(value);
2277 SGPropertyNode::hash_table::erase (const char * key)
2279 if (_data_length == 0)
2281 unsigned int index = hashcode(key) % _data_length;
2282 if (_data[index] == 0)
2284 _data[index]->erase(key);
2288 SGPropertyNode::hash_table::hashcode (const char * key)
2290 unsigned int hash = 0;
2292 hash = 31 * hash + *key;
2301 * Default constructor
2303 SGPropertyNode_ptr::SGPropertyNode_ptr()
2311 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2315 _ptr->incrementRef();
2319 * Constructor from a pointer to a node
2321 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2325 _ptr->incrementRef();
2331 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2333 if (_ptr && _ptr->decrementRef() == 0)
2338 * Assignement operator
2340 SGPropertyNode_ptr &
2341 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2343 if (_ptr && _ptr->decrementRef() == 0)
2347 _ptr->incrementRef();
2353 * Pointer access operator
2356 SGPropertyNode_ptr::operator->()
2362 * Pointer access operator (const)
2364 const SGPropertyNode *
2365 SGPropertyNode_ptr::operator->() const
2371 * Conversion to SGPropertyNode * operator
2373 SGPropertyNode_ptr::operator SGPropertyNode *()
2379 * Conversion to const SGPropertyNode * operator
2381 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2390 SGPropertyNode_ptr::valid() const
2397 ////////////////////////////////////////////////////////////////////////
2398 // Implementation of SGPropertyChangeListener.
2399 ////////////////////////////////////////////////////////////////////////
2401 SGPropertyChangeListener::~SGPropertyChangeListener ()
2403 // This will come back and remove
2404 // the current item each time. Is
2406 vector<SGPropertyNode *>::iterator it;
2407 for (it = _properties.begin(); it != _properties.end(); it++)
2408 (*it)->removeChangeListener(this);
2412 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2418 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2419 SGPropertyNode * child)
2425 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2426 SGPropertyNode * child)
2432 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2434 _properties.push_back(node);
2438 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2440 vector<SGPropertyNode *>::iterator it =
2441 find(_properties.begin(), _properties.end(), node);
2442 if (it != _properties.end())
2443 _properties.erase(it);