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;
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 * Revove child by position.
918 SGPropertyNode::removeChild (int pos, bool keep)
920 SGPropertyNode_ptr node;
921 if (pos < 0 || pos > _children.size() - 1)
924 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
926 node = _children[pos];
929 _removedChildren.push_back(node);
932 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
933 node->setAttribute(REMOVED, true);
935 fireChildRemoved(node);
941 * Remove a child node
944 SGPropertyNode::removeChild (const char * name, int index, bool keep)
946 SGPropertyNode_ptr ret;
947 int pos = find_child(name, index, _children);
949 ret = removeChild(pos, keep);
955 * Remove all children with the specified name.
957 vector<SGPropertyNode_ptr>
958 SGPropertyNode::removeChildren (const char * name, bool keep)
960 vector<SGPropertyNode_ptr> children;
962 for (int pos = _children.size() - 1; pos >= 0; pos--)
963 if (compare_strings(_children[pos]->getName(), name))
964 children.push_back(removeChild(pos, keep));
966 sort(children.begin(), children.end(), CompareIndices());
972 SGPropertyNode::getDisplayName (bool simplify) const
974 string display = _name;
975 if (_index != 0 || !simplify) {
977 sprintf(buffer, "[%d]", _index);
980 _display_name = copy_string(display.c_str());
981 return _display_name;
986 SGPropertyNode::getPath (bool simplify) const
988 // Calculate the complete path only once.
994 path = _parent->getPath(simplify);
996 path += getDisplayName(simplify);
998 _path = copy_string(path.c_str());
1004 SGPropertyNode::Type
1005 SGPropertyNode::getType () const
1008 return _value.alias->getType();
1015 SGPropertyNode::getBoolValue () const
1017 // Shortcut for common case
1018 if (_attr == (READ|WRITE) && _type == BOOL)
1021 if (getAttribute(TRACE_READ))
1023 if (!getAttribute(READ))
1024 return SGRawValue<bool>::DefaultValue;
1027 return _value.alias->getBoolValue();
1031 return get_int() == 0 ? false : true;
1033 return get_long() == 0L ? false : true;
1035 return get_float() == 0.0 ? false : true;
1037 return get_double() == 0.0L ? false : true;
1040 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1043 return SGRawValue<bool>::DefaultValue;
1048 SGPropertyNode::getIntValue () const
1050 // Shortcut for common case
1051 if (_attr == (READ|WRITE) && _type == INT)
1054 if (getAttribute(TRACE_READ))
1056 if (!getAttribute(READ))
1057 return SGRawValue<int>::DefaultValue;
1060 return _value.alias->getIntValue();
1062 return int(get_bool());
1066 return int(get_long());
1068 return int(get_float());
1070 return int(get_double());
1073 return atoi(get_string());
1076 return SGRawValue<int>::DefaultValue;
1081 SGPropertyNode::getLongValue () const
1083 // Shortcut for common case
1084 if (_attr == (READ|WRITE) && _type == LONG)
1087 if (getAttribute(TRACE_READ))
1089 if (!getAttribute(READ))
1090 return SGRawValue<long>::DefaultValue;
1093 return _value.alias->getLongValue();
1095 return long(get_bool());
1097 return long(get_int());
1101 return long(get_float());
1103 return long(get_double());
1106 return strtol(get_string(), 0, 0);
1109 return SGRawValue<long>::DefaultValue;
1114 SGPropertyNode::getFloatValue () const
1116 // Shortcut for common case
1117 if (_attr == (READ|WRITE) && _type == FLOAT)
1120 if (getAttribute(TRACE_READ))
1122 if (!getAttribute(READ))
1123 return SGRawValue<float>::DefaultValue;
1126 return _value.alias->getFloatValue();
1128 return float(get_bool());
1130 return float(get_int());
1132 return float(get_long());
1136 return float(get_double());
1139 return atof(get_string());
1142 return SGRawValue<float>::DefaultValue;
1147 SGPropertyNode::getDoubleValue () const
1149 // Shortcut for common case
1150 if (_attr == (READ|WRITE) && _type == DOUBLE)
1151 return get_double();
1153 if (getAttribute(TRACE_READ))
1155 if (!getAttribute(READ))
1156 return SGRawValue<double>::DefaultValue;
1160 return _value.alias->getDoubleValue();
1162 return double(get_bool());
1164 return double(get_int());
1166 return double(get_long());
1168 return double(get_float());
1170 return get_double();
1173 return strtod(get_string(), 0);
1176 return SGRawValue<double>::DefaultValue;
1181 SGPropertyNode::getStringValue () const
1183 // Shortcut for common case
1184 if (_attr == (READ|WRITE) && _type == STRING)
1185 return get_string();
1187 if (getAttribute(TRACE_READ))
1189 if (!getAttribute(READ))
1190 return SGRawValue<const char *>::DefaultValue;
1191 return make_string();
1195 SGPropertyNode::setBoolValue (bool value)
1197 // Shortcut for common case
1198 if (_attr == (READ|WRITE) && _type == BOOL)
1199 return set_bool(value);
1201 bool result = false;
1203 if (_type == NONE || _type == UNSPECIFIED) {
1211 result = _value.alias->setBoolValue(value);
1214 result = set_bool(value);
1217 result = set_int(int(value));
1220 result = set_long(long(value));
1223 result = set_float(float(value));
1226 result = set_double(double(value));
1230 result = set_string(value ? "true" : "false");
1237 if (getAttribute(TRACE_WRITE))
1243 SGPropertyNode::setIntValue (int value)
1245 // Shortcut for common case
1246 if (_attr == (READ|WRITE) && _type == INT)
1247 return set_int(value);
1249 bool result = false;
1251 if (_type == NONE || _type == UNSPECIFIED) {
1254 _local_val.int_val = 0;
1259 result = _value.alias->setIntValue(value);
1262 result = set_bool(value == 0 ? false : true);
1265 result = set_int(value);
1268 result = set_long(long(value));
1271 result = set_float(float(value));
1274 result = set_double(double(value));
1279 sprintf(buf, "%d", value);
1280 result = set_string(buf);
1288 if (getAttribute(TRACE_WRITE))
1294 SGPropertyNode::setLongValue (long value)
1296 // Shortcut for common case
1297 if (_attr == (READ|WRITE) && _type == LONG)
1298 return set_long(value);
1300 bool result = false;
1302 if (_type == NONE || _type == UNSPECIFIED) {
1305 _local_val.long_val = 0L;
1310 result = _value.alias->setLongValue(value);
1313 result = set_bool(value == 0L ? false : true);
1316 result = set_int(int(value));
1319 result = set_long(value);
1322 result = set_float(float(value));
1325 result = set_double(double(value));
1330 sprintf(buf, "%ld", value);
1331 result = set_string(buf);
1339 if (getAttribute(TRACE_WRITE))
1345 SGPropertyNode::setFloatValue (float value)
1347 // Shortcut for common case
1348 if (_attr == (READ|WRITE) && _type == FLOAT)
1349 return set_float(value);
1351 bool result = false;
1353 if (_type == NONE || _type == UNSPECIFIED) {
1356 _local_val.float_val = 0;
1361 result = _value.alias->setFloatValue(value);
1364 result = set_bool(value == 0.0 ? false : true);
1367 result = set_int(int(value));
1370 result = set_long(long(value));
1373 result = set_float(value);
1376 result = set_double(double(value));
1381 sprintf(buf, "%f", value);
1382 result = set_string(buf);
1390 if (getAttribute(TRACE_WRITE))
1396 SGPropertyNode::setDoubleValue (double value)
1398 // Shortcut for common case
1399 if (_attr == (READ|WRITE) && _type == DOUBLE)
1400 return set_double(value);
1402 bool result = false;
1404 if (_type == NONE || _type == UNSPECIFIED) {
1406 _local_val.double_val = value;
1412 result = _value.alias->setDoubleValue(value);
1415 result = set_bool(value == 0.0L ? false : true);
1418 result = set_int(int(value));
1421 result = set_long(long(value));
1424 result = set_float(float(value));
1427 result = set_double(value);
1432 sprintf(buf, "%f", value);
1433 result = set_string(buf);
1441 if (getAttribute(TRACE_WRITE))
1447 SGPropertyNode::setStringValue (const char * value)
1449 // Shortcut for common case
1450 if (_attr == (READ|WRITE) && _type == STRING)
1451 return set_string(value);
1453 bool result = false;
1455 if (_type == NONE || _type == UNSPECIFIED) {
1462 result = _value.alias->setStringValue(value);
1465 result = set_bool((compare_strings(value, "true")
1466 || atoi(value)) ? true : false);
1469 result = set_int(atoi(value));
1472 result = set_long(strtol(value, 0, 0));
1475 result = set_float(atof(value));
1478 result = set_double(strtod(value, 0));
1482 result = set_string(value);
1489 if (getAttribute(TRACE_WRITE))
1495 SGPropertyNode::setUnspecifiedValue (const char * value)
1497 bool result = false;
1499 if (_type == NONE) {
1501 _type = UNSPECIFIED;
1506 result = _value.alias->setUnspecifiedValue(value);
1509 result = set_bool((compare_strings(value, "true")
1510 || atoi(value)) ? true : false);
1513 result = set_int(atoi(value));
1516 result = set_long(strtol(value, 0, 0));
1519 result = set_float(atof(value));
1522 result = set_double(strtod(value, 0));
1526 result = set_string(value);
1533 if (getAttribute(TRACE_WRITE))
1539 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1541 if (_type == ALIAS || _tied)
1544 useDefault = useDefault && hasValue();
1545 bool old_val = false;
1547 old_val = getBoolValue();
1552 _value.bool_val = rawValue.clone();
1555 setBoolValue(old_val);
1561 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1563 if (_type == ALIAS || _tied)
1566 useDefault = useDefault && hasValue();
1569 old_val = getIntValue();
1574 _value.int_val = rawValue.clone();
1577 setIntValue(old_val);
1583 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1585 if (_type == ALIAS || _tied)
1588 useDefault = useDefault && hasValue();
1591 old_val = getLongValue();
1596 _value.long_val = rawValue.clone();
1599 setLongValue(old_val);
1605 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1607 if (_type == ALIAS || _tied)
1610 useDefault = useDefault && hasValue();
1611 float old_val = 0.0;
1613 old_val = getFloatValue();
1618 _value.float_val = rawValue.clone();
1621 setFloatValue(old_val);
1627 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1629 if (_type == ALIAS || _tied)
1632 useDefault = useDefault && hasValue();
1633 double old_val = 0.0;
1635 old_val = getDoubleValue();
1640 _value.double_val = rawValue.clone();
1643 setDoubleValue(old_val);
1650 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1652 if (_type == ALIAS || _tied)
1655 useDefault = useDefault && hasValue();
1658 old_val = getStringValue();
1663 _value.string_val = rawValue.clone();
1666 setStringValue(old_val.c_str());
1672 SGPropertyNode::untie ()
1679 bool val = getBoolValue();
1682 _local_val.bool_val = val;
1686 int val = getIntValue();
1689 _local_val.int_val = val;
1693 long val = getLongValue();
1696 _local_val.long_val = val;
1700 float val = getFloatValue();
1703 _local_val.float_val = val;
1707 double val = getDoubleValue();
1710 _local_val.double_val = val;
1715 string val = getStringValue();
1718 _local_val.string_val = copy_string(val.c_str());
1731 SGPropertyNode::getRootNode ()
1736 return _parent->getRootNode();
1739 const SGPropertyNode *
1740 SGPropertyNode::getRootNode () const
1745 return _parent->getRootNode();
1749 SGPropertyNode::getNode (const char * relative_path, bool create)
1751 if (_path_cache == 0)
1752 _path_cache = new hash_table;
1754 SGPropertyNode * result = _path_cache->get(relative_path);
1756 vector<PathComponent> components;
1757 parse_path(relative_path, components);
1758 result = find_node(this, components, 0, create);
1760 _path_cache->put(relative_path, result);
1767 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1769 vector<PathComponent> components;
1770 parse_path(relative_path, components);
1771 if (components.size() > 0)
1772 components.back().index = index;
1773 return find_node(this, components, 0, create);
1776 const SGPropertyNode *
1777 SGPropertyNode::getNode (const char * relative_path) const
1779 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1782 const SGPropertyNode *
1783 SGPropertyNode::getNode (const char * relative_path, int index) const
1785 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1789 ////////////////////////////////////////////////////////////////////////
1790 // Convenience methods using relative paths.
1791 ////////////////////////////////////////////////////////////////////////
1795 * Test whether another node has a value attached.
1798 SGPropertyNode::hasValue (const char * relative_path) const
1800 const SGPropertyNode * node = getNode(relative_path);
1801 return (node == 0 ? false : node->hasValue());
1806 * Get the value type for another node.
1808 SGPropertyNode::Type
1809 SGPropertyNode::getType (const char * relative_path) const
1811 const SGPropertyNode * node = getNode(relative_path);
1812 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1817 * Get a bool value for another node.
1820 SGPropertyNode::getBoolValue (const char * relative_path,
1821 bool defaultValue) const
1823 const SGPropertyNode * node = getNode(relative_path);
1824 return (node == 0 ? defaultValue : node->getBoolValue());
1829 * Get an int value for another node.
1832 SGPropertyNode::getIntValue (const char * relative_path,
1833 int defaultValue) const
1835 const SGPropertyNode * node = getNode(relative_path);
1836 return (node == 0 ? defaultValue : node->getIntValue());
1841 * Get a long value for another node.
1844 SGPropertyNode::getLongValue (const char * relative_path,
1845 long defaultValue) const
1847 const SGPropertyNode * node = getNode(relative_path);
1848 return (node == 0 ? defaultValue : node->getLongValue());
1853 * Get a float value for another node.
1856 SGPropertyNode::getFloatValue (const char * relative_path,
1857 float defaultValue) const
1859 const SGPropertyNode * node = getNode(relative_path);
1860 return (node == 0 ? defaultValue : node->getFloatValue());
1865 * Get a double value for another node.
1868 SGPropertyNode::getDoubleValue (const char * relative_path,
1869 double defaultValue) const
1871 const SGPropertyNode * node = getNode(relative_path);
1872 return (node == 0 ? defaultValue : node->getDoubleValue());
1877 * Get a string value for another node.
1880 SGPropertyNode::getStringValue (const char * relative_path,
1881 const char * defaultValue) const
1883 const SGPropertyNode * node = getNode(relative_path);
1884 return (node == 0 ? defaultValue : node->getStringValue());
1889 * Set a bool value for another node.
1892 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1894 return getNode(relative_path, true)->setBoolValue(value);
1899 * Set an int value for another node.
1902 SGPropertyNode::setIntValue (const char * relative_path, int value)
1904 return getNode(relative_path, true)->setIntValue(value);
1909 * Set a long value for another node.
1912 SGPropertyNode::setLongValue (const char * relative_path, long value)
1914 return getNode(relative_path, true)->setLongValue(value);
1919 * Set a float value for another node.
1922 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1924 return getNode(relative_path, true)->setFloatValue(value);
1929 * Set a double value for another node.
1932 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1934 return getNode(relative_path, true)->setDoubleValue(value);
1939 * Set a string value for another node.
1942 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1944 return getNode(relative_path, true)->setStringValue(value);
1949 * Set an unknown value for another node.
1952 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1955 return getNode(relative_path, true)->setUnspecifiedValue(value);
1960 * Test whether another node is tied.
1963 SGPropertyNode::isTied (const char * relative_path) const
1965 const SGPropertyNode * node = getNode(relative_path);
1966 return (node == 0 ? false : node->isTied());
1971 * Tie a node reached by a relative path, creating it if necessary.
1974 SGPropertyNode::tie (const char * relative_path,
1975 const SGRawValue<bool> &rawValue,
1978 return getNode(relative_path, true)->tie(rawValue, useDefault);
1983 * Tie a node reached by a relative path, creating it if necessary.
1986 SGPropertyNode::tie (const char * relative_path,
1987 const SGRawValue<int> &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<long> &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<float> &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<double> &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<const char *> &rawValue,
2038 return getNode(relative_path, true)->tie(rawValue, useDefault);
2043 * Attempt to untie another node reached by a relative path.
2046 SGPropertyNode::untie (const char * relative_path)
2048 SGPropertyNode * node = getNode(relative_path);
2049 return (node == 0 ? false : node->untie());
2053 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2055 if (_listeners == 0)
2056 _listeners = new vector<SGPropertyChangeListener *>;
2057 _listeners->push_back(listener);
2058 listener->register_property(this);
2062 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2064 vector<SGPropertyChangeListener *>::iterator it =
2065 find(_listeners->begin(), _listeners->end(), listener);
2066 if (it != _listeners->end()) {
2067 _listeners->erase(it);
2068 listener->unregister_property(this);
2069 if (_listeners->empty()) {
2070 vector<SGPropertyChangeListener *> * tmp = _listeners;
2078 SGPropertyNode::fireValueChanged ()
2080 fireValueChanged(this);
2084 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2086 fireChildAdded(this, child);
2090 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2092 fireChildRemoved(this, child);
2096 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2098 if (_listeners != 0) {
2099 for (unsigned int i = 0; i < _listeners->size(); i++) {
2100 (*_listeners)[i]->valueChanged(node);
2104 _parent->fireValueChanged(node);
2108 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2109 SGPropertyNode * child)
2111 if (_listeners != 0) {
2112 for (unsigned int i = 0; i < _listeners->size(); i++) {
2113 (*_listeners)[i]->childAdded(parent, child);
2117 _parent->fireChildAdded(parent, child);
2121 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2122 SGPropertyNode * child)
2124 if (_listeners != 0) {
2125 for (unsigned int i = 0; i < _listeners->size(); i++) {
2126 (*_listeners)[i]->childRemoved(parent, child);
2130 _parent->fireChildRemoved(parent, child);
2135 ////////////////////////////////////////////////////////////////////////
2136 // Simplified hash table for caching paths.
2137 ////////////////////////////////////////////////////////////////////////
2139 #define HASH_TABLE_SIZE 199
2141 SGPropertyNode::hash_table::entry::entry ()
2147 SGPropertyNode::hash_table::entry::~entry ()
2149 // Don't delete the value; we don't own
2155 SGPropertyNode::hash_table::entry::set_key (const char * key)
2157 _key = copy_string(key);
2161 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2166 SGPropertyNode::hash_table::bucket::bucket ()
2172 SGPropertyNode::hash_table::bucket::~bucket ()
2174 for (int i = 0; i < _length; i++)
2179 SGPropertyNode::hash_table::entry *
2180 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2183 for (i = 0; i < _length; i++) {
2184 if (!strcmp(_entries[i]->get_key(), key))
2188 entry ** new_entries = new entry*[_length+1];
2189 for (i = 0; i < _length; i++) {
2190 new_entries[i] = _entries[i];
2193 _entries = new_entries;
2194 _entries[_length] = new entry;
2195 _entries[_length]->set_key(key);
2197 return _entries[_length - 1];
2204 SGPropertyNode::hash_table::bucket::erase (const char * key)
2207 for (i = 0; i < _length; i++) {
2208 if (!strcmp(_entries[i]->get_key(), key))
2213 for (++i; i < _length; i++) {
2214 _entries[i-1] = _entries[i];
2221 SGPropertyNode::hash_table::hash_table ()
2227 SGPropertyNode::hash_table::~hash_table ()
2229 for (unsigned int i = 0; i < _data_length; i++)
2235 SGPropertyNode::hash_table::get (const char * key)
2237 if (_data_length == 0)
2239 unsigned int index = hashcode(key) % _data_length;
2240 if (_data[index] == 0)
2242 entry * e = _data[index]->get_entry(key);
2246 return e->get_value();
2250 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2252 if (_data_length == 0) {
2253 _data = new bucket*[HASH_TABLE_SIZE];
2254 _data_length = HASH_TABLE_SIZE;
2255 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2258 unsigned int index = hashcode(key) % _data_length;
2259 if (_data[index] == 0) {
2260 _data[index] = new bucket;
2262 entry * e = _data[index]->get_entry(key, true);
2263 e->set_value(value);
2267 SGPropertyNode::hash_table::erase (const char * key)
2269 if (_data_length == 0)
2271 unsigned int index = hashcode(key) % _data_length;
2272 if (_data[index] == 0)
2274 _data[index]->erase(key);
2278 SGPropertyNode::hash_table::hashcode (const char * key)
2280 unsigned int hash = 0;
2282 hash = 31 * hash + *key;
2291 * Default constructor
2293 SGPropertyNode_ptr::SGPropertyNode_ptr()
2301 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2305 _ptr->incrementRef();
2309 * Constructor from a pointer to a node
2311 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2315 _ptr->incrementRef();
2321 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2323 if (_ptr && _ptr->decrementRef() == 0)
2328 * Assignement operator
2330 SGPropertyNode_ptr &
2331 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2333 if (_ptr && _ptr->decrementRef() == 0)
2337 _ptr->incrementRef();
2343 * Pointer access operator
2346 SGPropertyNode_ptr::operator->()
2352 * Pointer access operator (const)
2354 const SGPropertyNode *
2355 SGPropertyNode_ptr::operator->() const
2361 * Conversion to SGPropertyNode * operator
2363 SGPropertyNode_ptr::operator SGPropertyNode *()
2369 * Conversion to const SGPropertyNode * operator
2371 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2380 SGPropertyNode_ptr::valid() const
2387 ////////////////////////////////////////////////////////////////////////
2388 // Implementation of SGPropertyChangeListener.
2389 ////////////////////////////////////////////////////////////////////////
2391 SGPropertyChangeListener::~SGPropertyChangeListener ()
2393 // This will come back and remove
2394 // the current item each time. Is
2396 vector<SGPropertyNode *>::iterator it;
2397 for (it = _properties.begin(); it != _properties.end(); it++)
2398 (*it)->removeChangeListener(this);
2402 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2408 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2409 SGPropertyNode * child)
2415 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2416 SGPropertyNode * child)
2422 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2424 _properties.push_back(node);
2428 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2430 vector<SGPropertyNode *>::iterator it =
2431 find(_properties.begin(), _properties.end(), node);
2432 if (it != _properties.end())
2433 _properties.erase(it);