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 * 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);
931 _path_cache->erase(name); // EMH - TODO: Take "index" into account!
932 node->setAttribute(REMOVED, true);
935 fireChildRemoved(node);
942 SGPropertyNode::getDisplayName (bool simplify) const
944 string display = _name;
945 if (_index != 0 || !simplify) {
947 sprintf(buffer, "[%d]", _index);
950 _display_name = copy_string(display.c_str());
951 return _display_name;
956 SGPropertyNode::getPath (bool simplify) const
958 // Calculate the complete path only once.
964 path = _parent->getPath(simplify);
966 path += getDisplayName(simplify);
968 _path = copy_string(path.c_str());
975 SGPropertyNode::getType () const
978 return _value.alias->getType();
985 SGPropertyNode::getBoolValue () const
987 // Shortcut for common case
988 if (_attr == (READ|WRITE) && _type == BOOL)
991 if (getAttribute(TRACE_READ))
993 if (!getAttribute(READ))
994 return SGRawValue<bool>::DefaultValue;
997 return _value.alias->getBoolValue();
1001 return get_int() == 0 ? false : true;
1003 return get_long() == 0L ? false : true;
1005 return get_float() == 0.0 ? false : true;
1007 return get_double() == 0.0L ? false : true;
1010 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1013 return SGRawValue<bool>::DefaultValue;
1018 SGPropertyNode::getIntValue () const
1020 // Shortcut for common case
1021 if (_attr == (READ|WRITE) && _type == INT)
1024 if (getAttribute(TRACE_READ))
1026 if (!getAttribute(READ))
1027 return SGRawValue<int>::DefaultValue;
1030 return _value.alias->getIntValue();
1032 return int(get_bool());
1036 return int(get_long());
1038 return int(get_float());
1040 return int(get_double());
1043 return atoi(get_string());
1046 return SGRawValue<int>::DefaultValue;
1051 SGPropertyNode::getLongValue () const
1053 // Shortcut for common case
1054 if (_attr == (READ|WRITE) && _type == LONG)
1057 if (getAttribute(TRACE_READ))
1059 if (!getAttribute(READ))
1060 return SGRawValue<long>::DefaultValue;
1063 return _value.alias->getLongValue();
1065 return long(get_bool());
1067 return long(get_int());
1071 return long(get_float());
1073 return long(get_double());
1076 return strtol(get_string(), 0, 0);
1079 return SGRawValue<long>::DefaultValue;
1084 SGPropertyNode::getFloatValue () const
1086 // Shortcut for common case
1087 if (_attr == (READ|WRITE) && _type == FLOAT)
1090 if (getAttribute(TRACE_READ))
1092 if (!getAttribute(READ))
1093 return SGRawValue<float>::DefaultValue;
1096 return _value.alias->getFloatValue();
1098 return float(get_bool());
1100 return float(get_int());
1102 return float(get_long());
1106 return float(get_double());
1109 return atof(get_string());
1112 return SGRawValue<float>::DefaultValue;
1117 SGPropertyNode::getDoubleValue () const
1119 // Shortcut for common case
1120 if (_attr == (READ|WRITE) && _type == DOUBLE)
1121 return get_double();
1123 if (getAttribute(TRACE_READ))
1125 if (!getAttribute(READ))
1126 return SGRawValue<double>::DefaultValue;
1130 return _value.alias->getDoubleValue();
1132 return double(get_bool());
1134 return double(get_int());
1136 return double(get_long());
1138 return double(get_float());
1140 return get_double();
1143 return strtod(get_string(), 0);
1146 return SGRawValue<double>::DefaultValue;
1151 SGPropertyNode::getStringValue () const
1153 // Shortcut for common case
1154 if (_attr == (READ|WRITE) && _type == STRING)
1155 return get_string();
1157 if (getAttribute(TRACE_READ))
1159 if (!getAttribute(READ))
1160 return SGRawValue<const char *>::DefaultValue;
1161 return make_string();
1165 SGPropertyNode::setBoolValue (bool value)
1167 // Shortcut for common case
1168 if (_attr == (READ|WRITE) && _type == BOOL)
1169 return set_bool(value);
1171 bool result = false;
1173 if (_type == NONE || _type == UNSPECIFIED) {
1181 result = _value.alias->setBoolValue(value);
1184 result = set_bool(value);
1187 result = set_int(int(value));
1190 result = set_long(long(value));
1193 result = set_float(float(value));
1196 result = set_double(double(value));
1200 result = set_string(value ? "true" : "false");
1207 if (getAttribute(TRACE_WRITE))
1213 SGPropertyNode::setIntValue (int value)
1215 // Shortcut for common case
1216 if (_attr == (READ|WRITE) && _type == INT)
1217 return set_int(value);
1219 bool result = false;
1221 if (_type == NONE || _type == UNSPECIFIED) {
1224 _local_val.int_val = 0;
1229 result = _value.alias->setIntValue(value);
1232 result = set_bool(value == 0 ? false : true);
1235 result = set_int(value);
1238 result = set_long(long(value));
1241 result = set_float(float(value));
1244 result = set_double(double(value));
1249 sprintf(buf, "%d", value);
1250 result = set_string(buf);
1258 if (getAttribute(TRACE_WRITE))
1264 SGPropertyNode::setLongValue (long value)
1266 // Shortcut for common case
1267 if (_attr == (READ|WRITE) && _type == LONG)
1268 return set_long(value);
1270 bool result = false;
1272 if (_type == NONE || _type == UNSPECIFIED) {
1275 _local_val.long_val = 0L;
1280 result = _value.alias->setLongValue(value);
1283 result = set_bool(value == 0L ? false : true);
1286 result = set_int(int(value));
1289 result = set_long(value);
1292 result = set_float(float(value));
1295 result = set_double(double(value));
1300 sprintf(buf, "%ld", value);
1301 result = set_string(buf);
1309 if (getAttribute(TRACE_WRITE))
1315 SGPropertyNode::setFloatValue (float value)
1317 // Shortcut for common case
1318 if (_attr == (READ|WRITE) && _type == FLOAT)
1319 return set_float(value);
1321 bool result = false;
1323 if (_type == NONE || _type == UNSPECIFIED) {
1326 _local_val.float_val = 0;
1331 result = _value.alias->setFloatValue(value);
1334 result = set_bool(value == 0.0 ? false : true);
1337 result = set_int(int(value));
1340 result = set_long(long(value));
1343 result = set_float(value);
1346 result = set_double(double(value));
1351 sprintf(buf, "%f", value);
1352 result = set_string(buf);
1360 if (getAttribute(TRACE_WRITE))
1366 SGPropertyNode::setDoubleValue (double value)
1368 // Shortcut for common case
1369 if (_attr == (READ|WRITE) && _type == DOUBLE)
1370 return set_double(value);
1372 bool result = false;
1374 if (_type == NONE || _type == UNSPECIFIED) {
1376 _local_val.double_val = value;
1382 result = _value.alias->setDoubleValue(value);
1385 result = set_bool(value == 0.0L ? false : true);
1388 result = set_int(int(value));
1391 result = set_long(long(value));
1394 result = set_float(float(value));
1397 result = set_double(value);
1402 sprintf(buf, "%f", value);
1403 result = set_string(buf);
1411 if (getAttribute(TRACE_WRITE))
1417 SGPropertyNode::setStringValue (const char * value)
1419 // Shortcut for common case
1420 if (_attr == (READ|WRITE) && _type == STRING)
1421 return set_string(value);
1423 bool result = false;
1425 if (_type == NONE || _type == UNSPECIFIED) {
1432 result = _value.alias->setStringValue(value);
1435 result = set_bool((compare_strings(value, "true")
1436 || atoi(value)) ? true : false);
1439 result = set_int(atoi(value));
1442 result = set_long(strtol(value, 0, 0));
1445 result = set_float(atof(value));
1448 result = set_double(strtod(value, 0));
1452 result = set_string(value);
1459 if (getAttribute(TRACE_WRITE))
1465 SGPropertyNode::setUnspecifiedValue (const char * value)
1467 bool result = false;
1469 if (_type == NONE) {
1471 _type = UNSPECIFIED;
1476 result = _value.alias->setUnspecifiedValue(value);
1479 result = set_bool((compare_strings(value, "true")
1480 || atoi(value)) ? true : false);
1483 result = set_int(atoi(value));
1486 result = set_long(strtol(value, 0, 0));
1489 result = set_float(atof(value));
1492 result = set_double(strtod(value, 0));
1496 result = set_string(value);
1503 if (getAttribute(TRACE_WRITE))
1509 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1511 if (_type == ALIAS || _tied)
1514 useDefault = useDefault && hasValue();
1515 bool old_val = false;
1517 old_val = getBoolValue();
1522 _value.bool_val = rawValue.clone();
1525 setBoolValue(old_val);
1531 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1533 if (_type == ALIAS || _tied)
1536 useDefault = useDefault && hasValue();
1539 old_val = getIntValue();
1544 _value.int_val = rawValue.clone();
1547 setIntValue(old_val);
1553 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1555 if (_type == ALIAS || _tied)
1558 useDefault = useDefault && hasValue();
1561 old_val = getLongValue();
1566 _value.long_val = rawValue.clone();
1569 setLongValue(old_val);
1575 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1577 if (_type == ALIAS || _tied)
1580 useDefault = useDefault && hasValue();
1581 float old_val = 0.0;
1583 old_val = getFloatValue();
1588 _value.float_val = rawValue.clone();
1591 setFloatValue(old_val);
1597 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1599 if (_type == ALIAS || _tied)
1602 useDefault = useDefault && hasValue();
1603 double old_val = 0.0;
1605 old_val = getDoubleValue();
1610 _value.double_val = rawValue.clone();
1613 setDoubleValue(old_val);
1620 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1622 if (_type == ALIAS || _tied)
1625 useDefault = useDefault && hasValue();
1628 old_val = getStringValue();
1633 _value.string_val = rawValue.clone();
1636 setStringValue(old_val.c_str());
1642 SGPropertyNode::untie ()
1649 bool val = getBoolValue();
1652 _local_val.bool_val = val;
1656 int val = getIntValue();
1659 _local_val.int_val = val;
1663 long val = getLongValue();
1666 _local_val.long_val = val;
1670 float val = getFloatValue();
1673 _local_val.float_val = val;
1677 double val = getDoubleValue();
1680 _local_val.double_val = val;
1685 string val = getStringValue();
1688 _local_val.string_val = copy_string(val.c_str());
1701 SGPropertyNode::getRootNode ()
1706 return _parent->getRootNode();
1709 const SGPropertyNode *
1710 SGPropertyNode::getRootNode () const
1715 return _parent->getRootNode();
1719 SGPropertyNode::getNode (const char * relative_path, bool create)
1721 if (_path_cache == 0)
1722 _path_cache = new hash_table;
1724 SGPropertyNode * result = _path_cache->get(relative_path);
1726 vector<PathComponent> components;
1727 parse_path(relative_path, components);
1728 result = find_node(this, components, 0, create);
1730 _path_cache->put(relative_path, result);
1737 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1739 vector<PathComponent> components;
1740 parse_path(relative_path, components);
1741 if (components.size() > 0)
1742 components.back().index = index;
1743 return find_node(this, components, 0, create);
1746 const SGPropertyNode *
1747 SGPropertyNode::getNode (const char * relative_path) const
1749 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1752 const SGPropertyNode *
1753 SGPropertyNode::getNode (const char * relative_path, int index) const
1755 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1759 ////////////////////////////////////////////////////////////////////////
1760 // Convenience methods using relative paths.
1761 ////////////////////////////////////////////////////////////////////////
1765 * Test whether another node has a value attached.
1768 SGPropertyNode::hasValue (const char * relative_path) const
1770 const SGPropertyNode * node = getNode(relative_path);
1771 return (node == 0 ? false : node->hasValue());
1776 * Get the value type for another node.
1778 SGPropertyNode::Type
1779 SGPropertyNode::getType (const char * relative_path) const
1781 const SGPropertyNode * node = getNode(relative_path);
1782 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1787 * Get a bool value for another node.
1790 SGPropertyNode::getBoolValue (const char * relative_path,
1791 bool defaultValue) const
1793 const SGPropertyNode * node = getNode(relative_path);
1794 return (node == 0 ? defaultValue : node->getBoolValue());
1799 * Get an int value for another node.
1802 SGPropertyNode::getIntValue (const char * relative_path,
1803 int defaultValue) const
1805 const SGPropertyNode * node = getNode(relative_path);
1806 return (node == 0 ? defaultValue : node->getIntValue());
1811 * Get a long value for another node.
1814 SGPropertyNode::getLongValue (const char * relative_path,
1815 long defaultValue) const
1817 const SGPropertyNode * node = getNode(relative_path);
1818 return (node == 0 ? defaultValue : node->getLongValue());
1823 * Get a float value for another node.
1826 SGPropertyNode::getFloatValue (const char * relative_path,
1827 float defaultValue) const
1829 const SGPropertyNode * node = getNode(relative_path);
1830 return (node == 0 ? defaultValue : node->getFloatValue());
1835 * Get a double value for another node.
1838 SGPropertyNode::getDoubleValue (const char * relative_path,
1839 double defaultValue) const
1841 const SGPropertyNode * node = getNode(relative_path);
1842 return (node == 0 ? defaultValue : node->getDoubleValue());
1847 * Get a string value for another node.
1850 SGPropertyNode::getStringValue (const char * relative_path,
1851 const char * defaultValue) const
1853 const SGPropertyNode * node = getNode(relative_path);
1854 return (node == 0 ? defaultValue : node->getStringValue());
1859 * Set a bool value for another node.
1862 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1864 return getNode(relative_path, true)->setBoolValue(value);
1869 * Set an int value for another node.
1872 SGPropertyNode::setIntValue (const char * relative_path, int value)
1874 return getNode(relative_path, true)->setIntValue(value);
1879 * Set a long value for another node.
1882 SGPropertyNode::setLongValue (const char * relative_path, long value)
1884 return getNode(relative_path, true)->setLongValue(value);
1889 * Set a float value for another node.
1892 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1894 return getNode(relative_path, true)->setFloatValue(value);
1899 * Set a double value for another node.
1902 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1904 return getNode(relative_path, true)->setDoubleValue(value);
1909 * Set a string value for another node.
1912 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1914 return getNode(relative_path, true)->setStringValue(value);
1919 * Set an unknown value for another node.
1922 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1925 return getNode(relative_path, true)->setUnspecifiedValue(value);
1930 * Test whether another node is tied.
1933 SGPropertyNode::isTied (const char * relative_path) const
1935 const SGPropertyNode * node = getNode(relative_path);
1936 return (node == 0 ? false : node->isTied());
1941 * Tie a node reached by a relative path, creating it if necessary.
1944 SGPropertyNode::tie (const char * relative_path,
1945 const SGRawValue<bool> &rawValue,
1948 return getNode(relative_path, true)->tie(rawValue, useDefault);
1953 * Tie a node reached by a relative path, creating it if necessary.
1956 SGPropertyNode::tie (const char * relative_path,
1957 const SGRawValue<int> &rawValue,
1960 return getNode(relative_path, true)->tie(rawValue, useDefault);
1965 * Tie a node reached by a relative path, creating it if necessary.
1968 SGPropertyNode::tie (const char * relative_path,
1969 const SGRawValue<long> &rawValue,
1972 return getNode(relative_path, true)->tie(rawValue, useDefault);
1977 * Tie a node reached by a relative path, creating it if necessary.
1980 SGPropertyNode::tie (const char * relative_path,
1981 const SGRawValue<float> &rawValue,
1984 return getNode(relative_path, true)->tie(rawValue, useDefault);
1989 * Tie a node reached by a relative path, creating it if necessary.
1992 SGPropertyNode::tie (const char * relative_path,
1993 const SGRawValue<double> &rawValue,
1996 return getNode(relative_path, true)->tie(rawValue, useDefault);
2001 * Tie a node reached by a relative path, creating it if necessary.
2004 SGPropertyNode::tie (const char * relative_path,
2005 const SGRawValue<const char *> &rawValue,
2008 return getNode(relative_path, true)->tie(rawValue, useDefault);
2013 * Attempt to untie another node reached by a relative path.
2016 SGPropertyNode::untie (const char * relative_path)
2018 SGPropertyNode * node = getNode(relative_path);
2019 return (node == 0 ? false : node->untie());
2023 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener)
2025 if (_listeners == 0)
2026 _listeners = new vector<SGPropertyChangeListener *>;
2027 _listeners->push_back(listener);
2028 listener->register_property(this);
2032 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2034 vector<SGPropertyChangeListener *>::iterator it =
2035 find(_listeners->begin(), _listeners->end(), listener);
2036 if (it != _listeners->end()) {
2037 _listeners->erase(it);
2038 listener->unregister_property(this);
2039 if (_listeners->empty()) {
2040 vector<SGPropertyChangeListener *> * tmp = _listeners;
2048 SGPropertyNode::fireValueChanged ()
2050 fireValueChanged(this);
2054 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2056 fireChildAdded(this, child);
2060 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2062 fireChildRemoved(this, child);
2066 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2068 if (_listeners != 0) {
2069 for (unsigned int i = 0; i < _listeners->size(); i++) {
2070 (*_listeners)[i]->valueChanged(node);
2074 _parent->fireValueChanged(node);
2078 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2079 SGPropertyNode * child)
2081 if (_listeners != 0) {
2082 for (unsigned int i = 0; i < _listeners->size(); i++) {
2083 (*_listeners)[i]->childAdded(parent, child);
2087 _parent->fireChildAdded(parent, child);
2091 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2092 SGPropertyNode * child)
2094 if (_listeners != 0) {
2095 for (unsigned int i = 0; i < _listeners->size(); i++) {
2096 (*_listeners)[i]->childRemoved(parent, child);
2100 _parent->fireChildRemoved(parent, child);
2105 ////////////////////////////////////////////////////////////////////////
2106 // Simplified hash table for caching paths.
2107 ////////////////////////////////////////////////////////////////////////
2109 #define HASH_TABLE_SIZE 199
2111 SGPropertyNode::hash_table::entry::entry ()
2117 SGPropertyNode::hash_table::entry::~entry ()
2119 // Don't delete the value; we don't own
2125 SGPropertyNode::hash_table::entry::set_key (const char * key)
2127 _key = copy_string(key);
2131 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2136 SGPropertyNode::hash_table::bucket::bucket ()
2142 SGPropertyNode::hash_table::bucket::~bucket ()
2144 for (int i = 0; i < _length; i++)
2148 SGPropertyNode::hash_table::entry *
2149 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2152 for (i = 0; i < _length; i++) {
2153 if (!strcmp(_entries[i]->get_key(), key))
2157 entry ** new_entries = new entry*[_length+1];
2158 for (i = 0; i < _length; i++) {
2159 new_entries[i] = _entries[i];
2162 _entries = new_entries;
2163 _entries[_length] = new entry;
2164 _entries[_length]->set_key(key);
2166 return _entries[_length - 1];
2173 SGPropertyNode::hash_table::bucket::erase (const char * key)
2176 for (i = 0; i < _length; i++) {
2177 if (!strcmp(_entries[i]->get_key(), key))
2182 for (++i; i < _length; i++) {
2183 _entries[i-1] = _entries[i];
2190 SGPropertyNode::hash_table::hash_table ()
2196 SGPropertyNode::hash_table::~hash_table ()
2198 for (unsigned int i = 0; i < _data_length; i++)
2203 SGPropertyNode::hash_table::get (const char * key)
2205 if (_data_length == 0)
2207 unsigned int index = hashcode(key) % _data_length;
2208 if (_data[index] == 0)
2210 entry * e = _data[index]->get_entry(key);
2214 return e->get_value();
2218 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2220 if (_data_length == 0) {
2221 _data = new bucket*[HASH_TABLE_SIZE];
2222 _data_length = HASH_TABLE_SIZE;
2223 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2226 unsigned int index = hashcode(key) % _data_length;
2227 if (_data[index] == 0) {
2228 _data[index] = new bucket;
2230 entry * e = _data[index]->get_entry(key, true);
2231 e->set_value(value);
2235 SGPropertyNode::hash_table::erase (const char * key)
2237 if (_data_length == 0)
2239 unsigned int index = hashcode(key) % _data_length;
2240 if (_data[index] == 0)
2242 _data[index]->erase(key);
2246 SGPropertyNode::hash_table::hashcode (const char * key)
2248 unsigned int hash = 0;
2250 hash = 31 * hash + *key;
2259 * Default constructor
2261 SGPropertyNode_ptr::SGPropertyNode_ptr()
2269 SGPropertyNode_ptr::SGPropertyNode_ptr( const SGPropertyNode_ptr &r )
2273 _ptr->incrementRef();
2277 * Constructor from a pointer to a node
2279 SGPropertyNode_ptr::SGPropertyNode_ptr( SGPropertyNode *p )
2283 _ptr->incrementRef();
2289 SGPropertyNode_ptr::~SGPropertyNode_ptr()
2291 if (_ptr && _ptr->decrementRef() == 0)
2296 * Assignement operator
2298 SGPropertyNode_ptr &
2299 SGPropertyNode_ptr::operator=( const SGPropertyNode_ptr &r )
2301 if (_ptr && _ptr->decrementRef() == 0)
2305 _ptr->incrementRef();
2311 * Pointer access operator
2314 SGPropertyNode_ptr::operator->()
2320 * Pointer access operator (const)
2322 const SGPropertyNode *
2323 SGPropertyNode_ptr::operator->() const
2329 * Conversion to SGPropertyNode * operator
2331 SGPropertyNode_ptr::operator SGPropertyNode *()
2337 * Conversion to const SGPropertyNode * operator
2339 SGPropertyNode_ptr::operator const SGPropertyNode *() const
2348 SGPropertyNode_ptr::valid() const
2355 ////////////////////////////////////////////////////////////////////////
2356 // Implementation of SGPropertyChangeListener.
2357 ////////////////////////////////////////////////////////////////////////
2359 SGPropertyChangeListener::~SGPropertyChangeListener ()
2361 // This will come back and remove
2362 // the current item each time. Is
2364 vector<SGPropertyNode *>::iterator it;
2365 for (it = _properties.begin(); it != _properties.end(); it++)
2366 (*it)->removeChangeListener(this);
2370 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2376 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2377 SGPropertyNode * child)
2383 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2384 SGPropertyNode * child)
2390 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2392 _properties.push_back(node);
2396 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2398 vector<SGPropertyNode *>::iterator it =
2399 find(_properties.begin(), _properties.end(), node);
2400 if (it != _properties.end())
2401 _properties.erase(it);