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, 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 ()
759 * Alias to another node.
762 SGPropertyNode::alias (SGPropertyNode * target)
764 if (target == 0 || _type == ALIAS || _tied)
767 _value.alias = target;
774 * Alias to another node by path.
777 SGPropertyNode::alias (const char * path)
779 return alias(getNode(path, true));
787 SGPropertyNode::unalias ()
798 * Get the target of an alias.
801 SGPropertyNode::getAliasTarget ()
803 return (_type == ALIAS ? _value.alias : 0);
807 const SGPropertyNode *
808 SGPropertyNode::getAliasTarget () const
810 return (_type == ALIAS ? _value.alias : 0);
815 * Get a non-const child by index.
818 SGPropertyNode::getChild (int position)
820 if (position >= 0 && position < nChildren())
821 return _children[position];
828 * Get a const child by index.
830 const SGPropertyNode *
831 SGPropertyNode::getChild (int position) const
833 if (position >= 0 && position < nChildren())
834 return _children[position];
841 * Get a non-const child by name and index, creating if necessary.
844 SGPropertyNode::getChild (const char * name, int index, bool create)
846 int pos = find_child(name, index, _children);
848 return _children[pos];
850 SGPropertyNode_ptr node;
851 pos = find_child(name, index, _removedChildren);
853 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
855 node = _removedChildren[pos];
856 _removedChildren.erase(it);
857 node->setAttribute(REMOVED, false);
859 node = new SGPropertyNode(name, index, this);
861 _children.push_back(node);
862 fireChildAdded(node);
871 * Get a const child by name and index.
873 const SGPropertyNode *
874 SGPropertyNode::getChild (const char * name, int index) const
876 int pos = find_child(name, index, _children);
878 return _children[pos];
885 * Get all children with the same name (but different indices).
887 vector<SGPropertyNode_ptr>
888 SGPropertyNode::getChildren (const char * name) const
890 vector<SGPropertyNode_ptr> children;
891 int max = _children.size();
893 for (int i = 0; i < max; i++)
894 if (compare_strings(_children[i]->getName(), name))
895 children.push_back(_children[i]);
897 sort(children.begin(), children.end(), CompareIndices());
903 * Remove child by position.
906 SGPropertyNode::removeChild (int pos, bool keep)
908 SGPropertyNode_ptr node;
909 if (pos < 0 || pos >= _children.size())
912 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
914 node = _children[pos];
917 _removedChildren.push_back(node);
920 _path_cache->erase(node->getName()); // EMH - TODO: Take "index" into account!
921 node->setAttribute(REMOVED, true);
923 fireChildRemoved(node);
929 * Remove a child node
932 SGPropertyNode::removeChild (const char * name, int index, bool keep)
934 SGPropertyNode_ptr ret;
935 int pos = find_child(name, index, _children);
937 ret = removeChild(pos, keep);
943 * Remove all children with the specified name.
945 vector<SGPropertyNode_ptr>
946 SGPropertyNode::removeChildren (const char * name, bool keep)
948 vector<SGPropertyNode_ptr> children;
950 for (int pos = _children.size() - 1; pos >= 0; pos--)
951 if (compare_strings(_children[pos]->getName(), name))
952 children.push_back(removeChild(pos, keep));
954 sort(children.begin(), children.end(), CompareIndices());
960 SGPropertyNode::getDisplayName (bool simplify) const
962 _display_name = _name;
963 if (_index != 0 || !simplify) {
965 sstr << '[' << _index << ']';
966 _display_name += sstr.str();
968 return _display_name.c_str();
973 SGPropertyNode::getPath (bool simplify) const
975 // Calculate the complete path only once.
976 if (_parent != 0 && _path.empty()) {
977 _path = _parent->getPath(simplify);
979 _path += getDisplayName(simplify);
982 return _path.c_str();
986 SGPropertyNode::getType () const
989 return _value.alias->getType();
996 SGPropertyNode::getBoolValue () const
998 // Shortcut for common case
999 if (_attr == (READ|WRITE) && _type == BOOL)
1002 if (getAttribute(TRACE_READ))
1004 if (!getAttribute(READ))
1005 return SGRawValue<bool>::DefaultValue;
1008 return _value.alias->getBoolValue();
1012 return get_int() == 0 ? false : true;
1014 return get_long() == 0L ? false : true;
1016 return get_float() == 0.0 ? false : true;
1018 return get_double() == 0.0L ? false : true;
1021 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1024 return SGRawValue<bool>::DefaultValue;
1029 SGPropertyNode::getIntValue () const
1031 // Shortcut for common case
1032 if (_attr == (READ|WRITE) && _type == INT)
1035 if (getAttribute(TRACE_READ))
1037 if (!getAttribute(READ))
1038 return SGRawValue<int>::DefaultValue;
1041 return _value.alias->getIntValue();
1043 return int(get_bool());
1047 return int(get_long());
1049 return int(get_float());
1051 return int(get_double());
1054 return atoi(get_string());
1057 return SGRawValue<int>::DefaultValue;
1062 SGPropertyNode::getLongValue () const
1064 // Shortcut for common case
1065 if (_attr == (READ|WRITE) && _type == LONG)
1068 if (getAttribute(TRACE_READ))
1070 if (!getAttribute(READ))
1071 return SGRawValue<long>::DefaultValue;
1074 return _value.alias->getLongValue();
1076 return long(get_bool());
1078 return long(get_int());
1082 return long(get_float());
1084 return long(get_double());
1087 return strtol(get_string(), 0, 0);
1090 return SGRawValue<long>::DefaultValue;
1095 SGPropertyNode::getFloatValue () const
1097 // Shortcut for common case
1098 if (_attr == (READ|WRITE) && _type == FLOAT)
1101 if (getAttribute(TRACE_READ))
1103 if (!getAttribute(READ))
1104 return SGRawValue<float>::DefaultValue;
1107 return _value.alias->getFloatValue();
1109 return float(get_bool());
1111 return float(get_int());
1113 return float(get_long());
1117 return float(get_double());
1120 return atof(get_string());
1123 return SGRawValue<float>::DefaultValue;
1128 SGPropertyNode::getDoubleValue () const
1130 // Shortcut for common case
1131 if (_attr == (READ|WRITE) && _type == DOUBLE)
1132 return get_double();
1134 if (getAttribute(TRACE_READ))
1136 if (!getAttribute(READ))
1137 return SGRawValue<double>::DefaultValue;
1141 return _value.alias->getDoubleValue();
1143 return double(get_bool());
1145 return double(get_int());
1147 return double(get_long());
1149 return double(get_float());
1151 return get_double();
1154 return strtod(get_string(), 0);
1157 return SGRawValue<double>::DefaultValue;
1162 SGPropertyNode::getStringValue () const
1164 // Shortcut for common case
1165 if (_attr == (READ|WRITE) && _type == STRING)
1166 return get_string();
1168 if (getAttribute(TRACE_READ))
1170 if (!getAttribute(READ))
1171 return SGRawValue<const char *>::DefaultValue;
1172 return make_string();
1176 SGPropertyNode::setBoolValue (bool value)
1178 // Shortcut for common case
1179 if (_attr == (READ|WRITE) && _type == BOOL)
1180 return set_bool(value);
1182 bool result = false;
1184 if (_type == NONE || _type == UNSPECIFIED) {
1192 result = _value.alias->setBoolValue(value);
1195 result = set_bool(value);
1198 result = set_int(int(value));
1201 result = set_long(long(value));
1204 result = set_float(float(value));
1207 result = set_double(double(value));
1211 result = set_string(value ? "true" : "false");
1218 if (getAttribute(TRACE_WRITE))
1224 SGPropertyNode::setIntValue (int value)
1226 // Shortcut for common case
1227 if (_attr == (READ|WRITE) && _type == INT)
1228 return set_int(value);
1230 bool result = false;
1232 if (_type == NONE || _type == UNSPECIFIED) {
1235 _local_val.int_val = 0;
1240 result = _value.alias->setIntValue(value);
1243 result = set_bool(value == 0 ? false : true);
1246 result = set_int(value);
1249 result = set_long(long(value));
1252 result = set_float(float(value));
1255 result = set_double(double(value));
1260 sprintf(buf, "%d", value);
1261 result = set_string(buf);
1269 if (getAttribute(TRACE_WRITE))
1275 SGPropertyNode::setLongValue (long value)
1277 // Shortcut for common case
1278 if (_attr == (READ|WRITE) && _type == LONG)
1279 return set_long(value);
1281 bool result = false;
1283 if (_type == NONE || _type == UNSPECIFIED) {
1286 _local_val.long_val = 0L;
1291 result = _value.alias->setLongValue(value);
1294 result = set_bool(value == 0L ? false : true);
1297 result = set_int(int(value));
1300 result = set_long(value);
1303 result = set_float(float(value));
1306 result = set_double(double(value));
1311 sprintf(buf, "%ld", value);
1312 result = set_string(buf);
1320 if (getAttribute(TRACE_WRITE))
1326 SGPropertyNode::setFloatValue (float value)
1328 // Shortcut for common case
1329 if (_attr == (READ|WRITE) && _type == FLOAT)
1330 return set_float(value);
1332 bool result = false;
1334 if (_type == NONE || _type == UNSPECIFIED) {
1337 _local_val.float_val = 0;
1342 result = _value.alias->setFloatValue(value);
1345 result = set_bool(value == 0.0 ? false : true);
1348 result = set_int(int(value));
1351 result = set_long(long(value));
1354 result = set_float(value);
1357 result = set_double(double(value));
1362 sprintf(buf, "%f", value);
1363 result = set_string(buf);
1371 if (getAttribute(TRACE_WRITE))
1377 SGPropertyNode::setDoubleValue (double value)
1379 // Shortcut for common case
1380 if (_attr == (READ|WRITE) && _type == DOUBLE)
1381 return set_double(value);
1383 bool result = false;
1385 if (_type == NONE || _type == UNSPECIFIED) {
1387 _local_val.double_val = value;
1393 result = _value.alias->setDoubleValue(value);
1396 result = set_bool(value == 0.0L ? false : true);
1399 result = set_int(int(value));
1402 result = set_long(long(value));
1405 result = set_float(float(value));
1408 result = set_double(value);
1413 sprintf(buf, "%f", value);
1414 result = set_string(buf);
1422 if (getAttribute(TRACE_WRITE))
1428 SGPropertyNode::setStringValue (const char * value)
1430 // Shortcut for common case
1431 if (_attr == (READ|WRITE) && _type == STRING)
1432 return set_string(value);
1434 bool result = false;
1436 if (_type == NONE || _type == UNSPECIFIED) {
1443 result = _value.alias->setStringValue(value);
1446 result = set_bool((compare_strings(value, "true")
1447 || atoi(value)) ? true : false);
1450 result = set_int(atoi(value));
1453 result = set_long(strtol(value, 0, 0));
1456 result = set_float(atof(value));
1459 result = set_double(strtod(value, 0));
1463 result = set_string(value);
1470 if (getAttribute(TRACE_WRITE))
1476 SGPropertyNode::setUnspecifiedValue (const char * value)
1478 bool result = false;
1480 if (_type == NONE) {
1482 _type = UNSPECIFIED;
1487 result = _value.alias->setUnspecifiedValue(value);
1490 result = set_bool((compare_strings(value, "true")
1491 || atoi(value)) ? true : false);
1494 result = set_int(atoi(value));
1497 result = set_long(strtol(value, 0, 0));
1500 result = set_float(atof(value));
1503 result = set_double(strtod(value, 0));
1507 result = set_string(value);
1514 if (getAttribute(TRACE_WRITE))
1520 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1522 if (_type == ALIAS || _tied)
1525 useDefault = useDefault && hasValue();
1526 bool old_val = false;
1528 old_val = getBoolValue();
1533 _value.bool_val = rawValue.clone();
1536 setBoolValue(old_val);
1542 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1544 if (_type == ALIAS || _tied)
1547 useDefault = useDefault && hasValue();
1550 old_val = getIntValue();
1555 _value.int_val = rawValue.clone();
1558 setIntValue(old_val);
1564 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1566 if (_type == ALIAS || _tied)
1569 useDefault = useDefault && hasValue();
1572 old_val = getLongValue();
1577 _value.long_val = rawValue.clone();
1580 setLongValue(old_val);
1586 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1588 if (_type == ALIAS || _tied)
1591 useDefault = useDefault && hasValue();
1592 float old_val = 0.0;
1594 old_val = getFloatValue();
1599 _value.float_val = rawValue.clone();
1602 setFloatValue(old_val);
1608 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1610 if (_type == ALIAS || _tied)
1613 useDefault = useDefault && hasValue();
1614 double old_val = 0.0;
1616 old_val = getDoubleValue();
1621 _value.double_val = rawValue.clone();
1624 setDoubleValue(old_val);
1631 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1633 if (_type == ALIAS || _tied)
1636 useDefault = useDefault && hasValue();
1639 old_val = getStringValue();
1644 _value.string_val = rawValue.clone();
1647 setStringValue(old_val.c_str());
1653 SGPropertyNode::untie ()
1660 bool val = getBoolValue();
1663 _local_val.bool_val = val;
1667 int val = getIntValue();
1670 _local_val.int_val = val;
1674 long val = getLongValue();
1677 _local_val.long_val = val;
1681 float val = getFloatValue();
1684 _local_val.float_val = val;
1688 double val = getDoubleValue();
1691 _local_val.double_val = val;
1696 string val = getStringValue();
1699 _local_val.string_val = copy_string(val.c_str());
1712 SGPropertyNode::getRootNode ()
1717 return _parent->getRootNode();
1720 const SGPropertyNode *
1721 SGPropertyNode::getRootNode () const
1726 return _parent->getRootNode();
1730 SGPropertyNode::getNode (const char * relative_path, bool create)
1732 if (_path_cache == 0)
1733 _path_cache = new hash_table;
1735 SGPropertyNode * result = _path_cache->get(relative_path);
1737 vector<PathComponent> components;
1738 parse_path(relative_path, components);
1739 result = find_node(this, components, 0, create);
1741 _path_cache->put(relative_path, result);
1748 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1750 vector<PathComponent> components;
1751 parse_path(relative_path, components);
1752 if (components.size() > 0)
1753 components.back().index = index;
1754 return find_node(this, components, 0, create);
1757 const SGPropertyNode *
1758 SGPropertyNode::getNode (const char * relative_path) const
1760 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1763 const SGPropertyNode *
1764 SGPropertyNode::getNode (const char * relative_path, int index) const
1766 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1770 ////////////////////////////////////////////////////////////////////////
1771 // Convenience methods using relative paths.
1772 ////////////////////////////////////////////////////////////////////////
1776 * Test whether another node has a value attached.
1779 SGPropertyNode::hasValue (const char * relative_path) const
1781 const SGPropertyNode * node = getNode(relative_path);
1782 return (node == 0 ? false : node->hasValue());
1787 * Get the value type for another node.
1789 SGPropertyNode::Type
1790 SGPropertyNode::getType (const char * relative_path) const
1792 const SGPropertyNode * node = getNode(relative_path);
1793 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1798 * Get a bool value for another node.
1801 SGPropertyNode::getBoolValue (const char * relative_path,
1802 bool defaultValue) const
1804 const SGPropertyNode * node = getNode(relative_path);
1805 return (node == 0 ? defaultValue : node->getBoolValue());
1810 * Get an int value for another node.
1813 SGPropertyNode::getIntValue (const char * relative_path,
1814 int defaultValue) const
1816 const SGPropertyNode * node = getNode(relative_path);
1817 return (node == 0 ? defaultValue : node->getIntValue());
1822 * Get a long value for another node.
1825 SGPropertyNode::getLongValue (const char * relative_path,
1826 long defaultValue) const
1828 const SGPropertyNode * node = getNode(relative_path);
1829 return (node == 0 ? defaultValue : node->getLongValue());
1834 * Get a float value for another node.
1837 SGPropertyNode::getFloatValue (const char * relative_path,
1838 float defaultValue) const
1840 const SGPropertyNode * node = getNode(relative_path);
1841 return (node == 0 ? defaultValue : node->getFloatValue());
1846 * Get a double value for another node.
1849 SGPropertyNode::getDoubleValue (const char * relative_path,
1850 double defaultValue) const
1852 const SGPropertyNode * node = getNode(relative_path);
1853 return (node == 0 ? defaultValue : node->getDoubleValue());
1858 * Get a string value for another node.
1861 SGPropertyNode::getStringValue (const char * relative_path,
1862 const char * defaultValue) const
1864 const SGPropertyNode * node = getNode(relative_path);
1865 return (node == 0 ? defaultValue : node->getStringValue());
1870 * Set a bool value for another node.
1873 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1875 return getNode(relative_path, true)->setBoolValue(value);
1880 * Set an int value for another node.
1883 SGPropertyNode::setIntValue (const char * relative_path, int value)
1885 return getNode(relative_path, true)->setIntValue(value);
1890 * Set a long value for another node.
1893 SGPropertyNode::setLongValue (const char * relative_path, long value)
1895 return getNode(relative_path, true)->setLongValue(value);
1900 * Set a float value for another node.
1903 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1905 return getNode(relative_path, true)->setFloatValue(value);
1910 * Set a double value for another node.
1913 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
1915 return getNode(relative_path, true)->setDoubleValue(value);
1920 * Set a string value for another node.
1923 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
1925 return getNode(relative_path, true)->setStringValue(value);
1930 * Set an unknown value for another node.
1933 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
1936 return getNode(relative_path, true)->setUnspecifiedValue(value);
1941 * Test whether another node is tied.
1944 SGPropertyNode::isTied (const char * relative_path) const
1946 const SGPropertyNode * node = getNode(relative_path);
1947 return (node == 0 ? false : node->isTied());
1952 * Tie a node reached by a relative path, creating it if necessary.
1955 SGPropertyNode::tie (const char * relative_path,
1956 const SGRawValue<bool> &rawValue,
1959 return getNode(relative_path, true)->tie(rawValue, useDefault);
1964 * Tie a node reached by a relative path, creating it if necessary.
1967 SGPropertyNode::tie (const char * relative_path,
1968 const SGRawValue<int> &rawValue,
1971 return getNode(relative_path, true)->tie(rawValue, useDefault);
1976 * Tie a node reached by a relative path, creating it if necessary.
1979 SGPropertyNode::tie (const char * relative_path,
1980 const SGRawValue<long> &rawValue,
1983 return getNode(relative_path, true)->tie(rawValue, useDefault);
1988 * Tie a node reached by a relative path, creating it if necessary.
1991 SGPropertyNode::tie (const char * relative_path,
1992 const SGRawValue<float> &rawValue,
1995 return getNode(relative_path, true)->tie(rawValue, useDefault);
2000 * Tie a node reached by a relative path, creating it if necessary.
2003 SGPropertyNode::tie (const char * relative_path,
2004 const SGRawValue<double> &rawValue,
2007 return getNode(relative_path, true)->tie(rawValue, useDefault);
2012 * Tie a node reached by a relative path, creating it if necessary.
2015 SGPropertyNode::tie (const char * relative_path,
2016 const SGRawValue<const char *> &rawValue,
2019 return getNode(relative_path, true)->tie(rawValue, useDefault);
2024 * Attempt to untie another node reached by a relative path.
2027 SGPropertyNode::untie (const char * relative_path)
2029 SGPropertyNode * node = getNode(relative_path);
2030 return (node == 0 ? false : node->untie());
2034 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2037 if (_listeners == 0)
2038 _listeners = new vector<SGPropertyChangeListener*>;
2039 _listeners->push_back(listener);
2040 listener->register_property(this);
2042 listener->valueChanged(this);
2046 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2048 vector<SGPropertyChangeListener*>::iterator it =
2049 find(_listeners->begin(), _listeners->end(), listener);
2050 if (it != _listeners->end()) {
2051 _listeners->erase(it);
2052 listener->unregister_property(this);
2053 if (_listeners->empty()) {
2054 vector<SGPropertyChangeListener*>* tmp = _listeners;
2062 SGPropertyNode::fireValueChanged ()
2064 fireValueChanged(this);
2068 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2070 fireChildAdded(this, child);
2074 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2076 fireChildRemoved(this, child);
2080 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2082 if (_listeners != 0) {
2083 for (unsigned int i = 0; i < _listeners->size(); i++) {
2084 (*_listeners)[i]->valueChanged(node);
2088 _parent->fireValueChanged(node);
2092 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2093 SGPropertyNode * child)
2095 if (_listeners != 0) {
2096 for (unsigned int i = 0; i < _listeners->size(); i++) {
2097 (*_listeners)[i]->childAdded(parent, child);
2101 _parent->fireChildAdded(parent, child);
2105 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2106 SGPropertyNode * child)
2108 if (_listeners != 0) {
2109 for (unsigned int i = 0; i < _listeners->size(); i++) {
2110 (*_listeners)[i]->childRemoved(parent, child);
2114 _parent->fireChildRemoved(parent, child);
2119 ////////////////////////////////////////////////////////////////////////
2120 // Simplified hash table for caching paths.
2121 ////////////////////////////////////////////////////////////////////////
2123 #define HASH_TABLE_SIZE 199
2125 SGPropertyNode::hash_table::entry::entry ()
2130 SGPropertyNode::hash_table::entry::~entry ()
2132 // Don't delete the value; we don't own
2137 SGPropertyNode::hash_table::entry::set_key (const char * key)
2143 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2148 SGPropertyNode::hash_table::bucket::bucket ()
2154 SGPropertyNode::hash_table::bucket::~bucket ()
2156 for (int i = 0; i < _length; i++)
2161 SGPropertyNode::hash_table::entry *
2162 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2165 for (i = 0; i < _length; i++) {
2166 if (!strcmp(_entries[i]->get_key(), key))
2170 entry ** new_entries = new entry*[_length+1];
2171 for (i = 0; i < _length; i++) {
2172 new_entries[i] = _entries[i];
2175 _entries = new_entries;
2176 _entries[_length] = new entry;
2177 _entries[_length]->set_key(key);
2179 return _entries[_length - 1];
2186 SGPropertyNode::hash_table::bucket::erase (const char * key)
2189 for (i = 0; i < _length; i++) {
2190 if (!strcmp(_entries[i]->get_key(), key))
2195 for (++i; i < _length; i++) {
2196 _entries[i-1] = _entries[i];
2203 SGPropertyNode::hash_table::hash_table ()
2209 SGPropertyNode::hash_table::~hash_table ()
2211 for (unsigned int i = 0; i < _data_length; i++)
2217 SGPropertyNode::hash_table::get (const char * key)
2219 if (_data_length == 0)
2221 unsigned int index = hashcode(key) % _data_length;
2222 if (_data[index] == 0)
2224 entry * e = _data[index]->get_entry(key);
2228 return e->get_value();
2232 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2234 if (_data_length == 0) {
2235 _data = new bucket*[HASH_TABLE_SIZE];
2236 _data_length = HASH_TABLE_SIZE;
2237 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2240 unsigned int index = hashcode(key) % _data_length;
2241 if (_data[index] == 0) {
2242 _data[index] = new bucket;
2244 entry * e = _data[index]->get_entry(key, true);
2245 e->set_value(value);
2249 SGPropertyNode::hash_table::erase (const char * key)
2251 if (_data_length == 0)
2253 unsigned int index = hashcode(key) % _data_length;
2254 if (_data[index] == 0)
2256 _data[index]->erase(key);
2260 SGPropertyNode::hash_table::hashcode (const char * key)
2262 unsigned int hash = 0;
2264 hash = 31 * hash + *key;
2272 ////////////////////////////////////////////////////////////////////////
2273 // Implementation of SGPropertyChangeListener.
2274 ////////////////////////////////////////////////////////////////////////
2276 SGPropertyChangeListener::~SGPropertyChangeListener ()
2278 // This will come back and remove
2279 // the current item each time. Is
2281 vector<SGPropertyNode *>::iterator it;
2282 for (it = _properties.begin(); it != _properties.end(); it++)
2283 (*it)->removeChangeListener(this);
2287 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2293 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2294 SGPropertyNode * child)
2300 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2301 SGPropertyNode * child)
2307 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2309 _properties.push_back(node);
2313 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2315 vector<SGPropertyNode *>::iterator it =
2316 find(_properties.begin(), _properties.end(), node);
2317 if (it != _properties.end())
2318 _properties.erase(it);