1 // props.cxx - implementation of a property list.
2 // Started Fall 2000 by David Megginson, david@megginson.com
3 // This code is released into the Public Domain.
5 // See props.html for documentation [replace with URL when available].
24 using std::stringstream;
28 #include <simgear/compiler.h>
29 #include <simgear/debug/logstream.hxx>
34 SG_USING_STD(stringstream);
36 #if ( _MSC_VER == 1200 )
37 // MSVC 6 is buggy, and needs something strange here
38 SG_USING_STD(vector<SGPropertyNode_ptr>);
39 SG_USING_STD(vector<SGPropertyChangeListener *>);
40 SG_USING_STD(vector<SGPropertyNode *>);
47 ////////////////////////////////////////////////////////////////////////
49 ////////////////////////////////////////////////////////////////////////
52 * Comparator class for sorting by index.
57 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
58 return (n1->getIndex() < n2->getIndex());
64 ////////////////////////////////////////////////////////////////////////
65 // Convenience macros for value access.
66 ////////////////////////////////////////////////////////////////////////
68 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
69 #define TEST_WRITE if (!getAttribute(WRITE)) return false
73 ////////////////////////////////////////////////////////////////////////
74 // Default values for every type.
75 ////////////////////////////////////////////////////////////////////////
77 template<> const bool SGRawValue<bool>::DefaultValue = false;
78 template<> const int SGRawValue<int>::DefaultValue = 0;
79 template<> const long SGRawValue<long>::DefaultValue = 0L;
80 template<> const float SGRawValue<float>::DefaultValue = 0.0;
81 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
82 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
86 ////////////////////////////////////////////////////////////////////////
87 // Local path normalization code.
88 ////////////////////////////////////////////////////////////////////////
91 * A component in a path.
100 * Parse the name for a path component.
102 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
104 static inline const string
105 parse_name (const string &path, int &i)
108 int max = path.size();
110 if (path[i] == '.') {
112 if (i < max && path[i] == '.') {
118 if (i < max && path[i] != '/')
119 throw string("Illegal character after " + name);
122 else if (isalpha(path[i]) || path[i] == '_') {
126 // The rules inside a name are a little
129 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
130 path[i] == '-' || path[i] == '.') {
132 } else if (path[i] == '[' || path[i] == '/') {
135 throw string("name may contain only ._- and alphanumeric characters");
142 if (name.size() == 0)
143 throw string("name must begin with alpha or '_'");
151 * Parse the optional integer index for a path component.
153 * Index: "[" [0-9]+ "]"
156 parse_index (const string &path, int &i)
165 for (int max = path.size(); i < max; i++) {
166 if (isdigit(path[i])) {
167 index = (index * 10) + (path[i] - '0');
168 } else if (path[i] == ']') {
176 throw string("unterminated index (looking for ']')");
181 * Parse a single path component.
183 * Component: Name Index?
185 static inline PathComponent
186 parse_component (const string &path, int &i)
188 PathComponent component;
189 component.name = parse_name(path, i);
190 if (component.name[0] != '.')
191 component.index = parse_index(path, i);
193 component.index = -1;
199 * Parse a path into its components.
202 parse_path (const string &path, vector<PathComponent> &components)
205 int max = path.size();
207 // Check for initial '/'
208 if (path[pos] == '/') {
212 components.push_back(root);
214 while (pos < max && path[pos] == '/')
219 components.push_back(parse_component(path, pos));
220 while (pos < max && path[pos] == '/')
227 ////////////////////////////////////////////////////////////////////////
228 // Other static utility functions.
229 ////////////////////////////////////////////////////////////////////////
233 copy_string (const char * s)
235 // FIXME: potential buffer overflow.
236 // For some reason, strnlen and
237 // strncpy cause all kinds of crashes.
238 char * copy = new char[strlen(s) + 1];
244 compare_strings (const char * s1, const char * s2)
246 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
250 * Locate a child node by name and index.
253 find_child (const char * name, int index, const vector<SGPropertyNode_ptr>& nodes)
255 int nNodes = nodes.size();
256 for (int i = 0; i < nNodes; i++) {
257 SGPropertyNode * node = nodes[i];
258 if (compare_strings(node->getName(), name) && node->getIndex() == index)
266 * Locate another node, given a relative path.
268 static SGPropertyNode *
269 find_node (SGPropertyNode * current,
270 const vector<PathComponent> &components,
274 // Run off the end of the list
279 // Success! This is the one we want.
280 else if (position >= (int)components.size()) {
281 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
284 // Empty component means root.
285 else if (components[position].name == "") {
286 return find_node(current->getRootNode(), components, position + 1, create);
289 // . means current directory
290 else if (components[position].name == ".") {
291 return find_node(current, components, position + 1, create);
294 // .. means parent directory
295 else if (components[position].name == "..") {
296 SGPropertyNode * parent = current->getParent();
298 throw string("Attempt to move past root with '..'");
300 return find_node(parent, components, position + 1, create);
303 // Otherwise, a child name
305 SGPropertyNode * child =
306 current->getChild(components[position].name.c_str(),
307 components[position].index,
309 return find_node(child, components, position + 1, create);
315 ////////////////////////////////////////////////////////////////////////
316 // Private methods from SGPropertyNode (may be inlined for speed).
317 ////////////////////////////////////////////////////////////////////////
320 SGPropertyNode::get_bool () const
323 return _value.bool_val->getValue();
325 return _local_val.bool_val;
329 SGPropertyNode::get_int () const
332 return _value.int_val->getValue();
334 return _local_val.int_val;
338 SGPropertyNode::get_long () const
341 return _value.long_val->getValue();
343 return _local_val.long_val;
347 SGPropertyNode::get_float () const
350 return _value.float_val->getValue();
352 return _local_val.float_val;
356 SGPropertyNode::get_double () const
359 return _value.double_val->getValue();
361 return _local_val.double_val;
365 SGPropertyNode::get_string () const
368 return _value.string_val->getValue();
370 return _local_val.string_val;
374 SGPropertyNode::set_bool (bool val)
377 if (_value.bool_val->setValue(val)) {
384 _local_val.bool_val = val;
391 SGPropertyNode::set_int (int val)
394 if (_value.int_val->setValue(val)) {
401 _local_val.int_val = val;
408 SGPropertyNode::set_long (long val)
411 if (_value.long_val->setValue(val)) {
418 _local_val.long_val = val;
425 SGPropertyNode::set_float (float val)
428 if (_value.float_val->setValue(val)) {
435 _local_val.float_val = val;
442 SGPropertyNode::set_double (double val)
445 if (_value.double_val->setValue(val)) {
452 _local_val.double_val = val;
459 SGPropertyNode::set_string (const char * val)
462 if (_value.string_val->setValue(val)) {
469 delete [] _local_val.string_val;
470 _local_val.string_val = copy_string(val);
477 SGPropertyNode::clearValue ()
487 delete _value.bool_val;
490 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
494 delete _value.int_val;
497 _local_val.int_val = SGRawValue<int>::DefaultValue;
501 delete _value.long_val;
502 _value.long_val = 0L;
504 _local_val.long_val = SGRawValue<long>::DefaultValue;
508 delete _value.float_val;
509 _value.float_val = 0;
511 _local_val.float_val = SGRawValue<float>::DefaultValue;
515 delete _value.double_val;
516 _value.double_val = 0;
518 _local_val.double_val = SGRawValue<double>::DefaultValue;
523 delete _value.string_val;
524 _value.string_val = 0;
526 delete [] _local_val.string_val;
528 _local_val.string_val = 0;
537 * Get the value as a string.
540 SGPropertyNode::make_string () const
542 if (!getAttribute(READ))
547 return _value.alias->getStringValue();
557 _buffer = sstr.str();
558 return _buffer.c_str();
564 _buffer = sstr.str();
565 return _buffer.c_str();
571 _buffer = sstr.str();
572 return _buffer.c_str();
577 sstr.precision( 10 );
578 sstr << get_double();
579 _buffer = sstr.str();
580 return _buffer.c_str();
592 * Trace a write access for a property.
595 SGPropertyNode::trace_write () const
598 cerr << "TRACE: Write node " << getPath () << ", value\""
599 << make_string() << '"' << endl;
601 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
602 << ", value\"" << make_string() << '"');
607 * Trace a read access for a property.
610 SGPropertyNode::trace_read () const
613 cerr << "TRACE: Write node " << getPath () << ", value \""
614 << make_string() << '"' << endl;
616 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
617 << ", value \"" << make_string() << '"');
622 ////////////////////////////////////////////////////////////////////////
623 // Public methods from SGPropertyNode.
624 ////////////////////////////////////////////////////////////////////////
627 * Last used attribute
628 * Update as needed when enum Attribute is changed
630 const int SGPropertyNode::LAST_USED_ATTRIBUTE = TRACE_WRITE;
633 * Default constructor: always creates a root node.
635 SGPropertyNode::SGPropertyNode ()
644 _local_val.string_val = 0;
651 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
652 : _index(node._index),
654 _parent(0), // don't copy the parent
659 _listeners(0) // CHECK!!
661 _local_val.string_val = 0;
666 _value.alias = node._value.alias;
672 _value.bool_val = node._value.bool_val->clone();
675 set_bool(node.get_bool());
681 _value.int_val = node._value.int_val->clone();
684 set_int(node.get_int());
690 _value.long_val = node._value.long_val->clone();
693 set_long(node.get_long());
699 _value.float_val = node._value.float_val->clone();
702 set_float(node.get_float());
708 _value.double_val = node._value.double_val->clone();
711 set_double(node.get_double());
718 _value.string_val = node._value.string_val->clone();
721 set_string(node.get_string());
729 * Convenience constructor.
731 SGPropertyNode::SGPropertyNode (const char * name,
733 SGPropertyNode * parent)
743 _local_val.string_val = 0;
750 SGPropertyNode::~SGPropertyNode ()
752 // zero out all parent pointers, else they might be dangling
753 for (unsigned i = 0; i < _children.size(); ++i)
754 _children[i]->_parent = 0;
755 for (unsigned i = 0; i < _removedChildren.size(); ++i)
756 _removedChildren[i]->_parent = 0;
761 for (unsigned i = 0; i < _listeners.size(); ++i)
762 _listeners[i]->unregister_property(this);
769 * Alias to another node.
772 SGPropertyNode::alias (SGPropertyNode * target)
774 if (target == 0 || _type == ALIAS || _tied)
777 _value.alias = target;
784 * Alias to another node by path.
787 SGPropertyNode::alias (const char * path)
789 return alias(getNode(path, true));
797 SGPropertyNode::unalias ()
808 * Get the target of an alias.
811 SGPropertyNode::getAliasTarget ()
813 return (_type == ALIAS ? _value.alias : 0);
817 const SGPropertyNode *
818 SGPropertyNode::getAliasTarget () const
820 return (_type == ALIAS ? _value.alias : 0);
825 * Get a non-const child by index.
828 SGPropertyNode::getChild (int position)
830 if (position >= 0 && position < nChildren())
831 return _children[position];
838 * Get a const child by index.
840 const SGPropertyNode *
841 SGPropertyNode::getChild (int position) const
843 if (position >= 0 && position < nChildren())
844 return _children[position];
851 * Get a non-const child by name and index, creating if necessary.
854 SGPropertyNode::getChild (const char * name, int index, bool create)
856 int pos = find_child(name, index, _children);
858 return _children[pos];
860 SGPropertyNode_ptr node;
861 pos = find_child(name, index, _removedChildren);
863 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
865 node = _removedChildren[pos];
866 _removedChildren.erase(it);
867 node->setAttribute(REMOVED, false);
869 node = new SGPropertyNode(name, index, this);
871 _children.push_back(node);
872 fireChildAdded(node);
881 * Get a const child by name and index.
883 const SGPropertyNode *
884 SGPropertyNode::getChild (const char * name, int index) const
886 int pos = find_child(name, index, _children);
888 return _children[pos];
895 * Get all children with the same name (but different indices).
897 vector<SGPropertyNode_ptr>
898 SGPropertyNode::getChildren (const char * name) const
900 vector<SGPropertyNode_ptr> children;
901 int max = _children.size();
903 for (int i = 0; i < max; i++)
904 if (compare_strings(_children[i]->getName(), name))
905 children.push_back(_children[i]);
907 sort(children.begin(), children.end(), CompareIndices());
913 * Remove child by position.
916 SGPropertyNode::removeChild (int pos, bool keep)
918 SGPropertyNode_ptr node;
919 if (pos < 0 || pos >= (int)_children.size())
922 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
924 node = _children[pos];
927 _removedChildren.push_back(node);
930 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
931 node->setAttribute(REMOVED, true);
933 fireChildRemoved(node);
939 * Remove a child node
942 SGPropertyNode::removeChild (const char * name, int index, bool keep)
944 SGPropertyNode_ptr ret;
945 int pos = find_child(name, index, _children);
947 ret = removeChild(pos, keep);
953 * Remove all children with the specified name.
955 vector<SGPropertyNode_ptr>
956 SGPropertyNode::removeChildren (const char * name, bool keep)
958 vector<SGPropertyNode_ptr> children;
960 for (int pos = _children.size() - 1; pos >= 0; pos--)
961 if (compare_strings(_children[pos]->getName(), name))
962 children.push_back(removeChild(pos, keep));
964 sort(children.begin(), children.end(), CompareIndices());
970 SGPropertyNode::getDisplayName (bool simplify) const
972 _display_name = _name;
973 if (_index != 0 || !simplify) {
975 sstr << '[' << _index << ']';
976 _display_name += sstr.str();
978 return _display_name.c_str();
983 SGPropertyNode::getPath (bool simplify) const
985 // Calculate the complete path only once.
986 if (_parent != 0 && _path.empty()) {
987 _path = _parent->getPath(simplify);
989 _path += getDisplayName(simplify);
992 return _path.c_str();
996 SGPropertyNode::getType () const
999 return _value.alias->getType();
1006 SGPropertyNode::getBoolValue () const
1008 // Shortcut for common case
1009 if (_attr == (READ|WRITE) && _type == BOOL)
1012 if (getAttribute(TRACE_READ))
1014 if (!getAttribute(READ))
1015 return SGRawValue<bool>::DefaultValue;
1018 return _value.alias->getBoolValue();
1022 return get_int() == 0 ? false : true;
1024 return get_long() == 0L ? false : true;
1026 return get_float() == 0.0 ? false : true;
1028 return get_double() == 0.0L ? false : true;
1031 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1034 return SGRawValue<bool>::DefaultValue;
1039 SGPropertyNode::getIntValue () const
1041 // Shortcut for common case
1042 if (_attr == (READ|WRITE) && _type == INT)
1045 if (getAttribute(TRACE_READ))
1047 if (!getAttribute(READ))
1048 return SGRawValue<int>::DefaultValue;
1051 return _value.alias->getIntValue();
1053 return int(get_bool());
1057 return int(get_long());
1059 return int(get_float());
1061 return int(get_double());
1064 return atoi(get_string());
1067 return SGRawValue<int>::DefaultValue;
1072 SGPropertyNode::getLongValue () const
1074 // Shortcut for common case
1075 if (_attr == (READ|WRITE) && _type == LONG)
1078 if (getAttribute(TRACE_READ))
1080 if (!getAttribute(READ))
1081 return SGRawValue<long>::DefaultValue;
1084 return _value.alias->getLongValue();
1086 return long(get_bool());
1088 return long(get_int());
1092 return long(get_float());
1094 return long(get_double());
1097 return strtol(get_string(), 0, 0);
1100 return SGRawValue<long>::DefaultValue;
1105 SGPropertyNode::getFloatValue () const
1107 // Shortcut for common case
1108 if (_attr == (READ|WRITE) && _type == FLOAT)
1111 if (getAttribute(TRACE_READ))
1113 if (!getAttribute(READ))
1114 return SGRawValue<float>::DefaultValue;
1117 return _value.alias->getFloatValue();
1119 return float(get_bool());
1121 return float(get_int());
1123 return float(get_long());
1127 return float(get_double());
1130 return atof(get_string());
1133 return SGRawValue<float>::DefaultValue;
1138 SGPropertyNode::getDoubleValue () const
1140 // Shortcut for common case
1141 if (_attr == (READ|WRITE) && _type == DOUBLE)
1142 return get_double();
1144 if (getAttribute(TRACE_READ))
1146 if (!getAttribute(READ))
1147 return SGRawValue<double>::DefaultValue;
1151 return _value.alias->getDoubleValue();
1153 return double(get_bool());
1155 return double(get_int());
1157 return double(get_long());
1159 return double(get_float());
1161 return get_double();
1164 return strtod(get_string(), 0);
1167 return SGRawValue<double>::DefaultValue;
1172 SGPropertyNode::getStringValue () const
1174 // Shortcut for common case
1175 if (_attr == (READ|WRITE) && _type == STRING)
1176 return get_string();
1178 if (getAttribute(TRACE_READ))
1180 if (!getAttribute(READ))
1181 return SGRawValue<const char *>::DefaultValue;
1182 return make_string();
1186 SGPropertyNode::setBoolValue (bool value)
1188 // Shortcut for common case
1189 if (_attr == (READ|WRITE) && _type == BOOL)
1190 return set_bool(value);
1192 bool result = false;
1194 if (_type == NONE || _type == UNSPECIFIED) {
1202 result = _value.alias->setBoolValue(value);
1205 result = set_bool(value);
1208 result = set_int(int(value));
1211 result = set_long(long(value));
1214 result = set_float(float(value));
1217 result = set_double(double(value));
1221 result = set_string(value ? "true" : "false");
1228 if (getAttribute(TRACE_WRITE))
1234 SGPropertyNode::setIntValue (int value)
1236 // Shortcut for common case
1237 if (_attr == (READ|WRITE) && _type == INT)
1238 return set_int(value);
1240 bool result = false;
1242 if (_type == NONE || _type == UNSPECIFIED) {
1245 _local_val.int_val = 0;
1250 result = _value.alias->setIntValue(value);
1253 result = set_bool(value == 0 ? false : true);
1256 result = set_int(value);
1259 result = set_long(long(value));
1262 result = set_float(float(value));
1265 result = set_double(double(value));
1270 sprintf(buf, "%d", value);
1271 result = set_string(buf);
1279 if (getAttribute(TRACE_WRITE))
1285 SGPropertyNode::setLongValue (long value)
1287 // Shortcut for common case
1288 if (_attr == (READ|WRITE) && _type == LONG)
1289 return set_long(value);
1291 bool result = false;
1293 if (_type == NONE || _type == UNSPECIFIED) {
1296 _local_val.long_val = 0L;
1301 result = _value.alias->setLongValue(value);
1304 result = set_bool(value == 0L ? false : true);
1307 result = set_int(int(value));
1310 result = set_long(value);
1313 result = set_float(float(value));
1316 result = set_double(double(value));
1321 sprintf(buf, "%ld", value);
1322 result = set_string(buf);
1330 if (getAttribute(TRACE_WRITE))
1336 SGPropertyNode::setFloatValue (float value)
1338 // Shortcut for common case
1339 if (_attr == (READ|WRITE) && _type == FLOAT)
1340 return set_float(value);
1342 bool result = false;
1344 if (_type == NONE || _type == UNSPECIFIED) {
1347 _local_val.float_val = 0;
1352 result = _value.alias->setFloatValue(value);
1355 result = set_bool(value == 0.0 ? false : true);
1358 result = set_int(int(value));
1361 result = set_long(long(value));
1364 result = set_float(value);
1367 result = set_double(double(value));
1372 sprintf(buf, "%f", value);
1373 result = set_string(buf);
1381 if (getAttribute(TRACE_WRITE))
1387 SGPropertyNode::setDoubleValue (double value)
1389 // Shortcut for common case
1390 if (_attr == (READ|WRITE) && _type == DOUBLE)
1391 return set_double(value);
1393 bool result = false;
1395 if (_type == NONE || _type == UNSPECIFIED) {
1397 _local_val.double_val = value;
1403 result = _value.alias->setDoubleValue(value);
1406 result = set_bool(value == 0.0L ? false : true);
1409 result = set_int(int(value));
1412 result = set_long(long(value));
1415 result = set_float(float(value));
1418 result = set_double(value);
1423 sprintf(buf, "%f", value);
1424 result = set_string(buf);
1432 if (getAttribute(TRACE_WRITE))
1438 SGPropertyNode::setStringValue (const char * value)
1440 // Shortcut for common case
1441 if (_attr == (READ|WRITE) && _type == STRING)
1442 return set_string(value);
1444 bool result = false;
1446 if (_type == NONE || _type == UNSPECIFIED) {
1453 result = _value.alias->setStringValue(value);
1456 result = set_bool((compare_strings(value, "true")
1457 || atoi(value)) ? true : false);
1460 result = set_int(atoi(value));
1463 result = set_long(strtol(value, 0, 0));
1466 result = set_float(atof(value));
1469 result = set_double(strtod(value, 0));
1473 result = set_string(value);
1480 if (getAttribute(TRACE_WRITE))
1486 SGPropertyNode::setUnspecifiedValue (const char * value)
1488 bool result = false;
1490 if (_type == NONE) {
1492 _type = UNSPECIFIED;
1497 result = _value.alias->setUnspecifiedValue(value);
1500 result = set_bool((compare_strings(value, "true")
1501 || atoi(value)) ? true : false);
1504 result = set_int(atoi(value));
1507 result = set_long(strtol(value, 0, 0));
1510 result = set_float(atof(value));
1513 result = set_double(strtod(value, 0));
1517 result = set_string(value);
1524 if (getAttribute(TRACE_WRITE))
1530 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1532 if (_type == ALIAS || _tied)
1535 useDefault = useDefault && hasValue();
1536 bool old_val = false;
1538 old_val = getBoolValue();
1543 _value.bool_val = rawValue.clone();
1546 setBoolValue(old_val);
1552 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1554 if (_type == ALIAS || _tied)
1557 useDefault = useDefault && hasValue();
1560 old_val = getIntValue();
1565 _value.int_val = rawValue.clone();
1568 setIntValue(old_val);
1574 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1576 if (_type == ALIAS || _tied)
1579 useDefault = useDefault && hasValue();
1582 old_val = getLongValue();
1587 _value.long_val = rawValue.clone();
1590 setLongValue(old_val);
1596 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1598 if (_type == ALIAS || _tied)
1601 useDefault = useDefault && hasValue();
1602 float old_val = 0.0;
1604 old_val = getFloatValue();
1609 _value.float_val = rawValue.clone();
1612 setFloatValue(old_val);
1618 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1620 if (_type == ALIAS || _tied)
1623 useDefault = useDefault && hasValue();
1624 double old_val = 0.0;
1626 old_val = getDoubleValue();
1631 _value.double_val = rawValue.clone();
1634 setDoubleValue(old_val);
1641 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1643 if (_type == ALIAS || _tied)
1646 useDefault = useDefault && hasValue();
1649 old_val = getStringValue();
1654 _value.string_val = rawValue.clone();
1657 setStringValue(old_val.c_str());
1663 SGPropertyNode::untie ()
1670 bool val = getBoolValue();
1673 _local_val.bool_val = val;
1677 int val = getIntValue();
1680 _local_val.int_val = val;
1684 long val = getLongValue();
1687 _local_val.long_val = val;
1691 float val = getFloatValue();
1694 _local_val.float_val = val;
1698 double val = getDoubleValue();
1701 _local_val.double_val = val;
1706 string val = getStringValue();
1709 _local_val.string_val = copy_string(val.c_str());
1722 SGPropertyNode::getRootNode ()
1727 return _parent->getRootNode();
1730 const SGPropertyNode *
1731 SGPropertyNode::getRootNode () const
1736 return _parent->getRootNode();
1740 SGPropertyNode::getNode (const char * relative_path, bool create)
1742 if (_path_cache == 0)
1743 _path_cache = new hash_table;
1745 SGPropertyNode * result = _path_cache->get(relative_path);
1747 vector<PathComponent> components;
1748 parse_path(relative_path, components);
1749 result = find_node(this, components, 0, create);
1751 _path_cache->put(relative_path, result);
1758 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1760 vector<PathComponent> components;
1761 parse_path(relative_path, components);
1762 if (components.size() > 0)
1763 components.back().index = index;
1764 return find_node(this, components, 0, create);
1767 const SGPropertyNode *
1768 SGPropertyNode::getNode (const char * relative_path) const
1770 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1773 const SGPropertyNode *
1774 SGPropertyNode::getNode (const char * relative_path, int index) const
1776 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1780 ////////////////////////////////////////////////////////////////////////
1781 // Convenience methods using relative paths.
1782 ////////////////////////////////////////////////////////////////////////
1786 * Test whether another node has a value attached.
1789 SGPropertyNode::hasValue (const char * relative_path) const
1791 const SGPropertyNode * node = getNode(relative_path);
1792 return (node == 0 ? false : node->hasValue());
1797 * Get the value type for another node.
1799 SGPropertyNode::Type
1800 SGPropertyNode::getType (const char * relative_path) const
1802 const SGPropertyNode * node = getNode(relative_path);
1803 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1808 * Get a bool value for another node.
1811 SGPropertyNode::getBoolValue (const char * relative_path,
1812 bool defaultValue) const
1814 const SGPropertyNode * node = getNode(relative_path);
1815 return (node == 0 ? defaultValue : node->getBoolValue());
1820 * Get an int value for another node.
1823 SGPropertyNode::getIntValue (const char * relative_path,
1824 int defaultValue) const
1826 const SGPropertyNode * node = getNode(relative_path);
1827 return (node == 0 ? defaultValue : node->getIntValue());
1832 * Get a long value for another node.
1835 SGPropertyNode::getLongValue (const char * relative_path,
1836 long defaultValue) const
1838 const SGPropertyNode * node = getNode(relative_path);
1839 return (node == 0 ? defaultValue : node->getLongValue());
1844 * Get a float value for another node.
1847 SGPropertyNode::getFloatValue (const char * relative_path,
1848 float defaultValue) const
1850 const SGPropertyNode * node = getNode(relative_path);
1851 return (node == 0 ? defaultValue : node->getFloatValue());
1856 * Get a double value for another node.
1859 SGPropertyNode::getDoubleValue (const char * relative_path,
1860 double defaultValue) const
1862 const SGPropertyNode * node = getNode(relative_path);
1863 return (node == 0 ? defaultValue : node->getDoubleValue());
1868 * Get a string value for another node.
1871 SGPropertyNode::getStringValue (const char * relative_path,
1872 const char * defaultValue) const
1874 const SGPropertyNode * node = getNode(relative_path);
1875 return (node == 0 ? defaultValue : node->getStringValue());
1880 * Set a bool value for another node.
1883 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1885 return getNode(relative_path, true)->setBoolValue(value);
1890 * Set an int value for another node.
1893 SGPropertyNode::setIntValue (const char * relative_path, int value)
1895 return getNode(relative_path, true)->setIntValue(value);
1900 * Set a long value for another node.
1903 SGPropertyNode::setLongValue (const char * relative_path, long value)
1905 return getNode(relative_path, true)->setLongValue(value);
1910 * Set a float value for another node.
1913 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1915 return getNode(relative_path, true)->setFloatValue(value);
1920 * Set a double value for another node.
1923 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1925 return getNode(relative_path, true)->setDoubleValue(value);
1930 * Set a string value for another node.
1933 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1935 return getNode(relative_path, true)->setStringValue(value);
1940 * Set an unknown value for another node.
1943 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1946 return getNode(relative_path, true)->setUnspecifiedValue(value);
1951 * Test whether another node is tied.
1954 SGPropertyNode::isTied (const char * relative_path) const
1956 const SGPropertyNode * node = getNode(relative_path);
1957 return (node == 0 ? false : node->isTied());
1962 * Tie a node reached by a relative path, creating it if necessary.
1965 SGPropertyNode::tie (const char * relative_path,
1966 const SGRawValue<bool> &rawValue,
1969 return getNode(relative_path, true)->tie(rawValue, useDefault);
1974 * Tie a node reached by a relative path, creating it if necessary.
1977 SGPropertyNode::tie (const char * relative_path,
1978 const SGRawValue<int> &rawValue,
1981 return getNode(relative_path, true)->tie(rawValue, useDefault);
1986 * Tie a node reached by a relative path, creating it if necessary.
1989 SGPropertyNode::tie (const char * relative_path,
1990 const SGRawValue<long> &rawValue,
1993 return getNode(relative_path, true)->tie(rawValue, useDefault);
1998 * Tie a node reached by a relative path, creating it if necessary.
2001 SGPropertyNode::tie (const char * relative_path,
2002 const SGRawValue<float> &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<double> &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<const char *> &rawValue,
2029 return getNode(relative_path, true)->tie(rawValue, useDefault);
2034 * Attempt to untie another node reached by a relative path.
2037 SGPropertyNode::untie (const char * relative_path)
2039 SGPropertyNode * node = getNode(relative_path);
2040 return (node == 0 ? false : node->untie());
2044 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2047 if (_listeners == 0)
2048 _listeners = new vector<SGPropertyChangeListener*>;
2049 _listeners->push_back(listener);
2050 listener->register_property(this);
2052 listener->valueChanged(this);
2056 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2058 vector<SGPropertyChangeListener*>::iterator it =
2059 find(_listeners->begin(), _listeners->end(), listener);
2060 if (it != _listeners->end()) {
2061 _listeners->erase(it);
2062 listener->unregister_property(this);
2063 if (_listeners->empty()) {
2064 vector<SGPropertyChangeListener*>* tmp = _listeners;
2072 SGPropertyNode::fireValueChanged ()
2074 fireValueChanged(this);
2078 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2080 fireChildAdded(this, child);
2084 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2086 fireChildRemoved(this, child);
2090 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2092 if (_listeners != 0) {
2093 for (unsigned int i = 0; i < _listeners->size(); i++) {
2094 (*_listeners)[i]->valueChanged(node);
2098 _parent->fireValueChanged(node);
2102 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2103 SGPropertyNode * child)
2105 if (_listeners != 0) {
2106 for (unsigned int i = 0; i < _listeners->size(); i++) {
2107 (*_listeners)[i]->childAdded(parent, child);
2111 _parent->fireChildAdded(parent, child);
2115 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2116 SGPropertyNode * child)
2118 if (_listeners != 0) {
2119 for (unsigned int i = 0; i < _listeners->size(); i++) {
2120 (*_listeners)[i]->childRemoved(parent, child);
2124 _parent->fireChildRemoved(parent, child);
2129 ////////////////////////////////////////////////////////////////////////
2130 // Simplified hash table for caching paths.
2131 ////////////////////////////////////////////////////////////////////////
2133 #define HASH_TABLE_SIZE 199
2135 SGPropertyNode::hash_table::entry::entry ()
2140 SGPropertyNode::hash_table::entry::~entry ()
2142 // Don't delete the value; we don't own
2147 SGPropertyNode::hash_table::entry::set_key (const char * key)
2153 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2158 SGPropertyNode::hash_table::bucket::bucket ()
2164 SGPropertyNode::hash_table::bucket::~bucket ()
2166 for (int i = 0; i < _length; i++)
2171 SGPropertyNode::hash_table::entry *
2172 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2175 for (i = 0; i < _length; i++) {
2176 if (!strcmp(_entries[i]->get_key(), key))
2180 entry ** new_entries = new entry*[_length+1];
2181 for (i = 0; i < _length; i++) {
2182 new_entries[i] = _entries[i];
2185 _entries = new_entries;
2186 _entries[_length] = new entry;
2187 _entries[_length]->set_key(key);
2189 return _entries[_length - 1];
2196 SGPropertyNode::hash_table::bucket::erase (const char * key)
2199 for (i = 0; i < _length; i++) {
2200 if (!strcmp(_entries[i]->get_key(), key))
2205 for (++i; i < _length; i++) {
2206 _entries[i-1] = _entries[i];
2213 SGPropertyNode::hash_table::hash_table ()
2219 SGPropertyNode::hash_table::~hash_table ()
2221 for (unsigned int i = 0; i < _data_length; i++)
2227 SGPropertyNode::hash_table::get (const char * key)
2229 if (_data_length == 0)
2231 unsigned int index = hashcode(key) % _data_length;
2232 if (_data[index] == 0)
2234 entry * e = _data[index]->get_entry(key);
2238 return e->get_value();
2242 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2244 if (_data_length == 0) {
2245 _data = new bucket*[HASH_TABLE_SIZE];
2246 _data_length = HASH_TABLE_SIZE;
2247 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2250 unsigned int index = hashcode(key) % _data_length;
2251 if (_data[index] == 0) {
2252 _data[index] = new bucket;
2254 entry * e = _data[index]->get_entry(key, true);
2255 e->set_value(value);
2259 SGPropertyNode::hash_table::erase (const char * key)
2261 if (_data_length == 0)
2263 unsigned int index = hashcode(key) % _data_length;
2264 if (_data[index] == 0)
2266 _data[index]->erase(key);
2270 SGPropertyNode::hash_table::hashcode (const char * key)
2272 unsigned int hash = 0;
2274 hash = 31 * hash + *key;
2282 ////////////////////////////////////////////////////////////////////////
2283 // Implementation of SGPropertyChangeListener.
2284 ////////////////////////////////////////////////////////////////////////
2286 SGPropertyChangeListener::~SGPropertyChangeListener ()
2288 // This will come back and remove
2289 // the current item each time. Is
2291 vector<SGPropertyNode *>::iterator it;
2292 for (it = _properties.begin(); it != _properties.end(); it++)
2293 (*it)->removeChangeListener(this);
2297 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2303 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2304 SGPropertyNode * child)
2310 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2311 SGPropertyNode * child)
2317 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2319 _properties.push_back(node);
2323 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2325 vector<SGPropertyNode *>::iterator it =
2326 find(_properties.begin(), _properties.end(), node);
2327 if (it != _properties.end())
2328 _properties.erase(it);