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>
34 // MSVC 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 const bool SGRawValue<bool>::DefaultValue = false;
75 const int SGRawValue<int>::DefaultValue = 0;
76 const long SGRawValue<long>::DefaultValue = 0L;
77 const float SGRawValue<float>::DefaultValue = 0.0;
78 const double SGRawValue<double>::DefaultValue = 0.0L;
79 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(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()) {
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::clear_value ()
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;
786 * Alias to another node by path.
789 SGPropertyNode::alias (const char * path)
791 return alias(getNode(path, true));
799 SGPropertyNode::unalias ()
810 * Get the target of an alias.
813 SGPropertyNode::getAliasTarget ()
815 return (_type == ALIAS ? _value.alias : 0);
819 const SGPropertyNode *
820 SGPropertyNode::getAliasTarget () const
822 return (_type == ALIAS ? _value.alias : 0);
827 * Get a non-const child by index.
830 SGPropertyNode::getChild (int position)
832 if (position >= 0 && position < nChildren())
833 return _children[position];
840 * Get a const child by index.
842 const SGPropertyNode *
843 SGPropertyNode::getChild (int position) const
845 if (position >= 0 && position < nChildren())
846 return _children[position];
853 * Get a non-const child by name and index, creating if necessary.
856 SGPropertyNode::getChild (const char * name, int index, bool create)
858 int pos = find_child(name, index, _children);
860 return _children[pos];
862 SGPropertyNode_ptr node;
863 pos = find_child(name, index, _removedChildren);
865 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
867 node = _removedChildren[pos];
868 _removedChildren.erase(it);
869 node->setAttribute(REMOVED, false);
871 node = new SGPropertyNode(name, index, this);
873 _children.push_back(node);
874 fireChildAdded(node);
883 * Get a const child by name and index.
885 const SGPropertyNode *
886 SGPropertyNode::getChild (const char * name, int index) const
888 int pos = find_child(name, index, _children);
890 return _children[pos];
897 * Get all children with the same name (but different indices).
899 vector<SGPropertyNode_ptr>
900 SGPropertyNode::getChildren (const char * name) const
902 vector<SGPropertyNode_ptr> children;
903 int max = _children.size();
905 for (int i = 0; i < max; i++)
906 if (compare_strings(_children[i]->getName(), name))
907 children.push_back(_children[i]);
909 sort(children.begin(), children.end(), CompareIndices());
915 * Remove a child node
918 SGPropertyNode::removeChild (const char * name, int index, bool keep)
920 SGPropertyNode_ptr ret;
921 int pos = find_child(name, index, _children);
923 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
925 SGPropertyNode_ptr node = _children[pos];
928 _removedChildren.push_back(node);
930 node->setAttribute(REMOVED, true);
932 fireChildRemoved(node);
939 SGPropertyNode::getDisplayName (bool simplify) const
941 string display = _name;
942 if (_index != 0 || !simplify) {
944 sprintf(buffer, "[%d]", _index);
947 _display_name = copy_string(display.c_str());
948 return _display_name;
953 SGPropertyNode::getPath (bool simplify) const
955 // Calculate the complete path only once.
961 path = _parent->getPath(simplify);
963 path += getDisplayName(simplify);
965 _path = copy_string(path.c_str());
972 SGPropertyNode::getType () const
975 return _value.alias->getType();
982 SGPropertyNode::getBoolValue () const
984 // Shortcut for common case
985 if (_attr == (READ|WRITE) && _type == BOOL)
988 if (getAttribute(TRACE_READ))
990 if (!getAttribute(READ))
991 return SGRawValue<bool>::DefaultValue;
994 return _value.alias->getBoolValue();
998 return get_int() == 0 ? false : true;
1000 return get_long() == 0L ? false : true;
1002 return get_float() == 0.0 ? false : true;
1004 return get_double() == 0.0L ? false : true;
1007 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1010 return SGRawValue<bool>::DefaultValue;
1015 SGPropertyNode::getIntValue () const
1017 // Shortcut for common case
1018 if (_attr == (READ|WRITE) && _type == INT)
1021 if (getAttribute(TRACE_READ))
1023 if (!getAttribute(READ))
1024 return SGRawValue<int>::DefaultValue;
1027 return _value.alias->getIntValue();
1029 return int(get_bool());
1033 return int(get_long());
1035 return int(get_float());
1037 return int(get_double());
1040 return atoi(get_string());
1043 return SGRawValue<int>::DefaultValue;
1048 SGPropertyNode::getLongValue () const
1050 // Shortcut for common case
1051 if (_attr == (READ|WRITE) && _type == LONG)
1054 if (getAttribute(TRACE_READ))
1056 if (!getAttribute(READ))
1057 return SGRawValue<long>::DefaultValue;
1060 return _value.alias->getLongValue();
1062 return long(get_bool());
1064 return long(get_int());
1068 return long(get_float());
1070 return long(get_double());
1073 return strtol(get_string(), 0, 0);
1076 return SGRawValue<long>::DefaultValue;
1081 SGPropertyNode::getFloatValue () const
1083 // Shortcut for common case
1084 if (_attr == (READ|WRITE) && _type == FLOAT)
1087 if (getAttribute(TRACE_READ))
1089 if (!getAttribute(READ))
1090 return SGRawValue<float>::DefaultValue;
1093 return _value.alias->getFloatValue();
1095 return float(get_bool());
1097 return float(get_int());
1099 return float(get_long());
1103 return float(get_double());
1106 return atof(get_string());
1109 return SGRawValue<float>::DefaultValue;
1114 SGPropertyNode::getDoubleValue () const
1116 // Shortcut for common case
1117 if (_attr == (READ|WRITE) && _type == DOUBLE)
1118 return get_double();
1120 if (getAttribute(TRACE_READ))
1122 if (!getAttribute(READ))
1123 return SGRawValue<double>::DefaultValue;
1127 return _value.alias->getDoubleValue();
1129 return double(get_bool());
1131 return double(get_int());
1133 return double(get_long());
1135 return double(get_float());
1137 return get_double();
1140 return strtod(get_string(), 0);
1143 return SGRawValue<double>::DefaultValue;
1148 SGPropertyNode::getStringValue () const
1150 // Shortcut for common case
1151 if (_attr == (READ|WRITE) && _type == STRING)
1152 return get_string();
1154 if (getAttribute(TRACE_READ))
1156 if (!getAttribute(READ))
1157 return SGRawValue<const char *>::DefaultValue;
1158 return make_string();
1162 SGPropertyNode::setBoolValue (bool value)
1164 // Shortcut for common case
1165 if (_attr == (READ|WRITE) && _type == BOOL)
1166 return set_bool(value);
1168 bool result = false;
1170 if (_type == NONE || _type == UNSPECIFIED) {
1178 result = _value.alias->setBoolValue(value);
1181 result = set_bool(value);
1184 result = set_int(int(value));
1187 result = set_long(long(value));
1190 result = set_float(float(value));
1193 result = set_double(double(value));
1197 result = set_string(value ? "true" : "false");
1204 if (getAttribute(TRACE_WRITE))
1210 SGPropertyNode::setIntValue (int value)
1212 // Shortcut for common case
1213 if (_attr == (READ|WRITE) && _type == INT)
1214 return set_int(value);
1216 bool result = false;
1218 if (_type == NONE || _type == UNSPECIFIED) {
1221 _local_val.int_val = 0;
1226 result = _value.alias->setIntValue(value);
1229 result = set_bool(value == 0 ? false : true);
1232 result = set_int(value);
1235 result = set_long(long(value));
1238 result = set_float(float(value));
1241 result = set_double(double(value));
1246 sprintf(buf, "%d", value);
1247 result = set_string(buf);
1255 if (getAttribute(TRACE_WRITE))
1261 SGPropertyNode::setLongValue (long value)
1263 // Shortcut for common case
1264 if (_attr == (READ|WRITE) && _type == LONG)
1265 return set_long(value);
1267 bool result = false;
1269 if (_type == NONE || _type == UNSPECIFIED) {
1272 _local_val.long_val = 0L;
1277 result = _value.alias->setLongValue(value);
1280 result = set_bool(value == 0L ? false : true);
1283 result = set_int(int(value));
1286 result = set_long(value);
1289 result = set_float(float(value));
1292 result = set_double(double(value));
1297 sprintf(buf, "%ld", value);
1298 result = set_string(buf);
1306 if (getAttribute(TRACE_WRITE))
1312 SGPropertyNode::setFloatValue (float value)
1314 // Shortcut for common case
1315 if (_attr == (READ|WRITE) && _type == FLOAT)
1316 return set_float(value);
1318 bool result = false;
1320 if (_type == NONE || _type == UNSPECIFIED) {
1323 _local_val.float_val = 0;
1328 result = _value.alias->setFloatValue(value);
1331 result = set_bool(value == 0.0 ? false : true);
1334 result = set_int(int(value));
1337 result = set_long(long(value));
1340 result = set_float(value);
1343 result = set_double(double(value));
1348 sprintf(buf, "%f", value);
1349 result = set_string(buf);
1357 if (getAttribute(TRACE_WRITE))
1363 SGPropertyNode::setDoubleValue (double value)
1365 // Shortcut for common case
1366 if (_attr == (READ|WRITE) && _type == DOUBLE)
1367 return set_double(value);
1369 bool result = false;
1371 if (_type == NONE || _type == UNSPECIFIED) {
1373 _local_val.double_val = value;
1379 result = _value.alias->setDoubleValue(value);
1382 result = set_bool(value == 0.0L ? false : true);
1385 result = set_int(int(value));
1388 result = set_long(long(value));
1391 result = set_float(float(value));
1394 result = set_double(value);
1399 sprintf(buf, "%f", value);
1400 result = set_string(buf);
1408 if (getAttribute(TRACE_WRITE))
1414 SGPropertyNode::setStringValue (const char * value)
1416 // Shortcut for common case
1417 if (_attr == (READ|WRITE) && _type == STRING)
1418 return set_string(value);
1420 bool result = false;
1422 if (_type == NONE || _type == UNSPECIFIED) {
1429 result = _value.alias->setStringValue(value);
1432 result = set_bool((compare_strings(value, "true")
1433 || atoi(value)) ? true : false);
1436 result = set_int(atoi(value));
1439 result = set_long(strtol(value, 0, 0));
1442 result = set_float(atof(value));
1445 result = set_double(strtod(value, 0));
1449 result = set_string(value);
1456 if (getAttribute(TRACE_WRITE))
1462 SGPropertyNode::setUnspecifiedValue (const char * value)
1464 bool result = false;
1466 if (_type == NONE) {
1468 _type = UNSPECIFIED;
1473 result = _value.alias->setUnspecifiedValue(value);
1476 result = set_bool((compare_strings(value, "true")
1477 || atoi(value)) ? true : false);
1480 result = set_int(atoi(value));
1483 result = set_long(strtol(value, 0, 0));
1486 result = set_float(atof(value));
1489 result = set_double(strtod(value, 0));
1493 result = set_string(value);
1500 if (getAttribute(TRACE_WRITE))
1506 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1508 if (_type == ALIAS || _tied)
1511 useDefault = useDefault && hasValue();
1512 bool old_val = false;
1514 old_val = getBoolValue();
1519 _value.bool_val = rawValue.clone();
1522 setBoolValue(old_val);
1528 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1530 if (_type == ALIAS || _tied)
1533 useDefault = useDefault && hasValue();
1536 old_val = getIntValue();
1541 _value.int_val = rawValue.clone();
1544 setIntValue(old_val);
1550 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1552 if (_type == ALIAS || _tied)
1555 useDefault = useDefault && hasValue();
1558 old_val = getLongValue();
1563 _value.long_val = rawValue.clone();
1566 setLongValue(old_val);
1572 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1574 if (_type == ALIAS || _tied)
1577 useDefault = useDefault && hasValue();
1578 float old_val = 0.0;
1580 old_val = getFloatValue();
1585 _value.float_val = rawValue.clone();
1588 setFloatValue(old_val);
1594 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1596 if (_type == ALIAS || _tied)
1599 useDefault = useDefault && hasValue();
1600 double old_val = 0.0;
1602 old_val = getDoubleValue();
1607 _value.double_val = rawValue.clone();
1610 setDoubleValue(old_val);
1617 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1619 if (_type == ALIAS || _tied)
1622 useDefault = useDefault && hasValue();
1625 old_val = getStringValue();
1630 _value.string_val = rawValue.clone();
1633 setStringValue(old_val.c_str());
1639 SGPropertyNode::untie ()
1646 bool val = getBoolValue();
1649 _local_val.bool_val = val;
1653 int val = getIntValue();
1656 _local_val.int_val = val;
1660 long val = getLongValue();
1663 _local_val.long_val = val;
1667 float val = getFloatValue();
1670 _local_val.float_val = val;
1674 double val = getDoubleValue();
1677 _local_val.double_val = val;
1682 string val = getStringValue();
1685 _local_val.string_val = copy_string(val.c_str());
1698 SGPropertyNode::getRootNode ()
1703 return _parent->getRootNode();
1706 const SGPropertyNode *
1707 SGPropertyNode::getRootNode () const
1712 return _parent->getRootNode();
1716 SGPropertyNode::getNode (const char * relative_path, bool create)
1718 if (_path_cache == 0)
1719 _path_cache = new hash_table;
1721 SGPropertyNode * result = _path_cache->get(relative_path);
1723 vector<PathComponent> components;
1724 parse_path(relative_path, components);
1725 result = find_node(this, components, 0, create);
1727 _path_cache->put(relative_path, result);
1734 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1736 vector<PathComponent> components;
1737 parse_path(relative_path, components);
1738 if (components.size() > 0)
1739 components[components.size()-1].index = index;
1740 return find_node(this, components, 0, create);
1743 const SGPropertyNode *
1744 SGPropertyNode::getNode (const char * relative_path) const
1746 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1749 const SGPropertyNode *
1750 SGPropertyNode::getNode (const char * relative_path, int index) const
1752 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1756 ////////////////////////////////////////////////////////////////////////
1757 // Convenience methods using relative paths.
1758 ////////////////////////////////////////////////////////////////////////
1762 * Test whether another node has a value attached.
1765 SGPropertyNode::hasValue (const char * relative_path) const
1767 const SGPropertyNode * node = getNode(relative_path);
1768 return (node == 0 ? false : node->hasValue());
1773 * Get the value type for another node.
1775 SGPropertyNode::Type
1776 SGPropertyNode::getType (const char * relative_path) const
1778 const SGPropertyNode * node = getNode(relative_path);
1779 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1784 * Get a bool value for another node.
1787 SGPropertyNode::getBoolValue (const char * relative_path,
1788 bool defaultValue) const
1790 const SGPropertyNode * node = getNode(relative_path);
1791 return (node == 0 ? defaultValue : node->getBoolValue());
1796 * Get an int value for another node.
1799 SGPropertyNode::getIntValue (const char * relative_path,
1800 int defaultValue) const
1802 const SGPropertyNode * node = getNode(relative_path);
1803 return (node == 0 ? defaultValue : node->getIntValue());
1808 * Get a long value for another node.
1811 SGPropertyNode::getLongValue (const char * relative_path,
1812 long defaultValue) const
1814 const SGPropertyNode * node = getNode(relative_path);
1815 return (node == 0 ? defaultValue : node->getLongValue());
1820 * Get a float value for another node.
1823 SGPropertyNode::getFloatValue (const char * relative_path,
1824 float defaultValue) const
1826 const SGPropertyNode * node = getNode(relative_path);
1827 return (node == 0 ? defaultValue : node->getFloatValue());
1832 * Get a double value for another node.
1835 SGPropertyNode::getDoubleValue (const char * relative_path,
1836 double defaultValue) const
1838 const SGPropertyNode * node = getNode(relative_path);
1839 return (node == 0 ? defaultValue : node->getDoubleValue());
1844 * Get a string value for another node.
1847 SGPropertyNode::getStringValue (const char * relative_path,
1848 const char * defaultValue) const
1850 const SGPropertyNode * node = getNode(relative_path);
1851 return (node == 0 ? defaultValue : node->getStringValue());
1856 * Set a bool value for another node.
1859 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1861 return getNode(relative_path, true)->setBoolValue(value);
1866 * Set an int value for another node.
1869 SGPropertyNode::setIntValue (const char * relative_path, int value)
1871 return getNode(relative_path, true)->setIntValue(value);
1876 * Set a long value for another node.
1879 SGPropertyNode::setLongValue (const char * relative_path, long value)
1881 return getNode(relative_path, true)->setLongValue(value);
1886 * Set a float value for another node.
1889 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1891 return getNode(relative_path, true)->setFloatValue(value);
1896 * Set a double value for another node.
1899 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1901 return getNode(relative_path, true)->setDoubleValue(value);
1906 * Set a string value for another node.
1909 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1911 return getNode(relative_path, true)->setStringValue(value);
1916 * Set an unknown value for another node.
1919 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1922 return getNode(relative_path, true)->setUnspecifiedValue(value);
1927 * Test whether another node is tied.
1930 SGPropertyNode::isTied (const char * relative_path) const
1932 const SGPropertyNode * node = getNode(relative_path);
1933 return (node == 0 ? false : node->isTied());
1938 * Tie a node reached by a relative path, creating it if necessary.
1941 SGPropertyNode::tie (const char * relative_path,
1942 const SGRawValue<bool> &rawValue,
1945 return getNode(relative_path, true)->tie(rawValue, useDefault);
1950 * Tie a node reached by a relative path, creating it if necessary.
1953 SGPropertyNode::tie (const char * relative_path,
1954 const SGRawValue<int> &rawValue,
1957 return getNode(relative_path, true)->tie(rawValue, useDefault);
1962 * Tie a node reached by a relative path, creating it if necessary.
1965 SGPropertyNode::tie (const char * relative_path,
1966 const SGRawValue<long> &rawValue,
1969 return getNode(relative_path, true)->tie(rawValue, useDefault);
1974 * Tie a node reached by a relative path, creating it if necessary.
1977 SGPropertyNode::tie (const char * relative_path,
1978 const SGRawValue<float> &rawValue,
1981 return getNode(relative_path, true)->tie(rawValue, useDefault);
1986 * Tie a node reached by a relative path, creating it if necessary.
1989 SGPropertyNode::tie (const char * relative_path,
1990 const SGRawValue<double> &rawValue,
1993 return getNode(relative_path, true)->tie(rawValue, useDefault);
1998 * Tie a node reached by a relative path, creating it if necessary.
2001 SGPropertyNode::tie (const char * relative_path,
2002 const SGRawValue<const char *> &rawValue,
2005 return getNode(relative_path, true)->tie(rawValue, useDefault);
2010 * Attempt to untie another node reached by a relative path.
2013 SGPropertyNode::untie (const char * relative_path)
2015 SGPropertyNode * node = getNode(relative_path);
2016 return (node == 0 ? false : node->untie());
2020 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2022 if (_listeners == 0)
2023 _listeners = new vector<SGPropertyChangeListener *>;
2024 _listeners->push_back(listener);
2025 listener->register_property(this);
2029 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2031 vector<SGPropertyChangeListener *>::iterator it =
2032 find(_listeners->begin(), _listeners->end(), listener);
2033 if (it != _listeners->end()) {
2034 _listeners->erase(it);
2035 listener->unregister_property(this);
2036 if (_listeners->empty()) {
2037 vector<SGPropertyChangeListener *> * tmp = _listeners;
2045 SGPropertyNode::fireValueChanged ()
2047 fireValueChanged(this);
2051 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2053 fireChildAdded(this, child);
2057 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2059 fireChildRemoved(this, child);
2063 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2065 if (_listeners != 0) {
2066 for (unsigned int i = 0; i < _listeners->size(); i++) {
2067 (*_listeners)[i]->valueChanged(node);
2071 _parent->fireValueChanged(node);
2075 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2076 SGPropertyNode * child)
2078 if (_listeners != 0) {
2079 for (unsigned int i = 0; i < _listeners->size(); i++) {
2080 (*_listeners)[i]->childAdded(parent, child);
2084 _parent->fireChildAdded(parent, child);
2088 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2089 SGPropertyNode * child)
2091 if (_listeners != 0) {
2092 for (unsigned int i = 0; i < _listeners->size(); i++) {
2093 (*_listeners)[i]->childRemoved(parent, child);
2097 _parent->fireChildRemoved(parent, child);
2102 ////////////////////////////////////////////////////////////////////////
2103 // Simplified hash table for caching paths.
2104 ////////////////////////////////////////////////////////////////////////
2106 #define HASH_TABLE_SIZE 199
2108 SGPropertyNode::hash_table::entry::entry ()
2114 SGPropertyNode::hash_table::entry::~entry ()
2116 // Don't delete the value; we don't own
2122 SGPropertyNode::hash_table::entry::set_key (const char * key)
2124 _key = copy_string(key);
2128 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2133 SGPropertyNode::hash_table::bucket::bucket ()
2139 SGPropertyNode::hash_table::bucket::~bucket ()
2141 for (int i = 0; i < _length; i++)
2145 SGPropertyNode::hash_table::entry *
2146 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2149 for (i = 0; i < _length; i++) {
2150 if (!strcmp(_entries[i]->get_key(), key))
2154 entry ** new_entries = new entry*[_length+1];
2155 for (i = 0; i < _length; i++) {
2156 new_entries[i] = _entries[i];
2159 _entries = new_entries;
2160 _entries[_length] = new entry;
2161 _entries[_length]->set_key(key);
2163 return _entries[_length - 1];
2170 SGPropertyNode::hash_table::hash_table ()
2176 SGPropertyNode::hash_table::~hash_table ()
2178 for (unsigned int i = 0; i < _data_length; i++)
2183 SGPropertyNode::hash_table::get (const char * key)
2185 if (_data_length == 0)
2187 unsigned int index = hashcode(key) % _data_length;
2188 if (_data[index] == 0)
2190 entry * e = _data[index]->get_entry(key);
2194 return e->get_value();
2198 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2200 if (_data_length == 0) {
2201 _data = new bucket*[HASH_TABLE_SIZE];
2202 _data_length = HASH_TABLE_SIZE;
2203 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2206 unsigned int index = hashcode(key) % _data_length;
2207 if (_data[index] == 0) {
2208 _data[index] = new bucket;
2210 entry * e = _data[index]->get_entry(key, true);
2211 e->set_value(value);
2215 SGPropertyNode::hash_table::hashcode (const char * key)
2217 unsigned int hash = 0;
2219 hash = 31 * hash + *key;
2228 * Default constructor
2230 SGPropertyNode_ptr::SGPropertyNode_ptr()
2238 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2242 _ptr->incrementRef();
2246 * Constructor from a pointer to a node
2248 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2252 _ptr->incrementRef();
2258 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2260 if (_ptr && _ptr->decrementRef() == 0)
2265 * Assignement operator
2267 SGPropertyNode_ptr &
2268 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2270 if (_ptr && _ptr->decrementRef() == 0)
2274 _ptr->incrementRef();
2280 * Pointer access operator
2283 SGPropertyNode_ptr::operator->()
2289 * Pointer access operator (const)
2291 const SGPropertyNode *
2292 SGPropertyNode_ptr::operator->() const
2298 * Conversion to SGPropertyNode * operator
2300 SGPropertyNode_ptr::operator SGPropertyNode *()
2306 * Conversion to const SGPropertyNode * operator
2308 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2317 SGPropertyNode_ptr::valid() const
2324 ////////////////////////////////////////////////////////////////////////
2325 // Implementation of SGPropertyChangeListener.
2326 ////////////////////////////////////////////////////////////////////////
2328 SGPropertyChangeListener::~SGPropertyChangeListener ()
2330 // This will come back and remove
2331 // the current item each time. Is
2333 vector<SGPropertyNode *>::iterator it;
2334 for (it = _properties.begin(); it != _properties.end(); it++)
2335 (*it)->removeChangeListener(this);
2339 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2345 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2346 SGPropertyNode * child)
2352 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2353 SGPropertyNode * child)
2359 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2361 _properties.push_back(node);
2365 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2367 vector<SGPropertyNode *>::iterator it =
2368 find(_properties.begin(), _properties.end(), node);
2369 if (it != _properties.end())
2370 _properties.erase(it);