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()) {
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 * 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);
933 fireChildRemoved(node);
940 SGPropertyNode::getDisplayName (bool simplify) const
942 string display = _name;
943 if (_index != 0 || !simplify) {
945 sprintf(buffer, "[%d]", _index);
948 _display_name = copy_string(display.c_str());
949 return _display_name;
954 SGPropertyNode::getPath (bool simplify) const
956 // Calculate the complete path only once.
962 path = _parent->getPath(simplify);
964 path += getDisplayName(simplify);
966 _path = copy_string(path.c_str());
973 SGPropertyNode::getType () const
976 return _value.alias->getType();
983 SGPropertyNode::getBoolValue () const
985 // Shortcut for common case
986 if (_attr == (READ|WRITE) && _type == BOOL)
989 if (getAttribute(TRACE_READ))
991 if (!getAttribute(READ))
992 return SGRawValue<bool>::DefaultValue;
995 return _value.alias->getBoolValue();
999 return get_int() == 0 ? false : true;
1001 return get_long() == 0L ? false : true;
1003 return get_float() == 0.0 ? false : true;
1005 return get_double() == 0.0L ? false : true;
1008 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1011 return SGRawValue<bool>::DefaultValue;
1016 SGPropertyNode::getIntValue () const
1018 // Shortcut for common case
1019 if (_attr == (READ|WRITE) && _type == INT)
1022 if (getAttribute(TRACE_READ))
1024 if (!getAttribute(READ))
1025 return SGRawValue<int>::DefaultValue;
1028 return _value.alias->getIntValue();
1030 return int(get_bool());
1034 return int(get_long());
1036 return int(get_float());
1038 return int(get_double());
1041 return atoi(get_string());
1044 return SGRawValue<int>::DefaultValue;
1049 SGPropertyNode::getLongValue () const
1051 // Shortcut for common case
1052 if (_attr == (READ|WRITE) && _type == LONG)
1055 if (getAttribute(TRACE_READ))
1057 if (!getAttribute(READ))
1058 return SGRawValue<long>::DefaultValue;
1061 return _value.alias->getLongValue();
1063 return long(get_bool());
1065 return long(get_int());
1069 return long(get_float());
1071 return long(get_double());
1074 return strtol(get_string(), 0, 0);
1077 return SGRawValue<long>::DefaultValue;
1082 SGPropertyNode::getFloatValue () const
1084 // Shortcut for common case
1085 if (_attr == (READ|WRITE) && _type == FLOAT)
1088 if (getAttribute(TRACE_READ))
1090 if (!getAttribute(READ))
1091 return SGRawValue<float>::DefaultValue;
1094 return _value.alias->getFloatValue();
1096 return float(get_bool());
1098 return float(get_int());
1100 return float(get_long());
1104 return float(get_double());
1107 return atof(get_string());
1110 return SGRawValue<float>::DefaultValue;
1115 SGPropertyNode::getDoubleValue () const
1117 // Shortcut for common case
1118 if (_attr == (READ|WRITE) && _type == DOUBLE)
1119 return get_double();
1121 if (getAttribute(TRACE_READ))
1123 if (!getAttribute(READ))
1124 return SGRawValue<double>::DefaultValue;
1128 return _value.alias->getDoubleValue();
1130 return double(get_bool());
1132 return double(get_int());
1134 return double(get_long());
1136 return double(get_float());
1138 return get_double();
1141 return strtod(get_string(), 0);
1144 return SGRawValue<double>::DefaultValue;
1149 SGPropertyNode::getStringValue () const
1151 // Shortcut for common case
1152 if (_attr == (READ|WRITE) && _type == STRING)
1153 return get_string();
1155 if (getAttribute(TRACE_READ))
1157 if (!getAttribute(READ))
1158 return SGRawValue<const char *>::DefaultValue;
1159 return make_string();
1163 SGPropertyNode::setBoolValue (bool value)
1165 // Shortcut for common case
1166 if (_attr == (READ|WRITE) && _type == BOOL)
1167 return set_bool(value);
1169 bool result = false;
1171 if (_type == NONE || _type == UNSPECIFIED) {
1179 result = _value.alias->setBoolValue(value);
1182 result = set_bool(value);
1185 result = set_int(int(value));
1188 result = set_long(long(value));
1191 result = set_float(float(value));
1194 result = set_double(double(value));
1198 result = set_string(value ? "true" : "false");
1205 if (getAttribute(TRACE_WRITE))
1211 SGPropertyNode::setIntValue (int value)
1213 // Shortcut for common case
1214 if (_attr == (READ|WRITE) && _type == INT)
1215 return set_int(value);
1217 bool result = false;
1219 if (_type == NONE || _type == UNSPECIFIED) {
1222 _local_val.int_val = 0;
1227 result = _value.alias->setIntValue(value);
1230 result = set_bool(value == 0 ? false : true);
1233 result = set_int(value);
1236 result = set_long(long(value));
1239 result = set_float(float(value));
1242 result = set_double(double(value));
1247 sprintf(buf, "%d", value);
1248 result = set_string(buf);
1256 if (getAttribute(TRACE_WRITE))
1262 SGPropertyNode::setLongValue (long value)
1264 // Shortcut for common case
1265 if (_attr == (READ|WRITE) && _type == LONG)
1266 return set_long(value);
1268 bool result = false;
1270 if (_type == NONE || _type == UNSPECIFIED) {
1273 _local_val.long_val = 0L;
1278 result = _value.alias->setLongValue(value);
1281 result = set_bool(value == 0L ? false : true);
1284 result = set_int(int(value));
1287 result = set_long(value);
1290 result = set_float(float(value));
1293 result = set_double(double(value));
1298 sprintf(buf, "%ld", value);
1299 result = set_string(buf);
1307 if (getAttribute(TRACE_WRITE))
1313 SGPropertyNode::setFloatValue (float value)
1315 // Shortcut for common case
1316 if (_attr == (READ|WRITE) && _type == FLOAT)
1317 return set_float(value);
1319 bool result = false;
1321 if (_type == NONE || _type == UNSPECIFIED) {
1324 _local_val.float_val = 0;
1329 result = _value.alias->setFloatValue(value);
1332 result = set_bool(value == 0.0 ? false : true);
1335 result = set_int(int(value));
1338 result = set_long(long(value));
1341 result = set_float(value);
1344 result = set_double(double(value));
1349 sprintf(buf, "%f", value);
1350 result = set_string(buf);
1358 if (getAttribute(TRACE_WRITE))
1364 SGPropertyNode::setDoubleValue (double value)
1366 // Shortcut for common case
1367 if (_attr == (READ|WRITE) && _type == DOUBLE)
1368 return set_double(value);
1370 bool result = false;
1372 if (_type == NONE || _type == UNSPECIFIED) {
1374 _local_val.double_val = value;
1380 result = _value.alias->setDoubleValue(value);
1383 result = set_bool(value == 0.0L ? false : true);
1386 result = set_int(int(value));
1389 result = set_long(long(value));
1392 result = set_float(float(value));
1395 result = set_double(value);
1400 sprintf(buf, "%f", value);
1401 result = set_string(buf);
1409 if (getAttribute(TRACE_WRITE))
1415 SGPropertyNode::setStringValue (const char * value)
1417 // Shortcut for common case
1418 if (_attr == (READ|WRITE) && _type == STRING)
1419 return set_string(value);
1421 bool result = false;
1423 if (_type == NONE || _type == UNSPECIFIED) {
1430 result = _value.alias->setStringValue(value);
1433 result = set_bool((compare_strings(value, "true")
1434 || atoi(value)) ? true : false);
1437 result = set_int(atoi(value));
1440 result = set_long(strtol(value, 0, 0));
1443 result = set_float(atof(value));
1446 result = set_double(strtod(value, 0));
1450 result = set_string(value);
1457 if (getAttribute(TRACE_WRITE))
1463 SGPropertyNode::setUnspecifiedValue (const char * value)
1465 bool result = false;
1467 if (_type == NONE) {
1469 _type = UNSPECIFIED;
1474 result = _value.alias->setUnspecifiedValue(value);
1477 result = set_bool((compare_strings(value, "true")
1478 || atoi(value)) ? true : false);
1481 result = set_int(atoi(value));
1484 result = set_long(strtol(value, 0, 0));
1487 result = set_float(atof(value));
1490 result = set_double(strtod(value, 0));
1494 result = set_string(value);
1501 if (getAttribute(TRACE_WRITE))
1507 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1509 if (_type == ALIAS || _tied)
1512 useDefault = useDefault && hasValue();
1513 bool old_val = false;
1515 old_val = getBoolValue();
1520 _value.bool_val = rawValue.clone();
1523 setBoolValue(old_val);
1529 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1531 if (_type == ALIAS || _tied)
1534 useDefault = useDefault && hasValue();
1537 old_val = getIntValue();
1542 _value.int_val = rawValue.clone();
1545 setIntValue(old_val);
1551 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1553 if (_type == ALIAS || _tied)
1556 useDefault = useDefault && hasValue();
1559 old_val = getLongValue();
1564 _value.long_val = rawValue.clone();
1567 setLongValue(old_val);
1573 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1575 if (_type == ALIAS || _tied)
1578 useDefault = useDefault && hasValue();
1579 float old_val = 0.0;
1581 old_val = getFloatValue();
1586 _value.float_val = rawValue.clone();
1589 setFloatValue(old_val);
1595 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1597 if (_type == ALIAS || _tied)
1600 useDefault = useDefault && hasValue();
1601 double old_val = 0.0;
1603 old_val = getDoubleValue();
1608 _value.double_val = rawValue.clone();
1611 setDoubleValue(old_val);
1618 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1620 if (_type == ALIAS || _tied)
1623 useDefault = useDefault && hasValue();
1626 old_val = getStringValue();
1631 _value.string_val = rawValue.clone();
1634 setStringValue(old_val.c_str());
1640 SGPropertyNode::untie ()
1647 bool val = getBoolValue();
1650 _local_val.bool_val = val;
1654 int val = getIntValue();
1657 _local_val.int_val = val;
1661 long val = getLongValue();
1664 _local_val.long_val = val;
1668 float val = getFloatValue();
1671 _local_val.float_val = val;
1675 double val = getDoubleValue();
1678 _local_val.double_val = val;
1683 string val = getStringValue();
1686 _local_val.string_val = copy_string(val.c_str());
1699 SGPropertyNode::getRootNode ()
1704 return _parent->getRootNode();
1707 const SGPropertyNode *
1708 SGPropertyNode::getRootNode () const
1713 return _parent->getRootNode();
1717 SGPropertyNode::getNode (const char * relative_path, bool create)
1719 if (_path_cache == 0)
1720 _path_cache = new hash_table;
1722 SGPropertyNode * result = _path_cache->get(relative_path);
1724 vector<PathComponent> components;
1725 parse_path(relative_path, components);
1726 result = find_node(this, components, 0, create);
1728 _path_cache->put(relative_path, result);
1735 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1737 vector<PathComponent> components;
1738 parse_path(relative_path, components);
1739 if (components.size() > 0)
1740 components[components.size()-1].index = index;
1741 return find_node(this, components, 0, create);
1744 const SGPropertyNode *
1745 SGPropertyNode::getNode (const char * relative_path) const
1747 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1750 const SGPropertyNode *
1751 SGPropertyNode::getNode (const char * relative_path, int index) const
1753 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1757 ////////////////////////////////////////////////////////////////////////
1758 // Convenience methods using relative paths.
1759 ////////////////////////////////////////////////////////////////////////
1763 * Test whether another node has a value attached.
1766 SGPropertyNode::hasValue (const char * relative_path) const
1768 const SGPropertyNode * node = getNode(relative_path);
1769 return (node == 0 ? false : node->hasValue());
1774 * Get the value type for another node.
1776 SGPropertyNode::Type
1777 SGPropertyNode::getType (const char * relative_path) const
1779 const SGPropertyNode * node = getNode(relative_path);
1780 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1785 * Get a bool value for another node.
1788 SGPropertyNode::getBoolValue (const char * relative_path,
1789 bool defaultValue) const
1791 const SGPropertyNode * node = getNode(relative_path);
1792 return (node == 0 ? defaultValue : node->getBoolValue());
1797 * Get an int value for another node.
1800 SGPropertyNode::getIntValue (const char * relative_path,
1801 int defaultValue) const
1803 const SGPropertyNode * node = getNode(relative_path);
1804 return (node == 0 ? defaultValue : node->getIntValue());
1809 * Get a long value for another node.
1812 SGPropertyNode::getLongValue (const char * relative_path,
1813 long defaultValue) const
1815 const SGPropertyNode * node = getNode(relative_path);
1816 return (node == 0 ? defaultValue : node->getLongValue());
1821 * Get a float value for another node.
1824 SGPropertyNode::getFloatValue (const char * relative_path,
1825 float defaultValue) const
1827 const SGPropertyNode * node = getNode(relative_path);
1828 return (node == 0 ? defaultValue : node->getFloatValue());
1833 * Get a double value for another node.
1836 SGPropertyNode::getDoubleValue (const char * relative_path,
1837 double defaultValue) const
1839 const SGPropertyNode * node = getNode(relative_path);
1840 return (node == 0 ? defaultValue : node->getDoubleValue());
1845 * Get a string value for another node.
1848 SGPropertyNode::getStringValue (const char * relative_path,
1849 const char * defaultValue) const
1851 const SGPropertyNode * node = getNode(relative_path);
1852 return (node == 0 ? defaultValue : node->getStringValue());
1857 * Set a bool value for another node.
1860 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1862 return getNode(relative_path, true)->setBoolValue(value);
1867 * Set an int value for another node.
1870 SGPropertyNode::setIntValue (const char * relative_path, int value)
1872 return getNode(relative_path, true)->setIntValue(value);
1877 * Set a long value for another node.
1880 SGPropertyNode::setLongValue (const char * relative_path, long value)
1882 return getNode(relative_path, true)->setLongValue(value);
1887 * Set a float value for another node.
1890 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1892 return getNode(relative_path, true)->setFloatValue(value);
1897 * Set a double value for another node.
1900 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1902 return getNode(relative_path, true)->setDoubleValue(value);
1907 * Set a string value for another node.
1910 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1912 return getNode(relative_path, true)->setStringValue(value);
1917 * Set an unknown value for another node.
1920 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1923 return getNode(relative_path, true)->setUnspecifiedValue(value);
1928 * Test whether another node is tied.
1931 SGPropertyNode::isTied (const char * relative_path) const
1933 const SGPropertyNode * node = getNode(relative_path);
1934 return (node == 0 ? false : node->isTied());
1939 * Tie a node reached by a relative path, creating it if necessary.
1942 SGPropertyNode::tie (const char * relative_path,
1943 const SGRawValue<bool> &rawValue,
1946 return getNode(relative_path, true)->tie(rawValue, useDefault);
1951 * Tie a node reached by a relative path, creating it if necessary.
1954 SGPropertyNode::tie (const char * relative_path,
1955 const SGRawValue<int> &rawValue,
1958 return getNode(relative_path, true)->tie(rawValue, useDefault);
1963 * Tie a node reached by a relative path, creating it if necessary.
1966 SGPropertyNode::tie (const char * relative_path,
1967 const SGRawValue<long> &rawValue,
1970 return getNode(relative_path, true)->tie(rawValue, useDefault);
1975 * Tie a node reached by a relative path, creating it if necessary.
1978 SGPropertyNode::tie (const char * relative_path,
1979 const SGRawValue<float> &rawValue,
1982 return getNode(relative_path, true)->tie(rawValue, useDefault);
1987 * Tie a node reached by a relative path, creating it if necessary.
1990 SGPropertyNode::tie (const char * relative_path,
1991 const SGRawValue<double> &rawValue,
1994 return getNode(relative_path, true)->tie(rawValue, useDefault);
1999 * Tie a node reached by a relative path, creating it if necessary.
2002 SGPropertyNode::tie (const char * relative_path,
2003 const SGRawValue<const char *> &rawValue,
2006 return getNode(relative_path, true)->tie(rawValue, useDefault);
2011 * Attempt to untie another node reached by a relative path.
2014 SGPropertyNode::untie (const char * relative_path)
2016 SGPropertyNode * node = getNode(relative_path);
2017 return (node == 0 ? false : node->untie());
2021 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2023 if (_listeners == 0)
2024 _listeners = new vector<SGPropertyChangeListener *>;
2025 _listeners->push_back(listener);
2026 listener->register_property(this);
2030 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2032 vector<SGPropertyChangeListener *>::iterator it =
2033 find(_listeners->begin(), _listeners->end(), listener);
2034 if (it != _listeners->end()) {
2035 _listeners->erase(it);
2036 listener->unregister_property(this);
2037 if (_listeners->empty()) {
2038 vector<SGPropertyChangeListener *> * tmp = _listeners;
2046 SGPropertyNode::fireValueChanged ()
2048 fireValueChanged(this);
2052 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2054 fireChildAdded(this, child);
2058 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2060 fireChildRemoved(this, child);
2064 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2066 if (_listeners != 0) {
2067 for (unsigned int i = 0; i < _listeners->size(); i++) {
2068 (*_listeners)[i]->valueChanged(node);
2072 _parent->fireValueChanged(node);
2076 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2077 SGPropertyNode * child)
2079 if (_listeners != 0) {
2080 for (unsigned int i = 0; i < _listeners->size(); i++) {
2081 (*_listeners)[i]->childAdded(parent, child);
2085 _parent->fireChildAdded(parent, child);
2089 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2090 SGPropertyNode * child)
2092 if (_listeners != 0) {
2093 for (unsigned int i = 0; i < _listeners->size(); i++) {
2094 (*_listeners)[i]->childRemoved(parent, child);
2098 _parent->fireChildRemoved(parent, child);
2103 ////////////////////////////////////////////////////////////////////////
2104 // Simplified hash table for caching paths.
2105 ////////////////////////////////////////////////////////////////////////
2107 #define HASH_TABLE_SIZE 199
2109 SGPropertyNode::hash_table::entry::entry ()
2115 SGPropertyNode::hash_table::entry::~entry ()
2117 // Don't delete the value; we don't own
2123 SGPropertyNode::hash_table::entry::set_key (const char * key)
2125 _key = copy_string(key);
2129 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2134 SGPropertyNode::hash_table::bucket::bucket ()
2140 SGPropertyNode::hash_table::bucket::~bucket ()
2142 for (int i = 0; i < _length; i++)
2146 SGPropertyNode::hash_table::entry *
2147 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2150 for (i = 0; i < _length; i++) {
2151 if (!strcmp(_entries[i]->get_key(), key))
2155 entry ** new_entries = new entry*[_length+1];
2156 for (i = 0; i < _length; i++) {
2157 new_entries[i] = _entries[i];
2160 _entries = new_entries;
2161 _entries[_length] = new entry;
2162 _entries[_length]->set_key(key);
2164 return _entries[_length - 1];
2171 SGPropertyNode::hash_table::hash_table ()
2177 SGPropertyNode::hash_table::~hash_table ()
2179 for (unsigned int i = 0; i < _data_length; i++)
2184 SGPropertyNode::hash_table::get (const char * key)
2186 if (_data_length == 0)
2188 unsigned int index = hashcode(key) % _data_length;
2189 if (_data[index] == 0)
2191 entry * e = _data[index]->get_entry(key);
2195 return e->get_value();
2199 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2201 if (_data_length == 0) {
2202 _data = new bucket*[HASH_TABLE_SIZE];
2203 _data_length = HASH_TABLE_SIZE;
2204 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2207 unsigned int index = hashcode(key) % _data_length;
2208 if (_data[index] == 0) {
2209 _data[index] = new bucket;
2211 entry * e = _data[index]->get_entry(key, true);
2212 e->set_value(value);
2216 SGPropertyNode::hash_table::hashcode (const char * key)
2218 unsigned int hash = 0;
2220 hash = 31 * hash + *key;
2229 * Default constructor
2231 SGPropertyNode_ptr::SGPropertyNode_ptr()
2239 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2243 _ptr->incrementRef();
2247 * Constructor from a pointer to a node
2249 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2253 _ptr->incrementRef();
2259 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2261 if (_ptr && _ptr->decrementRef() == 0)
2266 * Assignement operator
2268 SGPropertyNode_ptr &
2269 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2271 if (_ptr && _ptr->decrementRef() == 0)
2275 _ptr->incrementRef();
2281 * Pointer access operator
2284 SGPropertyNode_ptr::operator->()
2290 * Pointer access operator (const)
2292 const SGPropertyNode *
2293 SGPropertyNode_ptr::operator->() const
2299 * Conversion to SGPropertyNode * operator
2301 SGPropertyNode_ptr::operator SGPropertyNode *()
2307 * Conversion to const SGPropertyNode * operator
2309 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2318 SGPropertyNode_ptr::valid() const
2325 ////////////////////////////////////////////////////////////////////////
2326 // Implementation of SGPropertyChangeListener.
2327 ////////////////////////////////////////////////////////////////////////
2329 SGPropertyChangeListener::~SGPropertyChangeListener ()
2331 // This will come back and remove
2332 // the current item each time. Is
2334 vector<SGPropertyNode *>::iterator it;
2335 for (it = _properties.begin(); it != _properties.end(); it++)
2336 (*it)->removeChangeListener(this);
2340 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2346 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2347 SGPropertyNode * child)
2353 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2354 SGPropertyNode * child)
2360 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2362 _properties.push_back(node);
2366 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2368 vector<SGPropertyNode *>::iterator it =
2369 find(_properties.begin(), _properties.end(), node);
2370 if (it != _properties.end())
2371 _properties.erase(it);