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].
21 #include <simgear/compiler.h>
22 #include <simgear/debug/logstream.hxx>
24 #if ( _MSC_VER == 1200 )
25 // MSVC 6 is buggy, and needs something strange here
26 using std::vector<SGPropertyNode_ptr>;
27 using std::vector<SGPropertyChangeListener *>;
28 using std::vector<SGPropertyNode *>;
40 using std::stringstream;
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, const 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 ()
485 delete _value.bool_val;
488 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
492 delete _value.int_val;
495 _local_val.int_val = SGRawValue<int>::DefaultValue;
499 delete _value.long_val;
500 _value.long_val = 0L;
502 _local_val.long_val = SGRawValue<long>::DefaultValue;
506 delete _value.float_val;
507 _value.float_val = 0;
509 _local_val.float_val = SGRawValue<float>::DefaultValue;
513 delete _value.double_val;
514 _value.double_val = 0;
516 _local_val.double_val = SGRawValue<double>::DefaultValue;
521 delete _value.string_val;
522 _value.string_val = 0;
524 delete [] _local_val.string_val;
526 _local_val.string_val = 0;
535 * Get the value as a string.
538 SGPropertyNode::make_string () const
540 if (!getAttribute(READ))
545 return _value.alias->getStringValue();
555 _buffer = sstr.str();
556 return _buffer.c_str();
562 _buffer = sstr.str();
563 return _buffer.c_str();
569 _buffer = sstr.str();
570 return _buffer.c_str();
575 sstr.precision( 10 );
576 sstr << get_double();
577 _buffer = sstr.str();
578 return _buffer.c_str();
590 * Trace a write access for a property.
593 SGPropertyNode::trace_write () const
596 cerr << "TRACE: Write node " << getPath () << ", value \""
597 << make_string() << '"' << endl;
599 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Write node " << getPath()
600 << ", value \"" << make_string() << '"');
605 * Trace a read access for a property.
608 SGPropertyNode::trace_read () const
611 cerr << "TRACE: Write node " << getPath () << ", value \""
612 << make_string() << '"' << endl;
614 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Read node " << getPath()
615 << ", value \"" << make_string() << '"');
620 ////////////////////////////////////////////////////////////////////////
621 // Public methods from SGPropertyNode.
622 ////////////////////////////////////////////////////////////////////////
625 * Last used attribute
626 * Update as needed when enum Attribute is changed
628 const int SGPropertyNode::LAST_USED_ATTRIBUTE = USERARCHIVE;
631 * Default constructor: always creates a root node.
633 SGPropertyNode::SGPropertyNode ()
642 _local_val.string_val = 0;
649 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
650 : _index(node._index),
652 _parent(0), // don't copy the parent
657 _listeners(0) // CHECK!!
659 _local_val.string_val = 0;
664 _value.alias = node._value.alias;
671 _value.bool_val = node._value.bool_val->clone();
674 set_bool(node.get_bool());
680 _value.int_val = node._value.int_val->clone();
683 set_int(node.get_int());
689 _value.long_val = node._value.long_val->clone();
692 set_long(node.get_long());
698 _value.float_val = node._value.float_val->clone();
701 set_float(node.get_float());
707 _value.double_val = node._value.double_val->clone();
710 set_double(node.get_double());
717 _value.string_val = node._value.string_val->clone();
720 set_string(node.get_string());
728 * Convenience constructor.
730 SGPropertyNode::SGPropertyNode (const char * name,
732 SGPropertyNode * parent)
742 _name = parse_name(name, i);
743 if (i != int(strlen(name)) || name[0] == '.')
744 throw string("plain name expected instead of '") + name + '\'';
746 _local_val.string_val = 0;
753 SGPropertyNode::~SGPropertyNode ()
755 // zero out all parent pointers, else they might be dangling
756 for (unsigned i = 0; i < _children.size(); ++i)
757 _children[i]->_parent = 0;
758 for (unsigned i = 0; i < _removedChildren.size(); ++i)
759 _removedChildren[i]->_parent = 0;
764 vector<SGPropertyChangeListener*>::iterator it;
765 for (it = _listeners->begin(); it != _listeners->end(); ++it)
766 (*it)->unregister_property(this);
773 * Alias to another node.
776 SGPropertyNode::alias (SGPropertyNode * target)
778 if (target == 0 || _type == ALIAS || _tied)
782 _value.alias = target;
789 * Alias to another node by path.
792 SGPropertyNode::alias (const char * path)
794 return alias(getNode(path, true));
802 SGPropertyNode::unalias ()
812 * Get the target of an alias.
815 SGPropertyNode::getAliasTarget ()
817 return (_type == ALIAS ? _value.alias : 0);
821 const SGPropertyNode *
822 SGPropertyNode::getAliasTarget () const
824 return (_type == ALIAS ? _value.alias : 0);
829 * Get a non-const child by index.
832 SGPropertyNode::getChild (int position)
834 if (position >= 0 && position < nChildren())
835 return _children[position];
842 * Get a const child by index.
844 const SGPropertyNode *
845 SGPropertyNode::getChild (int position) const
847 if (position >= 0 && position < nChildren())
848 return _children[position];
855 * Get a non-const child by name and index, creating if necessary.
858 SGPropertyNode::getChild (const char * name, int index, bool create)
860 int pos = find_child(name, index, _children);
862 return _children[pos];
864 SGPropertyNode_ptr node;
865 pos = find_child(name, index, _removedChildren);
867 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
869 node = _removedChildren[pos];
870 _removedChildren.erase(it);
871 node->setAttribute(REMOVED, false);
873 node = new SGPropertyNode(name, index, this);
875 _children.push_back(node);
876 fireChildAdded(node);
885 * Get a const child by name and index.
887 const SGPropertyNode *
888 SGPropertyNode::getChild (const char * name, int index) const
890 int pos = find_child(name, index, _children);
892 return _children[pos];
899 * Get all children with the same name (but different indices).
901 vector<SGPropertyNode_ptr>
902 SGPropertyNode::getChildren (const char * name) const
904 vector<SGPropertyNode_ptr> children;
905 int max = _children.size();
907 for (int i = 0; i < max; i++)
908 if (compare_strings(_children[i]->getName(), name))
909 children.push_back(_children[i]);
911 sort(children.begin(), children.end(), CompareIndices());
917 * Remove this node and all children from nodes that link to them
918 * in their path cache.
921 SGPropertyNode::remove_from_path_caches ()
923 for (unsigned int i = 0; i < _children.size(); ++i)
924 _children[i]->remove_from_path_caches();
926 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
927 _linkedNodes[i]->erase(this);
928 _linkedNodes.clear();
933 * Remove child by position.
936 SGPropertyNode::removeChild (int pos, bool keep)
938 SGPropertyNode_ptr node;
939 if (pos < 0 || pos >= (int)_children.size())
942 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
944 node = _children[pos];
947 _removedChildren.push_back(node);
950 node->remove_from_path_caches();
951 node->setAttribute(REMOVED, true);
953 fireChildRemoved(node);
959 * Remove a child node
962 SGPropertyNode::removeChild (const char * name, int index, bool keep)
964 SGPropertyNode_ptr ret;
965 int pos = find_child(name, index, _children);
967 ret = removeChild(pos, keep);
973 * Remove all children with the specified name.
975 vector<SGPropertyNode_ptr>
976 SGPropertyNode::removeChildren (const char * name, bool keep)
978 vector<SGPropertyNode_ptr> children;
980 for (int pos = _children.size() - 1; pos >= 0; pos--)
981 if (compare_strings(_children[pos]->getName(), name))
982 children.push_back(removeChild(pos, keep));
984 sort(children.begin(), children.end(), CompareIndices());
990 * Remove a linked node.
993 SGPropertyNode::remove_linked_node (hash_table * node)
995 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
996 if (_linkedNodes[i] == node) {
997 vector<hash_table *>::iterator it = _linkedNodes.begin();
999 _linkedNodes.erase(it);
1008 SGPropertyNode::getDisplayName (bool simplify) const
1010 _display_name = _name;
1011 if (_index != 0 || !simplify) {
1013 sstr << '[' << _index << ']';
1014 _display_name += sstr.str();
1016 return _display_name.c_str();
1021 SGPropertyNode::getPath (bool simplify) const
1023 // Calculate the complete path only once.
1024 if (_parent != 0 && _path.empty()) {
1025 _path = _parent->getPath(simplify);
1027 _path += getDisplayName(simplify);
1030 return _path.c_str();
1033 SGPropertyNode::Type
1034 SGPropertyNode::getType () const
1037 return _value.alias->getType();
1044 SGPropertyNode::getBoolValue () const
1046 // Shortcut for common case
1047 if (_attr == (READ|WRITE) && _type == BOOL)
1050 if (getAttribute(TRACE_READ))
1052 if (!getAttribute(READ))
1053 return SGRawValue<bool>::DefaultValue;
1056 return _value.alias->getBoolValue();
1060 return get_int() == 0 ? false : true;
1062 return get_long() == 0L ? false : true;
1064 return get_float() == 0.0 ? false : true;
1066 return get_double() == 0.0L ? false : true;
1069 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1072 return SGRawValue<bool>::DefaultValue;
1077 SGPropertyNode::getIntValue () const
1079 // Shortcut for common case
1080 if (_attr == (READ|WRITE) && _type == INT)
1083 if (getAttribute(TRACE_READ))
1085 if (!getAttribute(READ))
1086 return SGRawValue<int>::DefaultValue;
1089 return _value.alias->getIntValue();
1091 return int(get_bool());
1095 return int(get_long());
1097 return int(get_float());
1099 return int(get_double());
1102 return atoi(get_string());
1105 return SGRawValue<int>::DefaultValue;
1110 SGPropertyNode::getLongValue () const
1112 // Shortcut for common case
1113 if (_attr == (READ|WRITE) && _type == LONG)
1116 if (getAttribute(TRACE_READ))
1118 if (!getAttribute(READ))
1119 return SGRawValue<long>::DefaultValue;
1122 return _value.alias->getLongValue();
1124 return long(get_bool());
1126 return long(get_int());
1130 return long(get_float());
1132 return long(get_double());
1135 return strtol(get_string(), 0, 0);
1138 return SGRawValue<long>::DefaultValue;
1143 SGPropertyNode::getFloatValue () const
1145 // Shortcut for common case
1146 if (_attr == (READ|WRITE) && _type == FLOAT)
1149 if (getAttribute(TRACE_READ))
1151 if (!getAttribute(READ))
1152 return SGRawValue<float>::DefaultValue;
1155 return _value.alias->getFloatValue();
1157 return float(get_bool());
1159 return float(get_int());
1161 return float(get_long());
1165 return float(get_double());
1168 return atof(get_string());
1171 return SGRawValue<float>::DefaultValue;
1176 SGPropertyNode::getDoubleValue () const
1178 // Shortcut for common case
1179 if (_attr == (READ|WRITE) && _type == DOUBLE)
1180 return get_double();
1182 if (getAttribute(TRACE_READ))
1184 if (!getAttribute(READ))
1185 return SGRawValue<double>::DefaultValue;
1189 return _value.alias->getDoubleValue();
1191 return double(get_bool());
1193 return double(get_int());
1195 return double(get_long());
1197 return double(get_float());
1199 return get_double();
1202 return strtod(get_string(), 0);
1205 return SGRawValue<double>::DefaultValue;
1210 SGPropertyNode::getStringValue () const
1212 // Shortcut for common case
1213 if (_attr == (READ|WRITE) && _type == STRING)
1214 return get_string();
1216 if (getAttribute(TRACE_READ))
1218 if (!getAttribute(READ))
1219 return SGRawValue<const char *>::DefaultValue;
1220 return make_string();
1224 SGPropertyNode::setBoolValue (bool value)
1226 // Shortcut for common case
1227 if (_attr == (READ|WRITE) && _type == BOOL)
1228 return set_bool(value);
1230 bool result = false;
1232 if (_type == NONE || _type == UNSPECIFIED) {
1240 result = _value.alias->setBoolValue(value);
1243 result = set_bool(value);
1246 result = set_int(int(value));
1249 result = set_long(long(value));
1252 result = set_float(float(value));
1255 result = set_double(double(value));
1259 result = set_string(value ? "true" : "false");
1266 if (getAttribute(TRACE_WRITE))
1272 SGPropertyNode::setIntValue (int value)
1274 // Shortcut for common case
1275 if (_attr == (READ|WRITE) && _type == INT)
1276 return set_int(value);
1278 bool result = false;
1280 if (_type == NONE || _type == UNSPECIFIED) {
1283 _local_val.int_val = 0;
1288 result = _value.alias->setIntValue(value);
1291 result = set_bool(value == 0 ? false : true);
1294 result = set_int(value);
1297 result = set_long(long(value));
1300 result = set_float(float(value));
1303 result = set_double(double(value));
1308 sprintf(buf, "%d", value);
1309 result = set_string(buf);
1317 if (getAttribute(TRACE_WRITE))
1323 SGPropertyNode::setLongValue (long value)
1325 // Shortcut for common case
1326 if (_attr == (READ|WRITE) && _type == LONG)
1327 return set_long(value);
1329 bool result = false;
1331 if (_type == NONE || _type == UNSPECIFIED) {
1334 _local_val.long_val = 0L;
1339 result = _value.alias->setLongValue(value);
1342 result = set_bool(value == 0L ? false : true);
1345 result = set_int(int(value));
1348 result = set_long(value);
1351 result = set_float(float(value));
1354 result = set_double(double(value));
1359 sprintf(buf, "%ld", value);
1360 result = set_string(buf);
1368 if (getAttribute(TRACE_WRITE))
1374 SGPropertyNode::setFloatValue (float value)
1376 // Shortcut for common case
1377 if (_attr == (READ|WRITE) && _type == FLOAT)
1378 return set_float(value);
1380 bool result = false;
1382 if (_type == NONE || _type == UNSPECIFIED) {
1385 _local_val.float_val = 0;
1390 result = _value.alias->setFloatValue(value);
1393 result = set_bool(value == 0.0 ? false : true);
1396 result = set_int(int(value));
1399 result = set_long(long(value));
1402 result = set_float(value);
1405 result = set_double(double(value));
1410 sprintf(buf, "%f", value);
1411 result = set_string(buf);
1419 if (getAttribute(TRACE_WRITE))
1425 SGPropertyNode::setDoubleValue (double value)
1427 // Shortcut for common case
1428 if (_attr == (READ|WRITE) && _type == DOUBLE)
1429 return set_double(value);
1431 bool result = false;
1433 if (_type == NONE || _type == UNSPECIFIED) {
1435 _local_val.double_val = value;
1441 result = _value.alias->setDoubleValue(value);
1444 result = set_bool(value == 0.0L ? false : true);
1447 result = set_int(int(value));
1450 result = set_long(long(value));
1453 result = set_float(float(value));
1456 result = set_double(value);
1461 sprintf(buf, "%f", value);
1462 result = set_string(buf);
1470 if (getAttribute(TRACE_WRITE))
1476 SGPropertyNode::setStringValue (const char * value)
1478 // Shortcut for common case
1479 if (_attr == (READ|WRITE) && _type == STRING)
1480 return set_string(value);
1482 bool result = false;
1484 if (_type == NONE || _type == UNSPECIFIED) {
1491 result = _value.alias->setStringValue(value);
1494 result = set_bool((compare_strings(value, "true")
1495 || atoi(value)) ? true : false);
1498 result = set_int(atoi(value));
1501 result = set_long(strtol(value, 0, 0));
1504 result = set_float(atof(value));
1507 result = set_double(strtod(value, 0));
1511 result = set_string(value);
1518 if (getAttribute(TRACE_WRITE))
1524 SGPropertyNode::setUnspecifiedValue (const char * value)
1526 bool result = false;
1528 if (_type == NONE) {
1530 _type = UNSPECIFIED;
1535 result = _value.alias->setUnspecifiedValue(value);
1538 result = set_bool((compare_strings(value, "true")
1539 || atoi(value)) ? true : false);
1542 result = set_int(atoi(value));
1545 result = set_long(strtol(value, 0, 0));
1548 result = set_float(atof(value));
1551 result = set_double(strtod(value, 0));
1555 result = set_string(value);
1562 if (getAttribute(TRACE_WRITE))
1568 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1570 if (_type == ALIAS || _tied)
1573 useDefault = useDefault && hasValue();
1574 bool old_val = false;
1576 old_val = getBoolValue();
1581 _value.bool_val = rawValue.clone();
1584 setBoolValue(old_val);
1590 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1592 if (_type == ALIAS || _tied)
1595 useDefault = useDefault && hasValue();
1598 old_val = getIntValue();
1603 _value.int_val = rawValue.clone();
1606 setIntValue(old_val);
1612 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1614 if (_type == ALIAS || _tied)
1617 useDefault = useDefault && hasValue();
1620 old_val = getLongValue();
1625 _value.long_val = rawValue.clone();
1628 setLongValue(old_val);
1634 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1636 if (_type == ALIAS || _tied)
1639 useDefault = useDefault && hasValue();
1640 float old_val = 0.0;
1642 old_val = getFloatValue();
1647 _value.float_val = rawValue.clone();
1650 setFloatValue(old_val);
1656 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1658 if (_type == ALIAS || _tied)
1661 useDefault = useDefault && hasValue();
1662 double old_val = 0.0;
1664 old_val = getDoubleValue();
1669 _value.double_val = rawValue.clone();
1672 setDoubleValue(old_val);
1679 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1681 if (_type == ALIAS || _tied)
1684 useDefault = useDefault && hasValue();
1687 old_val = getStringValue();
1692 _value.string_val = rawValue.clone();
1695 setStringValue(old_val.c_str());
1701 SGPropertyNode::untie ()
1708 bool val = getBoolValue();
1711 _local_val.bool_val = val;
1715 int val = getIntValue();
1718 _local_val.int_val = val;
1722 long val = getLongValue();
1725 _local_val.long_val = val;
1729 float val = getFloatValue();
1732 _local_val.float_val = val;
1736 double val = getDoubleValue();
1739 _local_val.double_val = val;
1744 string val = getStringValue();
1747 _local_val.string_val = copy_string(val.c_str());
1760 SGPropertyNode::getRootNode ()
1765 return _parent->getRootNode();
1768 const SGPropertyNode *
1769 SGPropertyNode::getRootNode () const
1774 return _parent->getRootNode();
1778 SGPropertyNode::getNode (const char * relative_path, bool create)
1780 if (_path_cache == 0)
1781 _path_cache = new hash_table;
1783 SGPropertyNode * result = _path_cache->get(relative_path);
1785 vector<PathComponent> components;
1786 parse_path(relative_path, components);
1787 result = find_node(this, components, 0, create);
1789 _path_cache->put(relative_path, result);
1796 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1798 vector<PathComponent> components;
1799 parse_path(relative_path, components);
1800 if (components.size() > 0)
1801 components.back().index = index;
1802 return find_node(this, components, 0, create);
1805 const SGPropertyNode *
1806 SGPropertyNode::getNode (const char * relative_path) const
1808 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1811 const SGPropertyNode *
1812 SGPropertyNode::getNode (const char * relative_path, int index) const
1814 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1818 ////////////////////////////////////////////////////////////////////////
1819 // Convenience methods using relative paths.
1820 ////////////////////////////////////////////////////////////////////////
1824 * Test whether another node has a value attached.
1827 SGPropertyNode::hasValue (const char * relative_path) const
1829 const SGPropertyNode * node = getNode(relative_path);
1830 return (node == 0 ? false : node->hasValue());
1835 * Get the value type for another node.
1837 SGPropertyNode::Type
1838 SGPropertyNode::getType (const char * relative_path) const
1840 const SGPropertyNode * node = getNode(relative_path);
1841 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1846 * Get a bool value for another node.
1849 SGPropertyNode::getBoolValue (const char * relative_path,
1850 bool defaultValue) const
1852 const SGPropertyNode * node = getNode(relative_path);
1853 return (node == 0 ? defaultValue : node->getBoolValue());
1858 * Get an int value for another node.
1861 SGPropertyNode::getIntValue (const char * relative_path,
1862 int defaultValue) const
1864 const SGPropertyNode * node = getNode(relative_path);
1865 return (node == 0 ? defaultValue : node->getIntValue());
1870 * Get a long value for another node.
1873 SGPropertyNode::getLongValue (const char * relative_path,
1874 long defaultValue) const
1876 const SGPropertyNode * node = getNode(relative_path);
1877 return (node == 0 ? defaultValue : node->getLongValue());
1882 * Get a float value for another node.
1885 SGPropertyNode::getFloatValue (const char * relative_path,
1886 float defaultValue) const
1888 const SGPropertyNode * node = getNode(relative_path);
1889 return (node == 0 ? defaultValue : node->getFloatValue());
1894 * Get a double value for another node.
1897 SGPropertyNode::getDoubleValue (const char * relative_path,
1898 double defaultValue) const
1900 const SGPropertyNode * node = getNode(relative_path);
1901 return (node == 0 ? defaultValue : node->getDoubleValue());
1906 * Get a string value for another node.
1909 SGPropertyNode::getStringValue (const char * relative_path,
1910 const char * defaultValue) const
1912 const SGPropertyNode * node = getNode(relative_path);
1913 return (node == 0 ? defaultValue : node->getStringValue());
1918 * Set a bool value for another node.
1921 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1923 return getNode(relative_path, true)->setBoolValue(value);
1928 * Set an int value for another node.
1931 SGPropertyNode::setIntValue (const char * relative_path, int value)
1933 return getNode(relative_path, true)->setIntValue(value);
1938 * Set a long value for another node.
1941 SGPropertyNode::setLongValue (const char * relative_path, long value)
1943 return getNode(relative_path, true)->setLongValue(value);
1948 * Set a float value for another node.
1951 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1953 return getNode(relative_path, true)->setFloatValue(value);
1958 * Set a double value for another node.
1961 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1963 return getNode(relative_path, true)->setDoubleValue(value);
1968 * Set a string value for another node.
1971 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1973 return getNode(relative_path, true)->setStringValue(value);
1978 * Set an unknown value for another node.
1981 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1984 return getNode(relative_path, true)->setUnspecifiedValue(value);
1989 * Test whether another node is tied.
1992 SGPropertyNode::isTied (const char * relative_path) const
1994 const SGPropertyNode * node = getNode(relative_path);
1995 return (node == 0 ? false : node->isTied());
2000 * Tie a node reached by a relative path, creating it if necessary.
2003 SGPropertyNode::tie (const char * relative_path,
2004 const SGRawValue<bool> &rawValue,
2007 return getNode(relative_path, true)->tie(rawValue, useDefault);
2012 * Tie a node reached by a relative path, creating it if necessary.
2015 SGPropertyNode::tie (const char * relative_path,
2016 const SGRawValue<int> &rawValue,
2019 return getNode(relative_path, true)->tie(rawValue, useDefault);
2024 * Tie a node reached by a relative path, creating it if necessary.
2027 SGPropertyNode::tie (const char * relative_path,
2028 const SGRawValue<long> &rawValue,
2031 return getNode(relative_path, true)->tie(rawValue, useDefault);
2036 * Tie a node reached by a relative path, creating it if necessary.
2039 SGPropertyNode::tie (const char * relative_path,
2040 const SGRawValue<float> &rawValue,
2043 return getNode(relative_path, true)->tie(rawValue, useDefault);
2048 * Tie a node reached by a relative path, creating it if necessary.
2051 SGPropertyNode::tie (const char * relative_path,
2052 const SGRawValue<double> &rawValue,
2055 return getNode(relative_path, true)->tie(rawValue, useDefault);
2060 * Tie a node reached by a relative path, creating it if necessary.
2063 SGPropertyNode::tie (const char * relative_path,
2064 const SGRawValue<const char *> &rawValue,
2067 return getNode(relative_path, true)->tie(rawValue, useDefault);
2072 * Attempt to untie another node reached by a relative path.
2075 SGPropertyNode::untie (const char * relative_path)
2077 SGPropertyNode * node = getNode(relative_path);
2078 return (node == 0 ? false : node->untie());
2082 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2085 if (_listeners == 0)
2086 _listeners = new vector<SGPropertyChangeListener*>;
2087 _listeners->push_back(listener);
2088 listener->register_property(this);
2090 listener->valueChanged(this);
2094 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2096 vector<SGPropertyChangeListener*>::iterator it =
2097 find(_listeners->begin(), _listeners->end(), listener);
2098 if (it != _listeners->end()) {
2099 _listeners->erase(it);
2100 listener->unregister_property(this);
2101 if (_listeners->empty()) {
2102 vector<SGPropertyChangeListener*>* tmp = _listeners;
2110 SGPropertyNode::fireValueChanged ()
2112 fireValueChanged(this);
2116 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2118 fireChildAdded(this, child);
2122 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2124 fireChildRemoved(this, child);
2128 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2130 if (_listeners != 0) {
2131 for (unsigned int i = 0; i < _listeners->size(); i++) {
2132 (*_listeners)[i]->valueChanged(node);
2136 _parent->fireValueChanged(node);
2140 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2141 SGPropertyNode * child)
2143 if (_listeners != 0) {
2144 for (unsigned int i = 0; i < _listeners->size(); i++) {
2145 (*_listeners)[i]->childAdded(parent, child);
2149 _parent->fireChildAdded(parent, child);
2153 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2154 SGPropertyNode * child)
2156 if (_listeners != 0) {
2157 for (unsigned int i = 0; i < _listeners->size(); i++) {
2158 (*_listeners)[i]->childRemoved(parent, child);
2162 _parent->fireChildRemoved(parent, child);
2167 ////////////////////////////////////////////////////////////////////////
2168 // Simplified hash table for caching paths.
2169 ////////////////////////////////////////////////////////////////////////
2171 #define HASH_TABLE_SIZE 199
2173 SGPropertyNode::hash_table::entry::entry ()
2178 SGPropertyNode::hash_table::entry::~entry ()
2180 // Don't delete the value; we don't own
2185 SGPropertyNode::hash_table::entry::set_key (const char * key)
2191 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2196 SGPropertyNode::hash_table::bucket::bucket ()
2202 SGPropertyNode::hash_table::bucket::~bucket ()
2204 for (int i = 0; i < _length; i++)
2209 SGPropertyNode::hash_table::entry *
2210 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2213 for (i = 0; i < _length; i++) {
2214 if (!strcmp(_entries[i]->get_key(), key))
2218 entry ** new_entries = new entry*[_length+1];
2219 for (i = 0; i < _length; i++) {
2220 new_entries[i] = _entries[i];
2223 _entries = new_entries;
2224 _entries[_length] = new entry;
2225 _entries[_length]->set_key(key);
2227 return _entries[_length - 1];
2234 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2236 for (int i = 0; i < _length; i++) {
2237 if (_entries[i]->get_value() == node) {
2239 for (++i; i < _length; i++) {
2240 _entries[i-1] = _entries[i];
2250 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2252 for (int i = 0; i < _length; i++) {
2253 SGPropertyNode * node = _entries[i]->get_value();
2255 node->remove_linked_node(owner);
2259 SGPropertyNode::hash_table::hash_table ()
2265 SGPropertyNode::hash_table::~hash_table ()
2267 for (unsigned int i = 0; i < _data_length; i++) {
2269 _data[i]->clear(this);
2277 SGPropertyNode::hash_table::get (const char * key)
2279 if (_data_length == 0)
2281 unsigned int index = hashcode(key) % _data_length;
2282 if (_data[index] == 0)
2284 entry * e = _data[index]->get_entry(key);
2288 return e->get_value();
2292 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2294 if (_data_length == 0) {
2295 _data = new bucket*[HASH_TABLE_SIZE];
2296 _data_length = HASH_TABLE_SIZE;
2297 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2300 unsigned int index = hashcode(key) % _data_length;
2301 if (_data[index] == 0) {
2302 _data[index] = new bucket;
2304 entry * e = _data[index]->get_entry(key, true);
2305 e->set_value(value);
2306 value->add_linked_node(this);
2310 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2312 for (unsigned int i = 0; i < _data_length; i++)
2313 if (_data[i] && _data[i]->erase(node))
2320 SGPropertyNode::hash_table::hashcode (const char * key)
2322 unsigned int hash = 0;
2324 hash = 31 * hash + *key;
2332 ////////////////////////////////////////////////////////////////////////
2333 // Implementation of SGPropertyChangeListener.
2334 ////////////////////////////////////////////////////////////////////////
2336 SGPropertyChangeListener::~SGPropertyChangeListener ()
2338 for (int i = _properties.size() - 1; i >= 0; i--)
2339 _properties[i]->removeChangeListener(this);
2343 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2349 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2350 SGPropertyNode * child)
2356 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2357 SGPropertyNode * child)
2363 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2365 _properties.push_back(node);
2369 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2371 vector<SGPropertyNode *>::iterator it =
2372 find(_properties.begin(), _properties.end(), node);
2373 if (it != _properties.end())
2374 _properties.erase(it);