1 // props.cxx - implementation of a property list.
2 // Started Fall 2000 by David Megginson, david@megginson.com
3 // This code is released into the Public Domain.
5 // See props.html for documentation [replace with URL when available].
21 #include <simgear/compiler.h>
22 #include <simgear/debug/logstream.hxx>
24 #if ( _MSC_VER == 1200 )
25 // MSVC 6 is buggy, and needs something strange here
26 using std::vector<SGPropertyNode_ptr>;
27 using std::vector<SGPropertyChangeListener *>;
28 using std::vector<SGPropertyNode *>;
40 using std::stringstream;
44 ////////////////////////////////////////////////////////////////////////
46 ////////////////////////////////////////////////////////////////////////
49 * Comparator class for sorting by index.
54 int operator() (const SGPropertyNode_ptr n1, const SGPropertyNode_ptr n2) const {
55 return (n1->getIndex() < n2->getIndex());
61 ////////////////////////////////////////////////////////////////////////
62 // Convenience macros for value access.
63 ////////////////////////////////////////////////////////////////////////
65 #define TEST_READ(dflt) if (!getAttribute(READ)) return dflt
66 #define TEST_WRITE if (!getAttribute(WRITE)) return false
70 ////////////////////////////////////////////////////////////////////////
71 // Default values for every type.
72 ////////////////////////////////////////////////////////////////////////
74 template<> const bool SGRawValue<bool>::DefaultValue = false;
75 template<> const int SGRawValue<int>::DefaultValue = 0;
76 template<> const long SGRawValue<long>::DefaultValue = 0L;
77 template<> const float SGRawValue<float>::DefaultValue = 0.0;
78 template<> const double SGRawValue<double>::DefaultValue = 0.0L;
79 template<> const char * const SGRawValue<const char *>::DefaultValue = "";
83 ////////////////////////////////////////////////////////////////////////
84 // Local path normalization code.
85 ////////////////////////////////////////////////////////////////////////
88 * A component in a path.
97 * Parse the name for a path component.
99 * Name: [_a-zA-Z][-._a-zA-Z0-9]*
101 static inline const string
102 parse_name (const string &path, int &i)
105 int max = path.size();
107 if (path[i] == '.') {
109 if (i < max && path[i] == '.') {
115 if (i < max && path[i] != '/')
116 throw string("illegal character after " + name);
119 else if (isalpha(path[i]) || path[i] == '_') {
123 // The rules inside a name are a little
126 if (isalpha(path[i]) || isdigit(path[i]) || path[i] == '_' ||
127 path[i] == '-' || path[i] == '.') {
129 } else if (path[i] == '[' || path[i] == '/') {
132 throw string("name may contain only ._- and alphanumeric characters");
139 if (name.size() == 0)
140 throw string("name must begin with alpha or '_'");
148 * Parse the optional integer index for a path component.
150 * Index: "[" [0-9]+ "]"
153 parse_index (const string &path, int &i)
162 for (int max = path.size(); i < max; i++) {
163 if (isdigit(path[i])) {
164 index = (index * 10) + (path[i] - '0');
165 } else if (path[i] == ']') {
173 throw string("unterminated index (looking for ']')");
178 * Parse a single path component.
180 * Component: Name Index?
182 static inline PathComponent
183 parse_component (const string &path, int &i)
185 PathComponent component;
186 component.name = parse_name(path, i);
187 if (component.name[0] != '.')
188 component.index = parse_index(path, i);
190 component.index = -1;
196 * Parse a path into its components.
199 parse_path (const string &path, vector<PathComponent> &components)
202 int max = path.size();
204 // Check for initial '/'
205 if (path[pos] == '/') {
209 components.push_back(root);
211 while (pos < max && path[pos] == '/')
216 components.push_back(parse_component(path, pos));
217 while (pos < max && path[pos] == '/')
224 ////////////////////////////////////////////////////////////////////////
225 // Other static utility functions.
226 ////////////////////////////////////////////////////////////////////////
230 copy_string (const char * s)
232 unsigned long int slen = strlen(s);
233 char * copy = new char[slen + 1];
235 // the source string length is known so no need to check for '\0'
236 // when copying every single character
237 memcpy(copy, s, slen);
238 *(copy + slen) = '\0';
243 compare_strings (const char * s1, const char * s2)
245 return !strncmp(s1, s2, SGPropertyNode::MAX_STRING_LEN);
249 * Locate a child node by name and index.
252 find_child (const char * name, int index, const vector<SGPropertyNode_ptr>& nodes)
254 int nNodes = nodes.size();
255 for (int i = 0; i < nNodes; i++) {
256 SGPropertyNode * node = nodes[i];
258 // searching for a mathing index is a lot less time consuming than
259 // comparing two strings so do that first.
260 if (node->getIndex() == index && compare_strings(node->getName(), name))
267 * Locate the last child node with a given name.
270 find_last_child (const char * name, const vector<SGPropertyNode_ptr>& nodes)
272 int nNodes = nodes.size();
275 for (int i = 0; i < nNodes; i++) {
276 SGPropertyNode * node = nodes[i];
277 if (compare_strings(node->getName(), name))
285 * Locate another node, given a relative path.
287 static SGPropertyNode *
288 find_node (SGPropertyNode * current,
289 const vector<PathComponent> &components,
293 // Run off the end of the list
298 // Success! This is the one we want.
299 else if (position >= (int)components.size()) {
300 return (current->getAttribute(SGPropertyNode::REMOVED) ? 0 : current);
303 // Empty component means root.
304 else if (components[position].name == "") {
305 return find_node(current->getRootNode(), components, position + 1, create);
308 // . means current directory
309 else if (components[position].name == ".") {
310 return find_node(current, components, position + 1, create);
313 // .. means parent directory
314 else if (components[position].name == "..") {
315 SGPropertyNode * parent = current->getParent();
317 throw string("attempt to move past root with '..'");
319 return find_node(parent, components, position + 1, create);
322 // Otherwise, a child name
324 SGPropertyNode * child =
325 current->getChild(components[position].name.c_str(),
326 components[position].index,
328 return find_node(child, components, position + 1, create);
334 ////////////////////////////////////////////////////////////////////////
335 // Private methods from SGPropertyNode (may be inlined for speed).
336 ////////////////////////////////////////////////////////////////////////
339 SGPropertyNode::get_bool () const
342 return _value.bool_val->getValue();
344 return _local_val.bool_val;
348 SGPropertyNode::get_int () const
351 return _value.int_val->getValue();
353 return _local_val.int_val;
357 SGPropertyNode::get_long () const
360 return _value.long_val->getValue();
362 return _local_val.long_val;
366 SGPropertyNode::get_float () const
369 return _value.float_val->getValue();
371 return _local_val.float_val;
375 SGPropertyNode::get_double () const
378 return _value.double_val->getValue();
380 return _local_val.double_val;
384 SGPropertyNode::get_string () const
387 return _value.string_val->getValue();
389 return _local_val.string_val;
393 SGPropertyNode::set_bool (bool val)
396 if (_value.bool_val->setValue(val)) {
403 _local_val.bool_val = val;
410 SGPropertyNode::set_int (int val)
413 if (_value.int_val->setValue(val)) {
420 _local_val.int_val = val;
427 SGPropertyNode::set_long (long val)
430 if (_value.long_val->setValue(val)) {
437 _local_val.long_val = val;
444 SGPropertyNode::set_float (float val)
447 if (_value.float_val->setValue(val)) {
454 _local_val.float_val = val;
461 SGPropertyNode::set_double (double val)
464 if (_value.double_val->setValue(val)) {
471 _local_val.double_val = val;
478 SGPropertyNode::set_string (const char * val)
481 if (_value.string_val->setValue(val)) {
488 delete [] _local_val.string_val;
489 _local_val.string_val = copy_string(val);
496 SGPropertyNode::clearValue ()
507 delete _value.bool_val;
510 _local_val.bool_val = SGRawValue<bool>::DefaultValue;
514 delete _value.int_val;
517 _local_val.int_val = SGRawValue<int>::DefaultValue;
521 delete _value.long_val;
522 _value.long_val = 0L;
524 _local_val.long_val = SGRawValue<long>::DefaultValue;
528 delete _value.float_val;
529 _value.float_val = 0;
531 _local_val.float_val = SGRawValue<float>::DefaultValue;
535 delete _value.double_val;
536 _value.double_val = 0;
538 _local_val.double_val = SGRawValue<double>::DefaultValue;
543 delete _value.string_val;
544 _value.string_val = 0;
546 delete [] _local_val.string_val;
548 _local_val.string_val = 0;
557 * Get the value as a string.
560 SGPropertyNode::make_string () const
562 if (!getAttribute(READ))
567 return _value.alias->getStringValue();
577 _buffer = sstr.str();
578 return _buffer.c_str();
584 _buffer = sstr.str();
585 return _buffer.c_str();
591 _buffer = sstr.str();
592 return _buffer.c_str();
597 sstr.precision( 10 );
598 sstr << get_double();
599 _buffer = sstr.str();
600 return _buffer.c_str();
612 * Trace a write access for a property.
615 SGPropertyNode::trace_write () const
618 cerr << "TRACE: Write node " << getPath () << ", value \""
619 << make_string() << '"' << endl;
621 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Write node " << getPath()
622 << ", value \"" << make_string() << '"');
627 * Trace a read access for a property.
630 SGPropertyNode::trace_read () const
633 cerr << "TRACE: Write node " << getPath () << ", value \""
634 << make_string() << '"' << endl;
636 SG_LOG(SG_GENERAL, SG_ALERT, "TRACE: Read node " << getPath()
637 << ", value \"" << make_string() << '"');
642 ////////////////////////////////////////////////////////////////////////
643 // Public methods from SGPropertyNode.
644 ////////////////////////////////////////////////////////////////////////
647 * Last used attribute
648 * Update as needed when enum Attribute is changed
650 const int SGPropertyNode::LAST_USED_ATTRIBUTE = USERARCHIVE;
653 * Default constructor: always creates a root node.
655 SGPropertyNode::SGPropertyNode ()
664 _local_val.string_val = 0;
671 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
672 : _index(node._index),
674 _parent(0), // don't copy the parent
679 _listeners(0) // CHECK!!
681 _local_val.string_val = 0;
686 _value.alias = node._value.alias;
693 _value.bool_val = node._value.bool_val->clone();
696 set_bool(node.get_bool());
702 _value.int_val = node._value.int_val->clone();
705 set_int(node.get_int());
711 _value.long_val = node._value.long_val->clone();
714 set_long(node.get_long());
720 _value.float_val = node._value.float_val->clone();
723 set_float(node.get_float());
729 _value.double_val = node._value.double_val->clone();
732 set_double(node.get_double());
739 _value.string_val = node._value.string_val->clone();
742 set_string(node.get_string());
750 * Convenience constructor.
752 SGPropertyNode::SGPropertyNode (const char * name,
754 SGPropertyNode * parent)
764 _name = parse_name(name, i);
765 if (i != int(strlen(name)) || name[0] == '.')
766 throw string("plain name expected instead of '") + name + '\'';
768 _local_val.string_val = 0;
775 SGPropertyNode::~SGPropertyNode ()
777 // zero out all parent pointers, else they might be dangling
778 for (unsigned i = 0; i < _children.size(); ++i)
779 _children[i]->_parent = 0;
780 for (unsigned i = 0; i < _removedChildren.size(); ++i)
781 _removedChildren[i]->_parent = 0;
786 vector<SGPropertyChangeListener*>::iterator it;
787 for (it = _listeners->begin(); it != _listeners->end(); ++it)
788 (*it)->unregister_property(this);
795 * Alias to another node.
798 SGPropertyNode::alias (SGPropertyNode * target)
800 if (target == 0 || _type == ALIAS || _tied)
804 _value.alias = target;
811 * Alias to another node by path.
814 SGPropertyNode::alias (const char * path)
816 return alias(getNode(path, true));
824 SGPropertyNode::unalias ()
834 * Get the target of an alias.
837 SGPropertyNode::getAliasTarget ()
839 return (_type == ALIAS ? _value.alias : 0);
843 const SGPropertyNode *
844 SGPropertyNode::getAliasTarget () const
846 return (_type == ALIAS ? _value.alias : 0);
850 * create a non-const child by name after the last node with the same name.
853 SGPropertyNode::addChild (const char * name)
855 int pos = find_last_child(name, _children);
857 SGPropertyNode_ptr node;
858 node = new SGPropertyNode(name, ++pos, this);
859 _children.push_back(node);
860 fireChildAdded(node);
866 * Get a non-const child by index.
869 SGPropertyNode::getChild (int position)
871 if (position >= 0 && position < nChildren())
872 return _children[position];
879 * Get a const child by index.
881 const SGPropertyNode *
882 SGPropertyNode::getChild (int position) const
884 if (position >= 0 && position < nChildren())
885 return _children[position];
892 * Get a non-const child by name and index, creating if necessary.
895 SGPropertyNode::getChild (const char * name, int index, bool create)
897 int pos = find_child(name, index, _children);
899 return _children[pos];
901 SGPropertyNode_ptr node;
902 pos = find_child(name, index, _removedChildren);
904 vector<SGPropertyNode_ptr>::iterator it = _removedChildren.begin();
906 node = _removedChildren[pos];
907 _removedChildren.erase(it);
908 node->setAttribute(REMOVED, false);
910 node = new SGPropertyNode(name, index, this);
912 _children.push_back(node);
913 fireChildAdded(node);
922 * Get a const child by name and index.
924 const SGPropertyNode *
925 SGPropertyNode::getChild (const char * name, int index) const
927 int pos = find_child(name, index, _children);
929 return _children[pos];
936 * Get all children with the same name (but different indices).
938 vector<SGPropertyNode_ptr>
939 SGPropertyNode::getChildren (const char * name) const
941 vector<SGPropertyNode_ptr> children;
942 int max = _children.size();
944 for (int i = 0; i < max; i++)
945 if (compare_strings(_children[i]->getName(), name))
946 children.push_back(_children[i]);
948 sort(children.begin(), children.end(), CompareIndices());
954 * Remove this node and all children from nodes that link to them
955 * in their path cache.
958 SGPropertyNode::remove_from_path_caches ()
960 for (unsigned int i = 0; i < _children.size(); ++i)
961 _children[i]->remove_from_path_caches();
963 for (unsigned int i = 0; i < _linkedNodes.size(); i++)
964 _linkedNodes[i]->erase(this);
965 _linkedNodes.clear();
970 * Remove child by position.
973 SGPropertyNode::removeChild (int pos, bool keep)
975 SGPropertyNode_ptr node;
976 if (pos < 0 || pos >= (int)_children.size())
979 vector<SGPropertyNode_ptr>::iterator it = _children.begin();
981 node = _children[pos];
984 _removedChildren.push_back(node);
987 node->remove_from_path_caches();
988 node->setAttribute(REMOVED, true);
990 fireChildRemoved(node);
996 * Remove a child node
999 SGPropertyNode::removeChild (const char * name, int index, bool keep)
1001 SGPropertyNode_ptr ret;
1002 int pos = find_child(name, index, _children);
1004 ret = removeChild(pos, keep);
1010 * Remove all children with the specified name.
1012 vector<SGPropertyNode_ptr>
1013 SGPropertyNode::removeChildren (const char * name, bool keep)
1015 vector<SGPropertyNode_ptr> children;
1017 for (int pos = _children.size() - 1; pos >= 0; pos--)
1018 if (compare_strings(_children[pos]->getName(), name))
1019 children.push_back(removeChild(pos, keep));
1021 sort(children.begin(), children.end(), CompareIndices());
1027 * Remove a linked node.
1030 SGPropertyNode::remove_linked_node (hash_table * node)
1032 for (unsigned int i = 0; i < _linkedNodes.size(); i++) {
1033 if (_linkedNodes[i] == node) {
1034 vector<hash_table *>::iterator it = _linkedNodes.begin();
1036 _linkedNodes.erase(it);
1045 SGPropertyNode::getDisplayName (bool simplify) const
1047 _display_name = _name;
1048 if (_index != 0 || !simplify) {
1050 sstr << '[' << _index << ']';
1051 _display_name += sstr.str();
1053 return _display_name.c_str();
1058 SGPropertyNode::getPath (bool simplify) const
1060 // Calculate the complete path only once.
1061 if (_parent != 0 && _path.empty()) {
1062 _path = _parent->getPath(simplify);
1064 _path += getDisplayName(simplify);
1067 return _path.c_str();
1070 SGPropertyNode::Type
1071 SGPropertyNode::getType () const
1074 return _value.alias->getType();
1081 SGPropertyNode::getBoolValue () const
1083 // Shortcut for common case
1084 if (_attr == (READ|WRITE) && _type == BOOL)
1087 if (getAttribute(TRACE_READ))
1089 if (!getAttribute(READ))
1090 return SGRawValue<bool>::DefaultValue;
1093 return _value.alias->getBoolValue();
1097 return get_int() == 0 ? false : true;
1099 return get_long() == 0L ? false : true;
1101 return get_float() == 0.0 ? false : true;
1103 return get_double() == 0.0L ? false : true;
1106 return (compare_strings(get_string(), "true") || getDoubleValue() != 0.0L);
1109 return SGRawValue<bool>::DefaultValue;
1114 SGPropertyNode::getIntValue () const
1116 // Shortcut for common case
1117 if (_attr == (READ|WRITE) && _type == INT)
1120 if (getAttribute(TRACE_READ))
1122 if (!getAttribute(READ))
1123 return SGRawValue<int>::DefaultValue;
1126 return _value.alias->getIntValue();
1128 return int(get_bool());
1132 return int(get_long());
1134 return int(get_float());
1136 return int(get_double());
1139 return atoi(get_string());
1142 return SGRawValue<int>::DefaultValue;
1147 SGPropertyNode::getLongValue () const
1149 // Shortcut for common case
1150 if (_attr == (READ|WRITE) && _type == LONG)
1153 if (getAttribute(TRACE_READ))
1155 if (!getAttribute(READ))
1156 return SGRawValue<long>::DefaultValue;
1159 return _value.alias->getLongValue();
1161 return long(get_bool());
1163 return long(get_int());
1167 return long(get_float());
1169 return long(get_double());
1172 return strtol(get_string(), 0, 0);
1175 return SGRawValue<long>::DefaultValue;
1180 SGPropertyNode::getFloatValue () const
1182 // Shortcut for common case
1183 if (_attr == (READ|WRITE) && _type == FLOAT)
1186 if (getAttribute(TRACE_READ))
1188 if (!getAttribute(READ))
1189 return SGRawValue<float>::DefaultValue;
1192 return _value.alias->getFloatValue();
1194 return float(get_bool());
1196 return float(get_int());
1198 return float(get_long());
1202 return float(get_double());
1205 return atof(get_string());
1208 return SGRawValue<float>::DefaultValue;
1213 SGPropertyNode::getDoubleValue () const
1215 // Shortcut for common case
1216 if (_attr == (READ|WRITE) && _type == DOUBLE)
1217 return get_double();
1219 if (getAttribute(TRACE_READ))
1221 if (!getAttribute(READ))
1222 return SGRawValue<double>::DefaultValue;
1226 return _value.alias->getDoubleValue();
1228 return double(get_bool());
1230 return double(get_int());
1232 return double(get_long());
1234 return double(get_float());
1236 return get_double();
1239 return strtod(get_string(), 0);
1242 return SGRawValue<double>::DefaultValue;
1247 SGPropertyNode::getStringValue () const
1249 // Shortcut for common case
1250 if (_attr == (READ|WRITE) && _type == STRING)
1251 return get_string();
1253 if (getAttribute(TRACE_READ))
1255 if (!getAttribute(READ))
1256 return SGRawValue<const char *>::DefaultValue;
1257 return make_string();
1261 SGPropertyNode::setBoolValue (bool value)
1263 // Shortcut for common case
1264 if (_attr == (READ|WRITE) && _type == BOOL)
1265 return set_bool(value);
1267 bool result = false;
1269 if (_type == NONE || _type == UNSPECIFIED) {
1277 result = _value.alias->setBoolValue(value);
1280 result = set_bool(value);
1283 result = set_int(int(value));
1286 result = set_long(long(value));
1289 result = set_float(float(value));
1292 result = set_double(double(value));
1296 result = set_string(value ? "true" : "false");
1303 if (getAttribute(TRACE_WRITE))
1309 SGPropertyNode::setIntValue (int value)
1311 // Shortcut for common case
1312 if (_attr == (READ|WRITE) && _type == INT)
1313 return set_int(value);
1315 bool result = false;
1317 if (_type == NONE || _type == UNSPECIFIED) {
1320 _local_val.int_val = 0;
1325 result = _value.alias->setIntValue(value);
1328 result = set_bool(value == 0 ? false : true);
1331 result = set_int(value);
1334 result = set_long(long(value));
1337 result = set_float(float(value));
1340 result = set_double(double(value));
1345 sprintf(buf, "%d", value);
1346 result = set_string(buf);
1354 if (getAttribute(TRACE_WRITE))
1360 SGPropertyNode::setLongValue (long value)
1362 // Shortcut for common case
1363 if (_attr == (READ|WRITE) && _type == LONG)
1364 return set_long(value);
1366 bool result = false;
1368 if (_type == NONE || _type == UNSPECIFIED) {
1371 _local_val.long_val = 0L;
1376 result = _value.alias->setLongValue(value);
1379 result = set_bool(value == 0L ? false : true);
1382 result = set_int(int(value));
1385 result = set_long(value);
1388 result = set_float(float(value));
1391 result = set_double(double(value));
1396 sprintf(buf, "%ld", value);
1397 result = set_string(buf);
1405 if (getAttribute(TRACE_WRITE))
1411 SGPropertyNode::setFloatValue (float value)
1413 // Shortcut for common case
1414 if (_attr == (READ|WRITE) && _type == FLOAT)
1415 return set_float(value);
1417 bool result = false;
1419 if (_type == NONE || _type == UNSPECIFIED) {
1422 _local_val.float_val = 0;
1427 result = _value.alias->setFloatValue(value);
1430 result = set_bool(value == 0.0 ? false : true);
1433 result = set_int(int(value));
1436 result = set_long(long(value));
1439 result = set_float(value);
1442 result = set_double(double(value));
1447 sprintf(buf, "%f", value);
1448 result = set_string(buf);
1456 if (getAttribute(TRACE_WRITE))
1462 SGPropertyNode::setDoubleValue (double value)
1464 // Shortcut for common case
1465 if (_attr == (READ|WRITE) && _type == DOUBLE)
1466 return set_double(value);
1468 bool result = false;
1470 if (_type == NONE || _type == UNSPECIFIED) {
1472 _local_val.double_val = value;
1478 result = _value.alias->setDoubleValue(value);
1481 result = set_bool(value == 0.0L ? false : true);
1484 result = set_int(int(value));
1487 result = set_long(long(value));
1490 result = set_float(float(value));
1493 result = set_double(value);
1498 sprintf(buf, "%f", value);
1499 result = set_string(buf);
1507 if (getAttribute(TRACE_WRITE))
1513 SGPropertyNode::setStringValue (const char * value)
1515 // Shortcut for common case
1516 if (_attr == (READ|WRITE) && _type == STRING)
1517 return set_string(value);
1519 bool result = false;
1521 if (_type == NONE || _type == UNSPECIFIED) {
1528 result = _value.alias->setStringValue(value);
1531 result = set_bool((compare_strings(value, "true")
1532 || atoi(value)) ? true : false);
1535 result = set_int(atoi(value));
1538 result = set_long(strtol(value, 0, 0));
1541 result = set_float(atof(value));
1544 result = set_double(strtod(value, 0));
1548 result = set_string(value);
1555 if (getAttribute(TRACE_WRITE))
1561 SGPropertyNode::setUnspecifiedValue (const char * value)
1563 bool result = false;
1565 if (_type == NONE) {
1567 _type = UNSPECIFIED;
1572 result = _value.alias->setUnspecifiedValue(value);
1575 result = set_bool((compare_strings(value, "true")
1576 || atoi(value)) ? true : false);
1579 result = set_int(atoi(value));
1582 result = set_long(strtol(value, 0, 0));
1585 result = set_float(atof(value));
1588 result = set_double(strtod(value, 0));
1592 result = set_string(value);
1599 if (getAttribute(TRACE_WRITE))
1605 SGPropertyNode::tie (const SGRawValue<bool> &rawValue, bool useDefault)
1607 if (_type == ALIAS || _tied)
1610 useDefault = useDefault && hasValue();
1611 bool old_val = false;
1613 old_val = getBoolValue();
1618 _value.bool_val = rawValue.clone();
1621 setBoolValue(old_val);
1627 SGPropertyNode::tie (const SGRawValue<int> &rawValue, bool useDefault)
1629 if (_type == ALIAS || _tied)
1632 useDefault = useDefault && hasValue();
1635 old_val = getIntValue();
1640 _value.int_val = rawValue.clone();
1643 setIntValue(old_val);
1649 SGPropertyNode::tie (const SGRawValue<long> &rawValue, bool useDefault)
1651 if (_type == ALIAS || _tied)
1654 useDefault = useDefault && hasValue();
1657 old_val = getLongValue();
1662 _value.long_val = rawValue.clone();
1665 setLongValue(old_val);
1671 SGPropertyNode::tie (const SGRawValue<float> &rawValue, bool useDefault)
1673 if (_type == ALIAS || _tied)
1676 useDefault = useDefault && hasValue();
1677 float old_val = 0.0;
1679 old_val = getFloatValue();
1684 _value.float_val = rawValue.clone();
1687 setFloatValue(old_val);
1693 SGPropertyNode::tie (const SGRawValue<double> &rawValue, bool useDefault)
1695 if (_type == ALIAS || _tied)
1698 useDefault = useDefault && hasValue();
1699 double old_val = 0.0;
1701 old_val = getDoubleValue();
1706 _value.double_val = rawValue.clone();
1709 setDoubleValue(old_val);
1716 SGPropertyNode::tie (const SGRawValue<const char *> &rawValue, bool useDefault)
1718 if (_type == ALIAS || _tied)
1721 useDefault = useDefault && hasValue();
1724 old_val = getStringValue();
1729 _value.string_val = rawValue.clone();
1732 setStringValue(old_val.c_str());
1738 SGPropertyNode::untie ()
1745 bool val = getBoolValue();
1748 _local_val.bool_val = val;
1752 int val = getIntValue();
1755 _local_val.int_val = val;
1759 long val = getLongValue();
1762 _local_val.long_val = val;
1766 float val = getFloatValue();
1769 _local_val.float_val = val;
1773 double val = getDoubleValue();
1776 _local_val.double_val = val;
1781 string val = getStringValue();
1784 _local_val.string_val = copy_string(val.c_str());
1797 SGPropertyNode::getRootNode ()
1802 return _parent->getRootNode();
1805 const SGPropertyNode *
1806 SGPropertyNode::getRootNode () const
1811 return _parent->getRootNode();
1815 SGPropertyNode::getNode (const char * relative_path, bool create)
1817 if (_path_cache == 0)
1818 _path_cache = new hash_table;
1820 SGPropertyNode * result = _path_cache->get(relative_path);
1822 vector<PathComponent> components;
1823 parse_path(relative_path, components);
1824 result = find_node(this, components, 0, create);
1826 _path_cache->put(relative_path, result);
1833 SGPropertyNode::getNode (const char * relative_path, int index, bool create)
1835 vector<PathComponent> components;
1836 parse_path(relative_path, components);
1837 if (components.size() > 0)
1838 components.back().index = index;
1839 return find_node(this, components, 0, create);
1842 const SGPropertyNode *
1843 SGPropertyNode::getNode (const char * relative_path) const
1845 return ((SGPropertyNode *)this)->getNode(relative_path, false);
1848 const SGPropertyNode *
1849 SGPropertyNode::getNode (const char * relative_path, int index) const
1851 return ((SGPropertyNode *)this)->getNode(relative_path, index, false);
1855 ////////////////////////////////////////////////////////////////////////
1856 // Convenience methods using relative paths.
1857 ////////////////////////////////////////////////////////////////////////
1861 * Test whether another node has a value attached.
1864 SGPropertyNode::hasValue (const char * relative_path) const
1866 const SGPropertyNode * node = getNode(relative_path);
1867 return (node == 0 ? false : node->hasValue());
1872 * Get the value type for another node.
1874 SGPropertyNode::Type
1875 SGPropertyNode::getType (const char * relative_path) const
1877 const SGPropertyNode * node = getNode(relative_path);
1878 return (node == 0 ? UNSPECIFIED : (Type)(node->getType()));
1883 * Get a bool value for another node.
1886 SGPropertyNode::getBoolValue (const char * relative_path,
1887 bool defaultValue) const
1889 const SGPropertyNode * node = getNode(relative_path);
1890 return (node == 0 ? defaultValue : node->getBoolValue());
1895 * Get an int value for another node.
1898 SGPropertyNode::getIntValue (const char * relative_path,
1899 int defaultValue) const
1901 const SGPropertyNode * node = getNode(relative_path);
1902 return (node == 0 ? defaultValue : node->getIntValue());
1907 * Get a long value for another node.
1910 SGPropertyNode::getLongValue (const char * relative_path,
1911 long defaultValue) const
1913 const SGPropertyNode * node = getNode(relative_path);
1914 return (node == 0 ? defaultValue : node->getLongValue());
1919 * Get a float value for another node.
1922 SGPropertyNode::getFloatValue (const char * relative_path,
1923 float defaultValue) const
1925 const SGPropertyNode * node = getNode(relative_path);
1926 return (node == 0 ? defaultValue : node->getFloatValue());
1931 * Get a double value for another node.
1934 SGPropertyNode::getDoubleValue (const char * relative_path,
1935 double defaultValue) const
1937 const SGPropertyNode * node = getNode(relative_path);
1938 return (node == 0 ? defaultValue : node->getDoubleValue());
1943 * Get a string value for another node.
1946 SGPropertyNode::getStringValue (const char * relative_path,
1947 const char * defaultValue) const
1949 const SGPropertyNode * node = getNode(relative_path);
1950 return (node == 0 ? defaultValue : node->getStringValue());
1955 * Set a bool value for another node.
1958 SGPropertyNode::setBoolValue (const char * relative_path, bool value)
1960 return getNode(relative_path, true)->setBoolValue(value);
1965 * Set an int value for another node.
1968 SGPropertyNode::setIntValue (const char * relative_path, int value)
1970 return getNode(relative_path, true)->setIntValue(value);
1975 * Set a long value for another node.
1978 SGPropertyNode::setLongValue (const char * relative_path, long value)
1980 return getNode(relative_path, true)->setLongValue(value);
1985 * Set a float value for another node.
1988 SGPropertyNode::setFloatValue (const char * relative_path, float value)
1990 return getNode(relative_path, true)->setFloatValue(value);
1995 * Set a double value for another node.
1998 SGPropertyNode::setDoubleValue (const char * relative_path, double value)
2000 return getNode(relative_path, true)->setDoubleValue(value);
2005 * Set a string value for another node.
2008 SGPropertyNode::setStringValue (const char * relative_path, const char * value)
2010 return getNode(relative_path, true)->setStringValue(value);
2015 * Set an unknown value for another node.
2018 SGPropertyNode::setUnspecifiedValue (const char * relative_path,
2021 return getNode(relative_path, true)->setUnspecifiedValue(value);
2026 * Test whether another node is tied.
2029 SGPropertyNode::isTied (const char * relative_path) const
2031 const SGPropertyNode * node = getNode(relative_path);
2032 return (node == 0 ? false : node->isTied());
2037 * Tie a node reached by a relative path, creating it if necessary.
2040 SGPropertyNode::tie (const char * relative_path,
2041 const SGRawValue<bool> &rawValue,
2044 return getNode(relative_path, true)->tie(rawValue, useDefault);
2049 * Tie a node reached by a relative path, creating it if necessary.
2052 SGPropertyNode::tie (const char * relative_path,
2053 const SGRawValue<int> &rawValue,
2056 return getNode(relative_path, true)->tie(rawValue, useDefault);
2061 * Tie a node reached by a relative path, creating it if necessary.
2064 SGPropertyNode::tie (const char * relative_path,
2065 const SGRawValue<long> &rawValue,
2068 return getNode(relative_path, true)->tie(rawValue, useDefault);
2073 * Tie a node reached by a relative path, creating it if necessary.
2076 SGPropertyNode::tie (const char * relative_path,
2077 const SGRawValue<float> &rawValue,
2080 return getNode(relative_path, true)->tie(rawValue, useDefault);
2085 * Tie a node reached by a relative path, creating it if necessary.
2088 SGPropertyNode::tie (const char * relative_path,
2089 const SGRawValue<double> &rawValue,
2092 return getNode(relative_path, true)->tie(rawValue, useDefault);
2097 * Tie a node reached by a relative path, creating it if necessary.
2100 SGPropertyNode::tie (const char * relative_path,
2101 const SGRawValue<const char *> &rawValue,
2104 return getNode(relative_path, true)->tie(rawValue, useDefault);
2109 * Attempt to untie another node reached by a relative path.
2112 SGPropertyNode::untie (const char * relative_path)
2114 SGPropertyNode * node = getNode(relative_path);
2115 return (node == 0 ? false : node->untie());
2119 SGPropertyNode::addChangeListener (SGPropertyChangeListener * listener,
2122 if (_listeners == 0)
2123 _listeners = new vector<SGPropertyChangeListener*>;
2124 _listeners->push_back(listener);
2125 listener->register_property(this);
2127 listener->valueChanged(this);
2131 SGPropertyNode::removeChangeListener (SGPropertyChangeListener * listener)
2133 vector<SGPropertyChangeListener*>::iterator it =
2134 find(_listeners->begin(), _listeners->end(), listener);
2135 if (it != _listeners->end()) {
2136 _listeners->erase(it);
2137 listener->unregister_property(this);
2138 if (_listeners->empty()) {
2139 vector<SGPropertyChangeListener*>* tmp = _listeners;
2147 SGPropertyNode::fireValueChanged ()
2149 fireValueChanged(this);
2153 SGPropertyNode::fireChildAdded (SGPropertyNode * child)
2155 fireChildAdded(this, child);
2159 SGPropertyNode::fireChildRemoved (SGPropertyNode * child)
2161 fireChildRemoved(this, child);
2165 SGPropertyNode::fireValueChanged (SGPropertyNode * node)
2167 if (_listeners != 0) {
2168 for (unsigned int i = 0; i < _listeners->size(); i++) {
2169 (*_listeners)[i]->valueChanged(node);
2173 _parent->fireValueChanged(node);
2177 SGPropertyNode::fireChildAdded (SGPropertyNode * parent,
2178 SGPropertyNode * child)
2180 if (_listeners != 0) {
2181 for (unsigned int i = 0; i < _listeners->size(); i++) {
2182 (*_listeners)[i]->childAdded(parent, child);
2186 _parent->fireChildAdded(parent, child);
2190 SGPropertyNode::fireChildRemoved (SGPropertyNode * parent,
2191 SGPropertyNode * child)
2193 if (_listeners != 0) {
2194 for (unsigned int i = 0; i < _listeners->size(); i++) {
2195 (*_listeners)[i]->childRemoved(parent, child);
2199 _parent->fireChildRemoved(parent, child);
2204 ////////////////////////////////////////////////////////////////////////
2205 // Simplified hash table for caching paths.
2206 ////////////////////////////////////////////////////////////////////////
2208 #define HASH_TABLE_SIZE 199
2210 SGPropertyNode::hash_table::entry::entry ()
2215 SGPropertyNode::hash_table::entry::~entry ()
2217 // Don't delete the value; we don't own
2222 SGPropertyNode::hash_table::entry::set_key (const char * key)
2228 SGPropertyNode::hash_table::entry::set_value (SGPropertyNode * value)
2233 SGPropertyNode::hash_table::bucket::bucket ()
2239 SGPropertyNode::hash_table::bucket::~bucket ()
2241 for (int i = 0; i < _length; i++)
2246 SGPropertyNode::hash_table::entry *
2247 SGPropertyNode::hash_table::bucket::get_entry (const char * key, bool create)
2250 for (i = 0; i < _length; i++) {
2251 if (!strcmp(_entries[i]->get_key(), key))
2255 entry ** new_entries = new entry*[_length+1];
2256 for (i = 0; i < _length; i++) {
2257 new_entries[i] = _entries[i];
2260 _entries = new_entries;
2261 _entries[_length] = new entry;
2262 _entries[_length]->set_key(key);
2264 return _entries[_length - 1];
2271 SGPropertyNode::hash_table::bucket::erase (SGPropertyNode * node)
2273 for (int i = 0; i < _length; i++) {
2274 if (_entries[i]->get_value() == node) {
2276 for (++i; i < _length; i++) {
2277 _entries[i-1] = _entries[i];
2287 SGPropertyNode::hash_table::bucket::clear (SGPropertyNode::hash_table * owner)
2289 for (int i = 0; i < _length; i++) {
2290 SGPropertyNode * node = _entries[i]->get_value();
2292 node->remove_linked_node(owner);
2296 SGPropertyNode::hash_table::hash_table ()
2302 SGPropertyNode::hash_table::~hash_table ()
2304 for (unsigned int i = 0; i < _data_length; i++) {
2306 _data[i]->clear(this);
2314 SGPropertyNode::hash_table::get (const char * key)
2316 if (_data_length == 0)
2318 unsigned int index = hashcode(key) % _data_length;
2319 if (_data[index] == 0)
2321 entry * e = _data[index]->get_entry(key);
2325 return e->get_value();
2329 SGPropertyNode::hash_table::put (const char * key, SGPropertyNode * value)
2331 if (_data_length == 0) {
2332 _data = new bucket*[HASH_TABLE_SIZE];
2333 _data_length = HASH_TABLE_SIZE;
2334 for (unsigned int i = 0; i < HASH_TABLE_SIZE; i++)
2337 unsigned int index = hashcode(key) % _data_length;
2338 if (_data[index] == 0) {
2339 _data[index] = new bucket;
2341 entry * e = _data[index]->get_entry(key, true);
2342 e->set_value(value);
2343 value->add_linked_node(this);
2347 SGPropertyNode::hash_table::erase (SGPropertyNode * node)
2349 for (unsigned int i = 0; i < _data_length; i++)
2350 if (_data[i] && _data[i]->erase(node))
2357 SGPropertyNode::hash_table::hashcode (const char * key)
2359 unsigned int hash = 0;
2361 hash = 31 * hash + *key;
2369 ////////////////////////////////////////////////////////////////////////
2370 // Implementation of SGPropertyChangeListener.
2371 ////////////////////////////////////////////////////////////////////////
2373 SGPropertyChangeListener::~SGPropertyChangeListener ()
2375 for (int i = _properties.size() - 1; i >= 0; i--)
2376 _properties[i]->removeChangeListener(this);
2380 SGPropertyChangeListener::valueChanged (SGPropertyNode * node)
2386 SGPropertyChangeListener::childAdded (SGPropertyNode * node,
2387 SGPropertyNode * child)
2393 SGPropertyChangeListener::childRemoved (SGPropertyNode * parent,
2394 SGPropertyNode * child)
2400 SGPropertyChangeListener::register_property (SGPropertyNode * node)
2402 _properties.push_back(node);
2406 SGPropertyChangeListener::unregister_property (SGPropertyNode * node)
2408 vector<SGPropertyNode *>::iterator it =
2409 find(_properties.begin(), _properties.end(), node);
2410 if (it != _properties.end())
2411 _properties.erase(it);