1 // props.cxx - implementation of a property list.
2 // Started Fall 2000 by David Megginson, david@megginson.com
3 // This code is released into the Public Domain.
5 // See props.html for documentation [replace with URL when available].
24 using std::stringstream;
28 #include <simgear/compiler.h>
29 #include <simgear/debug/logstream.hxx>
34 SG_USING_STD(stringstream);
36 #if ( _MSC_VER == 1200 )
37 // MSVC 6 is buggy, and needs something strange here
38 SG_USING_STD(vector<SGPropertyNode_ptr>);
39 SG_USING_STD(vector<SGPropertyChangeListener *>);
40 SG_USING_STD(vector<SGPropertyNode *>);
47 ////////////////////////////////////////////////////////////////////////
49 ////////////////////////////////////////////////////////////////////////
52 * Comparator class for sorting by index.
57 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
58 return (n1->getIndex() < n2->getIndex());
64 ////////////////////////////////////////////////////////////////////////
65 // Convenience macros for value access.
66 ////////////////////////////////////////////////////////////////////////
68 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
69 #define TEST_WRITE if (!getAttribute(WRITE)) return false
73 ////////////////////////////////////////////////////////////////////////
74 // Default values for every type.
75 ////////////////////////////////////////////////////////////////////////
77 template<> const bool SGRawValue<bool>::DefaultValue = false;
78 template<> const int SGRawValue<int>::DefaultValue = 0;
79 template<> const long SGRawValue<long>::DefaultValue = 0L;
80 template<> const float SGRawValue<float>::DefaultValue = 0.0;
81 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
82 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
86 ////////////////////////////////////////////////////////////////////////
87 // Local path normalization code.
88 ////////////////////////////////////////////////////////////////////////
91 * A component in a path.
100 * Parse the name for a path component.
102 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
104 static inline const string
105 parse_name (const string &path, int &i)
108 int max = path.size();
110 if (path[i] == '.') {
112 if (i < max && path[i] == '.') {
118 if (i < max && path[i] != '/')
119 throw string("Illegal character after " + name);
122 else if (isalpha(path[i]) || path[i] == '_') {
126 // The rules inside a name are a little
129 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
130 path[i] == '-' || path[i] == '.') {
132 } else if (path[i] == '[' || path[i] == '/') {
135 throw string("name may contain only ._- and alphanumeric characters");
142 if (name.size() == 0)
143 throw string("name must begin with alpha or '_'");
151 * Parse the optional integer index for a path component.
153 * Index: "[" [0-9]+ "]"
156 parse_index (const string &path, int &i)
165 for (int max = path.size(); i < max; i++) {
166 if (isdigit(path[i])) {
167 index = (index * 10) + (path[i] - '0');
168 } else if (path[i] == ']') {
176 throw string("unterminated index (looking for ']')");
181 * Parse a single path component.
183 * Component: Name Index?
185 static inline PathComponent
186 parse_component (const string &path, int &i)
188 PathComponent component;
189 component.name = parse_name(path, i);
190 if (component.name[0] != '.')
191 component.index = parse_index(path, i);
193 component.index = -1;
199 * Parse a path into its components.
202 parse_path (const string &path, vector<PathComponent> &components)
205 int max = path.size();
207 // Check for initial '/'
208 if (path[pos] == '/') {
212 components.push_back(root);
214 while (pos < max && path[pos] == '/')
219 components.push_back(parse_component(path, pos));
220 while (pos < max && path[pos] == '/')
227 ////////////////////////////////////////////////////////////////////////
228 // Other static utility functions.
229 ////////////////////////////////////////////////////////////////////////
233 copy_string (const char * s)
235 // FIXME: potential buffer overflow.
236 // For some reason, strnlen and
237 // strncpy cause all kinds of crashes.
238 char * copy = new char[strlen(s) + 1];
244 compare_strings (const char * s1, const char * s2)
246 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
250 * Locate a child node by name and index.
253 find_child (const char * name, int index, const vector<SGPropertyNode_ptr>& nodes)
255 int nNodes = nodes.size();
256 for (int i = 0; i < nNodes; i++) {
257 SGPropertyNode * node = nodes[i];
258 if (compare_strings(node->getName(), name) && node->getIndex() == index)
266 * Locate another node, given a relative path.
268 static SGPropertyNode *
269 find_node (SGPropertyNode * current,
270 const vector<PathComponent> &components,
274 // Run off the end of the list
279 // Success! This is the one we want.
280 else if (position >= (int)components.size()) {
281 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
284 // Empty component means root.
285 else if (components[position].name == "") {
286 return find_node(current->getRootNode(), components, position + 1, create);
289 // . means current directory
290 else if (components[position].name == ".") {
291 return find_node(current, components, position + 1, create);
294 // .. means parent directory
295 else if (components[position].name == "..") {
296 SGPropertyNode * parent = current->getParent();
298 throw string("Attempt to move past root with '..'");
300 return find_node(parent, components, position + 1, create);
303 // Otherwise, a child name
305 SGPropertyNode * child =
306 current->getChild(components[position].name.c_str(),
307 components[position].index,
309 return find_node(child, components, position + 1, create);
315 ////////////////////////////////////////////////////////////////////////
316 // Private methods from SGPropertyNode (may be inlined for speed).
317 ////////////////////////////////////////////////////////////////////////
320 SGPropertyNode::get_bool () const
323 return _value.bool_val->getValue();
325 return _local_val.bool_val;
329 SGPropertyNode::get_int () const
332 return _value.int_val->getValue();
334 return _local_val.int_val;
338 SGPropertyNode::get_long () const
341 return _value.long_val->getValue();
343 return _local_val.long_val;
347 SGPropertyNode::get_float () const
350 return _value.float_val->getValue();
352 return _local_val.float_val;
356 SGPropertyNode::get_double () const
359 return _value.double_val->getValue();
361 return _local_val.double_val;
365 SGPropertyNode::get_string () const
368 return _value.string_val->getValue();
370 return _local_val.string_val;
374 SGPropertyNode::set_bool (bool val)
377 if (_value.bool_val->setValue(val)) {
384 _local_val.bool_val = val;
391 SGPropertyNode::set_int (int val)
394 if (_value.int_val->setValue(val)) {
401 _local_val.int_val = val;
408 SGPropertyNode::set_long (long val)
411 if (_value.long_val->setValue(val)) {
418 _local_val.long_val = val;
425 SGPropertyNode::set_float (float val)
428 if (_value.float_val->setValue(val)) {
435 _local_val.float_val = val;
442 SGPropertyNode::set_double (double val)
445 if (_value.double_val->setValue(val)) {
452 _local_val.double_val = val;
459 SGPropertyNode::set_string (const char * val)
462 if (_value.string_val->setValue(val)) {
469 delete [] _local_val.string_val;
470 _local_val.string_val = copy_string(val);
477 SGPropertyNode::clearValue ()
487 delete _value.bool_val;
490 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
494 delete _value.int_val;
497 _local_val.int_val = SGRawValue<int>::DefaultValue;
501 delete _value.long_val;
502 _value.long_val = 0L;
504 _local_val.long_val = SGRawValue<long>::DefaultValue;
508 delete _value.float_val;
509 _value.float_val = 0;
511 _local_val.float_val = SGRawValue<float>::DefaultValue;
515 delete _value.double_val;
516 _value.double_val = 0;
518 _local_val.double_val = SGRawValue<double>::DefaultValue;
523 delete _value.string_val;
524 _value.string_val = 0;
526 delete [] _local_val.string_val;
528 _local_val.string_val = 0;
537 * Get the value as a string.
540 SGPropertyNode::make_string () const
542 if (!getAttribute(READ))
547 return _value.alias->getStringValue();
557 _buffer = sstr.str();
558 return _buffer.c_str();
564 _buffer = sstr.str();
565 return _buffer.c_str();
571 _buffer = sstr.str();
572 return _buffer.c_str();
577 sstr.precision( 10 );
578 sstr << get_double();
579 _buffer = sstr.str();
580 return _buffer.c_str();
592 * Trace a write access for a property.
595 SGPropertyNode::trace_write () const
598 cerr << "TRACE: Write node " << getPath () << ", value\""
599 << make_string() << '"' << endl;
601 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Write node " << getPath()
602 << ", value\"" << make_string() << '"');
607 * Trace a read access for a property.
610 SGPropertyNode::trace_read () const
613 cerr << "TRACE: Write node " << getPath () << ", value \""
614 << make_string() << '"' << endl;
616 SG_LOG(SG_GENERAL, SG_INFO, "TRACE: Read node " << getPath()
617 << ", value \"" << make_string() << '"');
622 ////////////////////////////////////////////////////////////////////////
623 // Public methods from SGPropertyNode.
624 ////////////////////////////////////////////////////////////////////////
627 * Last used attribute
628 * Update as needed when enum Attribute is changed
630 const int SGPropertyNode::LAST_USED_ATTRIBUTE = TRACE_WRITE;
633 * Default constructor: always creates a root node.
635 SGPropertyNode::SGPropertyNode ()
644 _local_val.string_val = 0;
651 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
652 : _index(node._index),
654 _parent(0), // don't copy the parent
659 _listeners(0) // CHECK!!
661 _local_val.string_val = 0;
666 _value.alias = node._value.alias;
672 _value.bool_val = node._value.bool_val->clone();
675 set_bool(node.get_bool());
681 _value.int_val = node._value.int_val->clone();
684 set_int(node.get_int());
690 _value.long_val = node._value.long_val->clone();
693 set_long(node.get_long());
699 _value.float_val = node._value.float_val->clone();
702 set_float(node.get_float());
708 _value.double_val = node._value.double_val->clone();
711 set_double(node.get_double());
718 _value.string_val = node._value.string_val->clone();
721 set_string(node.get_string());
729 * Convenience constructor.
731 SGPropertyNode::SGPropertyNode (const char * name,
733 SGPropertyNode * parent)
743 _local_val.string_val = 0;
750 SGPropertyNode::~SGPropertyNode ()
752 // zero out all parent pointers, else they might be dangling
753 for (unsigned i = 0; i < _children.size(); ++i)
754 _children[i]->_parent = 0;
755 for (unsigned i = 0; i < _removedChildren.size(); ++i)
756 _removedChildren[i]->_parent = 0;
761 vector<SGPropertyChangeListener*>::iterator it;
762 for (it = _listeners->begin(); it != _listeners->end(); ++it)
763 (*it)->unregister_property(this);
770 * Alias to another node.
773 SGPropertyNode::alias (SGPropertyNode * target)
775 if (target == 0 || _type == ALIAS || _tied)
778 _value.alias = target;
785 * Alias to another node by path.
788 SGPropertyNode::alias (const char * path)
790 return alias(getNode(path, true));
798 SGPropertyNode::unalias ()
809 * Get the target of an alias.
812 SGPropertyNode::getAliasTarget ()
814 return (_type == ALIAS ? _value.alias : 0);
818 const SGPropertyNode *
819 SGPropertyNode::getAliasTarget () const
821 return (_type == ALIAS ? _value.alias : 0);
826 * Get a non-const child by index.
829 SGPropertyNode::getChild (int position)
831 if (position >= 0 && position < nChildren())
832 return _children[position];
839 * Get a const child by index.
841 const SGPropertyNode *
842 SGPropertyNode::getChild (int position) const
844 if (position >= 0 && position < nChildren())
845 return _children[position];
852 * Get a non-const child by name and index, creating if necessary.
855 SGPropertyNode::getChild (const char * name, int index, bool create)
857 int pos = find_child(name, index, _children);
859 return _children[pos];
861 SGPropertyNode_ptr node;
862 pos = find_child(name, index, _removedChildren);
864 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
866 node = _removedChildren[pos];
867 _removedChildren.erase(it);
868 node->setAttribute(REMOVED, false);
870 node = new SGPropertyNode(name, index, this);
872 _children.push_back(node);
873 fireChildAdded(node);
882 * Get a const child by name and index.
884 const SGPropertyNode *
885 SGPropertyNode::getChild (const char * name, int index) const
887 int pos = find_child(name, index, _children);
889 return _children[pos];
896 * Get all children with the same name (but different indices).
898 vector<SGPropertyNode_ptr>
899 SGPropertyNode::getChildren (const char * name) const
901 vector<SGPropertyNode_ptr> children;
902 int max = _children.size();
904 for (int i = 0; i < max; i++)
905 if (compare_strings(_children[i]->getName(), name))
906 children.push_back(_children[i]);
908 sort(children.begin(), children.end(), CompareIndices());
914 * Remove child by position.
917 SGPropertyNode::removeChild (int pos, bool keep)
919 SGPropertyNode_ptr node;
920 if (pos < 0 || pos >= (int)_children.size())
923 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
925 node = _children[pos];
928 _removedChildren.push_back(node);
931 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
932 node->setAttribute(REMOVED, true);
934 fireChildRemoved(node);
940 * Remove a child node
943 SGPropertyNode::removeChild (const char * name, int index, bool keep)
945 SGPropertyNode_ptr ret;
946 int pos = find_child(name, index, _children);
948 ret = removeChild(pos, keep);
954 * Remove all children with the specified name.
956 vector<SGPropertyNode_ptr>
957 SGPropertyNode::removeChildren (const char * name, bool keep)
959 vector<SGPropertyNode_ptr> children;
961 for (int pos = _children.size() - 1; pos >= 0; pos--)
962 if (compare_strings(_children[pos]->getName(), name))
963 children.push_back(removeChild(pos, keep));
965 sort(children.begin(), children.end(), CompareIndices());
971 SGPropertyNode::getDisplayName (bool simplify) const
973 _display_name = _name;
974 if (_index != 0 || !simplify) {
976 sstr << '[' << _index << ']';
977 _display_name += sstr.str();
979 return _display_name.c_str();
984 SGPropertyNode::getPath (bool simplify) const
986 // Calculate the complete path only once.
987 if (_parent != 0 && _path.empty()) {
988 _path = _parent->getPath(simplify);
990 _path += getDisplayName(simplify);
993 return _path.c_str();
997 SGPropertyNode::getType () const
1000 return _value.alias->getType();
1007 SGPropertyNode::getBoolValue () const
1009 // Shortcut for common case
1010 if (_attr == (READ|WRITE) && _type == BOOL)
1013 if (getAttribute(TRACE_READ))
1015 if (!getAttribute(READ))
1016 return SGRawValue<bool>::DefaultValue;
1019 return _value.alias->getBoolValue();
1023 return get_int() == 0 ? false : true;
1025 return get_long() == 0L ? false : true;
1027 return get_float() == 0.0 ? false : true;
1029 return get_double() == 0.0L ? false : true;
1032 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1035 return SGRawValue<bool>::DefaultValue;
1040 SGPropertyNode::getIntValue () const
1042 // Shortcut for common case
1043 if (_attr == (READ|WRITE) && _type == INT)
1046 if (getAttribute(TRACE_READ))
1048 if (!getAttribute(READ))
1049 return SGRawValue<int>::DefaultValue;
1052 return _value.alias->getIntValue();
1054 return int(get_bool());
1058 return int(get_long());
1060 return int(get_float());
1062 return int(get_double());
1065 return atoi(get_string());
1068 return SGRawValue<int>::DefaultValue;
1073 SGPropertyNode::getLongValue () const
1075 // Shortcut for common case
1076 if (_attr == (READ|WRITE) && _type == LONG)
1079 if (getAttribute(TRACE_READ))
1081 if (!getAttribute(READ))
1082 return SGRawValue<long>::DefaultValue;
1085 return _value.alias->getLongValue();
1087 return long(get_bool());
1089 return long(get_int());
1093 return long(get_float());
1095 return long(get_double());
1098 return strtol(get_string(), 0, 0);
1101 return SGRawValue<long>::DefaultValue;
1106 SGPropertyNode::getFloatValue () const
1108 // Shortcut for common case
1109 if (_attr == (READ|WRITE) && _type == FLOAT)
1112 if (getAttribute(TRACE_READ))
1114 if (!getAttribute(READ))
1115 return SGRawValue<float>::DefaultValue;
1118 return _value.alias->getFloatValue();
1120 return float(get_bool());
1122 return float(get_int());
1124 return float(get_long());
1128 return float(get_double());
1131 return atof(get_string());
1134 return SGRawValue<float>::DefaultValue;
1139 SGPropertyNode::getDoubleValue () const
1141 // Shortcut for common case
1142 if (_attr == (READ|WRITE) && _type == DOUBLE)
1143 return get_double();
1145 if (getAttribute(TRACE_READ))
1147 if (!getAttribute(READ))
1148 return SGRawValue<double>::DefaultValue;
1152 return _value.alias->getDoubleValue();
1154 return double(get_bool());
1156 return double(get_int());
1158 return double(get_long());
1160 return double(get_float());
1162 return get_double();
1165 return strtod(get_string(), 0);
1168 return SGRawValue<double>::DefaultValue;
1173 SGPropertyNode::getStringValue () const
1175 // Shortcut for common case
1176 if (_attr == (READ|WRITE) && _type == STRING)
1177 return get_string();
1179 if (getAttribute(TRACE_READ))
1181 if (!getAttribute(READ))
1182 return SGRawValue<const char *>::DefaultValue;
1183 return make_string();
1187 SGPropertyNode::setBoolValue (bool value)
1189 // Shortcut for common case
1190 if (_attr == (READ|WRITE) && _type == BOOL)
1191 return set_bool(value);
1193 bool result = false;
1195 if (_type == NONE || _type == UNSPECIFIED) {
1203 result = _value.alias->setBoolValue(value);
1206 result = set_bool(value);
1209 result = set_int(int(value));
1212 result = set_long(long(value));
1215 result = set_float(float(value));
1218 result = set_double(double(value));
1222 result = set_string(value ? "true" : "false");
1229 if (getAttribute(TRACE_WRITE))
1235 SGPropertyNode::setIntValue (int value)
1237 // Shortcut for common case
1238 if (_attr == (READ|WRITE) && _type == INT)
1239 return set_int(value);
1241 bool result = false;
1243 if (_type == NONE || _type == UNSPECIFIED) {
1246 _local_val.int_val = 0;
1251 result = _value.alias->setIntValue(value);
1254 result = set_bool(value == 0 ? false : true);
1257 result = set_int(value);
1260 result = set_long(long(value));
1263 result = set_float(float(value));
1266 result = set_double(double(value));
1271 sprintf(buf, "%d", value);
1272 result = set_string(buf);
1280 if (getAttribute(TRACE_WRITE))
1286 SGPropertyNode::setLongValue (long value)
1288 // Shortcut for common case
1289 if (_attr == (READ|WRITE) && _type == LONG)
1290 return set_long(value);
1292 bool result = false;
1294 if (_type == NONE || _type == UNSPECIFIED) {
1297 _local_val.long_val = 0L;
1302 result = _value.alias->setLongValue(value);
1305 result = set_bool(value == 0L ? false : true);
1308 result = set_int(int(value));
1311 result = set_long(value);
1314 result = set_float(float(value));
1317 result = set_double(double(value));
1322 sprintf(buf, "%ld", value);
1323 result = set_string(buf);
1331 if (getAttribute(TRACE_WRITE))
1337 SGPropertyNode::setFloatValue (float value)
1339 // Shortcut for common case
1340 if (_attr == (READ|WRITE) && _type == FLOAT)
1341 return set_float(value);
1343 bool result = false;
1345 if (_type == NONE || _type == UNSPECIFIED) {
1348 _local_val.float_val = 0;
1353 result = _value.alias->setFloatValue(value);
1356 result = set_bool(value == 0.0 ? false : true);
1359 result = set_int(int(value));
1362 result = set_long(long(value));
1365 result = set_float(value);
1368 result = set_double(double(value));
1373 sprintf(buf, "%f", value);
1374 result = set_string(buf);
1382 if (getAttribute(TRACE_WRITE))
1388 SGPropertyNode::setDoubleValue (double value)
1390 // Shortcut for common case
1391 if (_attr == (READ|WRITE) && _type == DOUBLE)
1392 return set_double(value);
1394 bool result = false;
1396 if (_type == NONE || _type == UNSPECIFIED) {
1398 _local_val.double_val = value;
1404 result = _value.alias->setDoubleValue(value);
1407 result = set_bool(value == 0.0L ? false : true);
1410 result = set_int(int(value));
1413 result = set_long(long(value));
1416 result = set_float(float(value));
1419 result = set_double(value);
1424 sprintf(buf, "%f", value);
1425 result = set_string(buf);
1433 if (getAttribute(TRACE_WRITE))
1439 SGPropertyNode::setStringValue (const char * value)
1441 // Shortcut for common case
1442 if (_attr == (READ|WRITE) && _type == STRING)
1443 return set_string(value);
1445 bool result = false;
1447 if (_type == NONE || _type == UNSPECIFIED) {
1454 result = _value.alias->setStringValue(value);
1457 result = set_bool((compare_strings(value, "true")
1458 || atoi(value)) ? true : false);
1461 result = set_int(atoi(value));
1464 result = set_long(strtol(value, 0, 0));
1467 result = set_float(atof(value));
1470 result = set_double(strtod(value, 0));
1474 result = set_string(value);
1481 if (getAttribute(TRACE_WRITE))
1487 SGPropertyNode::setUnspecifiedValue (const char * value)
1489 bool result = false;
1491 if (_type == NONE) {
1493 _type = UNSPECIFIED;
1498 result = _value.alias->setUnspecifiedValue(value);
1501 result = set_bool((compare_strings(value, "true")
1502 || atoi(value)) ? true : false);
1505 result = set_int(atoi(value));
1508 result = set_long(strtol(value, 0, 0));
1511 result = set_float(atof(value));
1514 result = set_double(strtod(value, 0));
1518 result = set_string(value);
1525 if (getAttribute(TRACE_WRITE))
1531 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1533 if (_type == ALIAS || _tied)
1536 useDefault = useDefault && hasValue();
1537 bool old_val = false;
1539 old_val = getBoolValue();
1544 _value.bool_val = rawValue.clone();
1547 setBoolValue(old_val);
1553 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1555 if (_type == ALIAS || _tied)
1558 useDefault = useDefault && hasValue();
1561 old_val = getIntValue();
1566 _value.int_val = rawValue.clone();
1569 setIntValue(old_val);
1575 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1577 if (_type == ALIAS || _tied)
1580 useDefault = useDefault && hasValue();
1583 old_val = getLongValue();
1588 _value.long_val = rawValue.clone();
1591 setLongValue(old_val);
1597 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1599 if (_type == ALIAS || _tied)
1602 useDefault = useDefault && hasValue();
1603 float old_val = 0.0;
1605 old_val = getFloatValue();
1610 _value.float_val = rawValue.clone();
1613 setFloatValue(old_val);
1619 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1621 if (_type == ALIAS || _tied)
1624 useDefault = useDefault && hasValue();
1625 double old_val = 0.0;
1627 old_val = getDoubleValue();
1632 _value.double_val = rawValue.clone();
1635 setDoubleValue(old_val);
1642 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1644 if (_type == ALIAS || _tied)
1647 useDefault = useDefault && hasValue();
1650 old_val = getStringValue();
1655 _value.string_val = rawValue.clone();
1658 setStringValue(old_val.c_str());
1664 SGPropertyNode::untie ()
1671 bool val = getBoolValue();
1674 _local_val.bool_val = val;
1678 int val = getIntValue();
1681 _local_val.int_val = val;
1685 long val = getLongValue();
1688 _local_val.long_val = val;
1692 float val = getFloatValue();
1695 _local_val.float_val = val;
1699 double val = getDoubleValue();
1702 _local_val.double_val = val;
1707 string val = getStringValue();
1710 _local_val.string_val = copy_string(val.c_str());
1723 SGPropertyNode::getRootNode ()
1728 return _parent->getRootNode();
1731 const SGPropertyNode *
1732 SGPropertyNode::getRootNode () const
1737 return _parent->getRootNode();
1741 SGPropertyNode::getNode (const char * relative_path, bool create)
1743 if (_path_cache == 0)
1744 _path_cache = new hash_table;
1746 SGPropertyNode * result = _path_cache->get(relative_path);
1748 vector<PathComponent> components;
1749 parse_path(relative_path, components);
1750 result = find_node(this, components, 0, create);
1752 _path_cache->put(relative_path, result);
1759 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1761 vector<PathComponent> components;
1762 parse_path(relative_path, components);
1763 if (components.size() > 0)
1764 components.back().index = index;
1765 return find_node(this, components, 0, create);
1768 const SGPropertyNode *
1769 SGPropertyNode::getNode (const char * relative_path) const
1771 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1774 const SGPropertyNode *
1775 SGPropertyNode::getNode (const char * relative_path, int index) const
1777 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1781 ////////////////////////////////////////////////////////////////////////
1782 // Convenience methods using relative paths.
1783 ////////////////////////////////////////////////////////////////////////
1787 * Test whether another node has a value attached.
1790 SGPropertyNode::hasValue (const char * relative_path) const
1792 const SGPropertyNode * node = getNode(relative_path);
1793 return (node == 0 ? false : node->hasValue());
1798 * Get the value type for another node.
1800 SGPropertyNode::Type
1801 SGPropertyNode::getType (const char * relative_path) const
1803 const SGPropertyNode * node = getNode(relative_path);
1804 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1809 * Get a bool value for another node.
1812 SGPropertyNode::getBoolValue (const char * relative_path,
1813 bool defaultValue) const
1815 const SGPropertyNode * node = getNode(relative_path);
1816 return (node == 0 ? defaultValue : node->getBoolValue());
1821 * Get an int value for another node.
1824 SGPropertyNode::getIntValue (const char * relative_path,
1825 int defaultValue) const
1827 const SGPropertyNode * node = getNode(relative_path);
1828 return (node == 0 ? defaultValue : node->getIntValue());
1833 * Get a long value for another node.
1836 SGPropertyNode::getLongValue (const char * relative_path,
1837 long defaultValue) const
1839 const SGPropertyNode * node = getNode(relative_path);
1840 return (node == 0 ? defaultValue : node->getLongValue());
1845 * Get a float value for another node.
1848 SGPropertyNode::getFloatValue (const char * relative_path,
1849 float defaultValue) const
1851 const SGPropertyNode * node = getNode(relative_path);
1852 return (node == 0 ? defaultValue : node->getFloatValue());
1857 * Get a double value for another node.
1860 SGPropertyNode::getDoubleValue (const char * relative_path,
1861 double defaultValue) const
1863 const SGPropertyNode * node = getNode(relative_path);
1864 return (node == 0 ? defaultValue : node->getDoubleValue());
1869 * Get a string value for another node.
1872 SGPropertyNode::getStringValue (const char * relative_path,
1873 const char * defaultValue) const
1875 const SGPropertyNode * node = getNode(relative_path);
1876 return (node == 0 ? defaultValue : node->getStringValue());
1881 * Set a bool value for another node.
1884 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1886 return getNode(relative_path, true)->setBoolValue(value);
1891 * Set an int value for another node.
1894 SGPropertyNode::setIntValue (const char * relative_path, int value)
1896 return getNode(relative_path, true)->setIntValue(value);
1901 * Set a long value for another node.
1904 SGPropertyNode::setLongValue (const char * relative_path, long value)
1906 return getNode(relative_path, true)->setLongValue(value);
1911 * Set a float value for another node.
1914 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1916 return getNode(relative_path, true)->setFloatValue(value);
1921 * Set a double value for another node.
1924 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1926 return getNode(relative_path, true)->setDoubleValue(value);
1931 * Set a string value for another node.
1934 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1936 return getNode(relative_path, true)->setStringValue(value);
1941 * Set an unknown value for another node.
1944 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1947 return getNode(relative_path, true)->setUnspecifiedValue(value);
1952 * Test whether another node is tied.
1955 SGPropertyNode::isTied (const char * relative_path) const
1957 const SGPropertyNode * node = getNode(relative_path);
1958 return (node == 0 ? false : node->isTied());
1963 * Tie a node reached by a relative path, creating it if necessary.
1966 SGPropertyNode::tie (const char * relative_path,
1967 const SGRawValue<bool> &rawValue,
1970 return getNode(relative_path, true)->tie(rawValue, useDefault);
1975 * Tie a node reached by a relative path, creating it if necessary.
1978 SGPropertyNode::tie (const char * relative_path,
1979 const SGRawValue<int> &rawValue,
1982 return getNode(relative_path, true)->tie(rawValue, useDefault);
1987 * Tie a node reached by a relative path, creating it if necessary.
1990 SGPropertyNode::tie (const char * relative_path,
1991 const SGRawValue<long> &rawValue,
1994 return getNode(relative_path, true)->tie(rawValue, useDefault);
1999 * Tie a node reached by a relative path, creating it if necessary.
2002 SGPropertyNode::tie (const char * relative_path,
2003 const SGRawValue<float> &rawValue,
2006 return getNode(relative_path, true)->tie(rawValue, useDefault);
2011 * Tie a node reached by a relative path, creating it if necessary.
2014 SGPropertyNode::tie (const char * relative_path,
2015 const SGRawValue<double> &rawValue,
2018 return getNode(relative_path, true)->tie(rawValue, useDefault);
2023 * Tie a node reached by a relative path, creating it if necessary.
2026 SGPropertyNode::tie (const char * relative_path,
2027 const SGRawValue<const char *> &rawValue,
2030 return getNode(relative_path, true)->tie(rawValue, useDefault);
2035 * Attempt to untie another node reached by a relative path.
2038 SGPropertyNode::untie (const char * relative_path)
2040 SGPropertyNode * node = getNode(relative_path);
2041 return (node == 0 ? false : node->untie());
2045 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2048 if (_listeners == 0)
2049 _listeners = new vector<SGPropertyChangeListener*>;
2050 _listeners->push_back(listener);
2051 listener->register_property(this);
2053 listener->valueChanged(this);
2057 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2059 vector<SGPropertyChangeListener*>::iterator it =
2060 find(_listeners->begin(), _listeners->end(), listener);
2061 if (it != _listeners->end()) {
2062 _listeners->erase(it);
2063 listener->unregister_property(this);
2064 if (_listeners->empty()) {
2065 vector<SGPropertyChangeListener*>* tmp = _listeners;
2073 SGPropertyNode::fireValueChanged ()
2075 fireValueChanged(this);
2079 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2081 fireChildAdded(this, child);
2085 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2087 fireChildRemoved(this, child);
2091 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2093 if (_listeners != 0) {
2094 for (unsigned int i = 0; i < _listeners->size(); i++) {
2095 (*_listeners)[i]->valueChanged(node);
2099 _parent->fireValueChanged(node);
2103 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2104 SGPropertyNode * child)
2106 if (_listeners != 0) {
2107 for (unsigned int i = 0; i < _listeners->size(); i++) {
2108 (*_listeners)[i]->childAdded(parent, child);
2112 _parent->fireChildAdded(parent, child);
2116 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2117 SGPropertyNode * child)
2119 if (_listeners != 0) {
2120 for (unsigned int i = 0; i < _listeners->size(); i++) {
2121 (*_listeners)[i]->childRemoved(parent, child);
2125 _parent->fireChildRemoved(parent, child);
2130 ////////////////////////////////////////////////////////////////////////
2131 // Simplified hash table for caching paths.
2132 ////////////////////////////////////////////////////////////////////////
2134 #define HASH_TABLE_SIZE 199
2136 SGPropertyNode::hash_table::entry::entry ()
2141 SGPropertyNode::hash_table::entry::~entry ()
2143 // Don't delete the value; we don't own
2148 SGPropertyNode::hash_table::entry::set_key (const char * key)
2154 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2159 SGPropertyNode::hash_table::bucket::bucket ()
2165 SGPropertyNode::hash_table::bucket::~bucket ()
2167 for (int i = 0; i < _length; i++)
2172 SGPropertyNode::hash_table::entry *
2173 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2176 for (i = 0; i < _length; i++) {
2177 if (!strcmp(_entries[i]->get_key(), key))
2181 entry ** new_entries = new entry*[_length+1];
2182 for (i = 0; i < _length; i++) {
2183 new_entries[i] = _entries[i];
2186 _entries = new_entries;
2187 _entries[_length] = new entry;
2188 _entries[_length]->set_key(key);
2190 return _entries[_length - 1];
2197 SGPropertyNode::hash_table::bucket::erase (const char * key)
2200 for (i = 0; i < _length; i++) {
2201 if (!strcmp(_entries[i]->get_key(), key))
2206 for (++i; i < _length; i++) {
2207 _entries[i-1] = _entries[i];
2214 SGPropertyNode::hash_table::hash_table ()
2220 SGPropertyNode::hash_table::~hash_table ()
2222 for (unsigned int i = 0; i < _data_length; i++)
2228 SGPropertyNode::hash_table::get (const char * key)
2230 if (_data_length == 0)
2232 unsigned int index = hashcode(key) % _data_length;
2233 if (_data[index] == 0)
2235 entry * e = _data[index]->get_entry(key);
2239 return e->get_value();
2243 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2245 if (_data_length == 0) {
2246 _data = new bucket*[HASH_TABLE_SIZE];
2247 _data_length = HASH_TABLE_SIZE;
2248 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2251 unsigned int index = hashcode(key) % _data_length;
2252 if (_data[index] == 0) {
2253 _data[index] = new bucket;
2255 entry * e = _data[index]->get_entry(key, true);
2256 e->set_value(value);
2260 SGPropertyNode::hash_table::erase (const char * key)
2262 if (_data_length == 0)
2264 unsigned int index = hashcode(key) % _data_length;
2265 if (_data[index] == 0)
2267 _data[index]->erase(key);
2271 SGPropertyNode::hash_table::hashcode (const char * key)
2273 unsigned int hash = 0;
2275 hash = 31 * hash + *key;
2283 ////////////////////////////////////////////////////////////////////////
2284 // Implementation of SGPropertyChangeListener.
2285 ////////////////////////////////////////////////////////////////////////
2287 SGPropertyChangeListener::~SGPropertyChangeListener ()
2289 for (int i = _properties.size() - 1; i >= 0; i--)
2290 _properties[i]->removeChangeListener(this);
2294 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2300 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2301 SGPropertyNode * child)
2307 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2308 SGPropertyNode * child)
2314 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2316 _properties.push_back(node);
2320 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2322 vector<SGPropertyNode *>::iterator it =
2323 find(_properties.begin(), _properties.end(), node);
2324 if (it != _properties.end())
2325 _properties.erase(it);