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 * Detach a child node from the tree and return a guarded pointer to it.
920 SGPropertyNode::detachChild (const char * name, int index, bool keep)
922 SGPropertyNode_ptr ret;
923 int pos = find_child(name, index, _children);
925 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
927 SGPropertyNode_ptr node = _children[pos];
930 _removedChildren.push_back(node);
933 _path_cache->erase(name); // EMH - TODO: Take "index" into account!
934 node->setAttribute(REMOVED, true);
937 fireChildRemoved(node);
944 * Remove a child node, and all children that aren't referenced.
945 * Returns "true" if not all nodes could be deleted.
948 SGPropertyNode::removeChild (const char * name, int index)
951 int pos = find_child(name, index, _children);
953 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
955 SGPropertyNode *node = _children[pos];
956 if (node->nChildren() && node->removeChildren())
959 if (node->isTied() || node->_count != 1 || node->nChildren())
963 _path_cache->erase(name); // EMH - TODO: Take "index" into account!
965 node->setAttribute(REMOVED, true);
967 fireChildRemoved(node);
976 * Remove all children nodes, or all with a given name. Returns
977 * "true" if not all nodes could be deleted.
980 SGPropertyNode::removeChildren(const char *name)
983 vector<SGPropertyNode_ptr>::iterator it = _children.end();
984 vector<SGPropertyNode_ptr>::iterator begin = _children.begin();
985 while (it-- != begin) {
986 SGPropertyNode *node = *it;
987 if (name && !compare_strings(node->getName(), name))
990 if (node->nChildren() && node->removeChildren())
993 if (node->isTied() || node->_count != 1 || node->nChildren())
997 _path_cache->erase(node->getName());
999 node->setAttribute(REMOVED, true);
1001 fireChildRemoved(node);
1002 _children.erase(it);
1010 SGPropertyNode::getDisplayName (bool simplify) const
1012 string display = _name;
1013 if (_index != 0 || !simplify) {
1015 sprintf(buffer, "[%d]", _index);
1018 _display_name = copy_string(display.c_str());
1019 return _display_name;
1024 SGPropertyNode::getPath (bool simplify) const
1026 // Calculate the complete path only once.
1032 path = _parent->getPath(simplify);
1034 path += getDisplayName(simplify);
1036 _path = copy_string(path.c_str());
1042 SGPropertyNode::Type
1043 SGPropertyNode::getType () const
1046 return _value.alias->getType();
1053 SGPropertyNode::getBoolValue () const
1055 // Shortcut for common case
1056 if (_attr == (READ|WRITE) && _type == BOOL)
1059 if (getAttribute(TRACE_READ))
1061 if (!getAttribute(READ))
1062 return SGRawValue<bool>::DefaultValue;
1065 return _value.alias->getBoolValue();
1069 return get_int() == 0 ? false : true;
1071 return get_long() == 0L ? false : true;
1073 return get_float() == 0.0 ? false : true;
1075 return get_double() == 0.0L ? false : true;
1078 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1081 return SGRawValue<bool>::DefaultValue;
1086 SGPropertyNode::getIntValue () const
1088 // Shortcut for common case
1089 if (_attr == (READ|WRITE) && _type == INT)
1092 if (getAttribute(TRACE_READ))
1094 if (!getAttribute(READ))
1095 return SGRawValue<int>::DefaultValue;
1098 return _value.alias->getIntValue();
1100 return int(get_bool());
1104 return int(get_long());
1106 return int(get_float());
1108 return int(get_double());
1111 return atoi(get_string());
1114 return SGRawValue<int>::DefaultValue;
1119 SGPropertyNode::getLongValue () const
1121 // Shortcut for common case
1122 if (_attr == (READ|WRITE) && _type == LONG)
1125 if (getAttribute(TRACE_READ))
1127 if (!getAttribute(READ))
1128 return SGRawValue<long>::DefaultValue;
1131 return _value.alias->getLongValue();
1133 return long(get_bool());
1135 return long(get_int());
1139 return long(get_float());
1141 return long(get_double());
1144 return strtol(get_string(), 0, 0);
1147 return SGRawValue<long>::DefaultValue;
1152 SGPropertyNode::getFloatValue () const
1154 // Shortcut for common case
1155 if (_attr == (READ|WRITE) && _type == FLOAT)
1158 if (getAttribute(TRACE_READ))
1160 if (!getAttribute(READ))
1161 return SGRawValue<float>::DefaultValue;
1164 return _value.alias->getFloatValue();
1166 return float(get_bool());
1168 return float(get_int());
1170 return float(get_long());
1174 return float(get_double());
1177 return atof(get_string());
1180 return SGRawValue<float>::DefaultValue;
1185 SGPropertyNode::getDoubleValue () const
1187 // Shortcut for common case
1188 if (_attr == (READ|WRITE) && _type == DOUBLE)
1189 return get_double();
1191 if (getAttribute(TRACE_READ))
1193 if (!getAttribute(READ))
1194 return SGRawValue<double>::DefaultValue;
1198 return _value.alias->getDoubleValue();
1200 return double(get_bool());
1202 return double(get_int());
1204 return double(get_long());
1206 return double(get_float());
1208 return get_double();
1211 return strtod(get_string(), 0);
1214 return SGRawValue<double>::DefaultValue;
1219 SGPropertyNode::getStringValue () const
1221 // Shortcut for common case
1222 if (_attr == (READ|WRITE) && _type == STRING)
1223 return get_string();
1225 if (getAttribute(TRACE_READ))
1227 if (!getAttribute(READ))
1228 return SGRawValue<const char *>::DefaultValue;
1229 return make_string();
1233 SGPropertyNode::setBoolValue (bool value)
1235 // Shortcut for common case
1236 if (_attr == (READ|WRITE) && _type == BOOL)
1237 return set_bool(value);
1239 bool result = false;
1241 if (_type == NONE || _type == UNSPECIFIED) {
1249 result = _value.alias->setBoolValue(value);
1252 result = set_bool(value);
1255 result = set_int(int(value));
1258 result = set_long(long(value));
1261 result = set_float(float(value));
1264 result = set_double(double(value));
1268 result = set_string(value ? "true" : "false");
1275 if (getAttribute(TRACE_WRITE))
1281 SGPropertyNode::setIntValue (int value)
1283 // Shortcut for common case
1284 if (_attr == (READ|WRITE) && _type == INT)
1285 return set_int(value);
1287 bool result = false;
1289 if (_type == NONE || _type == UNSPECIFIED) {
1292 _local_val.int_val = 0;
1297 result = _value.alias->setIntValue(value);
1300 result = set_bool(value == 0 ? false : true);
1303 result = set_int(value);
1306 result = set_long(long(value));
1309 result = set_float(float(value));
1312 result = set_double(double(value));
1317 sprintf(buf, "%d", value);
1318 result = set_string(buf);
1326 if (getAttribute(TRACE_WRITE))
1332 SGPropertyNode::setLongValue (long value)
1334 // Shortcut for common case
1335 if (_attr == (READ|WRITE) && _type == LONG)
1336 return set_long(value);
1338 bool result = false;
1340 if (_type == NONE || _type == UNSPECIFIED) {
1343 _local_val.long_val = 0L;
1348 result = _value.alias->setLongValue(value);
1351 result = set_bool(value == 0L ? false : true);
1354 result = set_int(int(value));
1357 result = set_long(value);
1360 result = set_float(float(value));
1363 result = set_double(double(value));
1368 sprintf(buf, "%ld", value);
1369 result = set_string(buf);
1377 if (getAttribute(TRACE_WRITE))
1383 SGPropertyNode::setFloatValue (float value)
1385 // Shortcut for common case
1386 if (_attr == (READ|WRITE) && _type == FLOAT)
1387 return set_float(value);
1389 bool result = false;
1391 if (_type == NONE || _type == UNSPECIFIED) {
1394 _local_val.float_val = 0;
1399 result = _value.alias->setFloatValue(value);
1402 result = set_bool(value == 0.0 ? false : true);
1405 result = set_int(int(value));
1408 result = set_long(long(value));
1411 result = set_float(value);
1414 result = set_double(double(value));
1419 sprintf(buf, "%f", value);
1420 result = set_string(buf);
1428 if (getAttribute(TRACE_WRITE))
1434 SGPropertyNode::setDoubleValue (double value)
1436 // Shortcut for common case
1437 if (_attr == (READ|WRITE) && _type == DOUBLE)
1438 return set_double(value);
1440 bool result = false;
1442 if (_type == NONE || _type == UNSPECIFIED) {
1444 _local_val.double_val = value;
1450 result = _value.alias->setDoubleValue(value);
1453 result = set_bool(value == 0.0L ? false : true);
1456 result = set_int(int(value));
1459 result = set_long(long(value));
1462 result = set_float(float(value));
1465 result = set_double(value);
1470 sprintf(buf, "%f", value);
1471 result = set_string(buf);
1479 if (getAttribute(TRACE_WRITE))
1485 SGPropertyNode::setStringValue (const char * value)
1487 // Shortcut for common case
1488 if (_attr == (READ|WRITE) && _type == STRING)
1489 return set_string(value);
1491 bool result = false;
1493 if (_type == NONE || _type == UNSPECIFIED) {
1500 result = _value.alias->setStringValue(value);
1503 result = set_bool((compare_strings(value, "true")
1504 || atoi(value)) ? true : false);
1507 result = set_int(atoi(value));
1510 result = set_long(strtol(value, 0, 0));
1513 result = set_float(atof(value));
1516 result = set_double(strtod(value, 0));
1520 result = set_string(value);
1527 if (getAttribute(TRACE_WRITE))
1533 SGPropertyNode::setUnspecifiedValue (const char * value)
1535 bool result = false;
1537 if (_type == NONE) {
1539 _type = UNSPECIFIED;
1544 result = _value.alias->setUnspecifiedValue(value);
1547 result = set_bool((compare_strings(value, "true")
1548 || atoi(value)) ? true : false);
1551 result = set_int(atoi(value));
1554 result = set_long(strtol(value, 0, 0));
1557 result = set_float(atof(value));
1560 result = set_double(strtod(value, 0));
1564 result = set_string(value);
1571 if (getAttribute(TRACE_WRITE))
1577 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1579 if (_type == ALIAS || _tied)
1582 useDefault = useDefault && hasValue();
1583 bool old_val = false;
1585 old_val = getBoolValue();
1590 _value.bool_val = rawValue.clone();
1593 setBoolValue(old_val);
1599 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1601 if (_type == ALIAS || _tied)
1604 useDefault = useDefault && hasValue();
1607 old_val = getIntValue();
1612 _value.int_val = rawValue.clone();
1615 setIntValue(old_val);
1621 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1623 if (_type == ALIAS || _tied)
1626 useDefault = useDefault && hasValue();
1629 old_val = getLongValue();
1634 _value.long_val = rawValue.clone();
1637 setLongValue(old_val);
1643 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1645 if (_type == ALIAS || _tied)
1648 useDefault = useDefault && hasValue();
1649 float old_val = 0.0;
1651 old_val = getFloatValue();
1656 _value.float_val = rawValue.clone();
1659 setFloatValue(old_val);
1665 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1667 if (_type == ALIAS || _tied)
1670 useDefault = useDefault && hasValue();
1671 double old_val = 0.0;
1673 old_val = getDoubleValue();
1678 _value.double_val = rawValue.clone();
1681 setDoubleValue(old_val);
1688 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1690 if (_type == ALIAS || _tied)
1693 useDefault = useDefault && hasValue();
1696 old_val = getStringValue();
1701 _value.string_val = rawValue.clone();
1704 setStringValue(old_val.c_str());
1710 SGPropertyNode::untie ()
1717 bool val = getBoolValue();
1720 _local_val.bool_val = val;
1724 int val = getIntValue();
1727 _local_val.int_val = val;
1731 long val = getLongValue();
1734 _local_val.long_val = val;
1738 float val = getFloatValue();
1741 _local_val.float_val = val;
1745 double val = getDoubleValue();
1748 _local_val.double_val = val;
1753 string val = getStringValue();
1756 _local_val.string_val = copy_string(val.c_str());
1769 SGPropertyNode::getRootNode ()
1774 return _parent->getRootNode();
1777 const SGPropertyNode *
1778 SGPropertyNode::getRootNode () const
1783 return _parent->getRootNode();
1787 SGPropertyNode::getNode (const char * relative_path, bool create)
1789 if (_path_cache == 0)
1790 _path_cache = new hash_table;
1792 SGPropertyNode * result = _path_cache->get(relative_path);
1794 vector<PathComponent> components;
1795 parse_path(relative_path, components);
1796 result = find_node(this, components, 0, create);
1798 _path_cache->put(relative_path, result);
1805 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1807 vector<PathComponent> components;
1808 parse_path(relative_path, components);
1809 if (components.size() > 0)
1810 components.back().index = index;
1811 return find_node(this, components, 0, create);
1814 const SGPropertyNode *
1815 SGPropertyNode::getNode (const char * relative_path) const
1817 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1820 const SGPropertyNode *
1821 SGPropertyNode::getNode (const char * relative_path, int index) const
1823 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1827 ////////////////////////////////////////////////////////////////////////
1828 // Convenience methods using relative paths.
1829 ////////////////////////////////////////////////////////////////////////
1833 * Test whether another node has a value attached.
1836 SGPropertyNode::hasValue (const char * relative_path) const
1838 const SGPropertyNode * node = getNode(relative_path);
1839 return (node == 0 ? false : node->hasValue());
1844 * Get the value type for another node.
1846 SGPropertyNode::Type
1847 SGPropertyNode::getType (const char * relative_path) const
1849 const SGPropertyNode * node = getNode(relative_path);
1850 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1855 * Get a bool value for another node.
1858 SGPropertyNode::getBoolValue (const char * relative_path,
1859 bool defaultValue) const
1861 const SGPropertyNode * node = getNode(relative_path);
1862 return (node == 0 ? defaultValue : node->getBoolValue());
1867 * Get an int value for another node.
1870 SGPropertyNode::getIntValue (const char * relative_path,
1871 int defaultValue) const
1873 const SGPropertyNode * node = getNode(relative_path);
1874 return (node == 0 ? defaultValue : node->getIntValue());
1879 * Get a long value for another node.
1882 SGPropertyNode::getLongValue (const char * relative_path,
1883 long defaultValue) const
1885 const SGPropertyNode * node = getNode(relative_path);
1886 return (node == 0 ? defaultValue : node->getLongValue());
1891 * Get a float value for another node.
1894 SGPropertyNode::getFloatValue (const char * relative_path,
1895 float defaultValue) const
1897 const SGPropertyNode * node = getNode(relative_path);
1898 return (node == 0 ? defaultValue : node->getFloatValue());
1903 * Get a double value for another node.
1906 SGPropertyNode::getDoubleValue (const char * relative_path,
1907 double defaultValue) const
1909 const SGPropertyNode * node = getNode(relative_path);
1910 return (node == 0 ? defaultValue : node->getDoubleValue());
1915 * Get a string value for another node.
1918 SGPropertyNode::getStringValue (const char * relative_path,
1919 const char * defaultValue) const
1921 const SGPropertyNode * node = getNode(relative_path);
1922 return (node == 0 ? defaultValue : node->getStringValue());
1927 * Set a bool value for another node.
1930 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1932 return getNode(relative_path, true)->setBoolValue(value);
1937 * Set an int value for another node.
1940 SGPropertyNode::setIntValue (const char * relative_path, int value)
1942 return getNode(relative_path, true)->setIntValue(value);
1947 * Set a long value for another node.
1950 SGPropertyNode::setLongValue (const char * relative_path, long value)
1952 return getNode(relative_path, true)->setLongValue(value);
1957 * Set a float value for another node.
1960 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1962 return getNode(relative_path, true)->setFloatValue(value);
1967 * Set a double value for another node.
1970 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1972 return getNode(relative_path, true)->setDoubleValue(value);
1977 * Set a string value for another node.
1980 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1982 return getNode(relative_path, true)->setStringValue(value);
1987 * Set an unknown value for another node.
1990 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1993 return getNode(relative_path, true)->setUnspecifiedValue(value);
1998 * Test whether another node is tied.
2001 SGPropertyNode::isTied (const char * relative_path) const
2003 const SGPropertyNode * node = getNode(relative_path);
2004 return (node == 0 ? false : node->isTied());
2009 * Tie a node reached by a relative path, creating it if necessary.
2012 SGPropertyNode::tie (const char * relative_path,
2013 const SGRawValue<bool> &rawValue,
2016 return getNode(relative_path, true)->tie(rawValue, useDefault);
2021 * Tie a node reached by a relative path, creating it if necessary.
2024 SGPropertyNode::tie (const char * relative_path,
2025 const SGRawValue<int> &rawValue,
2028 return getNode(relative_path, true)->tie(rawValue, useDefault);
2033 * Tie a node reached by a relative path, creating it if necessary.
2036 SGPropertyNode::tie (const char * relative_path,
2037 const SGRawValue<long> &rawValue,
2040 return getNode(relative_path, true)->tie(rawValue, useDefault);
2045 * Tie a node reached by a relative path, creating it if necessary.
2048 SGPropertyNode::tie (const char * relative_path,
2049 const SGRawValue<float> &rawValue,
2052 return getNode(relative_path, true)->tie(rawValue, useDefault);
2057 * Tie a node reached by a relative path, creating it if necessary.
2060 SGPropertyNode::tie (const char * relative_path,
2061 const SGRawValue<double> &rawValue,
2064 return getNode(relative_path, true)->tie(rawValue, useDefault);
2069 * Tie a node reached by a relative path, creating it if necessary.
2072 SGPropertyNode::tie (const char * relative_path,
2073 const SGRawValue<const char *> &rawValue,
2076 return getNode(relative_path, true)->tie(rawValue, useDefault);
2081 * Attempt to untie another node reached by a relative path.
2084 SGPropertyNode::untie (const char * relative_path)
2086 SGPropertyNode * node = getNode(relative_path);
2087 return (node == 0 ? false : node->untie());
2091 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2093 if (_listeners == 0)
2094 _listeners = new vector<SGPropertyChangeListener *>;
2095 _listeners->push_back(listener);
2096 listener->register_property(this);
2100 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2102 vector<SGPropertyChangeListener *>::iterator it =
2103 find(_listeners->begin(), _listeners->end(), listener);
2104 if (it != _listeners->end()) {
2105 _listeners->erase(it);
2106 listener->unregister_property(this);
2107 if (_listeners->empty()) {
2108 vector<SGPropertyChangeListener *> * tmp = _listeners;
2116 SGPropertyNode::fireValueChanged ()
2118 fireValueChanged(this);
2122 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2124 fireChildAdded(this, child);
2128 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2130 fireChildRemoved(this, child);
2134 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2136 if (_listeners != 0) {
2137 for (unsigned int i = 0; i < _listeners->size(); i++) {
2138 (*_listeners)[i]->valueChanged(node);
2142 _parent->fireValueChanged(node);
2146 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2147 SGPropertyNode * child)
2149 if (_listeners != 0) {
2150 for (unsigned int i = 0; i < _listeners->size(); i++) {
2151 (*_listeners)[i]->childAdded(parent, child);
2155 _parent->fireChildAdded(parent, child);
2159 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2160 SGPropertyNode * child)
2162 if (_listeners != 0) {
2163 for (unsigned int i = 0; i < _listeners->size(); i++) {
2164 (*_listeners)[i]->childRemoved(parent, child);
2168 _parent->fireChildRemoved(parent, child);
2173 ////////////////////////////////////////////////////////////////////////
2174 // Simplified hash table for caching paths.
2175 ////////////////////////////////////////////////////////////////////////
2177 #define HASH_TABLE_SIZE 199
2179 SGPropertyNode::hash_table::entry::entry ()
2185 SGPropertyNode::hash_table::entry::~entry ()
2187 // Don't delete the value; we don't own
2193 SGPropertyNode::hash_table::entry::set_key (const char * key)
2195 _key = copy_string(key);
2199 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2204 SGPropertyNode::hash_table::bucket::bucket ()
2210 SGPropertyNode::hash_table::bucket::~bucket ()
2212 for (int i = 0; i < _length; i++)
2216 SGPropertyNode::hash_table::entry *
2217 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2220 for (i = 0; i < _length; i++) {
2221 if (!strcmp(_entries[i]->get_key(), key))
2225 entry ** new_entries = new entry*[_length+1];
2226 for (i = 0; i < _length; i++) {
2227 new_entries[i] = _entries[i];
2230 _entries = new_entries;
2231 _entries[_length] = new entry;
2232 _entries[_length]->set_key(key);
2234 return _entries[_length - 1];
2241 SGPropertyNode::hash_table::bucket::erase (const char * key)
2244 for (i = 0; i < _length; i++) {
2245 if (!strcmp(_entries[i]->get_key(), key))
2250 for (++i; i < _length; i++) {
2251 _entries[i-1] = _entries[i];
2258 SGPropertyNode::hash_table::hash_table ()
2264 SGPropertyNode::hash_table::~hash_table ()
2266 for (unsigned int i = 0; i < _data_length; i++)
2271 SGPropertyNode::hash_table::get (const char * key)
2273 if (_data_length == 0)
2275 unsigned int index = hashcode(key) % _data_length;
2276 if (_data[index] == 0)
2278 entry * e = _data[index]->get_entry(key);
2282 return e->get_value();
2286 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2288 if (_data_length == 0) {
2289 _data = new bucket*[HASH_TABLE_SIZE];
2290 _data_length = HASH_TABLE_SIZE;
2291 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2294 unsigned int index = hashcode(key) % _data_length;
2295 if (_data[index] == 0) {
2296 _data[index] = new bucket;
2298 entry * e = _data[index]->get_entry(key, true);
2299 e->set_value(value);
2303 SGPropertyNode::hash_table::erase (const char * key)
2305 if (_data_length == 0)
2307 unsigned int index = hashcode(key) % _data_length;
2308 if (_data[index] == 0)
2310 _data[index]->erase(key);
2314 SGPropertyNode::hash_table::hashcode (const char * key)
2316 unsigned int hash = 0;
2318 hash = 31 * hash + *key;
2327 * Default constructor
2329 SGPropertyNode_ptr::SGPropertyNode_ptr()
2337 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2341 _ptr->incrementRef();
2345 * Constructor from a pointer to a node
2347 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2351 _ptr->incrementRef();
2357 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2359 if (_ptr && _ptr->decrementRef() == 0)
2364 * Assignement operator
2366 SGPropertyNode_ptr &
2367 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2369 if (_ptr && _ptr->decrementRef() == 0)
2373 _ptr->incrementRef();
2379 * Pointer access operator
2382 SGPropertyNode_ptr::operator->()
2388 * Pointer access operator (const)
2390 const SGPropertyNode *
2391 SGPropertyNode_ptr::operator->() const
2397 * Conversion to SGPropertyNode * operator
2399 SGPropertyNode_ptr::operator SGPropertyNode *()
2405 * Conversion to const SGPropertyNode * operator
2407 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2416 SGPropertyNode_ptr::valid() const
2423 ////////////////////////////////////////////////////////////////////////
2424 // Implementation of SGPropertyChangeListener.
2425 ////////////////////////////////////////////////////////////////////////
2427 SGPropertyChangeListener::~SGPropertyChangeListener ()
2429 // This will come back and remove
2430 // the current item each time. Is
2432 vector<SGPropertyNode *>::iterator it;
2433 for (it = _properties.begin(); it != _properties.end(); it++)
2434 (*it)->removeChangeListener(this);
2438 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2444 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2445 SGPropertyNode * child)
2451 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2452 SGPropertyNode * child)
2458 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2460 _properties.push_back(node);
2464 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2466 vector<SGPropertyNode *>::iterator it =
2467 find(_properties.begin(), _properties.end(), node);
2468 if (it != _properties.end())
2469 _properties.erase(it);