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_ALERT, "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_ALERT, "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 _name = parse_name(name, i);
744 if (i != int(strlen(name)) || name[0] == '.')
745 throw string("plain name expected instead of '") + name + '\'';
747 _local_val.string_val = 0;
754 SGPropertyNode::~SGPropertyNode ()
756 // zero out all parent pointers, else they might be dangling
757 for (unsigned i = 0; i < _children.size(); ++i)
758 _children[i]->_parent = 0;
759 for (unsigned i = 0; i < _removedChildren.size(); ++i)
760 _removedChildren[i]->_parent = 0;
765 vector<SGPropertyChangeListener*>::iterator it;
766 for (it = _listeners->begin(); it != _listeners->end(); ++it)
767 (*it)->unregister_property(this);
774 * Alias to another node.
777 SGPropertyNode::alias (SGPropertyNode * target)
779 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 ()
813 * Get the target of an alias.
816 SGPropertyNode::getAliasTarget ()
818 return (_type == ALIAS ? _value.alias : 0);
822 const SGPropertyNode *
823 SGPropertyNode::getAliasTarget () const
825 return (_type == ALIAS ? _value.alias : 0);
830 * Get a non-const child by index.
833 SGPropertyNode::getChild (int position)
835 if (position >= 0 && position < nChildren())
836 return _children[position];
843 * Get a const child by index.
845 const SGPropertyNode *
846 SGPropertyNode::getChild (int position) const
848 if (position >= 0 && position < nChildren())
849 return _children[position];
856 * Get a non-const child by name and index, creating if necessary.
859 SGPropertyNode::getChild (const char * name, int index, bool create)
861 int pos = find_child(name, index, _children);
863 return _children[pos];
865 SGPropertyNode_ptr node;
866 pos = find_child(name, index, _removedChildren);
868 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
870 node = _removedChildren[pos];
871 _removedChildren.erase(it);
872 node->setAttribute(REMOVED, false);
874 node = new SGPropertyNode(name, index, this);
876 _children.push_back(node);
877 fireChildAdded(node);
886 * Get a const child by name and index.
888 const SGPropertyNode *
889 SGPropertyNode::getChild (const char * name, int index) const
891 int pos = find_child(name, index, _children);
893 return _children[pos];
900 * Get all children with the same name (but different indices).
902 vector<SGPropertyNode_ptr>
903 SGPropertyNode::getChildren (const char * name) const
905 vector<SGPropertyNode_ptr> children;
906 int max = _children.size();
908 for (int i = 0; i < max; i++)
909 if (compare_strings(_children[i]->getName(), name))
910 children.push_back(_children[i]);
912 sort(children.begin(), children.end(), CompareIndices());
918 * Remove this node and all children from nodes that link to them
919 * in their path cache.
922 SGPropertyNode::remove_from_path_caches ()
924 for (unsigned int i = 0; i < _children.size(); ++i)
925 _children[i]->remove_from_path_caches();
927 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
928 _linkedNodes[i]->erase(this);
929 _linkedNodes.clear();
934 * Remove child by position.
937 SGPropertyNode::removeChild (int pos, bool keep)
939 SGPropertyNode_ptr node;
940 if (pos < 0 || pos >= (int)_children.size())
943 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
945 node = _children[pos];
948 _removedChildren.push_back(node);
951 node->remove_from_path_caches();
952 node->setAttribute(REMOVED, true);
954 fireChildRemoved(node);
960 * Remove a child node
963 SGPropertyNode::removeChild (const char * name, int index, bool keep)
965 SGPropertyNode_ptr ret;
966 int pos = find_child(name, index, _children);
968 ret = removeChild(pos, keep);
974 * Remove all children with the specified name.
976 vector<SGPropertyNode_ptr>
977 SGPropertyNode::removeChildren (const char * name, bool keep)
979 vector<SGPropertyNode_ptr> children;
981 for (int pos = _children.size() - 1; pos >= 0; pos--)
982 if (compare_strings(_children[pos]->getName(), name))
983 children.push_back(removeChild(pos, keep));
985 sort(children.begin(), children.end(), CompareIndices());
991 * Remove a linked node.
994 SGPropertyNode::remove_linked_node (hash_table * node)
996 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
997 if (_linkedNodes[i] == node) {
998 vector<hash_table *>::iterator it = _linkedNodes.begin();
1000 _linkedNodes.erase(it);
1009 SGPropertyNode::getDisplayName (bool simplify) const
1011 _display_name = _name;
1012 if (_index != 0 || !simplify) {
1014 sstr << '[' << _index << ']';
1015 _display_name += sstr.str();
1017 return _display_name.c_str();
1022 SGPropertyNode::getPath (bool simplify) const
1024 // Calculate the complete path only once.
1025 if (_parent != 0 && _path.empty()) {
1026 _path = _parent->getPath(simplify);
1028 _path += getDisplayName(simplify);
1031 return _path.c_str();
1034 SGPropertyNode::Type
1035 SGPropertyNode::getType () const
1038 return _value.alias->getType();
1045 SGPropertyNode::getBoolValue () const
1047 // Shortcut for common case
1048 if (_attr == (READ|WRITE) && _type == BOOL)
1051 if (getAttribute(TRACE_READ))
1053 if (!getAttribute(READ))
1054 return SGRawValue<bool>::DefaultValue;
1057 return _value.alias->getBoolValue();
1061 return get_int() == 0 ? false : true;
1063 return get_long() == 0L ? false : true;
1065 return get_float() == 0.0 ? false : true;
1067 return get_double() == 0.0L ? false : true;
1070 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1073 return SGRawValue<bool>::DefaultValue;
1078 SGPropertyNode::getIntValue () const
1080 // Shortcut for common case
1081 if (_attr == (READ|WRITE) && _type == INT)
1084 if (getAttribute(TRACE_READ))
1086 if (!getAttribute(READ))
1087 return SGRawValue<int>::DefaultValue;
1090 return _value.alias->getIntValue();
1092 return int(get_bool());
1096 return int(get_long());
1098 return int(get_float());
1100 return int(get_double());
1103 return atoi(get_string());
1106 return SGRawValue<int>::DefaultValue;
1111 SGPropertyNode::getLongValue () const
1113 // Shortcut for common case
1114 if (_attr == (READ|WRITE) && _type == LONG)
1117 if (getAttribute(TRACE_READ))
1119 if (!getAttribute(READ))
1120 return SGRawValue<long>::DefaultValue;
1123 return _value.alias->getLongValue();
1125 return long(get_bool());
1127 return long(get_int());
1131 return long(get_float());
1133 return long(get_double());
1136 return strtol(get_string(), 0, 0);
1139 return SGRawValue<long>::DefaultValue;
1144 SGPropertyNode::getFloatValue () const
1146 // Shortcut for common case
1147 if (_attr == (READ|WRITE) && _type == FLOAT)
1150 if (getAttribute(TRACE_READ))
1152 if (!getAttribute(READ))
1153 return SGRawValue<float>::DefaultValue;
1156 return _value.alias->getFloatValue();
1158 return float(get_bool());
1160 return float(get_int());
1162 return float(get_long());
1166 return float(get_double());
1169 return atof(get_string());
1172 return SGRawValue<float>::DefaultValue;
1177 SGPropertyNode::getDoubleValue () const
1179 // Shortcut for common case
1180 if (_attr == (READ|WRITE) && _type == DOUBLE)
1181 return get_double();
1183 if (getAttribute(TRACE_READ))
1185 if (!getAttribute(READ))
1186 return SGRawValue<double>::DefaultValue;
1190 return _value.alias->getDoubleValue();
1192 return double(get_bool());
1194 return double(get_int());
1196 return double(get_long());
1198 return double(get_float());
1200 return get_double();
1203 return strtod(get_string(), 0);
1206 return SGRawValue<double>::DefaultValue;
1211 SGPropertyNode::getStringValue () const
1213 // Shortcut for common case
1214 if (_attr == (READ|WRITE) && _type == STRING)
1215 return get_string();
1217 if (getAttribute(TRACE_READ))
1219 if (!getAttribute(READ))
1220 return SGRawValue<const char *>::DefaultValue;
1221 return make_string();
1225 SGPropertyNode::setBoolValue (bool value)
1227 // Shortcut for common case
1228 if (_attr == (READ|WRITE) && _type == BOOL)
1229 return set_bool(value);
1231 bool result = false;
1233 if (_type == NONE || _type == UNSPECIFIED) {
1241 result = _value.alias->setBoolValue(value);
1244 result = set_bool(value);
1247 result = set_int(int(value));
1250 result = set_long(long(value));
1253 result = set_float(float(value));
1256 result = set_double(double(value));
1260 result = set_string(value ? "true" : "false");
1267 if (getAttribute(TRACE_WRITE))
1273 SGPropertyNode::setIntValue (int value)
1275 // Shortcut for common case
1276 if (_attr == (READ|WRITE) && _type == INT)
1277 return set_int(value);
1279 bool result = false;
1281 if (_type == NONE || _type == UNSPECIFIED) {
1284 _local_val.int_val = 0;
1289 result = _value.alias->setIntValue(value);
1292 result = set_bool(value == 0 ? false : true);
1295 result = set_int(value);
1298 result = set_long(long(value));
1301 result = set_float(float(value));
1304 result = set_double(double(value));
1309 sprintf(buf, "%d", value);
1310 result = set_string(buf);
1318 if (getAttribute(TRACE_WRITE))
1324 SGPropertyNode::setLongValue (long value)
1326 // Shortcut for common case
1327 if (_attr == (READ|WRITE) && _type == LONG)
1328 return set_long(value);
1330 bool result = false;
1332 if (_type == NONE || _type == UNSPECIFIED) {
1335 _local_val.long_val = 0L;
1340 result = _value.alias->setLongValue(value);
1343 result = set_bool(value == 0L ? false : true);
1346 result = set_int(int(value));
1349 result = set_long(value);
1352 result = set_float(float(value));
1355 result = set_double(double(value));
1360 sprintf(buf, "%ld", value);
1361 result = set_string(buf);
1369 if (getAttribute(TRACE_WRITE))
1375 SGPropertyNode::setFloatValue (float value)
1377 // Shortcut for common case
1378 if (_attr == (READ|WRITE) && _type == FLOAT)
1379 return set_float(value);
1381 bool result = false;
1383 if (_type == NONE || _type == UNSPECIFIED) {
1386 _local_val.float_val = 0;
1391 result = _value.alias->setFloatValue(value);
1394 result = set_bool(value == 0.0 ? false : true);
1397 result = set_int(int(value));
1400 result = set_long(long(value));
1403 result = set_float(value);
1406 result = set_double(double(value));
1411 sprintf(buf, "%f", value);
1412 result = set_string(buf);
1420 if (getAttribute(TRACE_WRITE))
1426 SGPropertyNode::setDoubleValue (double value)
1428 // Shortcut for common case
1429 if (_attr == (READ|WRITE) && _type == DOUBLE)
1430 return set_double(value);
1432 bool result = false;
1434 if (_type == NONE || _type == UNSPECIFIED) {
1436 _local_val.double_val = value;
1442 result = _value.alias->setDoubleValue(value);
1445 result = set_bool(value == 0.0L ? false : true);
1448 result = set_int(int(value));
1451 result = set_long(long(value));
1454 result = set_float(float(value));
1457 result = set_double(value);
1462 sprintf(buf, "%f", value);
1463 result = set_string(buf);
1471 if (getAttribute(TRACE_WRITE))
1477 SGPropertyNode::setStringValue (const char * value)
1479 // Shortcut for common case
1480 if (_attr == (READ|WRITE) && _type == STRING)
1481 return set_string(value);
1483 bool result = false;
1485 if (_type == NONE || _type == UNSPECIFIED) {
1492 result = _value.alias->setStringValue(value);
1495 result = set_bool((compare_strings(value, "true")
1496 || atoi(value)) ? true : false);
1499 result = set_int(atoi(value));
1502 result = set_long(strtol(value, 0, 0));
1505 result = set_float(atof(value));
1508 result = set_double(strtod(value, 0));
1512 result = set_string(value);
1519 if (getAttribute(TRACE_WRITE))
1525 SGPropertyNode::setUnspecifiedValue (const char * value)
1527 bool result = false;
1529 if (_type == NONE) {
1531 _type = UNSPECIFIED;
1536 result = _value.alias->setUnspecifiedValue(value);
1539 result = set_bool((compare_strings(value, "true")
1540 || atoi(value)) ? true : false);
1543 result = set_int(atoi(value));
1546 result = set_long(strtol(value, 0, 0));
1549 result = set_float(atof(value));
1552 result = set_double(strtod(value, 0));
1556 result = set_string(value);
1563 if (getAttribute(TRACE_WRITE))
1569 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1571 if (_type == ALIAS || _tied)
1574 useDefault = useDefault && hasValue();
1575 bool old_val = false;
1577 old_val = getBoolValue();
1582 _value.bool_val = rawValue.clone();
1585 setBoolValue(old_val);
1591 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1593 if (_type == ALIAS || _tied)
1596 useDefault = useDefault && hasValue();
1599 old_val = getIntValue();
1604 _value.int_val = rawValue.clone();
1607 setIntValue(old_val);
1613 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1615 if (_type == ALIAS || _tied)
1618 useDefault = useDefault && hasValue();
1621 old_val = getLongValue();
1626 _value.long_val = rawValue.clone();
1629 setLongValue(old_val);
1635 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1637 if (_type == ALIAS || _tied)
1640 useDefault = useDefault && hasValue();
1641 float old_val = 0.0;
1643 old_val = getFloatValue();
1648 _value.float_val = rawValue.clone();
1651 setFloatValue(old_val);
1657 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1659 if (_type == ALIAS || _tied)
1662 useDefault = useDefault && hasValue();
1663 double old_val = 0.0;
1665 old_val = getDoubleValue();
1670 _value.double_val = rawValue.clone();
1673 setDoubleValue(old_val);
1680 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1682 if (_type == ALIAS || _tied)
1685 useDefault = useDefault && hasValue();
1688 old_val = getStringValue();
1693 _value.string_val = rawValue.clone();
1696 setStringValue(old_val.c_str());
1702 SGPropertyNode::untie ()
1709 bool val = getBoolValue();
1712 _local_val.bool_val = val;
1716 int val = getIntValue();
1719 _local_val.int_val = val;
1723 long val = getLongValue();
1726 _local_val.long_val = val;
1730 float val = getFloatValue();
1733 _local_val.float_val = val;
1737 double val = getDoubleValue();
1740 _local_val.double_val = val;
1745 string val = getStringValue();
1748 _local_val.string_val = copy_string(val.c_str());
1761 SGPropertyNode::getRootNode ()
1766 return _parent->getRootNode();
1769 const SGPropertyNode *
1770 SGPropertyNode::getRootNode () const
1775 return _parent->getRootNode();
1779 SGPropertyNode::getNode (const char * relative_path, bool create)
1781 if (_path_cache == 0)
1782 _path_cache = new hash_table;
1784 SGPropertyNode * result = _path_cache->get(relative_path);
1786 vector<PathComponent> components;
1787 parse_path(relative_path, components);
1788 result = find_node(this, components, 0, create);
1790 _path_cache->put(relative_path, result);
1797 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1799 vector<PathComponent> components;
1800 parse_path(relative_path, components);
1801 if (components.size() > 0)
1802 components.back().index = index;
1803 return find_node(this, components, 0, create);
1806 const SGPropertyNode *
1807 SGPropertyNode::getNode (const char * relative_path) const
1809 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1812 const SGPropertyNode *
1813 SGPropertyNode::getNode (const char * relative_path, int index) const
1815 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1819 ////////////////////////////////////////////////////////////////////////
1820 // Convenience methods using relative paths.
1821 ////////////////////////////////////////////////////////////////////////
1825 * Test whether another node has a value attached.
1828 SGPropertyNode::hasValue (const char * relative_path) const
1830 const SGPropertyNode * node = getNode(relative_path);
1831 return (node == 0 ? false : node->hasValue());
1836 * Get the value type for another node.
1838 SGPropertyNode::Type
1839 SGPropertyNode::getType (const char * relative_path) const
1841 const SGPropertyNode * node = getNode(relative_path);
1842 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1847 * Get a bool value for another node.
1850 SGPropertyNode::getBoolValue (const char * relative_path,
1851 bool defaultValue) const
1853 const SGPropertyNode * node = getNode(relative_path);
1854 return (node == 0 ? defaultValue : node->getBoolValue());
1859 * Get an int value for another node.
1862 SGPropertyNode::getIntValue (const char * relative_path,
1863 int defaultValue) const
1865 const SGPropertyNode * node = getNode(relative_path);
1866 return (node == 0 ? defaultValue : node->getIntValue());
1871 * Get a long value for another node.
1874 SGPropertyNode::getLongValue (const char * relative_path,
1875 long defaultValue) const
1877 const SGPropertyNode * node = getNode(relative_path);
1878 return (node == 0 ? defaultValue : node->getLongValue());
1883 * Get a float value for another node.
1886 SGPropertyNode::getFloatValue (const char * relative_path,
1887 float defaultValue) const
1889 const SGPropertyNode * node = getNode(relative_path);
1890 return (node == 0 ? defaultValue : node->getFloatValue());
1895 * Get a double value for another node.
1898 SGPropertyNode::getDoubleValue (const char * relative_path,
1899 double defaultValue) const
1901 const SGPropertyNode * node = getNode(relative_path);
1902 return (node == 0 ? defaultValue : node->getDoubleValue());
1907 * Get a string value for another node.
1910 SGPropertyNode::getStringValue (const char * relative_path,
1911 const char * defaultValue) const
1913 const SGPropertyNode * node = getNode(relative_path);
1914 return (node == 0 ? defaultValue : node->getStringValue());
1919 * Set a bool value for another node.
1922 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1924 return getNode(relative_path, true)->setBoolValue(value);
1929 * Set an int value for another node.
1932 SGPropertyNode::setIntValue (const char * relative_path, int value)
1934 return getNode(relative_path, true)->setIntValue(value);
1939 * Set a long value for another node.
1942 SGPropertyNode::setLongValue (const char * relative_path, long value)
1944 return getNode(relative_path, true)->setLongValue(value);
1949 * Set a float value for another node.
1952 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1954 return getNode(relative_path, true)->setFloatValue(value);
1959 * Set a double value for another node.
1962 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1964 return getNode(relative_path, true)->setDoubleValue(value);
1969 * Set a string value for another node.
1972 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1974 return getNode(relative_path, true)->setStringValue(value);
1979 * Set an unknown value for another node.
1982 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1985 return getNode(relative_path, true)->setUnspecifiedValue(value);
1990 * Test whether another node is tied.
1993 SGPropertyNode::isTied (const char * relative_path) const
1995 const SGPropertyNode * node = getNode(relative_path);
1996 return (node == 0 ? false : node->isTied());
2001 * Tie a node reached by a relative path, creating it if necessary.
2004 SGPropertyNode::tie (const char * relative_path,
2005 const SGRawValue<bool> &rawValue,
2008 return getNode(relative_path, true)->tie(rawValue, useDefault);
2013 * Tie a node reached by a relative path, creating it if necessary.
2016 SGPropertyNode::tie (const char * relative_path,
2017 const SGRawValue<int> &rawValue,
2020 return getNode(relative_path, true)->tie(rawValue, useDefault);
2025 * Tie a node reached by a relative path, creating it if necessary.
2028 SGPropertyNode::tie (const char * relative_path,
2029 const SGRawValue<long> &rawValue,
2032 return getNode(relative_path, true)->tie(rawValue, useDefault);
2037 * Tie a node reached by a relative path, creating it if necessary.
2040 SGPropertyNode::tie (const char * relative_path,
2041 const SGRawValue<float> &rawValue,
2044 return getNode(relative_path, true)->tie(rawValue, useDefault);
2049 * Tie a node reached by a relative path, creating it if necessary.
2052 SGPropertyNode::tie (const char * relative_path,
2053 const SGRawValue<double> &rawValue,
2056 return getNode(relative_path, true)->tie(rawValue, useDefault);
2061 * Tie a node reached by a relative path, creating it if necessary.
2064 SGPropertyNode::tie (const char * relative_path,
2065 const SGRawValue<const char *> &rawValue,
2068 return getNode(relative_path, true)->tie(rawValue, useDefault);
2073 * Attempt to untie another node reached by a relative path.
2076 SGPropertyNode::untie (const char * relative_path)
2078 SGPropertyNode * node = getNode(relative_path);
2079 return (node == 0 ? false : node->untie());
2083 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2086 if (_listeners == 0)
2087 _listeners = new vector<SGPropertyChangeListener*>;
2088 _listeners->push_back(listener);
2089 listener->register_property(this);
2091 listener->valueChanged(this);
2095 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2097 vector<SGPropertyChangeListener*>::iterator it =
2098 find(_listeners->begin(), _listeners->end(), listener);
2099 if (it != _listeners->end()) {
2100 _listeners->erase(it);
2101 listener->unregister_property(this);
2102 if (_listeners->empty()) {
2103 vector<SGPropertyChangeListener*>* tmp = _listeners;
2111 SGPropertyNode::fireValueChanged ()
2113 fireValueChanged(this);
2117 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2119 fireChildAdded(this, child);
2123 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2125 fireChildRemoved(this, child);
2129 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2131 if (_listeners != 0) {
2132 for (unsigned int i = 0; i < _listeners->size(); i++) {
2133 (*_listeners)[i]->valueChanged(node);
2137 _parent->fireValueChanged(node);
2141 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2142 SGPropertyNode * child)
2144 if (_listeners != 0) {
2145 for (unsigned int i = 0; i < _listeners->size(); i++) {
2146 (*_listeners)[i]->childAdded(parent, child);
2150 _parent->fireChildAdded(parent, child);
2154 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2155 SGPropertyNode * child)
2157 if (_listeners != 0) {
2158 for (unsigned int i = 0; i < _listeners->size(); i++) {
2159 (*_listeners)[i]->childRemoved(parent, child);
2163 _parent->fireChildRemoved(parent, child);
2168 ////////////////////////////////////////////////////////////////////////
2169 // Simplified hash table for caching paths.
2170 ////////////////////////////////////////////////////////////////////////
2172 #define HASH_TABLE_SIZE 199
2174 SGPropertyNode::hash_table::entry::entry ()
2179 SGPropertyNode::hash_table::entry::~entry ()
2181 // Don't delete the value; we don't own
2186 SGPropertyNode::hash_table::entry::set_key (const char * key)
2192 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2197 SGPropertyNode::hash_table::bucket::bucket ()
2203 SGPropertyNode::hash_table::bucket::~bucket ()
2205 for (int i = 0; i < _length; i++)
2210 SGPropertyNode::hash_table::entry *
2211 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2214 for (i = 0; i < _length; i++) {
2215 if (!strcmp(_entries[i]->get_key(), key))
2219 entry ** new_entries = new entry*[_length+1];
2220 for (i = 0; i < _length; i++) {
2221 new_entries[i] = _entries[i];
2224 _entries = new_entries;
2225 _entries[_length] = new entry;
2226 _entries[_length]->set_key(key);
2228 return _entries[_length - 1];
2235 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2237 for (int i = 0; i < _length; i++) {
2238 if (_entries[i]->get_value() == node) {
2240 for (++i; i < _length; i++) {
2241 _entries[i-1] = _entries[i];
2251 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2253 for (int i = 0; i < _length; i++) {
2254 SGPropertyNode * node = _entries[i]->get_value();
2256 node->remove_linked_node(owner);
2260 SGPropertyNode::hash_table::hash_table ()
2266 SGPropertyNode::hash_table::~hash_table ()
2268 for (unsigned int i = 0; i < _data_length; i++) {
2270 _data[i]->clear(this);
2278 SGPropertyNode::hash_table::get (const char * key)
2280 if (_data_length == 0)
2282 unsigned int index = hashcode(key) % _data_length;
2283 if (_data[index] == 0)
2285 entry * e = _data[index]->get_entry(key);
2289 return e->get_value();
2293 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2295 if (_data_length == 0) {
2296 _data = new bucket*[HASH_TABLE_SIZE];
2297 _data_length = HASH_TABLE_SIZE;
2298 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2301 unsigned int index = hashcode(key) % _data_length;
2302 if (_data[index] == 0) {
2303 _data[index] = new bucket;
2305 entry * e = _data[index]->get_entry(key, true);
2306 e->set_value(value);
2307 value->add_linked_node(this);
2311 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2313 for (unsigned int i = 0; i < _data_length; i++)
2314 if (_data[i] && _data[i]->erase(node))
2321 SGPropertyNode::hash_table::hashcode (const char * key)
2323 unsigned int hash = 0;
2325 hash = 31 * hash + *key;
2333 ////////////////////////////////////////////////////////////////////////
2334 // Implementation of SGPropertyChangeListener.
2335 ////////////////////////////////////////////////////////////////////////
2337 SGPropertyChangeListener::~SGPropertyChangeListener ()
2339 for (int i = _properties.size() - 1; i >= 0; i--)
2340 _properties[i]->removeChangeListener(this);
2344 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2350 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2351 SGPropertyNode * child)
2357 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2358 SGPropertyNode * child)
2364 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2366 _properties.push_back(node);
2370 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2372 vector<SGPropertyNode *>::iterator it =
2373 find(_properties.begin(), _properties.end(), node);
2374 if (it != _properties.end())
2375 _properties.erase(it);