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 SG_USING_STD(vector<SGPropertyNode_ptr>);
27 SG_USING_STD(vector<SGPropertyChangeListener *>);
28 SG_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 ()
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();
554 _buffer = sstr.str();
555 return _buffer.c_str();
561 _buffer = sstr.str();
562 return _buffer.c_str();
568 _buffer = sstr.str();
569 return _buffer.c_str();
574 sstr.precision( 10 );
575 sstr << get_double();
576 _buffer = sstr.str();
577 return _buffer.c_str();
589 * Trace a write access for a property.
592 SGPropertyNode::trace_write () const
595 cerr << "TRACE: Write node " << getPath () << ", value \""
596 << make_string() << '"' << endl;
598 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Write node " << getPath()
599 << ", value \"" << make_string() << '"');
604 * Trace a read access for a property.
607 SGPropertyNode::trace_read () const
610 cerr << "TRACE: Write node " << getPath () << ", value \""
611 << make_string() << '"' << endl;
613 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Read node " << getPath()
614 << ", value \"" << make_string() << '"');
619 ////////////////////////////////////////////////////////////////////////
620 // Public methods from SGPropertyNode.
621 ////////////////////////////////////////////////////////////////////////
624 * Last used attribute
625 * Update as needed when enum Attribute is changed
627 const int SGPropertyNode::LAST_USED_ATTRIBUTE = USERARCHIVE;
630 * Default constructor: always creates a root node.
632 SGPropertyNode::SGPropertyNode ()
641 _local_val.string_val = 0;
648 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
649 : _index(node._index),
651 _parent(0), // don't copy the parent
656 _listeners(0) // CHECK!!
658 _local_val.string_val = 0;
663 _value.alias = node._value.alias;
669 _value.bool_val = node._value.bool_val->clone();
672 set_bool(node.get_bool());
678 _value.int_val = node._value.int_val->clone();
681 set_int(node.get_int());
687 _value.long_val = node._value.long_val->clone();
690 set_long(node.get_long());
696 _value.float_val = node._value.float_val->clone();
699 set_float(node.get_float());
705 _value.double_val = node._value.double_val->clone();
708 set_double(node.get_double());
715 _value.string_val = node._value.string_val->clone();
718 set_string(node.get_string());
726 * Convenience constructor.
728 SGPropertyNode::SGPropertyNode (const char * name,
730 SGPropertyNode * parent)
740 _name = parse_name(name, i);
741 if (i != int(strlen(name)) || name[0] == '.')
742 throw string("plain name expected instead of '") + name + '\'';
744 _local_val.string_val = 0;
751 SGPropertyNode::~SGPropertyNode ()
753 // zero out all parent pointers, else they might be dangling
754 for (unsigned i = 0; i < _children.size(); ++i)
755 _children[i]->_parent = 0;
756 for (unsigned i = 0; i < _removedChildren.size(); ++i)
757 _removedChildren[i]->_parent = 0;
762 vector<SGPropertyChangeListener*>::iterator it;
763 for (it = _listeners->begin(); it != _listeners->end(); ++it)
764 (*it)->unregister_property(this);
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 this node and all children from nodes that link to them
916 * in their path cache.
919 SGPropertyNode::remove_from_path_caches ()
921 for (unsigned int i = 0; i < _children.size(); ++i)
922 _children[i]->remove_from_path_caches();
924 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
925 _linkedNodes[i]->erase(this);
926 _linkedNodes.clear();
931 * Remove child by position.
934 SGPropertyNode::removeChild (int pos, bool keep)
936 SGPropertyNode_ptr node;
937 if (pos < 0 || pos >= (int)_children.size())
940 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
942 node = _children[pos];
945 _removedChildren.push_back(node);
948 node->remove_from_path_caches();
949 node->setAttribute(REMOVED, true);
951 fireChildRemoved(node);
957 * Remove a child node
960 SGPropertyNode::removeChild (const char * name, int index, bool keep)
962 SGPropertyNode_ptr ret;
963 int pos = find_child(name, index, _children);
965 ret = removeChild(pos, keep);
971 * Remove all children with the specified name.
973 vector<SGPropertyNode_ptr>
974 SGPropertyNode::removeChildren (const char * name, bool keep)
976 vector<SGPropertyNode_ptr> children;
978 for (int pos = _children.size() - 1; pos >= 0; pos--)
979 if (compare_strings(_children[pos]->getName(), name))
980 children.push_back(removeChild(pos, keep));
982 sort(children.begin(), children.end(), CompareIndices());
988 * Remove a linked node.
991 SGPropertyNode::remove_linked_node (hash_table * node)
993 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
994 if (_linkedNodes[i] == node) {
995 vector<hash_table *>::iterator it = _linkedNodes.begin();
997 _linkedNodes.erase(it);
1006 SGPropertyNode::getDisplayName (bool simplify) const
1008 _display_name = _name;
1009 if (_index != 0 || !simplify) {
1011 sstr << '[' << _index << ']';
1012 _display_name += sstr.str();
1014 return _display_name.c_str();
1019 SGPropertyNode::getPath (bool simplify) const
1021 // Calculate the complete path only once.
1022 if (_parent != 0 && _path.empty()) {
1023 _path = _parent->getPath(simplify);
1025 _path += getDisplayName(simplify);
1028 return _path.c_str();
1031 SGPropertyNode::Type
1032 SGPropertyNode::getType () const
1035 return _value.alias->getType();
1042 SGPropertyNode::getBoolValue () const
1044 // Shortcut for common case
1045 if (_attr == (READ|WRITE) && _type == BOOL)
1048 if (getAttribute(TRACE_READ))
1050 if (!getAttribute(READ))
1051 return SGRawValue<bool>::DefaultValue;
1054 return _value.alias->getBoolValue();
1058 return get_int() == 0 ? false : true;
1060 return get_long() == 0L ? false : true;
1062 return get_float() == 0.0 ? false : true;
1064 return get_double() == 0.0L ? false : true;
1067 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1070 return SGRawValue<bool>::DefaultValue;
1075 SGPropertyNode::getIntValue () const
1077 // Shortcut for common case
1078 if (_attr == (READ|WRITE) && _type == INT)
1081 if (getAttribute(TRACE_READ))
1083 if (!getAttribute(READ))
1084 return SGRawValue<int>::DefaultValue;
1087 return _value.alias->getIntValue();
1089 return int(get_bool());
1093 return int(get_long());
1095 return int(get_float());
1097 return int(get_double());
1100 return atoi(get_string());
1103 return SGRawValue<int>::DefaultValue;
1108 SGPropertyNode::getLongValue () const
1110 // Shortcut for common case
1111 if (_attr == (READ|WRITE) && _type == LONG)
1114 if (getAttribute(TRACE_READ))
1116 if (!getAttribute(READ))
1117 return SGRawValue<long>::DefaultValue;
1120 return _value.alias->getLongValue();
1122 return long(get_bool());
1124 return long(get_int());
1128 return long(get_float());
1130 return long(get_double());
1133 return strtol(get_string(), 0, 0);
1136 return SGRawValue<long>::DefaultValue;
1141 SGPropertyNode::getFloatValue () const
1143 // Shortcut for common case
1144 if (_attr == (READ|WRITE) && _type == FLOAT)
1147 if (getAttribute(TRACE_READ))
1149 if (!getAttribute(READ))
1150 return SGRawValue<float>::DefaultValue;
1153 return _value.alias->getFloatValue();
1155 return float(get_bool());
1157 return float(get_int());
1159 return float(get_long());
1163 return float(get_double());
1166 return atof(get_string());
1169 return SGRawValue<float>::DefaultValue;
1174 SGPropertyNode::getDoubleValue () const
1176 // Shortcut for common case
1177 if (_attr == (READ|WRITE) && _type == DOUBLE)
1178 return get_double();
1180 if (getAttribute(TRACE_READ))
1182 if (!getAttribute(READ))
1183 return SGRawValue<double>::DefaultValue;
1187 return _value.alias->getDoubleValue();
1189 return double(get_bool());
1191 return double(get_int());
1193 return double(get_long());
1195 return double(get_float());
1197 return get_double();
1200 return strtod(get_string(), 0);
1203 return SGRawValue<double>::DefaultValue;
1208 SGPropertyNode::getStringValue () const
1210 // Shortcut for common case
1211 if (_attr == (READ|WRITE) && _type == STRING)
1212 return get_string();
1214 if (getAttribute(TRACE_READ))
1216 if (!getAttribute(READ))
1217 return SGRawValue<const char *>::DefaultValue;
1218 return make_string();
1222 SGPropertyNode::setBoolValue (bool value)
1224 // Shortcut for common case
1225 if (_attr == (READ|WRITE) && _type == BOOL)
1226 return set_bool(value);
1228 bool result = false;
1230 if (_type == NONE || _type == UNSPECIFIED) {
1238 result = _value.alias->setBoolValue(value);
1241 result = set_bool(value);
1244 result = set_int(int(value));
1247 result = set_long(long(value));
1250 result = set_float(float(value));
1253 result = set_double(double(value));
1257 result = set_string(value ? "true" : "false");
1264 if (getAttribute(TRACE_WRITE))
1270 SGPropertyNode::setIntValue (int value)
1272 // Shortcut for common case
1273 if (_attr == (READ|WRITE) && _type == INT)
1274 return set_int(value);
1276 bool result = false;
1278 if (_type == NONE || _type == UNSPECIFIED) {
1281 _local_val.int_val = 0;
1286 result = _value.alias->setIntValue(value);
1289 result = set_bool(value == 0 ? false : true);
1292 result = set_int(value);
1295 result = set_long(long(value));
1298 result = set_float(float(value));
1301 result = set_double(double(value));
1306 sprintf(buf, "%d", value);
1307 result = set_string(buf);
1315 if (getAttribute(TRACE_WRITE))
1321 SGPropertyNode::setLongValue (long value)
1323 // Shortcut for common case
1324 if (_attr == (READ|WRITE) && _type == LONG)
1325 return set_long(value);
1327 bool result = false;
1329 if (_type == NONE || _type == UNSPECIFIED) {
1332 _local_val.long_val = 0L;
1337 result = _value.alias->setLongValue(value);
1340 result = set_bool(value == 0L ? false : true);
1343 result = set_int(int(value));
1346 result = set_long(value);
1349 result = set_float(float(value));
1352 result = set_double(double(value));
1357 sprintf(buf, "%ld", value);
1358 result = set_string(buf);
1366 if (getAttribute(TRACE_WRITE))
1372 SGPropertyNode::setFloatValue (float value)
1374 // Shortcut for common case
1375 if (_attr == (READ|WRITE) && _type == FLOAT)
1376 return set_float(value);
1378 bool result = false;
1380 if (_type == NONE || _type == UNSPECIFIED) {
1383 _local_val.float_val = 0;
1388 result = _value.alias->setFloatValue(value);
1391 result = set_bool(value == 0.0 ? false : true);
1394 result = set_int(int(value));
1397 result = set_long(long(value));
1400 result = set_float(value);
1403 result = set_double(double(value));
1408 sprintf(buf, "%f", value);
1409 result = set_string(buf);
1417 if (getAttribute(TRACE_WRITE))
1423 SGPropertyNode::setDoubleValue (double value)
1425 // Shortcut for common case
1426 if (_attr == (READ|WRITE) && _type == DOUBLE)
1427 return set_double(value);
1429 bool result = false;
1431 if (_type == NONE || _type == UNSPECIFIED) {
1433 _local_val.double_val = value;
1439 result = _value.alias->setDoubleValue(value);
1442 result = set_bool(value == 0.0L ? false : true);
1445 result = set_int(int(value));
1448 result = set_long(long(value));
1451 result = set_float(float(value));
1454 result = set_double(value);
1459 sprintf(buf, "%f", value);
1460 result = set_string(buf);
1468 if (getAttribute(TRACE_WRITE))
1474 SGPropertyNode::setStringValue (const char * value)
1476 // Shortcut for common case
1477 if (_attr == (READ|WRITE) && _type == STRING)
1478 return set_string(value);
1480 bool result = false;
1482 if (_type == NONE || _type == UNSPECIFIED) {
1489 result = _value.alias->setStringValue(value);
1492 result = set_bool((compare_strings(value, "true")
1493 || atoi(value)) ? true : false);
1496 result = set_int(atoi(value));
1499 result = set_long(strtol(value, 0, 0));
1502 result = set_float(atof(value));
1505 result = set_double(strtod(value, 0));
1509 result = set_string(value);
1516 if (getAttribute(TRACE_WRITE))
1522 SGPropertyNode::setUnspecifiedValue (const char * value)
1524 bool result = false;
1526 if (_type == NONE) {
1528 _type = UNSPECIFIED;
1533 result = _value.alias->setUnspecifiedValue(value);
1536 result = set_bool((compare_strings(value, "true")
1537 || atoi(value)) ? true : false);
1540 result = set_int(atoi(value));
1543 result = set_long(strtol(value, 0, 0));
1546 result = set_float(atof(value));
1549 result = set_double(strtod(value, 0));
1553 result = set_string(value);
1560 if (getAttribute(TRACE_WRITE))
1566 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1568 if (_type == ALIAS || _tied)
1571 useDefault = useDefault && hasValue();
1572 bool old_val = false;
1574 old_val = getBoolValue();
1579 _value.bool_val = rawValue.clone();
1582 setBoolValue(old_val);
1588 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1590 if (_type == ALIAS || _tied)
1593 useDefault = useDefault && hasValue();
1596 old_val = getIntValue();
1601 _value.int_val = rawValue.clone();
1604 setIntValue(old_val);
1610 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1612 if (_type == ALIAS || _tied)
1615 useDefault = useDefault && hasValue();
1618 old_val = getLongValue();
1623 _value.long_val = rawValue.clone();
1626 setLongValue(old_val);
1632 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1634 if (_type == ALIAS || _tied)
1637 useDefault = useDefault && hasValue();
1638 float old_val = 0.0;
1640 old_val = getFloatValue();
1645 _value.float_val = rawValue.clone();
1648 setFloatValue(old_val);
1654 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1656 if (_type == ALIAS || _tied)
1659 useDefault = useDefault && hasValue();
1660 double old_val = 0.0;
1662 old_val = getDoubleValue();
1667 _value.double_val = rawValue.clone();
1670 setDoubleValue(old_val);
1677 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1679 if (_type == ALIAS || _tied)
1682 useDefault = useDefault && hasValue();
1685 old_val = getStringValue();
1690 _value.string_val = rawValue.clone();
1693 setStringValue(old_val.c_str());
1699 SGPropertyNode::untie ()
1706 bool val = getBoolValue();
1709 _local_val.bool_val = val;
1713 int val = getIntValue();
1716 _local_val.int_val = val;
1720 long val = getLongValue();
1723 _local_val.long_val = val;
1727 float val = getFloatValue();
1730 _local_val.float_val = val;
1734 double val = getDoubleValue();
1737 _local_val.double_val = val;
1742 string val = getStringValue();
1745 _local_val.string_val = copy_string(val.c_str());
1758 SGPropertyNode::getRootNode ()
1763 return _parent->getRootNode();
1766 const SGPropertyNode *
1767 SGPropertyNode::getRootNode () const
1772 return _parent->getRootNode();
1776 SGPropertyNode::getNode (const char * relative_path, bool create)
1778 if (_path_cache == 0)
1779 _path_cache = new hash_table;
1781 SGPropertyNode * result = _path_cache->get(relative_path);
1783 vector<PathComponent> components;
1784 parse_path(relative_path, components);
1785 result = find_node(this, components, 0, create);
1787 _path_cache->put(relative_path, result);
1794 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1796 vector<PathComponent> components;
1797 parse_path(relative_path, components);
1798 if (components.size() > 0)
1799 components.back().index = index;
1800 return find_node(this, components, 0, create);
1803 const SGPropertyNode *
1804 SGPropertyNode::getNode (const char * relative_path) const
1806 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1809 const SGPropertyNode *
1810 SGPropertyNode::getNode (const char * relative_path, int index) const
1812 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1816 ////////////////////////////////////////////////////////////////////////
1817 // Convenience methods using relative paths.
1818 ////////////////////////////////////////////////////////////////////////
1822 * Test whether another node has a value attached.
1825 SGPropertyNode::hasValue (const char * relative_path) const
1827 const SGPropertyNode * node = getNode(relative_path);
1828 return (node == 0 ? false : node->hasValue());
1833 * Get the value type for another node.
1835 SGPropertyNode::Type
1836 SGPropertyNode::getType (const char * relative_path) const
1838 const SGPropertyNode * node = getNode(relative_path);
1839 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1844 * Get a bool value for another node.
1847 SGPropertyNode::getBoolValue (const char * relative_path,
1848 bool defaultValue) const
1850 const SGPropertyNode * node = getNode(relative_path);
1851 return (node == 0 ? defaultValue : node->getBoolValue());
1856 * Get an int value for another node.
1859 SGPropertyNode::getIntValue (const char * relative_path,
1860 int defaultValue) const
1862 const SGPropertyNode * node = getNode(relative_path);
1863 return (node == 0 ? defaultValue : node->getIntValue());
1868 * Get a long value for another node.
1871 SGPropertyNode::getLongValue (const char * relative_path,
1872 long defaultValue) const
1874 const SGPropertyNode * node = getNode(relative_path);
1875 return (node == 0 ? defaultValue : node->getLongValue());
1880 * Get a float value for another node.
1883 SGPropertyNode::getFloatValue (const char * relative_path,
1884 float defaultValue) const
1886 const SGPropertyNode * node = getNode(relative_path);
1887 return (node == 0 ? defaultValue : node->getFloatValue());
1892 * Get a double value for another node.
1895 SGPropertyNode::getDoubleValue (const char * relative_path,
1896 double defaultValue) const
1898 const SGPropertyNode * node = getNode(relative_path);
1899 return (node == 0 ? defaultValue : node->getDoubleValue());
1904 * Get a string value for another node.
1907 SGPropertyNode::getStringValue (const char * relative_path,
1908 const char * defaultValue) const
1910 const SGPropertyNode * node = getNode(relative_path);
1911 return (node == 0 ? defaultValue : node->getStringValue());
1916 * Set a bool value for another node.
1919 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1921 return getNode(relative_path, true)->setBoolValue(value);
1926 * Set an int value for another node.
1929 SGPropertyNode::setIntValue (const char * relative_path, int value)
1931 return getNode(relative_path, true)->setIntValue(value);
1936 * Set a long value for another node.
1939 SGPropertyNode::setLongValue (const char * relative_path, long value)
1941 return getNode(relative_path, true)->setLongValue(value);
1946 * Set a float value for another node.
1949 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1951 return getNode(relative_path, true)->setFloatValue(value);
1956 * Set a double value for another node.
1959 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1961 return getNode(relative_path, true)->setDoubleValue(value);
1966 * Set a string value for another node.
1969 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1971 return getNode(relative_path, true)->setStringValue(value);
1976 * Set an unknown value for another node.
1979 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1982 return getNode(relative_path, true)->setUnspecifiedValue(value);
1987 * Test whether another node is tied.
1990 SGPropertyNode::isTied (const char * relative_path) const
1992 const SGPropertyNode * node = getNode(relative_path);
1993 return (node == 0 ? false : node->isTied());
1998 * Tie a node reached by a relative path, creating it if necessary.
2001 SGPropertyNode::tie (const char * relative_path,
2002 const SGRawValue<bool> &rawValue,
2005 return getNode(relative_path, true)->tie(rawValue, useDefault);
2010 * Tie a node reached by a relative path, creating it if necessary.
2013 SGPropertyNode::tie (const char * relative_path,
2014 const SGRawValue<int> &rawValue,
2017 return getNode(relative_path, true)->tie(rawValue, useDefault);
2022 * Tie a node reached by a relative path, creating it if necessary.
2025 SGPropertyNode::tie (const char * relative_path,
2026 const SGRawValue<long> &rawValue,
2029 return getNode(relative_path, true)->tie(rawValue, useDefault);
2034 * Tie a node reached by a relative path, creating it if necessary.
2037 SGPropertyNode::tie (const char * relative_path,
2038 const SGRawValue<float> &rawValue,
2041 return getNode(relative_path, true)->tie(rawValue, useDefault);
2046 * Tie a node reached by a relative path, creating it if necessary.
2049 SGPropertyNode::tie (const char * relative_path,
2050 const SGRawValue<double> &rawValue,
2053 return getNode(relative_path, true)->tie(rawValue, useDefault);
2058 * Tie a node reached by a relative path, creating it if necessary.
2061 SGPropertyNode::tie (const char * relative_path,
2062 const SGRawValue<const char *> &rawValue,
2065 return getNode(relative_path, true)->tie(rawValue, useDefault);
2070 * Attempt to untie another node reached by a relative path.
2073 SGPropertyNode::untie (const char * relative_path)
2075 SGPropertyNode * node = getNode(relative_path);
2076 return (node == 0 ? false : node->untie());
2080 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2083 if (_listeners == 0)
2084 _listeners = new vector<SGPropertyChangeListener*>;
2085 _listeners->push_back(listener);
2086 listener->register_property(this);
2088 listener->valueChanged(this);
2092 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2094 vector<SGPropertyChangeListener*>::iterator it =
2095 find(_listeners->begin(), _listeners->end(), listener);
2096 if (it != _listeners->end()) {
2097 _listeners->erase(it);
2098 listener->unregister_property(this);
2099 if (_listeners->empty()) {
2100 vector<SGPropertyChangeListener*>* tmp = _listeners;
2108 SGPropertyNode::fireValueChanged ()
2110 fireValueChanged(this);
2114 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2116 fireChildAdded(this, child);
2120 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2122 fireChildRemoved(this, child);
2126 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2128 if (_listeners != 0) {
2129 for (unsigned int i = 0; i < _listeners->size(); i++) {
2130 (*_listeners)[i]->valueChanged(node);
2134 _parent->fireValueChanged(node);
2138 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2139 SGPropertyNode * child)
2141 if (_listeners != 0) {
2142 for (unsigned int i = 0; i < _listeners->size(); i++) {
2143 (*_listeners)[i]->childAdded(parent, child);
2147 _parent->fireChildAdded(parent, child);
2151 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2152 SGPropertyNode * child)
2154 if (_listeners != 0) {
2155 for (unsigned int i = 0; i < _listeners->size(); i++) {
2156 (*_listeners)[i]->childRemoved(parent, child);
2160 _parent->fireChildRemoved(parent, child);
2165 ////////////////////////////////////////////////////////////////////////
2166 // Simplified hash table for caching paths.
2167 ////////////////////////////////////////////////////////////////////////
2169 #define HASH_TABLE_SIZE 199
2171 SGPropertyNode::hash_table::entry::entry ()
2176 SGPropertyNode::hash_table::entry::~entry ()
2178 // Don't delete the value; we don't own
2183 SGPropertyNode::hash_table::entry::set_key (const char * key)
2189 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2194 SGPropertyNode::hash_table::bucket::bucket ()
2200 SGPropertyNode::hash_table::bucket::~bucket ()
2202 for (int i = 0; i < _length; i++)
2207 SGPropertyNode::hash_table::entry *
2208 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2211 for (i = 0; i < _length; i++) {
2212 if (!strcmp(_entries[i]->get_key(), key))
2216 entry ** new_entries = new entry*[_length+1];
2217 for (i = 0; i < _length; i++) {
2218 new_entries[i] = _entries[i];
2221 _entries = new_entries;
2222 _entries[_length] = new entry;
2223 _entries[_length]->set_key(key);
2225 return _entries[_length - 1];
2232 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2234 for (int i = 0; i < _length; i++) {
2235 if (_entries[i]->get_value() == node) {
2237 for (++i; i < _length; i++) {
2238 _entries[i-1] = _entries[i];
2248 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2250 for (int i = 0; i < _length; i++) {
2251 SGPropertyNode * node = _entries[i]->get_value();
2253 node->remove_linked_node(owner);
2257 SGPropertyNode::hash_table::hash_table ()
2263 SGPropertyNode::hash_table::~hash_table ()
2265 for (unsigned int i = 0; i < _data_length; i++) {
2267 _data[i]->clear(this);
2275 SGPropertyNode::hash_table::get (const char * key)
2277 if (_data_length == 0)
2279 unsigned int index = hashcode(key) % _data_length;
2280 if (_data[index] == 0)
2282 entry * e = _data[index]->get_entry(key);
2286 return e->get_value();
2290 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2292 if (_data_length == 0) {
2293 _data = new bucket*[HASH_TABLE_SIZE];
2294 _data_length = HASH_TABLE_SIZE;
2295 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2298 unsigned int index = hashcode(key) % _data_length;
2299 if (_data[index] == 0) {
2300 _data[index] = new bucket;
2302 entry * e = _data[index]->get_entry(key, true);
2303 e->set_value(value);
2304 value->add_linked_node(this);
2308 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2310 for (unsigned int i = 0; i < _data_length; i++)
2311 if (_data[i] && _data[i]->erase(node))
2318 SGPropertyNode::hash_table::hashcode (const char * key)
2320 unsigned int hash = 0;
2322 hash = 31 * hash + *key;
2330 ////////////////////////////////////////////////////////////////////////
2331 // Implementation of SGPropertyChangeListener.
2332 ////////////////////////////////////////////////////////////////////////
2334 SGPropertyChangeListener::~SGPropertyChangeListener ()
2336 for (int i = _properties.size() - 1; i >= 0; i--)
2337 _properties[i]->removeChangeListener(this);
2341 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2347 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2348 SGPropertyNode * child)
2354 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2355 SGPropertyNode * child)
2361 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2363 _properties.push_back(node);
2367 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2369 vector<SGPropertyNode *>::iterator it =
2370 find(_properties.begin(), _properties.end(), node);
2371 if (it != _properties.end())
2372 _properties.erase(it);