/usr/include/simgear/props/props.hxx is in libsimgear-dev 3.4.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 | /**
* \file props.hxx
* Interface definition for a property list.
* Started Fall 2000 by David Megginson, david@megginson.com
* This code is released into the Public Domain.
*
* See props.html for documentation [replace with URL when available].
*
* $Id$
*/
#ifndef __PROPS_HXX
#define __PROPS_HXX
#ifndef PROPS_STANDALONE
#define PROPS_STANDALONE 0
#endif
#include <vector>
#include <string>
#include <iostream>
#include <sstream>
#include <typeinfo>
#include <boost/utility.hpp>
#include <boost/type_traits/is_enum.hpp>
#if PROPS_STANDALONE
#else
#include <simgear/compiler.h>
#include <simgear/debug/logstream.hxx>
#endif
#include <simgear/math/SGMathFwd.hxx>
#include <simgear/math/sg_types.hxx>
#include <simgear/structure/SGReferenced.hxx>
#include <simgear/structure/SGSharedPtr.hxx>
// XXX This whole file should be in the simgear namespace, but I don't
// have the guts yet...
namespace simgear
{
class PropertyInterpolationMgr;
template<typename T>
std::istream& readFrom(std::istream& stream, T& result)
{
stream >> result;
return stream;
}
/**
* Parse a string as an object of a given type.
* XXX no error behavior yet.
*
* @tparam T the return type
* @param str the string
* @return the object.
*/
template<typename T>
inline T parseString(const std::string& str)
{
std::istringstream stream(str);
T result;
readFrom(stream, result);
return result;
}
/**
* Property value types.
*/
#ifdef NONE
#pragma warn A sloppy coder has defined NONE as a macro!
#undef NONE
#endif
#ifdef ALIAS
#pragma warn A sloppy coder has defined ALIAS as a macro!
#undef ALIAS
#endif
#ifdef UNSPECIFIED
#pragma warn A sloppy coder has defined UNSPECIFIED as a macro!
#undef UNSPECIFIED
#endif
#ifdef BOOL
#pragma warn A sloppy coder has defined BOOL as a macro!
#undef BOOL
#endif
#ifdef INT
#pragma warn A sloppy coder has defined INT as a macro!
#undef INT
#endif
#ifdef LONG
#pragma warn A sloppy coder has defined LONG as a macro!
#undef LONG
#endif
#ifdef FLOAT
#pragma warn A sloppy coder has defined FLOAT as a macro!
#undef FLOAT
#endif
#ifdef DOUBLE
#pragma warn A sloppy coder has defined DOUBLE as a macro!
#undef DOUBLE
#endif
#ifdef STRING
#pragma warn A sloppy coder has defined STRING as a macro!
#undef STRING
#endif
namespace props
{
/**
* The possible types of an SGPropertyNode. Types that appear after
* EXTENDED are not stored in the SGPropertyNode itself.
*/
enum Type {
NONE = 0, /**< The node hasn't been assigned a value yet. */
ALIAS, /**< The node "points" to another node. */
BOOL,
INT,
LONG,
FLOAT,
DOUBLE,
STRING,
UNSPECIFIED,
EXTENDED, /**< The node's value is not stored in the property;
* the actual value and type is retrieved from an
* SGRawValue node. This type is never returned by @see
* SGPropertyNode::getType.
*/
// Extended properties
VEC3D,
VEC4D
};
template<typename T> struct PropertyTraits;
#define DEFINTERNALPROP(TYPE, PROP) \
template<> \
struct PropertyTraits<TYPE> \
{ \
static const Type type_tag = PROP; \
enum { Internal = 1 }; \
}
DEFINTERNALPROP(bool, BOOL);
DEFINTERNALPROP(int, INT);
DEFINTERNALPROP(long, LONG);
DEFINTERNALPROP(float, FLOAT);
DEFINTERNALPROP(double, DOUBLE);
DEFINTERNALPROP(const char *, STRING);
DEFINTERNALPROP(const char[], STRING);
#undef DEFINTERNALPROP
}
}
////////////////////////////////////////////////////////////////////////
// A raw value.
//
// This is the mechanism that information-providing routines can
// use to link their own values to the property manager. Any
// SGValue can be tied to a raw value and then untied again.
//
// Note: we are forced to use inlined methods here to ensure
// that the templates will be instantiated. We're probably taking
// a small performance hit for that.
////////////////////////////////////////////////////////////////////////
/**
* Base class for SGRawValue classes that holds no type
* information. This allows some generic manipulation of the
* SGRawValue object.
*/
class SGRaw
{
public:
/**
* Get the type enumeration for the raw value.
*
* @return the type.
*/
virtual simgear::props::Type getType() const = 0;
virtual ~SGRaw() {}
/**
* Create a new deep copy of this raw value.
*
* The copy will contain its own version of the underlying value
* as well, and will be the same type.
*
* @return A deep copy of the current object.
*/
virtual SGRaw* clone() const = 0;
};
class SGRawExtended : public SGRaw
{
public:
/**
* Make an SGRawValueContainer from the SGRawValue.
*
* This is a virtual function of SGRawExtended so that
* SGPropertyNode::untie doesn't need to know the type of an
* extended property.
*/
virtual SGRawExtended* makeContainer() const = 0;
/**
* Write value out to a stream
*/
virtual std::ostream& printOn(std::ostream& stream) const = 0;
/**
* Read value from a stream and store it.
*/
virtual std::istream& readFrom(std::istream& stream) = 0;
};
// Choose between different base classes based on whether the value is
// stored internal to the property node. This frees us from defining
// the virtual functions in the SGRawExtended interface where they
// don't make sense, e.g. readFrom for the const char* type.
template<typename T, int internal = simgear::props::PropertyTraits<T>::Internal>
class SGRawBase;
template<typename T>
class SGRawBase<T, 1> : public SGRaw
{
};
template<typename T>
class SGRawBase<T, 0> : public SGRawExtended
{
virtual SGRawExtended* makeContainer() const;
virtual std::ostream& printOn(std::ostream& stream) const;
virtual std::istream& readFrom(std::istream& stream);
};
/**
* Abstract base class for a raw value.
*
* The property manager is implemented in two layers. The SGPropertyNode is the
* highest and most abstract layer, representing an LValue/RValue pair: it
* records the position of the property in the property tree and contains
* facilities for navigation to other nodes. It is guaranteed to be persistent:
* the SGPropertyNode will not change during a session, even if the property is
* bound and unbound multiple times.
*
* When the property value is not managed internally in the
* SGPropertyNode, the SGPropertyNode will contain a reference to an
* SGRawValue (this class), which provides an abstract way to get,
* set, and clone the underlying value. The SGRawValue may change
* frequently during a session as a value is retyped or bound and
* unbound to various data source, but the abstract SGPropertyNode
* layer insulates the application from those changes.
*
* The SGPropertyNode class always keeps a *copy* of a raw value, not the
* original one passed to it; if you override a derived class but do not replace
* the {@link SGRaw::clone clone()} method, strange things will happen.
*
* All derived SGRawValue classes must implement getValue(), setValue(), and
* {@link SGRaw::clone clone()} for the appropriate type.
*
* @see SGPropertyNode
* @see SGRawValuePointer
* @see SGRawValueFunctions
* @see SGRawValueFunctionsIndexed
* @see SGRawValueMethods
* @see SGRawValueMethodsIndexed
* @see SGRawValueContainer
*/
template <class T>
class SGRawValue : public SGRawBase<T>
{
public:
/**
* The default underlying value for this type.
*
* Every raw value has a default; the default is false for a
* boolean, 0 for the various numeric values, and "" for a string.
* If additional types of raw values are added in the future, they
* may need different kinds of default values (such as epoch for a
* date type). The default value is used when creating new values.
*/
static T DefaultValue()
{
return T();
}
/**
* Constructor.
*
* Use the default value for this type.
*/
SGRawValue () {}
/**
* Destructor.
*/
virtual ~SGRawValue () {}
/**
* Return the underlying value.
*
* @return The actual value for the property.
* @see #setValue
*/
virtual T getValue () const = 0;
/**
* Assign a new underlying value.
*
* If the new value cannot be set (because this is a read-only
* raw value, or because the new value is not acceptable for
* some reason) this method returns false and leaves the original
* value unchanged.
*
* @param value The actual value for the property.
* @return true if the value was set successfully, false otherwise.
* @see #getValue
*/
virtual bool setValue (T value) = 0;
/**
* Return the type tag for this raw value type.
*/
virtual simgear::props::Type getType() const
{
return simgear::props::PropertyTraits<T>::type_tag;
}
};
////////////////////////////////////////////////////////////////////////
// Default values for every type.
////////////////////////////////////////////////////////////////////////
template<> inline bool SGRawValue<bool>::DefaultValue()
{
return false;
}
template<> inline const char * SGRawValue<const char *>::DefaultValue()
{
return "";
}
/**
* A raw value bound to a pointer.
*
* This is the most efficient way to tie an external value, but also
* the most dangerous, because there is no way for the supplier to
* perform bounds checking and derived calculations except by polling
* the variable to see if it has changed. There is no default
* constructor, because this class would be meaningless without a
* pointer.
*/
template <class T>
class SGRawValuePointer : public SGRawValue<T>
{
public:
/**
* Explicit pointer constructor.
*
* Create a new raw value bound to the value of the variable
* referenced by the pointer.
*
* @param ptr The pointer to the variable to which this raw value
* will be bound.
*/
SGRawValuePointer (T * ptr) : _ptr(ptr) {}
/**
* Destructor.
*/
virtual ~SGRawValuePointer () {}
/**
* Get the underlying value.
*
* This method will dereference the pointer and return the
* variable's value.
*/
virtual T getValue () const { return *_ptr; }
/**
* Set the underlying value.
*
* This method will dereference the pointer and change the
* variable's value.
*/
virtual bool setValue (T value) { *_ptr = value; return true; }
/**
* Create a copy of this raw value.
*
* The copy will use the same external pointer as the original.
*/
virtual SGRaw* clone () const {
return new SGRawValuePointer(_ptr);
}
private:
T * _ptr;
};
/**
* A value managed through static functions.
*
* A read-only value will not have a setter; a write-only value will
* not have a getter.
*/
template <class T>
class SGRawValueFunctions : public SGRawValue<T>
{
public:
/**
* The template type of a static getter function.
*/
typedef T (*getter_t)();
/**
* The template type of a static setter function.
*/
typedef void (*setter_t)(T);
/**
* Explicit constructor.
*
* Create a new raw value bound to the getter and setter supplied.
*
* @param getter A static function for getting a value, or 0
* to read-disable the value.
* @param setter A static function for setting a value, or 0
* to write-disable the value.
*/
SGRawValueFunctions (getter_t getter = 0, setter_t setter = 0)
: _getter(getter), _setter(setter) {}
/**
* Destructor.
*/
virtual ~SGRawValueFunctions () {}
/**
* Get the underlying value.
*
* This method will invoke the getter function to get a value.
* If no getter function was supplied, this method will always
* return the default value for the type.
*/
virtual T getValue () const {
if (_getter) return (*_getter)();
else return SGRawValue<T>::DefaultValue();
}
/**
* Set the underlying value.
*
* This method will invoke the setter function to change the
* underlying value. If no setter function was supplied, this
* method will return false.
*/
virtual bool setValue (T value) {
if (_setter) { (*_setter)(value); return true; }
else return false;
}
/**
* Create a copy of this raw value, bound to the same functions.
*/
virtual SGRaw* clone () const {
return new SGRawValueFunctions(_getter,_setter);
}
private:
getter_t _getter;
setter_t _setter;
};
/**
* An indexed value bound to static functions.
*
* A read-only value will not have a setter; a write-only value will
* not have a getter. An indexed value is useful for binding one
* of a list of possible values (such as multiple engines for a
* plane). The index is hard-coded at creation time.
*
* @see SGRawValue
*/
template <class T>
class SGRawValueFunctionsIndexed : public SGRawValue<T>
{
public:
typedef T (*getter_t)(int);
typedef void (*setter_t)(int,T);
SGRawValueFunctionsIndexed (int index, getter_t getter = 0, setter_t setter = 0)
: _index(index), _getter(getter), _setter(setter) {}
virtual ~SGRawValueFunctionsIndexed () {}
virtual T getValue () const {
if (_getter) return (*_getter)(_index);
else return SGRawValue<T>::DefaultValue();
}
virtual bool setValue (T value) {
if (_setter) { (*_setter)(_index, value); return true; }
else return false;
}
virtual SGRaw* clone () const {
return new SGRawValueFunctionsIndexed(_index, _getter, _setter);
}
private:
int _index;
getter_t _getter;
setter_t _setter;
};
/**
* A value managed through an object and access methods.
*
* A read-only value will not have a setter; a write-only value will
* not have a getter.
*/
template <class C, class T>
class SGRawValueMethods : public SGRawValue<T>
{
public:
typedef T (C::*getter_t)() const;
typedef void (C::*setter_t)(T);
SGRawValueMethods (C &obj, getter_t getter = 0, setter_t setter = 0)
: _obj(obj), _getter(getter), _setter(setter) {}
virtual ~SGRawValueMethods () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(); }
else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(value); return true; }
else return false;
}
virtual SGRaw* clone () const {
return new SGRawValueMethods(_obj, _getter, _setter);
}
private:
C &_obj;
getter_t _getter;
setter_t _setter;
};
/**
* An indexed value managed through an object and access methods.
*
* A read-only value will not have a setter; a write-only value will
* not have a getter.
*/
template <class C, class T>
class SGRawValueMethodsIndexed : public SGRawValue<T>
{
public:
typedef T (C::*getter_t)(int) const;
typedef void (C::*setter_t)(int, T);
SGRawValueMethodsIndexed (C &obj, int index,
getter_t getter = 0, setter_t setter = 0)
: _obj(obj), _index(index), _getter(getter), _setter(setter) {}
virtual ~SGRawValueMethodsIndexed () {}
virtual T getValue () const {
if (_getter) { return (_obj.*_getter)(_index); }
else { return SGRawValue<T>::DefaultValue(); }
}
virtual bool setValue (T value) {
if (_setter) { (_obj.*_setter)(_index, value); return true; }
else return false;
}
virtual SGRaw* clone () const {
return new SGRawValueMethodsIndexed(_obj, _index, _getter, _setter);
}
private:
C &_obj;
int _index;
getter_t _getter;
setter_t _setter;
};
/**
* A raw value that contains its value. This provides a way for
* property nodes to contain values that shouldn't be stored in the
* property node itself.
*/
template <class T>
class SGRawValueContainer : public SGRawValue<T>
{
public:
/**
* Explicit constructor.
*/
SGRawValueContainer(const T& obj) : _obj(obj) {}
/**
* Destructor.
*/
virtual ~SGRawValueContainer() {}
/**
* Get the underlying value.
*/
virtual T getValue() const { return _obj; }
/**
* Set the underlying value.
*
* This method will dereference the pointer and change the
* variable's value.
*/
virtual bool setValue (T value) { _obj = value; return true; }
/**
* Create a copy of this raw value.
*/
virtual SGRaw* clone () const {
return new SGRawValueContainer(_obj);
}
private:
T _obj;
};
template<typename T>
SGRawExtended* SGRawBase<T, 0>::makeContainer() const
{
return new SGRawValueContainer<T>(static_cast<const SGRawValue<T>*>(this)
->getValue());
}
template<typename T>
std::ostream& SGRawBase<T, 0>::printOn(std::ostream& stream) const
{
return stream << static_cast<SGRawValue<T>*>(this)->getValue();
}
template<typename T>
std::istream& SGRawBase<T, 0>::readFrom(std::istream& stream)
{
T value;
simgear::readFrom(stream, value);
static_cast<SGRawValue<T>*>(this)->setValue(value);
return stream;
}
/**
* The smart pointer that manage reference counting
*/
class SGPropertyNode;
typedef SGSharedPtr<SGPropertyNode> SGPropertyNode_ptr;
typedef SGSharedPtr<const SGPropertyNode> SGConstPropertyNode_ptr;
namespace simgear
{
typedef std::vector<SGPropertyNode_ptr> PropertyList;
}
/**
* The property change listener interface.
*
* <p>Any class that needs to listen for property changes must implement
* this interface.</p>
*/
class SGPropertyChangeListener
{
public:
virtual ~SGPropertyChangeListener ();
/// Called if value of \a node has changed.
virtual void valueChanged(SGPropertyNode * node);
/// Called if \a child has been added to the given \a parent.
virtual void childAdded(SGPropertyNode * parent, SGPropertyNode * child);
/// Called if \a child has been removed from its \a parent.
virtual void childRemoved(SGPropertyNode * parent, SGPropertyNode * child);
protected:
friend class SGPropertyNode;
virtual void register_property (SGPropertyNode * node);
virtual void unregister_property (SGPropertyNode * node);
private:
std::vector<SGPropertyNode *> _properties;
};
/**
* A node in a property tree.
*/
class SGPropertyNode : public SGReferenced
{
public:
/**
* Public constants.
*/
enum {
MAX_STRING_LEN = 1024
};
/**
* Access mode attributes.
*
* <p>The ARCHIVE attribute is strictly advisory, and controls
* whether the property should normally be saved and restored.</p>
*/
enum Attribute {
NO_ATTR = 0,
READ = 1,
WRITE = 2,
ARCHIVE = 4,
REMOVED = 8,
TRACE_READ = 16,
TRACE_WRITE = 32,
USERARCHIVE = 64,
PRESERVE = 128
// beware: if you add another attribute here,
// also update value of "LAST_USED_ATTRIBUTE".
};
/**
* Last used attribute
* Update as needed when enum Attribute is changed
*/
static const int LAST_USED_ATTRIBUTE;
/**
* Default constructor.
*/
SGPropertyNode ();
/**
* Copy constructor.
*/
SGPropertyNode (const SGPropertyNode &node);
/**
* Destructor.
*/
virtual ~SGPropertyNode ();
//
// Basic properties.
//
/**
* Test whether this node contains a primitive leaf value.
*/
bool hasValue () const { return (_type != simgear::props::NONE); }
/**
* Get the node's simple (XML) name.
*/
const char * getName () const { return _name.c_str(); }
/**
* Get the node's simple name as a string.
*/
const std::string& getNameString () const { return _name; }
/**
* Get the node's pretty display name, with subscript when needed.
*/
std::string getDisplayName (bool simplify = false) const;
/**
* Get the node's integer index.
*/
int getIndex () const { return _index; }
/**
* Get a non-const pointer to the node's parent.
*/
SGPropertyNode * getParent () { return _parent; }
/**
* Get a const pointer to the node's parent.
*/
const SGPropertyNode * getParent () const { return _parent; }
//
// Children.
//
/**
* Get the number of child nodes.
*/
int nChildren () const { return (int)_children.size(); }
/**
* Get a child node by position (*NOT* index).
*/
SGPropertyNode * getChild (int position);
/**
* Get a const child node by position (*NOT* index).
*/
const SGPropertyNode * getChild (int position) const;
/**
* Test whether a named child exists.
*/
bool hasChild (const char * name, int index = 0) const
{
return (getChild(name, index) != 0);
}
/**
* Test whether a named child exists.
*/
bool hasChild (const std::string& name, int index = 0) const
{
return (getChild(name, index) != 0);
}
/**
* Create a new child node with the given name and an unused index
*
* @param min_index Minimal index for new node (skips lower indices)
* @param append Whether to simply use the index after the last used index
* or use a lower, unused index if it exists
*/
SGPropertyNode * addChild ( const char* name,
int min_index = 0,
bool append = true );
SGPropertyNode * addChild ( const std::string& name,
int min_index = 0,
bool append = true )
{ return addChild(name.c_str(), min_index, append); }
/**
* Create multiple child nodes with the given name an unused indices
*
* @param count The number of nodes create
* @param min_index Minimal index for new nodes (skips lower indices)
* @param append Whether to simply use the index after the last used index
* or use a lower, unused index if it exists
*/
simgear::PropertyList addChildren ( const std::string& name,
size_t count,
int min_index = 0,
bool append = true );
/**
* Get a child node by name and index.
*/
SGPropertyNode * getChild (const char* name, int index = 0,
bool create = false);
SGPropertyNode * getChild (const std::string& name, int index = 0,
bool create = false);
/**
* Get a const child node by name and index.
*/
const SGPropertyNode * getChild (const char * name, int index = 0) const;
/**
* Get a const child node by name and index.
*/
const SGPropertyNode * getChild (const std::string& name, int index = 0) const
{ return getChild(name.c_str(), index); }
/**
* Get a vector of all children with the specified name.
*/
simgear::PropertyList getChildren (const char * name) const;
/**
* Get a vector of all children with the specified name.
*/
simgear::PropertyList getChildren (const std::string& name) const
{ return getChildren(name.c_str()); }
/**
* Remove child by pointer (if it is a child of this node).
*
* @return true, if the node was deleted.
*/
bool removeChild(SGPropertyNode* node);
// TODO do we need the removeXXX methods to return the deleted nodes?
/**
* Remove child by position.
*/
SGPropertyNode_ptr removeChild(int pos);
/**
* Remove a child node
*/
SGPropertyNode_ptr removeChild(const char * name, int index = 0);
/**
* Remove a child node
*/
SGPropertyNode_ptr removeChild(const std::string& name, int index = 0)
{ return removeChild(name.c_str(), index); }
/**
* Remove all children with the specified name.
*/
simgear::PropertyList removeChildren(const char * name);
/**
* Remove all children with the specified name.
*/
simgear::PropertyList removeChildren(const std::string& name)
{ return removeChildren(name.c_str()); }
/**
* Remove all children (does not change the value of the node)
*/
void removeAllChildren();
//
// Alias support.
//
/**
* Alias this node's leaf value to another's.
*/
bool alias (SGPropertyNode * target);
/**
* Alias this node's leaf value to another's by relative path.
*/
bool alias (const char * path);
/**
* Alias this node's leaf value to another's by relative path.
*/
bool alias (const std::string& path)
{ return alias(path.c_str()); }
/**
* Remove any alias for this node.
*/
bool unalias ();
/**
* Test whether the node's leaf value is aliased to another's.
*/
bool isAlias () const { return (_type == simgear::props::ALIAS); }
/**
* Get a non-const pointer to the current alias target, if any.
*/
SGPropertyNode * getAliasTarget ();
/**
* Get a const pointer to the current alias target, if any.
*/
const SGPropertyNode * getAliasTarget () const;
//
// Path information.
//
/**
* Get the path to this node from the root.
*/
std::string getPath (bool simplify = false) const;
/**
* Get a pointer to the root node.
*/
SGPropertyNode * getRootNode ();
/**
* Get a const pointer to the root node.
*/
const SGPropertyNode * getRootNode () const;
/**
* Get a pointer to another node by relative path.
*/
SGPropertyNode * getNode (const char * relative_path, bool create = false);
/**
* Get a pointer to another node by relative path.
*/
SGPropertyNode * getNode (const std::string& relative_path, bool create = false)
{ return getNode(relative_path.c_str(), create); }
/**
* Get a pointer to another node by relative path.
*
* This method leaves the index off the last member of the path,
* so that the user can specify it separately (and save some
* string building). For example, getNode("/bar[1]/foo", 3) is
* exactly equivalent to getNode("bar[1]/foo[3]"). The index
* provided overrides any given in the path itself for the last
* component.
*/
SGPropertyNode * getNode (const char * relative_path, int index,
bool create = false);
/**
* Get a pointer to another node by relative path.
*
* This method leaves the index off the last member of the path,
* so that the user can specify it separately (and save some
* string building). For example, getNode("/bar[1]/foo", 3) is
* exactly equivalent to getNode("bar[1]/foo[3]"). The index
* provided overrides any given in the path itself for the last
* component.
*/
SGPropertyNode * getNode (const std::string& relative_path, int index,
bool create = false)
{ return getNode(relative_path.c_str(), index, create); }
/**
* Get a const pointer to another node by relative path.
*/
const SGPropertyNode * getNode (const char * relative_path) const;
/**
* Get a const pointer to another node by relative path.
*/
const SGPropertyNode * getNode (const std::string& relative_path) const
{ return getNode(relative_path.c_str()); }
/**
* Get a const pointer to another node by relative path.
*
* This method leaves the index off the last member of the path,
* so that the user can specify it separate.
*/
const SGPropertyNode * getNode (const char * relative_path,
int index) const;
/**
* Get a const pointer to another node by relative path.
*
* This method leaves the index off the last member of the path,
* so that the user can specify it separate.
*/
const SGPropertyNode * getNode (const std::string& relative_path,
int index) const
{ return getNode(relative_path.c_str(), index); }
//
// Access Mode.
//
/**
* Check a single mode attribute for the property node.
*/
bool getAttribute (Attribute attr) const { return ((_attr & attr) != 0); }
/**
* Set a single mode attribute for the property node.
*/
void setAttribute (Attribute attr, bool state) {
(state ? _attr |= attr : _attr &= ~attr);
}
/**
* Get all of the mode attributes for the property node.
*/
int getAttributes () const { return _attr; }
/**
* Set all of the mode attributes for the property node.
*/
void setAttributes (int attr) { _attr = attr; }
//
// Leaf Value (primitive).
//
/**
* Get the type of leaf value, if any, for this node.
*/
simgear::props::Type getType () const;
/**
* Get a bool value for this node.
*/
bool getBoolValue () const;
/**
* Get an int value for this node.
*/
int getIntValue () const;
/**
* Get a long int value for this node.
*/
long getLongValue () const;
/**
* Get a float value for this node.
*/
float getFloatValue () const;
/**
* Get a double value for this node.
*/
double getDoubleValue () const;
/**
* Get a string value for this node.
*/
const char * getStringValue () const;
/**
* Get a value from a node. If the actual type of the node doesn't
* match the desired type, a conversion isn't guaranteed.
*/
template<typename T>
T getValue(typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
::type* dummy = 0) const;
// Getter for extended property
template<typename T>
T getValue(typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
::type* dummy = 0) const;
/**
* Get a list of values from all children with the given name
*/
template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
std::vector<T> getChildValues(const std::string& name) const;
/**
* Get a list of values from all children with the given name
*/
template<typename T>
std::vector<T> getChildValues(const std::string& name) const;
/**
* Set a bool value for this node.
*/
bool setBoolValue (bool value);
/**
* Set an int value for this node.
*/
bool setIntValue (int value);
/**
* Set a long int value for this node.
*/
bool setLongValue (long value);
/**
* Set a float value for this node.
*/
bool setFloatValue (float value);
/**
* Set a double value for this node.
*/
bool setDoubleValue (double value);
/**
* Set a string value for this node.
*/
bool setStringValue (const char * value);
/**
* Set a string value for this node.
*/
bool setStringValue (const std::string& value)
{ return setStringValue(value.c_str()); }
/**
* Set a value of unspecified type for this node.
*/
bool setUnspecifiedValue (const char * value);
template<typename T>
bool setValue(const T& val,
typename boost::enable_if_c<simgear::props::PropertyTraits<T>::Internal>
::type* dummy = 0);
template<typename T>
bool setValue(const T& val,
typename boost::disable_if_c<simgear::props::PropertyTraits<T>::Internal>
::type* dummy = 0);
template<int N>
bool setValue(const char (&val)[N])
{
return setValue(&val[0]);
}
/**
* Set relative node to given value and afterwards make read only.
*
* @param relative_path Path to node
* @param value Value to set
*
* @return whether value could be set
*/
template<typename T>
bool setValueReadOnly(const std::string& relative_path, const T& value)
{
SGPropertyNode* node = getNode(relative_path, true);
bool ret = node->setValue(value);
node->setAttributes(READ);
return ret;
}
/**
* Interpolate current value to target value within given time.
*
* @param type Type of interpolation ("numeric", "color", etc.)
* @param target Node containing target value
* @param duration Duration of interpolation (in seconds)
* @param easing Easing function (http://easings.net/)
*/
bool interpolate( const std::string& type,
const SGPropertyNode& target,
double duration = 0.6,
const std::string& easing = "swing" );
/**
* Interpolate current value to a series of values within given durations.
*
* @param type Type of interpolation ("numeric", "color", etc.)
* @param values Nodes containing intermediate and target values
* @param deltas Durations for each interpolation step (in seconds)
* @param easing Easing function (http://easings.net/)
*/
bool interpolate( const std::string& type,
const simgear::PropertyList& values,
const double_list& deltas,
const std::string& easing = "swing" );
/**
* Set the interpolation manager used by the interpolate methods.
*/
static void setInterpolationMgr(simgear::PropertyInterpolationMgr* mgr);
/**
* Get the interpolation manager
*/
static simgear::PropertyInterpolationMgr* getInterpolationMgr();
/**
* Print the value of the property to a stream.
*/
std::ostream& printOn(std::ostream& stream) const;
//
// Data binding.
//
/**
* Test whether this node is bound to an external data source.
*/
bool isTied () const { return _tied; }
/**
* Bind this node to an external source.
*/
template<typename T>
bool tie(const SGRawValue<T> &rawValue, bool useDefault = true);
/**
* Unbind this node from any external data source.
*/
bool untie ();
//
// Convenience methods using paths.
// TODO: add attribute methods
//
/**
* Get another node's type.
*/
simgear::props::Type getType (const char * relative_path) const;
/**
* Get another node's type.
*/
simgear::props::Type getType (const std::string& relative_path) const
{ return getType(relative_path.c_str()); }
/**
* Test whether another node has a leaf value.
*/
bool hasValue (const char * relative_path) const;
/**
* Test whether another node has a leaf value.
*/
bool hasValue (const std::string& relative_path) const
{ return hasValue(relative_path.c_str()); }
/**
* Get another node's value as a bool.
*/
bool getBoolValue (const char * relative_path,
bool defaultValue = false) const;
/**
* Get another node's value as a bool.
*/
bool getBoolValue (const std::string& relative_path,
bool defaultValue = false) const
{ return getBoolValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as an int.
*/
int getIntValue (const char * relative_path,
int defaultValue = 0) const;
/**
* Get another node's value as an int.
*/
int getIntValue (const std::string& relative_path,
int defaultValue = 0) const
{ return getIntValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a long int.
*/
long getLongValue (const char * relative_path,
long defaultValue = 0L) const;
/**
* Get another node's value as a long int.
*/
long getLongValue (const std::string& relative_path,
long defaultValue = 0L) const
{ return getLongValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a float.
*/
float getFloatValue (const char * relative_path,
float defaultValue = 0.0f) const;
/**
* Get another node's value as a float.
*/
float getFloatValue (const std::string& relative_path,
float defaultValue = 0.0f) const
{ return getFloatValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a double.
*/
double getDoubleValue (const char * relative_path,
double defaultValue = 0.0) const;
/**
* Get another node's value as a double.
*/
double getDoubleValue (const std::string& relative_path,
double defaultValue = 0.0) const
{ return getDoubleValue(relative_path.c_str(), defaultValue); }
/**
* Get another node's value as a string.
*/
const char * getStringValue (const char * relative_path,
const char * defaultValue = "") const;
/**
* Get another node's value as a string.
*/
const char * getStringValue (const std::string& relative_path,
const char * defaultValue = "") const
{ return getStringValue(relative_path.c_str(), defaultValue); }
/**
* Set another node's value as a bool.
*/
bool setBoolValue (const char * relative_path, bool value);
/**
* Set another node's value as a bool.
*/
bool setBoolValue (const std::string& relative_path, bool value)
{ return setBoolValue(relative_path.c_str(), value); }
/**
* Set another node's value as an int.
*/
bool setIntValue (const char * relative_path, int value);
/**
* Set another node's value as an int.
*/
bool setIntValue (const std::string& relative_path, int value)
{ return setIntValue(relative_path.c_str(), value); }
/**
* Set another node's value as a long int.
*/
bool setLongValue (const char * relative_path, long value);
/**
* Set another node's value as a long int.
*/
bool setLongValue (const std::string& relative_path, long value)
{ return setLongValue(relative_path.c_str(), value); }
/**
* Set another node's value as a float.
*/
bool setFloatValue (const char * relative_path, float value);
/**
* Set another node's value as a float.
*/
bool setFloatValue (const std::string& relative_path, float value)
{ return setFloatValue(relative_path.c_str(), value); }
/**
* Set another node's value as a double.
*/
bool setDoubleValue (const char * relative_path, double value);
/**
* Set another node's value as a double.
*/
bool setDoubleValue (const std::string& relative_path, double value)
{ return setDoubleValue(relative_path.c_str(), value); }
/**
* Set another node's value as a string.
*/
bool setStringValue (const char * relative_path, const char * value);
bool setStringValue(const char * relative_path, const std::string& value)
{ return setStringValue(relative_path, value.c_str()); }
/**
* Set another node's value as a string.
*/
bool setStringValue (const std::string& relative_path, const char * value)
{ return setStringValue(relative_path.c_str(), value); }
bool setStringValue (const std::string& relative_path,
const std::string& value)
{ return setStringValue(relative_path.c_str(), value.c_str()); }
/**
* Set another node's value with no specified type.
*/
bool setUnspecifiedValue (const char * relative_path, const char * value);
/**
* Test whether another node is bound to an external data source.
*/
bool isTied (const char * relative_path) const;
/**
* Test whether another node is bound to an external data source.
*/
bool isTied (const std::string& relative_path) const
{ return isTied(relative_path.c_str()); }
/**
* Bind another node to an external bool source.
*/
bool tie (const char * relative_path, const SGRawValue<bool> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external bool source.
*/
bool tie (const std::string& relative_path, const SGRawValue<bool> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Bind another node to an external int source.
*/
bool tie (const char * relative_path, const SGRawValue<int> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external int source.
*/
bool tie (const std::string& relative_path, const SGRawValue<int> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Bind another node to an external long int source.
*/
bool tie (const char * relative_path, const SGRawValue<long> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external long int source.
*/
bool tie (const std::string& relative_path, const SGRawValue<long> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Bind another node to an external float source.
*/
bool tie (const char * relative_path, const SGRawValue<float> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external float source.
*/
bool tie (const std::string& relative_path, const SGRawValue<float> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Bind another node to an external double source.
*/
bool tie (const char * relative_path, const SGRawValue<double> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external double source.
*/
bool tie (const std::string& relative_path, const SGRawValue<double> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Bind another node to an external string source.
*/
bool tie (const char * relative_path, const SGRawValue<const char *> &rawValue,
bool useDefault = true);
/**
* Bind another node to an external string source.
*/
bool tie (const std::string& relative_path, const SGRawValue<const char*> &rawValue,
bool useDefault = true)
{ return tie(relative_path.c_str(), rawValue, useDefault); }
/**
* Unbind another node from any external data source.
*/
bool untie (const char * relative_path);
/**
* Unbind another node from any external data source.
*/
bool untie (const std::string& relative_path)
{ return untie(relative_path.c_str()); }
/**
* Add a change listener to the property. If "initial" is set call the
* listener initially.
*/
void addChangeListener (SGPropertyChangeListener * listener,
bool initial = false);
/**
* Remove a change listener from the property.
*/
void removeChangeListener (SGPropertyChangeListener * listener);
/**
* Get the number of listeners.
*/
int nListeners () const { return _listeners ? (int)_listeners->size() : 0; }
/**
* Fire a value change event to all listeners.
*/
void fireValueChanged ();
/**
* Fire a child-added event to all listeners.
*/
void fireChildAdded (SGPropertyNode * child);
/**
* Trigger a child-added and value-changed event for every child (Unlimited
* depth).
*
* @param fire_self Whether to trigger the events also for the node itself.
*
* It can be used to simulating the creation of a property tree, eg. for
* (re)initializing a subsystem which is controlled through the property tree.
*/
void fireCreatedRecursive(bool fire_self = false);
/**
* Fire a child-removed event to all listeners.
*/
void fireChildRemoved (SGPropertyNode * child);
/**
* Fire a child-removed event for every child of this node (Unlimited depth)
*
* Upon removal of a child node only for this single node a child-removed
* event is triggered. If eg. resource cleanup relies on receiving a
* child-removed event for every child this method can be used.
*/
void fireChildrenRemovedRecursive();
/**
* Clear any existing value and set the type to NONE.
*/
void clearValue ();
/**
* Compare two property trees. The property trees are equal if: 1)
* They have no children, and have the same type and the values are
* equal, or 2) have the same number of children, and the
* corresponding children in each tree are equal. "corresponding"
* means have the same name and index.
*
* Attributes, removed children, and aliases aren't considered.
*/
static bool compare (const SGPropertyNode& lhs, const SGPropertyNode& rhs);
protected:
void fireValueChanged (SGPropertyNode * node);
void fireChildAdded (SGPropertyNode * parent, SGPropertyNode * child);
void fireChildRemoved (SGPropertyNode * parent, SGPropertyNode * child);
SGPropertyNode_ptr eraseChild(simgear::PropertyList::iterator child);
/**
* Protected constructor for making new nodes on demand.
*/
SGPropertyNode (const std::string& name, int index, SGPropertyNode * parent);
template<typename Itr>
SGPropertyNode (Itr begin, Itr end, int index, SGPropertyNode * parent);
static simgear::PropertyInterpolationMgr* _interpolation_mgr;
private:
// Get the raw value
bool get_bool () const;
int get_int () const;
long get_long () const;
float get_float () const;
double get_double () const;
const char * get_string () const;
// Set the raw value
bool set_bool (bool value);
bool set_int (int value);
bool set_long (long value);
bool set_float (float value);
bool set_double (double value);
bool set_string (const char * value);
/**
* Get the value as a string.
*/
const char * make_string () const;
/**
* Trace a read access.
*/
void trace_read () const;
/**
* Trace a write access.
*/
void trace_write () const;
int _index;
std::string _name;
/// To avoid cyclic reference counting loops this shall not be a reference
/// counted pointer
SGPropertyNode * _parent;
simgear::PropertyList _children;
mutable std::string _buffer;
simgear::props::Type _type;
bool _tied;
int _attr;
// The right kind of pointer...
union {
SGPropertyNode * alias;
SGRaw* val;
} _value;
union {
bool bool_val;
int int_val;
long long_val;
float float_val;
double double_val;
char * string_val;
} _local_val;
std::vector<SGPropertyChangeListener *> * _listeners;
// Pass name as a pair of iterators
template<typename Itr>
SGPropertyNode * getChildImpl (Itr begin, Itr end, int index = 0, bool create = false);
// very internal method
template<typename Itr>
SGPropertyNode* getExistingChild (Itr begin, Itr end, int index);
// very internal path parsing function
template<typename SplitItr>
friend SGPropertyNode* find_node_aux(SGPropertyNode * current, SplitItr& itr,
bool create, int last_index);
// For boost
friend size_t hash_value(const SGPropertyNode& node);
};
// Convenience functions for use in templates
template<typename T>
typename boost::disable_if<boost::is_enum<T>, T>::type
getValue(const SGPropertyNode*);
template<>
inline bool getValue<bool>(const SGPropertyNode* node) { return node->getBoolValue(); }
template<>
inline int getValue<int>(const SGPropertyNode* node) { return node->getIntValue(); }
template<>
inline long getValue<long>(const SGPropertyNode* node) { return node->getLongValue(); }
template<>
inline float getValue<float>(const SGPropertyNode* node)
{
return node->getFloatValue();
}
template<>
inline double getValue<double>(const SGPropertyNode* node)
{
return node->getDoubleValue();
}
template<>
inline const char * getValue<const char*>(const SGPropertyNode* node)
{
return node->getStringValue ();
}
template<>
inline std::string getValue<std::string>(const SGPropertyNode* node)
{
return node->getStringValue();
}
namespace simgear
{
/**
* Default trait for extracting enum values from SGPropertyNode. Create your
* own specialization for specific enum types to enable validation of values.
*/
template<class T>
struct enum_traits
{
/**
* Typename of the enum
*/
static const char* name() { return typeid(T).name(); }
/**
* @return Default value (will be used if validation fails)
*/
static T defVal() { return T(); }
/**
* @return Whether the given integer value has an enum value defined
*/
static bool validate(int) { return true; }
};
} // namespace simgear
/** Extract enum from SGPropertyNode */
template<typename T>
inline typename boost::enable_if<boost::is_enum<T>, T>::type
getValue(const SGPropertyNode* node)
{
typedef simgear::enum_traits<T> Traits;
int val = node->getIntValue();
if( !Traits::validate(val) )
{
SG_LOG
(
SG_GENERAL,
SG_WARN,
"Invalid value for enum (" << Traits::name() << ", val = " << val << ")"
);
return Traits::defVal();
}
return static_cast<T>(node->getIntValue());
}
inline bool setValue(SGPropertyNode* node, bool value)
{
return node->setBoolValue(value);
}
inline bool setValue(SGPropertyNode* node, int value)
{
return node->setIntValue(value);
}
inline bool setValue(SGPropertyNode* node, long value)
{
return node->setLongValue(value);
}
inline bool setValue(SGPropertyNode* node, float value)
{
return node->setFloatValue(value);
}
inline bool setValue(SGPropertyNode* node, double value)
{
return node->setDoubleValue(value);
}
inline bool setValue(SGPropertyNode* node, const char* value)
{
return node->setStringValue(value);
}
inline bool setValue (SGPropertyNode* node, const std::string& value)
{
return node->setStringValue(value.c_str());
}
template<typename T>
bool SGPropertyNode::tie(const SGRawValue<T> &rawValue, bool useDefault)
{
using namespace simgear::props;
if (_type == ALIAS || _tied)
return false;
useDefault = useDefault && hasValue();
T old_val = SGRawValue<T>::DefaultValue();
if (useDefault)
old_val = getValue<T>(this);
clearValue();
if (PropertyTraits<T>::Internal)
_type = PropertyTraits<T>::type_tag;
else
_type = EXTENDED;
_tied = true;
_value.val = rawValue.clone();
if (useDefault) {
int save_attributes = getAttributes();
setAttribute( WRITE, true );
setValue(old_val);
setAttributes( save_attributes );
}
return true;
}
template<>
bool SGPropertyNode::tie (const SGRawValue<const char *> &rawValue,
bool useDefault);
template<typename T>
T SGPropertyNode::getValue(typename boost::disable_if_c<simgear::props
::PropertyTraits<T>::Internal>::type* dummy) const
{
using namespace simgear::props;
if (_attr == (READ|WRITE) && _type == EXTENDED
&& _value.val->getType() == PropertyTraits<T>::type_tag) {
return static_cast<SGRawValue<T>*>(_value.val)->getValue();
}
if (getAttribute(TRACE_READ))
trace_read();
if (!getAttribute(READ))
return SGRawValue<T>::DefaultValue();
switch (_type) {
case EXTENDED:
if (_value.val->getType() == PropertyTraits<T>::type_tag)
return static_cast<SGRawValue<T>*>(_value.val)->getValue();
break;
case STRING:
case UNSPECIFIED:
return simgear::parseString<T>(make_string());
break;
default: // avoid compiler warning
break;
}
return SGRawValue<T>::DefaultValue();
}
template<typename T>
inline T SGPropertyNode::getValue(typename boost::enable_if_c<simgear::props
::PropertyTraits<T>::Internal>::type* dummy) const
{
return ::getValue<T>(this);
}
template<typename T, typename T_get /* = T */> // TODO use C++11 or traits
std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
{
const simgear::PropertyList& props = getChildren(name);
std::vector<T> values( props.size() );
for( size_t i = 0; i < props.size(); ++i )
values[i] = props[i]->getValue<T_get>();
return values;
}
template<typename T>
inline
std::vector<T> SGPropertyNode::getChildValues(const std::string& name) const
{
return getChildValues<T, T>(name);
}
template<typename T>
bool SGPropertyNode::setValue(const T& val,
typename boost::disable_if_c<simgear::props
::PropertyTraits<T>::Internal>::type* dummy)
{
using namespace simgear::props;
if (_attr == (READ|WRITE) && _type == EXTENDED
&& _value.val->getType() == PropertyTraits<T>::type_tag) {
static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
return true;
}
if (getAttribute(WRITE)
&& ((_type == EXTENDED
&& _value.val->getType() == PropertyTraits<T>::type_tag)
|| _type == NONE || _type == UNSPECIFIED)) {
if (_type == NONE || _type == UNSPECIFIED) {
clearValue();
_type = EXTENDED;
_value.val = new SGRawValueContainer<T>(val);
} else {
static_cast<SGRawValue<T>*>(_value.val)->setValue(val);
}
if (getAttribute(TRACE_WRITE))
trace_write();
return true;
}
return false;
}
template<typename T>
inline bool SGPropertyNode::setValue(const T& val,
typename boost::enable_if_c<simgear::props
::PropertyTraits<T>::Internal>::type* dummy)
{
return ::setValue(this, val);
}
/**
* Utility function for creation of a child property node.
*/
inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name,
int index = 0)
{
return parent->getChild(name, index, true);
}
/**
* Utility function for creation of a child property node using a
* relative path.
*/
namespace simgear
{
template<typename StringType>
inline SGPropertyNode* makeNode(SGPropertyNode* parent, const StringType& name)
{
return parent->getNode(name, true);
}
}
// For boost::hash
size_t hash_value(const SGPropertyNode& node);
// Helper comparison and hash functions for common cases
namespace simgear
{
namespace props
{
struct Compare
{
bool operator()(const SGPropertyNode* lhs, const SGPropertyNode* rhs) const
{
return SGPropertyNode::compare(*lhs, *rhs);
}
bool operator()(SGPropertyNode_ptr lhs, const SGPropertyNode* rhs) const
{
return SGPropertyNode::compare(*lhs, *rhs);
}
bool operator()(const SGPropertyNode* lhs, SGPropertyNode_ptr rhs) const
{
return SGPropertyNode::compare(*lhs, *rhs);
}
bool operator()(SGPropertyNode_ptr lhs, SGPropertyNode_ptr rhs) const
{
return SGPropertyNode::compare(*lhs, *rhs);
}
};
struct Hash
{
size_t operator()(const SGPropertyNode* node) const
{
return hash_value(*node);
}
size_t operator()(SGPropertyNode_ptr node) const
{
return hash_value(*node);
}
};
}
}
/** Convenience class for change listener callbacks without
* creating a derived class implementing a "valueChanged" method.
* Also removes listener on destruction automatically.
*/
template<class T>
class SGPropertyChangeCallback
: public SGPropertyChangeListener
{
public:
SGPropertyChangeCallback(T* obj, void (T::*method)(SGPropertyNode*),
SGPropertyNode_ptr property,bool initial=false)
: _obj(obj), _callback(method), _property(property)
{
_property->addChangeListener(this,initial);
}
SGPropertyChangeCallback(const SGPropertyChangeCallback<T>& other) :
_obj(other._obj), _callback(other._callback), _property(other._property)
{
_property->addChangeListener(this,false);
}
virtual ~SGPropertyChangeCallback()
{
_property->removeChangeListener(this);
}
void valueChanged (SGPropertyNode * node)
{
(_obj->*_callback)(node);
}
private:
T* _obj;
void (T::*_callback)(SGPropertyNode*);
SGPropertyNode_ptr _property;
};
#endif // __PROPS_HXX
// end of props.hxx
|