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].
24 using std::stringstream;
28 #include <simgear/compiler.h>
29 #include <simgear/debug/logstream.hxx>
34 SG_USING_STD(stringstream);
36 #if ( _MSC_VER == 1200 )
37 // MSVC 6 is buggy, and needs something strange here
38 SG_USING_STD(vector<SGPropertyNode_ptr>);
39 SG_USING_STD(vector<SGPropertyChangeListener *>);
40 SG_USING_STD(vector<SGPropertyNode *>);
47 ////////////////////////////////////////////////////////////////////////
49 ////////////////////////////////////////////////////////////////////////
52 * Comparator class for sorting by index.
57 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
58 return (n1->getIndex() < n2->getIndex());
64 ////////////////////////////////////////////////////////////////////////
65 // Convenience macros for value access.
66 ////////////////////////////////////////////////////////////////////////
68 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
69 #define TEST_WRITE if (!getAttribute(WRITE)) return false
73 ////////////////////////////////////////////////////////////////////////
74 // Default values for every type.
75 ////////////////////////////////////////////////////////////////////////
77 template<> const bool SGRawValue<bool>::DefaultValue = false;
78 template<> const int SGRawValue<int>::DefaultValue = 0;
79 template<> const long SGRawValue<long>::DefaultValue = 0L;
80 template<> const float SGRawValue<float>::DefaultValue = 0.0;
81 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
82 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
86 ////////////////////////////////////////////////////////////////////////
87 // Local path normalization code.
88 ////////////////////////////////////////////////////////////////////////
91 * A component in a path.
100 * Parse the name for a path component.
102 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
104 static inline const string
105 parse_name (const string &path, int &i)
108 int max = path.size();
110 if (path[i] == '.') {
112 if (i < max && path[i] == '.') {
118 if (i < max && path[i] != '/')
119 throw string("Illegal character after " + name);
122 else if (isalpha(path[i]) || path[i] == '_') {
126 // The rules inside a name are a little
129 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
130 path[i] == '-' || path[i] == '.') {
132 } else if (path[i] == '[' || path[i] == '/') {
135 throw string("name may contain only ._- and alphanumeric characters");
142 if (name.size() == 0)
143 throw string("name must begin with alpha or '_'");
151 * Parse the optional integer index for a path component.
153 * Index: "[" [0-9]+ "]"
156 parse_index (const string &path, int &i)
165 for (int max = path.size(); i < max; i++) {
166 if (isdigit(path[i])) {
167 index = (index * 10) + (path[i] - '0');
168 } else if (path[i] == ']') {
176 throw string("unterminated index (looking for ']')");
181 * Parse a single path component.
183 * Component: Name Index?
185 static inline PathComponent
186 parse_component (const string &path, int &i)
188 PathComponent component;
189 component.name = parse_name(path, i);
190 if (component.name[0] != '.')
191 component.index = parse_index(path, i);
193 component.index = -1;
199 * Parse a path into its components.
202 parse_path (const string &path, vector<PathComponent> &components)
205 int max = path.size();
207 // Check for initial '/'
208 if (path[pos] == '/') {
212 components.push_back(root);
214 while (pos < max && path[pos] == '/')
219 components.push_back(parse_component(path, pos));
220 while (pos < max && path[pos] == '/')
227 ////////////////////////////////////////////////////////////////////////
228 // Other static utility functions.
229 ////////////////////////////////////////////////////////////////////////
233 copy_string (const char * s)
235 // FIXME: potential buffer overflow.
236 // For some reason, strnlen and
237 // strncpy cause all kinds of crashes.
238 char * copy = new char[strlen(s) + 1];
244 compare_strings (const char * s1, const char * s2)
246 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
250 * Locate a child node by name and index.
253 find_child (const char * name, int index, const vector<SGPropertyNode_ptr>& nodes)
255 int nNodes = nodes.size();
256 for (int i = 0; i < nNodes; i++) {
257 SGPropertyNode * node = nodes[i];
258 if (compare_strings(node->getName(), name) && node->getIndex() == index)
266 * Locate another node, given a relative path.
268 static SGPropertyNode *
269 find_node (SGPropertyNode * current,
270 const vector<PathComponent> &components,
274 // Run off the end of the list
279 // Success! This is the one we want.
280 else if (position >= (int)components.size()) {
281 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
284 // Empty component means root.
285 else if (components[position].name == "") {
286 return find_node(current->getRootNode(), components, position + 1, create);
289 // . means current directory
290 else if (components[position].name == ".") {
291 return find_node(current, components, position + 1, create);
294 // .. means parent directory
295 else if (components[position].name == "..") {
296 SGPropertyNode * parent = current->getParent();
298 throw string("Attempt to move past root with '..'");
300 return find_node(parent, components, position + 1, create);
303 // Otherwise, a child name
305 SGPropertyNode * child =
306 current->getChild(components[position].name.c_str(),
307 components[position].index,
309 return find_node(child, components, position + 1, create);
315 ////////////////////////////////////////////////////////////////////////
316 // Private methods from SGPropertyNode (may be inlined for speed).
317 ////////////////////////////////////////////////////////////////////////
320 SGPropertyNode::get_bool () const
323 return _value.bool_val->getValue();
325 return _local_val.bool_val;
329 SGPropertyNode::get_int () const
332 return _value.int_val->getValue();
334 return _local_val.int_val;
338 SGPropertyNode::get_long () const
341 return _value.long_val->getValue();
343 return _local_val.long_val;
347 SGPropertyNode::get_float () const
350 return _value.float_val->getValue();
352 return _local_val.float_val;
356 SGPropertyNode::get_double () const
359 return _value.double_val->getValue();
361 return _local_val.double_val;
365 SGPropertyNode::get_string () const
368 return _value.string_val->getValue();
370 return _local_val.string_val;
374 SGPropertyNode::set_bool (bool val)
377 if (_value.bool_val->setValue(val)) {
384 _local_val.bool_val = val;
391 SGPropertyNode::set_int (int val)
394 if (_value.int_val->setValue(val)) {
401 _local_val.int_val = val;
408 SGPropertyNode::set_long (long val)
411 if (_value.long_val->setValue(val)) {
418 _local_val.long_val = val;
425 SGPropertyNode::set_float (float val)
428 if (_value.float_val->setValue(val)) {
435 _local_val.float_val = val;
442 SGPropertyNode::set_double (double val)
445 if (_value.double_val->setValue(val)) {
452 _local_val.double_val = val;
459 SGPropertyNode::set_string (const char * val)
462 if (_value.string_val->setValue(val)) {
469 delete [] _local_val.string_val;
470 _local_val.string_val = copy_string(val);
477 SGPropertyNode::clearValue ()
487 delete _value.bool_val;
490 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
494 delete _value.int_val;
497 _local_val.int_val = SGRawValue<int>::DefaultValue;
501 delete _value.long_val;
502 _value.long_val = 0L;
504 _local_val.long_val = SGRawValue<long>::DefaultValue;
508 delete _value.float_val;
509 _value.float_val = 0;
511 _local_val.float_val = SGRawValue<float>::DefaultValue;
515 delete _value.double_val;
516 _value.double_val = 0;
518 _local_val.double_val = SGRawValue<double>::DefaultValue;
523 delete _value.string_val;
524 _value.string_val = 0;
526 delete [] _local_val.string_val;
528 _local_val.string_val = 0;
537 * Get the value as a string.
540 SGPropertyNode::make_string () const
542 if (!getAttribute(READ))
547 return _value.alias->getStringValue();
557 _buffer = sstr.str();
558 return _buffer.c_str();
564 _buffer = sstr.str();
565 return _buffer.c_str();
571 _buffer = sstr.str();
572 return _buffer.c_str();
577 sstr.precision( 10 );
578 sstr << get_double();
579 _buffer = sstr.str();
580 return _buffer.c_str();
592 * Trace a write access for a property.
595 SGPropertyNode::trace_write () const
598 cerr << "TRACE: Write node " << getPath () << ", value\""
599 << make_string() << '"' << endl;
601 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
602 << ", value\"" << make_string() << '"');
607 * Trace a read access for a property.
610 SGPropertyNode::trace_read () const
613 cerr << "TRACE: Write node " << getPath () << ", value \""
614 << make_string() << '"' << endl;
616 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
617 << ", value \"" << make_string() << '"');
622 ////////////////////////////////////////////////////////////////////////
623 // Public methods from SGPropertyNode.
624 ////////////////////////////////////////////////////////////////////////
627 * Last used attribute
628 * Update as needed when enum Attribute is changed
630 const int SGPropertyNode::LAST_USED_ATTRIBUTE = TRACE_WRITE;
633 * Default constructor: always creates a root node.
635 SGPropertyNode::SGPropertyNode ()
644 _local_val.string_val = 0;
651 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
652 : _index(node._index),
654 _parent(0), // don't copy the parent
659 _listeners(0) // CHECK!!
661 _local_val.string_val = 0;
666 _value.alias = node._value.alias;
672 _value.bool_val = node._value.bool_val->clone();
675 set_bool(node.get_bool());
681 _value.int_val = node._value.int_val->clone();
684 set_int(node.get_int());
690 _value.long_val = node._value.long_val->clone();
693 set_long(node.get_long());
699 _value.float_val = node._value.float_val->clone();
702 set_float(node.get_float());
708 _value.double_val = node._value.double_val->clone();
711 set_double(node.get_double());
718 _value.string_val = node._value.string_val->clone();
721 set_string(node.get_string());
729 * Convenience constructor.
731 SGPropertyNode::SGPropertyNode (const char * name,
733 SGPropertyNode * parent)
743 _local_val.string_val = 0;
750 SGPropertyNode::~SGPropertyNode ()
752 // zero out all parent pointers, else they might be dangling
753 for (unsigned i = 0; i < _children.size(); ++i)
754 _children[i]->_parent = 0;
755 for (unsigned i = 0; i < _removedChildren.size(); ++i)
756 _removedChildren[i]->_parent = 0;
761 vector<SGPropertyChangeListener*>::iterator it;
762 for (it = _listeners->begin(); it != _listeners->end(); ++it)
763 (*it)->unregister_property(this);
770 * Alias to another node.
773 SGPropertyNode::alias (SGPropertyNode * target)
775 if (target == 0 || _type == ALIAS || _tied)
778 _value.alias = target;
785 * Alias to another node by path.
788 SGPropertyNode::alias (const char * path)
790 return alias(getNode(path, true));
798 SGPropertyNode::unalias ()
809 * Get the target of an alias.
812 SGPropertyNode::getAliasTarget ()
814 return (_type == ALIAS ? _value.alias : 0);
818 const SGPropertyNode *
819 SGPropertyNode::getAliasTarget () const
821 return (_type == ALIAS ? _value.alias : 0);
826 * Get a non-const child by index.
829 SGPropertyNode::getChild (int position)
831 if (position >= 0 && position < nChildren())
832 return _children[position];
839 * Get a const child by index.
841 const SGPropertyNode *
842 SGPropertyNode::getChild (int position) const
844 if (position >= 0 && position < nChildren())
845 return _children[position];
852 * Get a non-const child by name and index, creating if necessary.
855 SGPropertyNode::getChild (const char * name, int index, bool create)
857 int pos = find_child(name, index, _children);
859 return _children[pos];
861 SGPropertyNode_ptr node;
862 pos = find_child(name, index, _removedChildren);
864 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
866 node = _removedChildren[pos];
867 _removedChildren.erase(it);
868 node->setAttribute(REMOVED, false);
870 node = new SGPropertyNode(name, index, this);
872 _children.push_back(node);
873 fireChildAdded(node);
882 * Get a const child by name and index.
884 const SGPropertyNode *
885 SGPropertyNode::getChild (const char * name, int index) const
887 int pos = find_child(name, index, _children);
889 return _children[pos];
896 * Get all children with the same name (but different indices).
898 vector<SGPropertyNode_ptr>
899 SGPropertyNode::getChildren (const char * name) const
901 vector<SGPropertyNode_ptr> children;
902 int max = _children.size();
904 for (int i = 0; i < max; i++)
905 if (compare_strings(_children[i]->getName(), name))
906 children.push_back(_children[i]);
908 sort(children.begin(), children.end(), CompareIndices());
914 * Remove this node and all children from nodes that link to them
915 * in their path cache.
918 SGPropertyNode::remove_from_path_caches ()
920 for (unsigned int i = 0; i < _children.size(); ++i)
921 _children[i]->remove_from_path_caches();
923 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
924 _linkedNodes[i]->erase(this);
925 _linkedNodes.clear();
930 * Remove child by position.
933 SGPropertyNode::removeChild (int pos, bool keep)
935 SGPropertyNode_ptr node;
936 if (pos < 0 || pos >= (int)_children.size())
939 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
941 node = _children[pos];
944 _removedChildren.push_back(node);
947 node->remove_from_path_caches();
948 node->setAttribute(REMOVED, true);
950 fireChildRemoved(node);
956 * Remove a child node
959 SGPropertyNode::removeChild (const char * name, int index, bool keep)
961 SGPropertyNode_ptr ret;
962 int pos = find_child(name, index, _children);
964 ret = removeChild(pos, keep);
970 * Remove all children with the specified name.
972 vector<SGPropertyNode_ptr>
973 SGPropertyNode::removeChildren (const char * name, bool keep)
975 vector<SGPropertyNode_ptr> children;
977 for (int pos = _children.size() - 1; pos >= 0; pos--)
978 if (compare_strings(_children[pos]->getName(), name))
979 children.push_back(removeChild(pos, keep));
981 sort(children.begin(), children.end(), CompareIndices());
987 * Remove a linked node.
990 SGPropertyNode::remove_linked_node (hash_table * node)
992 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
993 if (_linkedNodes[i] == node) {
994 vector<hash_table *>::iterator it = _linkedNodes.begin();
996 _linkedNodes.erase(it);
1005 SGPropertyNode::getDisplayName (bool simplify) const
1007 _display_name = _name;
1008 if (_index != 0 || !simplify) {
1010 sstr << '[' << _index << ']';
1011 _display_name += sstr.str();
1013 return _display_name.c_str();
1018 SGPropertyNode::getPath (bool simplify) const
1020 // Calculate the complete path only once.
1021 if (_parent != 0 && _path.empty()) {
1022 _path = _parent->getPath(simplify);
1024 _path += getDisplayName(simplify);
1027 return _path.c_str();
1030 SGPropertyNode::Type
1031 SGPropertyNode::getType () const
1034 return _value.alias->getType();
1041 SGPropertyNode::getBoolValue () const
1043 // Shortcut for common case
1044 if (_attr == (READ|WRITE) && _type == BOOL)
1047 if (getAttribute(TRACE_READ))
1049 if (!getAttribute(READ))
1050 return SGRawValue<bool>::DefaultValue;
1053 return _value.alias->getBoolValue();
1057 return get_int() == 0 ? false : true;
1059 return get_long() == 0L ? false : true;
1061 return get_float() == 0.0 ? false : true;
1063 return get_double() == 0.0L ? false : true;
1066 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1069 return SGRawValue<bool>::DefaultValue;
1074 SGPropertyNode::getIntValue () const
1076 // Shortcut for common case
1077 if (_attr == (READ|WRITE) && _type == INT)
1080 if (getAttribute(TRACE_READ))
1082 if (!getAttribute(READ))
1083 return SGRawValue<int>::DefaultValue;
1086 return _value.alias->getIntValue();
1088 return int(get_bool());
1092 return int(get_long());
1094 return int(get_float());
1096 return int(get_double());
1099 return atoi(get_string());
1102 return SGRawValue<int>::DefaultValue;
1107 SGPropertyNode::getLongValue () const
1109 // Shortcut for common case
1110 if (_attr == (READ|WRITE) && _type == LONG)
1113 if (getAttribute(TRACE_READ))
1115 if (!getAttribute(READ))
1116 return SGRawValue<long>::DefaultValue;
1119 return _value.alias->getLongValue();
1121 return long(get_bool());
1123 return long(get_int());
1127 return long(get_float());
1129 return long(get_double());
1132 return strtol(get_string(), 0, 0);
1135 return SGRawValue<long>::DefaultValue;
1140 SGPropertyNode::getFloatValue () const
1142 // Shortcut for common case
1143 if (_attr == (READ|WRITE) && _type == FLOAT)
1146 if (getAttribute(TRACE_READ))
1148 if (!getAttribute(READ))
1149 return SGRawValue<float>::DefaultValue;
1152 return _value.alias->getFloatValue();
1154 return float(get_bool());
1156 return float(get_int());
1158 return float(get_long());
1162 return float(get_double());
1165 return atof(get_string());
1168 return SGRawValue<float>::DefaultValue;
1173 SGPropertyNode::getDoubleValue () const
1175 // Shortcut for common case
1176 if (_attr == (READ|WRITE) && _type == DOUBLE)
1177 return get_double();
1179 if (getAttribute(TRACE_READ))
1181 if (!getAttribute(READ))
1182 return SGRawValue<double>::DefaultValue;
1186 return _value.alias->getDoubleValue();
1188 return double(get_bool());
1190 return double(get_int());
1192 return double(get_long());
1194 return double(get_float());
1196 return get_double();
1199 return strtod(get_string(), 0);
1202 return SGRawValue<double>::DefaultValue;
1207 SGPropertyNode::getStringValue () const
1209 // Shortcut for common case
1210 if (_attr == (READ|WRITE) && _type == STRING)
1211 return get_string();
1213 if (getAttribute(TRACE_READ))
1215 if (!getAttribute(READ))
1216 return SGRawValue<const char *>::DefaultValue;
1217 return make_string();
1221 SGPropertyNode::setBoolValue (bool value)
1223 // Shortcut for common case
1224 if (_attr == (READ|WRITE) && _type == BOOL)
1225 return set_bool(value);
1227 bool result = false;
1229 if (_type == NONE || _type == UNSPECIFIED) {
1237 result = _value.alias->setBoolValue(value);
1240 result = set_bool(value);
1243 result = set_int(int(value));
1246 result = set_long(long(value));
1249 result = set_float(float(value));
1252 result = set_double(double(value));
1256 result = set_string(value ? "true" : "false");
1263 if (getAttribute(TRACE_WRITE))
1269 SGPropertyNode::setIntValue (int value)
1271 // Shortcut for common case
1272 if (_attr == (READ|WRITE) && _type == INT)
1273 return set_int(value);
1275 bool result = false;
1277 if (_type == NONE || _type == UNSPECIFIED) {
1280 _local_val.int_val = 0;
1285 result = _value.alias->setIntValue(value);
1288 result = set_bool(value == 0 ? false : true);
1291 result = set_int(value);
1294 result = set_long(long(value));
1297 result = set_float(float(value));
1300 result = set_double(double(value));
1305 sprintf(buf, "%d", value);
1306 result = set_string(buf);
1314 if (getAttribute(TRACE_WRITE))
1320 SGPropertyNode::setLongValue (long value)
1322 // Shortcut for common case
1323 if (_attr == (READ|WRITE) && _type == LONG)
1324 return set_long(value);
1326 bool result = false;
1328 if (_type == NONE || _type == UNSPECIFIED) {
1331 _local_val.long_val = 0L;
1336 result = _value.alias->setLongValue(value);
1339 result = set_bool(value == 0L ? false : true);
1342 result = set_int(int(value));
1345 result = set_long(value);
1348 result = set_float(float(value));
1351 result = set_double(double(value));
1356 sprintf(buf, "%ld", value);
1357 result = set_string(buf);
1365 if (getAttribute(TRACE_WRITE))
1371 SGPropertyNode::setFloatValue (float value)
1373 // Shortcut for common case
1374 if (_attr == (READ|WRITE) && _type == FLOAT)
1375 return set_float(value);
1377 bool result = false;
1379 if (_type == NONE || _type == UNSPECIFIED) {
1382 _local_val.float_val = 0;
1387 result = _value.alias->setFloatValue(value);
1390 result = set_bool(value == 0.0 ? false : true);
1393 result = set_int(int(value));
1396 result = set_long(long(value));
1399 result = set_float(value);
1402 result = set_double(double(value));
1407 sprintf(buf, "%f", value);
1408 result = set_string(buf);
1416 if (getAttribute(TRACE_WRITE))
1422 SGPropertyNode::setDoubleValue (double value)
1424 // Shortcut for common case
1425 if (_attr == (READ|WRITE) && _type == DOUBLE)
1426 return set_double(value);
1428 bool result = false;
1430 if (_type == NONE || _type == UNSPECIFIED) {
1432 _local_val.double_val = value;
1438 result = _value.alias->setDoubleValue(value);
1441 result = set_bool(value == 0.0L ? false : true);
1444 result = set_int(int(value));
1447 result = set_long(long(value));
1450 result = set_float(float(value));
1453 result = set_double(value);
1458 sprintf(buf, "%f", value);
1459 result = set_string(buf);
1467 if (getAttribute(TRACE_WRITE))
1473 SGPropertyNode::setStringValue (const char * value)
1475 // Shortcut for common case
1476 if (_attr == (READ|WRITE) && _type == STRING)
1477 return set_string(value);
1479 bool result = false;
1481 if (_type == NONE || _type == UNSPECIFIED) {
1488 result = _value.alias->setStringValue(value);
1491 result = set_bool((compare_strings(value, "true")
1492 || atoi(value)) ? true : false);
1495 result = set_int(atoi(value));
1498 result = set_long(strtol(value, 0, 0));
1501 result = set_float(atof(value));
1504 result = set_double(strtod(value, 0));
1508 result = set_string(value);
1515 if (getAttribute(TRACE_WRITE))
1521 SGPropertyNode::setUnspecifiedValue (const char * value)
1523 bool result = false;
1525 if (_type == NONE) {
1527 _type = UNSPECIFIED;
1532 result = _value.alias->setUnspecifiedValue(value);
1535 result = set_bool((compare_strings(value, "true")
1536 || atoi(value)) ? true : false);
1539 result = set_int(atoi(value));
1542 result = set_long(strtol(value, 0, 0));
1545 result = set_float(atof(value));
1548 result = set_double(strtod(value, 0));
1552 result = set_string(value);
1559 if (getAttribute(TRACE_WRITE))
1565 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1567 if (_type == ALIAS || _tied)
1570 useDefault = useDefault && hasValue();
1571 bool old_val = false;
1573 old_val = getBoolValue();
1578 _value.bool_val = rawValue.clone();
1581 setBoolValue(old_val);
1587 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1589 if (_type == ALIAS || _tied)
1592 useDefault = useDefault && hasValue();
1595 old_val = getIntValue();
1600 _value.int_val = rawValue.clone();
1603 setIntValue(old_val);
1609 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1611 if (_type == ALIAS || _tied)
1614 useDefault = useDefault && hasValue();
1617 old_val = getLongValue();
1622 _value.long_val = rawValue.clone();
1625 setLongValue(old_val);
1631 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1633 if (_type == ALIAS || _tied)
1636 useDefault = useDefault && hasValue();
1637 float old_val = 0.0;
1639 old_val = getFloatValue();
1644 _value.float_val = rawValue.clone();
1647 setFloatValue(old_val);
1653 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1655 if (_type == ALIAS || _tied)
1658 useDefault = useDefault && hasValue();
1659 double old_val = 0.0;
1661 old_val = getDoubleValue();
1666 _value.double_val = rawValue.clone();
1669 setDoubleValue(old_val);
1676 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1678 if (_type == ALIAS || _tied)
1681 useDefault = useDefault && hasValue();
1684 old_val = getStringValue();
1689 _value.string_val = rawValue.clone();
1692 setStringValue(old_val.c_str());
1698 SGPropertyNode::untie ()
1705 bool val = getBoolValue();
1708 _local_val.bool_val = val;
1712 int val = getIntValue();
1715 _local_val.int_val = val;
1719 long val = getLongValue();
1722 _local_val.long_val = val;
1726 float val = getFloatValue();
1729 _local_val.float_val = val;
1733 double val = getDoubleValue();
1736 _local_val.double_val = val;
1741 string val = getStringValue();
1744 _local_val.string_val = copy_string(val.c_str());
1757 SGPropertyNode::getRootNode ()
1762 return _parent->getRootNode();
1765 const SGPropertyNode *
1766 SGPropertyNode::getRootNode () const
1771 return _parent->getRootNode();
1775 SGPropertyNode::getNode (const char * relative_path, bool create)
1777 if (_path_cache == 0)
1778 _path_cache = new hash_table;
1780 SGPropertyNode * result = _path_cache->get(relative_path);
1782 vector<PathComponent> components;
1783 parse_path(relative_path, components);
1784 result = find_node(this, components, 0, create);
1786 _path_cache->put(relative_path, result);
1793 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1795 vector<PathComponent> components;
1796 parse_path(relative_path, components);
1797 if (components.size() > 0)
1798 components.back().index = index;
1799 return find_node(this, components, 0, create);
1802 const SGPropertyNode *
1803 SGPropertyNode::getNode (const char * relative_path) const
1805 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1808 const SGPropertyNode *
1809 SGPropertyNode::getNode (const char * relative_path, int index) const
1811 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1815 ////////////////////////////////////////////////////////////////////////
1816 // Convenience methods using relative paths.
1817 ////////////////////////////////////////////////////////////////////////
1821 * Test whether another node has a value attached.
1824 SGPropertyNode::hasValue (const char * relative_path) const
1826 const SGPropertyNode * node = getNode(relative_path);
1827 return (node == 0 ? false : node->hasValue());
1832 * Get the value type for another node.
1834 SGPropertyNode::Type
1835 SGPropertyNode::getType (const char * relative_path) const
1837 const SGPropertyNode * node = getNode(relative_path);
1838 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1843 * Get a bool value for another node.
1846 SGPropertyNode::getBoolValue (const char * relative_path,
1847 bool defaultValue) const
1849 const SGPropertyNode * node = getNode(relative_path);
1850 return (node == 0 ? defaultValue : node->getBoolValue());
1855 * Get an int value for another node.
1858 SGPropertyNode::getIntValue (const char * relative_path,
1859 int defaultValue) const
1861 const SGPropertyNode * node = getNode(relative_path);
1862 return (node == 0 ? defaultValue : node->getIntValue());
1867 * Get a long value for another node.
1870 SGPropertyNode::getLongValue (const char * relative_path,
1871 long defaultValue) const
1873 const SGPropertyNode * node = getNode(relative_path);
1874 return (node == 0 ? defaultValue : node->getLongValue());
1879 * Get a float value for another node.
1882 SGPropertyNode::getFloatValue (const char * relative_path,
1883 float defaultValue) const
1885 const SGPropertyNode * node = getNode(relative_path);
1886 return (node == 0 ? defaultValue : node->getFloatValue());
1891 * Get a double value for another node.
1894 SGPropertyNode::getDoubleValue (const char * relative_path,
1895 double defaultValue) const
1897 const SGPropertyNode * node = getNode(relative_path);
1898 return (node == 0 ? defaultValue : node->getDoubleValue());
1903 * Get a string value for another node.
1906 SGPropertyNode::getStringValue (const char * relative_path,
1907 const char * defaultValue) const
1909 const SGPropertyNode * node = getNode(relative_path);
1910 return (node == 0 ? defaultValue : node->getStringValue());
1915 * Set a bool value for another node.
1918 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1920 return getNode(relative_path, true)->setBoolValue(value);
1925 * Set an int value for another node.
1928 SGPropertyNode::setIntValue (const char * relative_path, int value)
1930 return getNode(relative_path, true)->setIntValue(value);
1935 * Set a long value for another node.
1938 SGPropertyNode::setLongValue (const char * relative_path, long value)
1940 return getNode(relative_path, true)->setLongValue(value);
1945 * Set a float value for another node.
1948 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1950 return getNode(relative_path, true)->setFloatValue(value);
1955 * Set a double value for another node.
1958 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1960 return getNode(relative_path, true)->setDoubleValue(value);
1965 * Set a string value for another node.
1968 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1970 return getNode(relative_path, true)->setStringValue(value);
1975 * Set an unknown value for another node.
1978 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1981 return getNode(relative_path, true)->setUnspecifiedValue(value);
1986 * Test whether another node is tied.
1989 SGPropertyNode::isTied (const char * relative_path) const
1991 const SGPropertyNode * node = getNode(relative_path);
1992 return (node == 0 ? false : node->isTied());
1997 * Tie a node reached by a relative path, creating it if necessary.
2000 SGPropertyNode::tie (const char * relative_path,
2001 const SGRawValue<bool> &rawValue,
2004 return getNode(relative_path, true)->tie(rawValue, useDefault);
2009 * Tie a node reached by a relative path, creating it if necessary.
2012 SGPropertyNode::tie (const char * relative_path,
2013 const SGRawValue<int> &rawValue,
2016 return getNode(relative_path, true)->tie(rawValue, useDefault);
2021 * Tie a node reached by a relative path, creating it if necessary.
2024 SGPropertyNode::tie (const char * relative_path,
2025 const SGRawValue<long> &rawValue,
2028 return getNode(relative_path, true)->tie(rawValue, useDefault);
2033 * Tie a node reached by a relative path, creating it if necessary.
2036 SGPropertyNode::tie (const char * relative_path,
2037 const SGRawValue<float> &rawValue,
2040 return getNode(relative_path, true)->tie(rawValue, useDefault);
2045 * Tie a node reached by a relative path, creating it if necessary.
2048 SGPropertyNode::tie (const char * relative_path,
2049 const SGRawValue<double> &rawValue,
2052 return getNode(relative_path, true)->tie(rawValue, useDefault);
2057 * Tie a node reached by a relative path, creating it if necessary.
2060 SGPropertyNode::tie (const char * relative_path,
2061 const SGRawValue<const char *> &rawValue,
2064 return getNode(relative_path, true)->tie(rawValue, useDefault);
2069 * Attempt to untie another node reached by a relative path.
2072 SGPropertyNode::untie (const char * relative_path)
2074 SGPropertyNode * node = getNode(relative_path);
2075 return (node == 0 ? false : node->untie());
2079 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2082 if (_listeners == 0)
2083 _listeners = new vector<SGPropertyChangeListener*>;
2084 _listeners->push_back(listener);
2085 listener->register_property(this);
2087 listener->valueChanged(this);
2091 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2093 vector<SGPropertyChangeListener*>::iterator it =
2094 find(_listeners->begin(), _listeners->end(), listener);
2095 if (it != _listeners->end()) {
2096 _listeners->erase(it);
2097 listener->unregister_property(this);
2098 if (_listeners->empty()) {
2099 vector<SGPropertyChangeListener*>* tmp = _listeners;
2107 SGPropertyNode::fireValueChanged ()
2109 fireValueChanged(this);
2113 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2115 fireChildAdded(this, child);
2119 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2121 fireChildRemoved(this, child);
2125 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2127 if (_listeners != 0) {
2128 for (unsigned int i = 0; i < _listeners->size(); i++) {
2129 (*_listeners)[i]->valueChanged(node);
2133 _parent->fireValueChanged(node);
2137 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2138 SGPropertyNode * child)
2140 if (_listeners != 0) {
2141 for (unsigned int i = 0; i < _listeners->size(); i++) {
2142 (*_listeners)[i]->childAdded(parent, child);
2146 _parent->fireChildAdded(parent, child);
2150 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2151 SGPropertyNode * child)
2153 if (_listeners != 0) {
2154 for (unsigned int i = 0; i < _listeners->size(); i++) {
2155 (*_listeners)[i]->childRemoved(parent, child);
2159 _parent->fireChildRemoved(parent, child);
2164 ////////////////////////////////////////////////////////////////////////
2165 // Simplified hash table for caching paths.
2166 ////////////////////////////////////////////////////////////////////////
2168 #define HASH_TABLE_SIZE 199
2170 SGPropertyNode::hash_table::entry::entry ()
2175 SGPropertyNode::hash_table::entry::~entry ()
2177 // Don't delete the value; we don't own
2182 SGPropertyNode::hash_table::entry::set_key (const char * key)
2188 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2193 SGPropertyNode::hash_table::bucket::bucket ()
2199 SGPropertyNode::hash_table::bucket::~bucket ()
2201 for (int i = 0; i < _length; i++)
2206 SGPropertyNode::hash_table::entry *
2207 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2210 for (i = 0; i < _length; i++) {
2211 if (!strcmp(_entries[i]->get_key(), key))
2215 entry ** new_entries = new entry*[_length+1];
2216 for (i = 0; i < _length; i++) {
2217 new_entries[i] = _entries[i];
2220 _entries = new_entries;
2221 _entries[_length] = new entry;
2222 _entries[_length]->set_key(key);
2224 return _entries[_length - 1];
2231 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2233 for (int i = 0; i < _length; i++) {
2234 if (_entries[i]->get_value() == node) {
2236 for (++i; i < _length; i++) {
2237 _entries[i-1] = _entries[i];
2247 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2249 for (int i = 0; i < _length; i++) {
2250 SGPropertyNode * node = _entries[i]->get_value();
2252 node->remove_linked_node(owner);
2256 SGPropertyNode::hash_table::hash_table ()
2262 SGPropertyNode::hash_table::~hash_table ()
2264 for (unsigned int i = 0; i < _data_length; i++) {
2266 _data[i]->clear(this);
2274 SGPropertyNode::hash_table::get (const char * key)
2276 if (_data_length == 0)
2278 unsigned int index = hashcode(key) % _data_length;
2279 if (_data[index] == 0)
2281 entry * e = _data[index]->get_entry(key);
2285 return e->get_value();
2289 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2291 if (_data_length == 0) {
2292 _data = new bucket*[HASH_TABLE_SIZE];
2293 _data_length = HASH_TABLE_SIZE;
2294 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2297 unsigned int index = hashcode(key) % _data_length;
2298 if (_data[index] == 0) {
2299 _data[index] = new bucket;
2301 entry * e = _data[index]->get_entry(key, true);
2302 e->set_value(value);
2303 value->add_linked_node(this);
2307 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2309 for (unsigned int i = 0; i < _data_length; i++)
2310 if (_data[i] && _data[i]->erase(node))
2317 SGPropertyNode::hash_table::hashcode (const char * key)
2319 unsigned int hash = 0;
2321 hash = 31 * hash + *key;
2329 ////////////////////////////////////////////////////////////////////////
2330 // Implementation of SGPropertyChangeListener.
2331 ////////////////////////////////////////////////////////////////////////
2333 SGPropertyChangeListener::~SGPropertyChangeListener ()
2335 for (int i = _properties.size() - 1; i >= 0; i--)
2336 _properties[i]->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);