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 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394
|
/*
nutconf.hpp - Nut configuration file manipulation API
Copyright (C) 2012 Eaton
Author: Emilien Kia <emilien.kia@gmail.com>
Copyright (C) 2024-2025 NUT Community
Author: Jim Klimov <jimklimov+nut@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef NUTCONF_H_SEEN
#define NUTCONF_H_SEEN 1
#include "nutstream.hpp"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdint.h>
#include <string>
#include <vector>
#include <list>
#include <map>
#include <stdexcept>
#include <typeinfo>
/* See include/common.h for details behind this */
#ifndef NUT_UNUSED_VARIABLE
#define NUT_UNUSED_VARIABLE(x) (void)(x)
#endif
#ifdef __cplusplus
namespace nut
{
class NutParser;
class NutConfigParser;
class DefaultConfigParser;
class GenericConfigParser;
/**
* Helper to specify if a configuration variable is set or not.
* In addition of its value.
*/
template<typename Type>
class Settable
{
protected:
Type _value;
bool _set;
std::string errMsg_ENOTSET()const {
static const std::string msg =
"Can not retrieve a Settable value of "
"an instance that was not assigned yet "
"(or was last known cleared)";
return msg;
}
public:
Settable():_set(false){}
Settable(const Settable<Type>& val):_value(val._value), _set(val._set){}
Settable(const Type& val):_value(val), _set(true){}
/* Avoid implicit copy/move operator declarations */
Settable(Settable&&) = default;
Settable& operator=(const Settable&) = default;
Settable& operator=(Settable&&) = default;
bool set()const{return _set;}
void clear(){_set = false;}
operator const Type&()const
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (!set())
throw std::invalid_argument(errMsg_ENOTSET());
return _value;
}
operator Type&()
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (!set())
throw std::invalid_argument(errMsg_ENOTSET());
return _value;
}
const Type& operator *()const
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (!set())
throw std::invalid_argument(errMsg_ENOTSET());
return _value;
}
Type& operator *()
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (!set())
throw std::invalid_argument(errMsg_ENOTSET());
return _value;
}
Settable<Type>& operator=(const Type& val){_value = val; _set = true; return *this;}
bool operator==(const Settable<Type>& val)const
{
if(!set() && !val.set())
return false;
else
return (set() && val.set() && _value==val._value);
}
bool operator==(const Type& val)const
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if(!set())
return false;
else
try {
#if (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_PUSH_POP) && (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_MAYBE_UNINITIALIZED)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
#endif
// some compilers are concerned that Settable<Type>._value
// may be queried as un-initialized here (for equality)
// but we are supposed to rule that out with "if set()"...
return _value == val;
#if (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_PUSH_POP) && (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_MAYBE_UNINITIALIZED)
#pragma GCC diagnostic pop
#endif
} catch(...) {
throw std::invalid_argument(errMsg_ENOTSET());
}
}
};
/**
* \brief Serialisable interface
*
* Classes that implement this interface provide way to serialize
* and deserialize instances to/from streams.
*/
class Serialisable
{
protected:
/** Formal constructor */
Serialisable() {}
public:
/**
* \brief Deserializer
*
* \param istream Input stream
*
* \retval true in case of success
* \retval false in case of read error
*/
virtual bool parseFrom(NutStream & istream) = 0;
/**
* \brief Serializer
*
* \param ostream Output stream
*
* \retval true in case of success
* \retval false in case of write error
*/
virtual bool writeTo(NutStream & ostream) const = 0;
/** Destructor */
virtual ~Serialisable();
}; // end of class Serialisable
/**
* \brief Mix a boolean (yes/no) or wider integer range
*/
class BoolInt
{
private:
Settable<bool> b;
Settable<int> i;
public:
/** If set, its value specifies if we want i==0/1 to mean false/true
* in value-equality and type-cast operators for int and bool types.
* NOTE: If true, assignment from "0" and "1" strings sets the int
* not bool stored value representation!
* NOTE: Survives the clear() call which applies to stored value,
* but would be reset by assignment from another BoolInt object.
*/
Settable<bool> bool01;
/** Leave all contents un-set */
BoolInt() {
clearWithBool01();
}
BoolInt(const bool val) {
*this = val;
}
BoolInt(const bool val, bool newBool01) {
this->bool01 = newBool01;
*this = val;
}
BoolInt(const int val) {
*this = val;
}
BoolInt(const int val, bool newBool01) {
this->bool01 = newBool01;
*this = val;
}
BoolInt(const char* val) {
*this = val;
}
BoolInt(const char* val, bool newBool01) {
this->bool01 = newBool01;
*this = val;
}
BoolInt(const std::string &val) {
*this = val;
}
BoolInt(const std::string &val, bool newBool01) {
this->bool01 = newBool01;
*this = val;
}
BoolInt(const BoolInt& other) {
*this = other;
}
BoolInt(const BoolInt& other, bool newBool01) {
this->bool01 = newBool01;
*this = other;
this->bool01 = newBool01;
}
inline void clear()
{
i = 0;
b = false;
i.clear();
b.clear();
}
inline void clearWithBool01()
{
clear();
bool01 = false;
bool01.clear();
}
inline BoolInt& operator=(const BoolInt& other)
{
clearWithBool01();
if (other.b.set()) b = other.b;
if (other.i.set()) i = other.i;
if (other.bool01.set())
bool01 = other.bool01;
return *this;
}
inline BoolInt& operator=(BoolInt&& other)
{
clearWithBool01();
if (other.b.set()) b = other.b;
if (other.i.set()) i = other.i;
if (other.bool01.set())
bool01 = other.bool01;
return *this;
}
inline BoolInt& operator=(int val)
{
clear();
i = val;
return *this;
}
inline BoolInt& operator=(bool val)
{
clear();
b = val;
return *this;
}
inline BoolInt& operator=(const char* s)
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (!s)
throw std::invalid_argument(
"BoolInt value from <null> string is is not supported");
std::string src(s);
return (*this = src);
}
inline BoolInt& operator=(std::string src)
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
static const Settable<bool> b0(false);
static const Settable<bool> b1(true);
// NOTE: Not a pointer, is not null at least
if (src.empty())
throw std::invalid_argument(
"BoolInt value from <empty> string is is not supported");
clear();
if ("false" == src) { b = b0; return *this; }
if ("off" == src) { b = b0; return *this; }
if ("0" == src) {
if (bool01.set() && bool01 == false) {
i = 0;
} else {
b = b0;
}
return *this;
}
if ("no" == src) { b = b0; return *this; }
if ("true" == src) { b = b1; return *this; }
if ("on" == src) { b = b1; return *this; }
if ("1" == src) {
if (bool01.set() && bool01 == false) {
i = 1;
} else {
b = b1;
}
return *this;
}
if ("yes" == src) { b = b1; return *this; }
if ("ok" == src) { b = b1; return *this; }
std::stringstream ss(src);
int result;
if (ss >> result && ss.rdbuf()->in_avail() == 0) {
// Conversion succeeded and all chars were read
// (e.g. not a decimal number)
i = result;
#ifdef DEBUG
std::cerr << "BoolInt assigned from '" << src
<< "': got int '" << result << "'"
<< " stream empty? " << ss.rdbuf()->in_avail()
<< std::endl;
#endif
return *this;
}
throw std::invalid_argument("BoolInt value from '" + src +
"' string not understood as bool nor int");
}
inline BoolInt& operator<<(bool other)
{
*this = other;
return *this;
}
inline BoolInt& operator<<(int other)
{
*this = other;
return *this;
}
inline BoolInt& operator<<(std::string other)
{
*this = other;
return *this;
}
inline BoolInt& operator<<(const char* other)
{
*this = other;
return *this;
}
inline bool operator==(const BoolInt& other)const
{
// Either direct values are set and then equal; optionally
// else numeric values of int and bool are cross-equal.
if (b.set() && other.b.set()) return (b == other.b);
if (i.set() && other.i.set()) return (i == other.i);
if ((bool01.set() && bool01 == true)
|| (!bool01.set() && other.bool01.set() && other.bool01 == true)
) {
// false if at least one object has neither i nor b
// values "set()", or if their numeric values do not
// match up as 0 or 1 exactly vs. boolean values.
#if (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_PUSH_POP) && (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_MAYBE_UNINITIALIZED)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
#endif
// some compilers are concerned that Settable<Type>._value
// may be queried as un-initialized here (for 0/1 equality)
// but we are supposed to rule that out with "if set()"...
try {
if (i.set() && other.b.set())
return ( (other.b && i == 1) || (!other.b && i == 0) );
} catch (...) {}
try {
if (b.set() && other.i.set())
return ( (b && other.i == 1) || (!b && other.i == 0) );
} catch (...) {}
#if (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_PUSH_POP) && (defined HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_MAYBE_UNINITIALIZED)
#pragma GCC diagnostic pop
#endif
}
return false;
}
inline bool operator==(const bool other)const
{
if (b.set()) return (b == other);
if (bool01.set() && bool01 == true) {
if (i.set())
return ((other && i == 1) || (!other && i == 0));
}
return false;
}
inline bool operator==(const int other)const
{
if (i.set()) return (i == other);
if (bool01.set() && bool01 == true) {
if (b.set())
return ((b && other == 1) || (!b && other == 0));
}
return false;
}
inline bool operator==(const std::string other)const
{
BoolInt tmp;
if (bool01.set())
tmp.bool01 = bool01;
tmp = other;
return (*this == tmp);
}
inline bool operator==(const char* s)const
{
if (!s)
return false;
std::string src(s);
return (*this == src);
}
inline bool set()const
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (i.set() && b.set())
throw std::invalid_argument(
"BoolInt value somehow got both bool and int values set");
return (i.set() || b.set());
}
operator int()
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (i.set()) return i;
if (bool01.set() && bool01 == true) {
if (b.set()) {
/** Cause use of operator to avoid warnings like
* "may be used uninitialized in this function"
*/
if (b == true) return 1;
return 0;
}
} else {
throw std::invalid_argument(
"BoolInt value not set to int");
}
throw std::invalid_argument(
"BoolInt value not set, neither to bool nor to int");
}
operator bool()
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (b.set()) return b;
if (bool01.set() && bool01 == true) {
if (i.set()) {
if (i == 0) return false;
if (i == 1) return true;
}
} else {
throw std::invalid_argument(
"BoolInt value not set to bool");
}
throw std::invalid_argument(
"BoolInt value not set, neither to bool nor to int");
}
inline std::string toString()const
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
if (b.set()) {
if (b == true) return "yes";
return "no";
}
if (i.set()) {
if (bool01.set() && bool01 == true) {
if (i == 0) return "no";
if (i == 1) return "yes";
}
std::ostringstream ss;
ss << i;
return ss.str();
}
throw std::invalid_argument(
"BoolInt value not set, neither to bool nor to int");
}
// FIXME: `std::string s = bi;` just won't work
// but we can use `s = bi.toString()` or `cout << bi`
operator std::string()const {
return this->toString();
}
operator std::string&()const {
return *(new std::string(this->operator std::string()));
}
};
std::ostream& operator << (std::ostream &os, const BoolInt &bi);
inline std::ostream& operator << (std::ostream &os, const BoolInt &bi) {
return (os << bi.toString());
}
/**
* \brief Certificate Identification structure for NUT
*
* Contains a certificate name and database password
*/
struct CertIdent
{
Settable<std::string> certName, certDbPass;
inline bool operator==(const CertIdent& ident)const
{
return certName == ident.certName && certDbPass == ident.certDbPass;
}
inline bool set()const
{
return certName.set() && certDbPass.set();
}
};
/**
* \brief Certificate protected host structure for NUT
*
* Contains a host name, certificate name and option flags
*/
struct CertHost
{
Settable<std::string> host, certName;
nut::BoolInt certVerify, forceSsl;
inline bool operator==(const CertHost& other)const
{
return certName == other.certName
&& host == other.host
&& certVerify == other.certVerify
&& forceSsl == other.forceSsl;
}
inline bool set()const
{
return certName.set() && host.set()
&& certVerify.set() && forceSsl.set();
}
};
/**
* NUT config parser.
*/
class NutParser
{
public:
enum ParsingOption
{
OPTION_DEFAULT = 0,
/** Colon character is considered as string character and not as specific token.
Useful for IPv6 addresses */
OPTION_IGNORE_COLON = 1
};
NutParser(const char* buffer = nullptr, unsigned int options = OPTION_DEFAULT);
NutParser(const std::string& buffer, unsigned int options = OPTION_DEFAULT);
virtual ~NutParser();
/** Parsing configuration functions
* \{ */
void setOptions(unsigned int options){_options = options;}
unsigned int getOptions()const{return _options;}
void setOptions(unsigned int options, bool set = true);
void unsetOptions(unsigned int options){setOptions(options, false);}
bool hasOptions(unsigned int options)const{return (_options&options) == options;}
/** \} */
struct Token
{
enum TokenType {
TOKEN_UNKNOWN = -1,
TOKEN_NONE = 0,
TOKEN_STRING = 1,
TOKEN_QUOTED_STRING,
TOKEN_COMMENT,
TOKEN_BRACKET_OPEN,
TOKEN_BRACKET_CLOSE,
TOKEN_EQUAL,
TOKEN_COLON,
TOKEN_EOL
} type;
std::string str;
Token():type(TOKEN_NONE),str(){}
Token(TokenType type_arg, const std::string& str_arg=""):type(type_arg),str(str_arg){}
Token(TokenType type_arg, char c):type(type_arg),str(1, c){}
Token(const Token& tok):type(tok.type),str(tok.str){}
/* Avoid implicit copy/move operator declarations */
Token(Token&&) = default;
Token& operator=(const Token&) = default;
Token& operator=(Token&&) = default;
bool is(TokenType type_arg)const{return this->type==type_arg;}
bool operator==(const Token& tok)const{return tok.type==type && tok.str==str;}
operator bool()const{return type!=TOKEN_UNKNOWN && type!=TOKEN_NONE;}
};
/** Parsing functions
* \{ */
std::string parseCHARS();
std::string parseSTRCHARS();
Token parseToken();
std::list<Token> parseLine();
/** \} */
#ifndef UNITEST_MODE
protected:
#endif /* UNITEST_MODE */
size_t getPos()const;
void setPos(size_t pos);
char charAt(size_t pos)const;
void pushPos();
size_t popPos();
void rewind();
void back();
char get();
char peek();
private:
unsigned int _options;
std::string _buffer;
size_t _pos;
std::vector<size_t> _stack;
};
typedef std::list<std::string> ConfigParamList;
struct GenericConfigSectionEntry
{
std::string name;
ConfigParamList values;
// std::string comment;
};
struct GenericConfigSection
{
/** Section entries map */
typedef std::map<std::string, GenericConfigSectionEntry> EntryMap;
std::string name;
// std::string comment;
EntryMap entries;
const GenericConfigSectionEntry& operator [] (const std::string& varname)const{return entries.find(varname)->second;}
GenericConfigSectionEntry& operator [] (const std::string& varname){return entries[varname];}
bool empty()const;
void clear();
};
class BaseConfiguration
{
friend class GenericConfigParser;
public:
virtual ~BaseConfiguration();
protected:
virtual void setGenericConfigSection(const GenericConfigSection& section) = 0;
};
class NutConfigParser : public NutParser
{
public:
virtual void parseConfig();
/* Declared for cleaner overrides; arg ignored in current class */
virtual void parseConfig(BaseConfiguration* config);
protected:
NutConfigParser(const char* buffer = nullptr, unsigned int options = OPTION_DEFAULT);
NutConfigParser(const std::string& buffer, unsigned int options = OPTION_DEFAULT);
virtual void onParseBegin()=0;
virtual void onParseComment(const std::string& comment)=0;
virtual void onParseSectionName(const std::string& sectionName, const std::string& comment = "")=0;
virtual void onParseDirective(const std::string& directiveName, char sep = 0, const ConfigParamList& values = ConfigParamList(), const std::string& comment = "")=0;
virtual void onParseEnd()=0;
};
class DefaultConfigParser : public NutConfigParser
{
public:
DefaultConfigParser(const char* buffer = nullptr);
DefaultConfigParser(const std::string& buffer);
protected:
virtual void onParseSection(const GenericConfigSection& section)=0;
virtual void onParseBegin() override;
virtual void onParseComment(const std::string& comment) override;
virtual void onParseSectionName(const std::string& sectionName, const std::string& comment = "") override;
virtual void onParseDirective(const std::string& directiveName, char sep = 0, const ConfigParamList& values = ConfigParamList(), const std::string& comment = "") override;
virtual void onParseEnd() override;
GenericConfigSection _section; ///> Currently parsed section
};
class GenericConfigParser : public DefaultConfigParser
{
public:
GenericConfigParser(const char* buffer = nullptr);
GenericConfigParser(const std::string& buffer);
virtual void parseConfig(BaseConfiguration* config) override;
protected:
virtual void onParseSection(const GenericConfigSection& section) override;
BaseConfiguration* _config;
};
class GenericConfiguration : public BaseConfiguration, public Serialisable
{
public:
/** Sections map */
typedef std::map<std::string, GenericConfigSection> SectionMap;
GenericConfiguration(){}
virtual ~GenericConfiguration() override;
void parseFromString(const std::string& str);
/** Serialisable interface implementation \{ */
bool parseFrom(NutStream & istream) override;
bool writeTo(NutStream & ostream) const override;
/** \} */
// FIXME Let be public or set it as protected with public accessors ?
SectionMap sections;
const GenericConfigSection& operator[](const std::string& secname)const{return sections.find(secname)->second;}
GenericConfigSection& operator[](const std::string& secname){return sections[secname];}
protected:
virtual void setGenericConfigSection(const GenericConfigSection& section) override;
/**
* \brief Configuration parameters getter
*
* \param[in] section Section name
* \param[in] entry Entry name
* \param[out] params Configuration parameters
* \param[in] caseSensitive Use case-sensitive entry name matching? (default: true)
*
* \retval true if the entry was found
* \retval false otherwise
*/
bool get(const std::string & section, const std::string & entry, ConfigParamList & params, bool caseSensitive = true) const;
/**
* \brief Global scope configuration parameters getter
*
* \param[in] entry Entry name
* \param[out] params Configuration parameters
* \param[in] caseSensitive Use case-sensitive entry name matching? (default: true)
*
* \retval true if the entry was found
* \retval false otherwise
*/
inline bool get(const std::string & entry, ConfigParamList & params, bool caseSensitive = true) const
{
return get("", entry, params, caseSensitive);
}
/**
* \brief Configuration parameters setter
*
* The section and entry are created unless they already exist.
*
* \param[in] section Section name
* \param[in] entry Entry name
* \param[in] params Configuration parameters
*/
void set(const std::string & section, const std::string & entry, const ConfigParamList & params);
/**
* \brief Global scope configuration parameters setter
*
* The entry is created unless it already exists.
*
* \param[in] entry Entry name
* \param[in] params Configuration parameters
*/
inline void set(const std::string & entry, const ConfigParamList & params)
{
set("", entry, params);
}
/**
* \brief Add configuration parameters
*
* The section and entry are created unless they already exist.
* Current parameters are kept, the provided are added to the list end.
*
* \param[in] section Section name
* \param[in] entry Entry name
* \param[in] params Configuration parameters
*/
void add(const std::string & section, const std::string & entry, const ConfigParamList & params);
/**
* \brief Add global scope configuration parameters
*
* The entry is created unless they already exists.
* Current parameters are kept, the provided are added to the list end.
*
* \param[in] entry Entry name
* \param[in] params Configuration parameters
*/
inline void add(const std::string & entry, const ConfigParamList & params)
{
add("", entry, params);
}
/**
* \brief Configuration parameters removal
*
* Removes the entry, only.
* Does nothing if the section or the entry don't exist.
*
* \param section Section name
* \param entry Entry name
*/
void remove(const std::string & section, const std::string & entry);
/**
* \brief Global scope configuration parameters removal
*
* Removes the entry, only.
* Does nothing if the entry don't exist.
*
* \param entry Entry name
*/
inline void remove(const std::string & entry)
{
remove("", entry);
}
/**
* \brief Configuration section removal
*
* Removes entire section (if exists).
*
* \param section Section name
*/
void removeSection(const std::string & section);
/** Global scope configuration removal */
inline void removeGlobal()
{
removeSection("");
}
/**
* \brief Configuration string getter
*
* Empty string is returned if the section or entry doesn't exist.
*
* \param section Section name
* \param entry Entry name
* \param caseSensitive Use case-sensitive entry name matching? (default: true)
*
* \return Configuration parameter as string
*/
std::string getStr(
const std::string & section,
const std::string & entry,
bool caseSensitive = true) const;
/**
* \brief Configuration string getter
*
* Empty string is returned if the section or entry doesn't exist.
*
* \param section Section name
* \param entry Entry name (as C char array or string literal)
* \param caseSensitive Use case-sensitive entry name matching? (default: true)
*
* \return Configuration parameter as string
*/
std::string getStr(
const std::string & section,
const char * entry,
bool caseSensitive = true) const
{
std::string sEntry{entry};
return getStr(section, sEntry, caseSensitive);
}
/**
* \brief Global scope configuration string getter
*
* Empty string is returned if the entry doesn't exist.
*
* \param entry Entry name
* \param caseSensitive Use case-sensitive entry name matching? (default: true)
*
* \return Configuration parameter as string
*/
inline std::string getStr(
const std::string & entry,
bool caseSensitive = true) const
{
return getStr("", entry, caseSensitive);
}
/**
* \brief Configuration string setter
*
* \param section Section name
* \param entry Entry name
* \param value Parameter value
*/
void setStr(
const std::string & section,
const std::string & entry,
const std::string & value);
/**
* \brief Global scope configuration string setter
*
* \param entry Entry name
* \param value Parameter value
*/
inline void setStr(
const std::string & entry,
const std::string & value)
{
setStr("", entry, value);
}
/**
* \brief Configuration flag getter
*
* False is returned if the section or entry doesn't exist.
* If a flag exists in configuration (any value is ignored),
* it is effectively True.
*
* \param section Section name
* \param entry Entry name
*
* \return Configuration parameter as boolean
*/
bool getFlag(
const std::string & section,
const std::string & entry) const;
/**
* \brief Global scope configuration flag getter
*
* False is returned if the entry doesn't exist.
* If a flag exists in configuration (any value is ignored),
* it is effectively True.
*
* \param entry Entry name
*
* \return Configuration parameter as boolean
*/
inline bool getFlag(const std::string & entry) const
{
return getFlag("", entry);
}
/**
* \brief Configuration flag setter (mentioned == true)
*
* Note: to unset a flag, we just use remove() method.
*
* \param section Section name
* \param entry Entry name
*/
void setFlag(
const std::string & section,
const std::string & entry,
bool val = true);
/**
* \brief Global scope configuration flag setter (mentioned == true)
*
* Note: to unset a flag, we just use remove() method.
*
* \param entry Entry name
*/
inline void setFlag(
const std::string & entry,
bool val = true)
{
setFlag("", entry, val);
}
/**
* \brief Configuration boolean option getter
*
* Value depends on original string representation of a setting.
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as boolean (or the default if not defined)
*/
bool getBool(
const std::string & section,
const std::string & entry,
bool val = false) const;
/**
* \brief Configuration boolean option getter
*
* Value depends on original string representation of a setting.
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as boolean (or the default if not defined)
*/
// Avoid error: implicit conversion turns string literal
// into bool: 'const char[7]' to 'bool'
bool getBool(
const std::string & section,
const char * entry,
bool val = false) const
{
return getBool(section, std::string(entry), val);
}
/**
* \brief Global scope configuration boolean option getter
*
* Value depends on original string representation of a setting.
*
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as boolean (or the default if not defined)
*/
inline bool getBool(const std::string & entry, bool val = false) const
{
return getBool("", entry, val);
}
/**
* \brief Configuration boolean option setter
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
inline void setBool(
const std::string & section,
const std::string & entry,
bool val = true)
{
setStr(section, entry, bool2str(val));
}
/**
* \brief Global scope configuration boolean option setter
*
* \param entry Entry name
* \param val Default value
*/
inline void setBool(
const std::string & entry,
bool val = true)
{
setBool("", entry, val);
}
/**
* \brief Configuration boolean option setter from a string
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
inline void setBool(
const std::string & section,
const std::string & entry,
const std::string & val = "true")
{
// Normalize:
bool b = str2bool(val);
setStr(section, entry, bool2str(b));
}
/**
* \brief Global scope configuration boolean option setter from a string
*
* \param entry Entry name
* \param val Default value
*/
inline void setBool(
const std::string & entry,
const std::string & val = "true")
{
setBool("", entry, val);
}
/**
* \brief Configuration number getter
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
long long int getInt(
const std::string & section,
const std::string & entry,
long long int val = 0) const;
/**
* \brief Global scope configuration number getter
*
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
inline long long int getInt(const std::string & entry, long long int val = 0) const
{
return getInt("", entry, val);
}
/**
* \brief Configuration number setter
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
void setInt(
const std::string & section,
const std::string & entry,
long long int val);
/**
* \brief Global scope configuration number setter
*
* \param entry Entry name
* \param val Default value
*/
inline void setInt(
const std::string & entry,
long long int val)
{
setInt("", entry, val);
}
/**
* \brief Configuration number getter (hex value even if without leading "0x")
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
long long int getIntHex(
const std::string & section,
const std::string & entry,
long long int val = 0) const;
/**
* \brief Global scope configuration number getter (hex value even if without leading "0x")
*
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
inline long long int getIntHex(const std::string & entry, long long int val = 0) const
{
return getIntHex("", entry, val);
}
/**
* \brief Configuration number setter (hex value even if without leading "0x")
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
void setIntHex(
const std::string & section,
const std::string & entry,
long long int val);
/**
* \brief Global scope configuration number setter (hex value even if without leading "0x")
*
* \param entry Entry name
* \param val Default value
*/
inline void setIntHex(
const std::string & entry,
long long int val)
{
setIntHex("", entry, val);
}
/**
* \brief Configuration floating-point number getter
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
double getDouble(
const std::string & section,
const std::string & entry,
double val = 0.0) const;
/**
* \brief Global scope configuration floating-point number getter
*
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as number (or the default if not defined)
*/
inline double getDouble(const std::string & entry, double val = 0.0) const
{
return getDouble("", entry, val);
}
/**
* \brief Configuration floating-point number setter
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
void setDouble(
const std::string & section,
const std::string & entry,
double val);
/**
* \brief Global scope configuration floating-point number setter
*
* \param entry Entry name
* \param val Default value
*/
inline void setDouble(
const std::string & entry,
double val)
{
setDouble("", entry, val);
}
/**
* \brief Cast numeric type with range check
*
* Throws an exception on cast error.
*
* \param number Number
* \param min Minimum
* \param max Maximum
*
* \return \c number which was cast to target type
*/
template <typename T>
static T range_cast(long long int number, long long int min, long long int max)
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::range_error)
#endif
{
if (number < min)
{
std::stringstream e;
e << "Failed to range-cast " << number << " (underflows " << min << ')';
throw std::range_error(e.str());
}
if (number > max)
{
std::stringstream e;
e << "Failed to range-cast " << number << " (overflows " << max << ')';
throw std::range_error(e.str());
}
return static_cast<T>(number);
}
/**
* \brief Configuration mixed boolean/int option getter
*
* Value depends on original string representation of a setting.
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as BoolInt type for original
* values which have a boolean or integer-numeric meaning
* (or the default if not defined)
*/
nut::BoolInt getBoolInt(
const std::string & section,
const std::string & entry,
nut::BoolInt val = false) const;
/**
* \brief Global scope configuration mixed boolean/int option getter
*
* Value depends on original string representation of a setting.
*
* \param entry Entry name
* \param val Default value
*
* \return Configuration parameter as BoolInt type for original
* values which have a boolean or integer-numeric meaning
* (or the default if not defined)
*/
inline nut::BoolInt getBoolInt(const std::string & entry, nut::BoolInt val = false) const
{
return getBoolInt("", entry, val);
}
/**
* \brief Configuration mixed boolean/int option setter
*
* Input value types are auto-converted through BoolInt
* type for sanity checks (e.g. throw exceptions for
* invalid string contents) and are stored as strings
* internally.
*
* \param section Section name
* \param entry Entry name
* \param val Default value
*/
inline void setBoolInt(
const std::string & section,
const std::string & entry,
nut::BoolInt val = true)
#if (defined __cplusplus) && (__cplusplus < 201100)
throw(std::invalid_argument)
#endif
{
setStr(section, entry, val);
}
/**
* \brief Global scope configuration mixed boolean/int option setter
*
* \param entry Entry name
* \param val Default value
*/
inline void setBoolInt(
const std::string & entry,
nut::BoolInt val = true)
{
setBoolInt("", entry, val);
}
/**
* \brief Resolve string as Boolean value
*
* \param str String
*
* \retval true IFF the string expresses a known true value
* \retval false otherwise (no errors emitted for bogus inputs)
*/
static bool str2bool(const std::string & str);
/**
* \brief Convert Boolean value to string
*
* \param val Boolean value
*
* \return \c val as string
*/
static const std::string & bool2str(bool val);
}; // end of class GenericConfiguration
class UpsmonConfiguration : public Serialisable
{
public:
UpsmonConfiguration();
void parseFromString(const std::string& str);
Settable<int> debugMin, pollFailLogThrottleMax;
Settable<int> offDuration, oblbDuration, overDuration;
Settable<std::string> runAsUser, shutdownCmd, notifyCmd, powerDownFlag;
/* yes|no (boolean) or a delay */
Settable<nut::BoolInt> shutdownExit;
/* practically boolean, but in 0|1 written form (bool01 fiddling) */
Settable<nut::BoolInt> certVerify, forceSsl, alarmCritical;
Settable<std::string> certPath;
CertIdent certIdent;
std::list<CertHost> certHosts;
Settable<unsigned int> minSupplies, pollFreq, pollFreqAlert, hostSync;
Settable<unsigned int> deadTime, rbWarnTime, noCommWarnTime, finalDelay;
enum NotifyFlag {
NOTIFY_IGNORE = 0,
NOTIFY_SYSLOG = 1,
NOTIFY_WALL = 1 << 1,
NOTIFY_EXEC = 1 << 2
};
enum NotifyType {
NOTIFY_ONLINE = 0,
NOTIFY_ONBATT,
NOTIFY_LOWBATT,
NOTIFY_FSD,
NOTIFY_COMMOK,
NOTIFY_COMMBAD,
NOTIFY_SHUTDOWN,
NOTIFY_REPLBATT,
NOTIFY_NOCOMM,
NOTIFY_NOPARENT,
NOTIFY_CAL,
NOTIFY_NOTCAL,
NOTIFY_OFF,
NOTIFY_NOTOFF,
NOTIFY_BYPASS,
NOTIFY_NOTBYPASS,
NOTIFY_ECO,
NOTIFY_NOTECO,
NOTIFY_ALARM,
NOTIFY_NOTALARM,
NOTIFY_OVER,
NOTIFY_NOTOVER,
NOTIFY_TRIM,
NOTIFY_NOTTRIM,
NOTIFY_BOOST,
NOTIFY_NOTBOOST,
NOTIFY_OTHER = 28,
NOTIFY_NOTOTHER,
NOTIFY_SUSPEND_STARTING = 30,
NOTIFY_SUSPEND_FINISHED,
NOTIFY_TYPE_MAX
};
static NotifyFlag NotifyFlagFromString(const std::string& str);
static NotifyType NotifyTypeFromString(const std::string& str);
Settable<unsigned int> notifyFlags[NOTIFY_TYPE_MAX];
Settable<std::string> notifyMessages[NOTIFY_TYPE_MAX];
struct Monitor {
std::string upsname, hostname;
uint16_t port;
unsigned int powerValue;
std::string username, password;
bool isPrimary;
};
std::list<Monitor> monitors;
/** Serialisable interface implementation \{ */
bool parseFrom(NutStream & istream) override;
bool writeTo(NutStream & ostream) const override;
/** \} */
}; // end of class UpsmonConfiguration
class UpsmonConfigParser : public NutConfigParser
{
public:
UpsmonConfigParser(const char* buffer = nullptr);
UpsmonConfigParser(const std::string& buffer);
void parseUpsmonConfig(UpsmonConfiguration* config);
protected:
virtual void onParseBegin() override;
virtual void onParseComment(const std::string& comment) override;
virtual void onParseSectionName(const std::string& sectionName, const std::string& comment = "") override;
virtual void onParseDirective(const std::string& directiveName, char sep = 0, const ConfigParamList& values = ConfigParamList(), const std::string& comment = "") override;
virtual void onParseEnd() override;
UpsmonConfiguration* _config;
};
class NutConfiguration: public Serialisable
{
public:
NutConfiguration();
void parseFromString(const std::string& str);
enum NutMode {
MODE_UNKNOWN = -1,
MODE_NONE = 0,
MODE_STANDALONE,
MODE_NETSERVER,
MODE_NETCLIENT,
MODE_CONTROLLED,
MODE_MANUAL,
};
Settable<NutMode> mode;
Settable<bool> allowNoDevice, allowNotAllListeners, poweroffQuiet;
Settable<std::string> upsdOptions, upsmonOptions;
Settable<unsigned int> poweroffWait;
Settable<int> debugLevel;
static NutMode NutModeFromString(const std::string& str);
/** Serialisable interface implementation \{ */
bool parseFrom(NutStream & istream) override;
bool writeTo(NutStream & ostream) const override;
/** \} */
};
class NutConfConfigParser : public NutConfigParser
{
public:
NutConfConfigParser(const char* buffer = nullptr);
NutConfConfigParser(const std::string& buffer);
void parseNutConfConfig(NutConfiguration* config);
protected:
virtual void onParseBegin() override;
virtual void onParseComment(const std::string& comment) override;
virtual void onParseSectionName(const std::string& sectionName, const std::string& comment = "") override;
virtual void onParseDirective(const std::string& directiveName, char sep = 0, const ConfigParamList& values = ConfigParamList(), const std::string& comment = "") override;
virtual void onParseEnd() override;
NutConfiguration* _config;
};
class UpsdConfiguration : public Serialisable
{
public:
UpsdConfiguration();
void parseFromString(const std::string& str);
Settable<int> debugMin;
Settable<unsigned int> maxAge, maxConn, trackingDelay, certRequestLevel;
Settable<std::string> statePath, certFile, certPath;
Settable<bool> allowNoDevice, allowNotAllListeners, disableWeakSsl;
struct Listen
{
std::string address;
Settable<uint16_t> port;
inline bool operator==(const Listen& listen)const
{
return address == listen.address && port == listen.port;
}
};
std::list<Listen> listens;
CertIdent certIdent;
/** Serialisable interface implementation \{ */
bool parseFrom(NutStream & istream) override;
bool writeTo(NutStream & ostream) const override;
/** \} */
};
class UpsdConfigParser : public NutConfigParser
{
public:
UpsdConfigParser(const char* buffer = nullptr);
UpsdConfigParser(const std::string& buffer);
void parseUpsdConfig(UpsdConfiguration* config);
protected:
virtual void onParseBegin() override;
virtual void onParseComment(const std::string& comment) override;
virtual void onParseSectionName(const std::string& sectionName, const std::string& comment = "") override;
virtual void onParseDirective(const std::string& directiveName, char sep = 0, const ConfigParamList& values = ConfigParamList(), const std::string& comment = "") override;
virtual void onParseEnd() override;
UpsdConfiguration* _config;
};
/** UPS configuration */
class UpsConfiguration : public GenericConfiguration
{
/* Note: key words for ups.conf are well collected from sources
* by augeas lens preparation scripts. Maintainers of this class
* can consume that information like this to see key words in
* context of their use in sources and documentation (omit the
* `continue` in grep of `nutconf.hpp` to see details of ALL
* keywords and not just those not yet covered by this class
* (e.g. to verify handling as str/int/bool/flag... types):
:; ( cd scripts/augeas && python ./gen-nutupsconf-aug.py.in )
:; grep -E '[=|] "' scripts/augeas/nutupsconf.aug.in | awk '{print $NF}' | tr -d '"' \
| while read O ; do echo "=== $O :" ; \
grep -w '"'"$O"'"' ./include/nutconf.hpp && continue ; \
{ cd ./docs/man/ && grep -A10 -w "$O" *.txt || echo '!!! UNDOCUMENTED !!!' ; } ; \
echo "-----"; { cd ./drivers && grep -A10 -w '"'"$O"'"' *.{c,h} || echo '!!! NOT USED IN CODE !!!' ; } ; \
echo "-----"; echo "" ; done | less
* Arrange found new keywords into two columns (first would be
* "C names" camel-cased and expanded as deemed fit) and generate
* lines for code blocks below as e.g.:
:; while read C O ; do \
printf '\tinline std::string get%-45sconst { return getStr(ups, "%s"); }\n' \
"$C"'(const std::string & ups)' "$O"; \
printf '\tinline void set%-75s{ setStr(ups, "%-22s val); }\n' \
"$C"'(const std::string & ups, const std::string & val)' "$O"'",' ; \
done < nutupsconf-newnames.bool | sort
*/
public:
/** Global configuration attributes getters and setters \{ */
inline std::string getChroot() const { return getStr("chroot"); }
inline std::string getDriverPath() const { return getStr("driverpath"); }
inline std::string getStatePath() const { return getStr("statepath", false); } // NOTE: accept it case-insensitively
inline std::string getGroup() const { return getStr("group"); }
inline std::string getSynchronous() const { return getStr("synchronous"); }
inline std::string getUser() const { return getStr("user"); }
// Flag - if exists then "true"
inline bool getNoWait() const { return getFlag("nowait"); }
inline long long int getDebugMin() const { return getInt("debug_min"); }
inline long long int getLibusbDebug() const { return getInt("LIBUSB_DEBUG"); }
inline long long int getMaxRetry() const { return getInt("maxretry"); }
inline long long int getMaxStartDelay() const { return getInt("maxstartdelay"); }
inline long long int getPollInterval() const { return getInt("pollinterval", 5); } // TODO: check the default
inline long long int getRetryDelay() const { return getInt("retrydelay"); }
inline void setChroot(const std::string & path) { setStr("chroot", path); }
inline void setDriverPath(const std::string & path) { setStr("driverpath", path); }
inline void setStatePath(const std::string & path) { setStr("statepath", path); }
inline void setGroup(const std::string & group) { setStr("group", group); }
inline void setSynchronous(const std::string & val) { setStr("synchronous", val); }
inline void setUser(const std::string & user) { setStr("user", user); }
inline void setNoWait(bool val = true) { setFlag("nowait", val); }
inline void setDebugMin(long long int num) { setInt("debug_min", num); }
inline void setLibusbDebug(long long int num) { setInt("LIBUSB_DEBUG", num); }
inline void setMaxRetry(long long int num) { setInt("maxretry", num); }
inline void setMaxStartDelay(long long int delay) { setInt("maxstartdelay", delay); }
inline void setPollInterval(long long int interval) { setInt("pollinterval", interval); }
inline void setRetryDelay(long long int delay) { setInt("retrydelay", delay); }
/** \} */
/** Generic <key>=<value> getter */
inline std::string getKey(const std::string & ups, const std::string & key) const { return getStr(ups, key); }
/** Generic <key>=<value> setter */
inline void setKey(const std::string & ups, const std::string & key, const std::string & val) {
setStr(ups, key, val);
}
/** PUZZLE: What to do about "default.*" and "override.*"
* settings that apply to anything (vars!) that follows?
* Maybe nest the UpsConfiguration objects, and so query
* e.g. upscfg.default.getBatteryNominalVoltage() ?
* Or just keep that info in ConfigParamList per section
* and wrap free-style queries? */
inline std::string getDefaultStr(const std::string & ups, const std::string & key) const { return getStr(ups, "default." + key); }
inline long long int getDefaultInt(const std::string & ups, const std::string & key) const { return getInt(ups, "default." + key); }
inline long long int getDefaultIntHex(const std::string & ups, const std::string & key) const { return getIntHex(ups, "default." + key); }
inline bool getDefaultFlag(const std::string & ups, const std::string & key) const { return getFlag(ups, "default." + key); }
inline bool getDefaultBool(const std::string & ups, const std::string & key) const { return getBool(ups, "default." + key); }
inline nut::BoolInt getDefaultBoolInt(const std::string & ups, const std::string & key) const { return getBoolInt(ups, "default." + key); }
inline double getDefaultDouble(const std::string & ups, const std::string & key) const { return getDouble(ups, "default." + key); }
inline std::string getOverrideStr(const std::string & ups, const std::string & key) const { return getStr(ups, "override." + key); }
inline long long int getOverrideInt(const std::string & ups, const std::string & key) const { return getInt(ups, "override." + key); }
inline long long int getOverrideIntHex(const std::string & ups, const std::string & key) const { return getIntHex(ups, "override." + key); }
inline bool getOverrideFlag(const std::string & ups, const std::string & key) const { return getFlag(ups, "override." + key); }
inline bool getOverrideBool(const std::string & ups, const std::string & key) const { return getBool(ups, "override." + key); }
inline nut::BoolInt getOverrideBoolInt(const std::string & ups, const std::string & key) const { return getBoolInt(ups, "override." + key); }
inline double getOverrideDouble(const std::string & ups, const std::string & key) const { return getDouble(ups, "override." + key); }
inline void setDefaultStr(const std::string & ups, const std::string & key, const std::string & val) { setStr(ups, "default." + key, val); }
inline void setDefaultInt(const std::string & ups, const std::string & key, long long int val) { setInt(ups, "default." + key, val); }
inline void setDefaultIntHex(const std::string & ups, const std::string & key, long long int val) { setIntHex(ups, "default." + key, val); }
inline void setDefaultFlag(const std::string & ups, const std::string & key, bool val = true) { setFlag(ups, "default." + key, val); }
inline void setDefaultBool(const std::string & ups, const std::string & key, bool val) { setBool(ups, "default." + key, val); }
inline void setDefaultBoolInt(const std::string & ups, const std::string & key, nut::BoolInt val) { setBoolInt(ups, "default." + key, val); }
inline void setDefaultDouble(const std::string & ups, const std::string & key, double val) { setDouble(ups, "default." + key, val); }
inline void setOverrideStr(const std::string & ups, const std::string & key, const std::string & val) { setStr(ups, "override." + key, val); }
inline void setOverrideInt(const std::string & ups, const std::string & key, long long int val) { setInt(ups, "override." + key, val); }
inline void setOverrideIntHex(const std::string & ups, const std::string & key, long long int val) { setIntHex(ups, "override." + key, val); }
inline void setOverrideFlag(const std::string & ups, const std::string & key, bool val = true) { setFlag(ups, "override." + key, val); }
inline void setOverrideBool(const std::string & ups, const std::string & key, bool val) { setBool(ups, "override." + key, val); }
inline void setOverrideBoolInt(const std::string & ups, const std::string & key, nut::BoolInt val) { setBoolInt(ups, "override." + key, val); }
inline void setOverrideDouble(const std::string & ups, const std::string & key, double val) { setDouble(ups, "override." + key, val); }
/** UPS-specific configuration attributes getters and setters \{ */
inline std::string getAuthPassword(const std::string & ups) const { return getStr(ups, "authPassword"); }
inline std::string getAuthProtocol(const std::string & ups) const { return getStr(ups, "authProtocol"); }
inline std::string getAuthType(const std::string & ups) const { return getStr(ups, "authtype"); }
inline std::string getAWD(const std::string & ups) const { return getStr(ups, "awd"); }
inline std::string getBatText(const std::string & ups) const { return getStr(ups, "battext"); }
inline std::string getBus(const std::string & ups) const { return getStr(ups, "bus"); }
inline std::string getCommunity(const std::string & ups) const { return getStr(ups, "community"); }
inline std::string getDriver(const std::string & ups) const { return getStr(ups, "driver"); }
inline std::string getDescription(const std::string & ups) const { return getStr(ups, "desc"); }
inline std::string getFRUID(const std::string & ups) const { return getStr(ups, "fruid"); }
inline std::string getGenericGPIO_Rules(const std::string & ups) const { return getStr(ups, "rules"); }
inline std::string getGenericUPS_BYPASS(const std::string & ups) const { return getStr(ups, "BYPASS"); }
inline std::string getGenericUPS_CP(const std::string & ups) const { return getStr(ups, "CP"); }
inline std::string getGenericUPS_LB(const std::string & ups) const { return getStr(ups, "LB"); }
inline std::string getGenericUPS_OL(const std::string & ups) const { return getStr(ups, "OL"); }
inline std::string getGenericUPS_RB(const std::string & ups) const { return getStr(ups, "RB"); }
inline std::string getGenericUPS_SD(const std::string & ups) const { return getStr(ups, "SD"); }
inline std::string getGroup(const std::string & ups) const { return getStr(ups, "group"); }
inline std::string getID(const std::string & ups) const { return getStr(ups, "ID"); }
inline std::string getLoadStatus(const std::string & ups) const { return getStr(ups, "load.status"); }
inline std::string getLogin(const std::string & ups) const { return getStr(ups, "login"); }
inline std::string getLowBatt(const std::string & ups) const { return getStr(ups, "LowBatt"); }
inline std::string getLowbatt(const std::string & ups) const { return getStr(ups, "lowbatt"); }
inline std::string getManufacturer(const std::string & ups) const { return getStr(ups, "manufacturer"); }
inline std::string getMethodOfFlowControl(const std::string & ups) const { return getStr(ups, "methodOfFlowControl"); }
inline std::string getMIBs(const std::string & ups) const { return getStr(ups, "mibs"); }
inline std::string getModbus_DeviceMfr(const std::string & ups) const { return getStr(ups, "device_mfr"); }
inline std::string getModbus_DeviceModel(const std::string & ups) const { return getStr(ups, "device_model"); }
inline std::string getModbus_Parity(const std::string & ups) const { return getStr(ups, "parity"); }
inline std::string getModbus_PortType(const std::string & ups) const { return getStr(ups, "porttype"); }
inline std::string getModbus_SerParity(const std::string & ups) const { return getStr(ups, "ser_parity"); }
inline std::string getModel(const std::string & ups) const { return getStr(ups, "model"); }
inline std::string getModelName(const std::string & ups) const { return getStr(ups, "modelname"); }
inline std::string getNotification(const std::string & ups) const { return getStr(ups, "notification"); }
inline std::string getPassword(const std::string & ups) const { return getStr(ups, "password"); }
inline std::string getPort(const std::string & ups) const { return getStr(ups, "port"); }
inline std::string getPrefix(const std::string & ups) const { return getStr(ups, "prefix"); }
inline std::string getPrivPassword(const std::string & ups) const { return getStr(ups, "privPassword"); }
inline std::string getPrivProtocol(const std::string & ups) const { return getStr(ups, "privProtocol"); }
inline std::string getProduct(const std::string & ups) const { return getStr(ups, "product"); }
inline std::string getProductID(const std::string & ups) const { return getStr(ups, "productid"); }
inline std::string getProtocol(const std::string & ups) const { return getStr(ups, "protocol"); }
inline std::string getRuntimeCal(const std::string & ups) const { return getStr(ups, "runtimecal"); }
inline std::string getSDType(const std::string & ups) const { return getStr(ups, "sdtype"); }
inline std::string getSecLevel(const std::string & ups) const { return getStr(ups, "secLevel"); }
inline std::string getSecName(const std::string & ups) const { return getStr(ups, "secName"); }
inline std::string getSensorID(const std::string & ups) const { return getStr(ups, "sensorid"); }
inline std::string getSerial(const std::string & ups) const { return getStr(ups, "serial"); }
inline std::string getSerialNumber(const std::string & ups) const { return getStr(ups, "serialnumber"); }
inline std::string getShutdownArguments(const std::string & ups) const { return getStr(ups, "shutdownArguments"); }
inline std::string getSNMPversion(const std::string & ups) const { return getStr(ups, "snmp_version"); }
inline std::string getSubdriver(const std::string & ups) const { return getStr(ups, "subdriver"); }
inline std::string getSynchronous(const std::string & ups) const { return getStr(ups, "synchronous"); }
inline std::string getTtyMode(const std::string & ups) const { return getStr(ups, "ttymode"); }
inline std::string getType(const std::string & ups) const { return getStr(ups, "type"); }
inline std::string getUPStype(const std::string & ups) const { return getStr(ups, "upstype"); }
inline std::string getUpsId(const std::string & ups) const { return getStr(ups, "upsid"); }
inline std::string getUsbBusPort(const std::string & ups) const { return getStr(ups, "busport"); }
inline std::string getUsbDevice(const std::string & ups) const { return getStr(ups, "device"); }
inline std::string getUSD(const std::string & ups) const { return getStr(ups, "usd"); }
inline std::string getUser(const std::string & ups) const { return getStr(ups, "user"); }
inline std::string getUsername(const std::string & ups) const { return getStr(ups, "username"); }
inline std::string getValidationSequence(const std::string & ups) const { return getStr(ups, "validationSequence"); }
inline std::string getVendor(const std::string & ups) const { return getStr(ups, "vendor"); }
inline std::string getVendorID(const std::string & ups) const { return getStr(ups, "vendorid"); }
inline std::string getWorkRangeType(const std::string & ups) const { return getStr(ups, "work_range_type"); }
inline std::string getWUGrace(const std::string & ups) const { return getStr(ups, "wugrace"); }
// Items below are "unused" - mostly set in
// drivers/nutdrv_qx_masterguard.c
inline std::string getFault1(const std::string & ups) const { return getStr(ups, "fault_1"); }
inline std::string getFault2(const std::string & ups) const { return getStr(ups, "fault_2"); }
inline std::string getFault3(const std::string & ups) const { return getStr(ups, "fault_3"); }
inline std::string getFault4(const std::string & ups) const { return getStr(ups, "fault_4"); }
inline std::string getFault5(const std::string & ups) const { return getStr(ups, "fault_5"); }
inline std::string getInputFaultVoltage(const std::string & ups) const { return getStr(ups, "input_fault_voltage"); }
inline std::string getNominalCellVoltage(const std::string & ups) const { return getStr(ups, "nominal_cell_voltage"); }
inline std::string getNumberOfBatteryCells(const std::string & ups)const { return getStr(ups, "number_of_battery_cells"); }
inline std::string getOutputVoltages(const std::string & ups) const { return getStr(ups, "output_voltages"); }
inline std::string getRechargeTime(const std::string & ups) const { return getStr(ups, "recharge_time"); }
inline std::string getRuntimeFull(const std::string & ups) const { return getStr(ups, "runtime_full"); }
inline std::string getRuntimeHalf(const std::string & ups) const { return getStr(ups, "runtime_half"); }
inline std::string getSeries(const std::string & ups) const { return getStr(ups, "series"); }
// Items below are essentially booleans (expected values
// are "enabled/disabled") -- refactoring planned per
// https://github.com/networkupstools/nut/issues/2421
inline std::string getAdvancedEcoMode(const std::string & ups) const { return getStr(ups, "advanced_eco_mode"); }
inline std::string getAlarmControl(const std::string & ups) const { return getStr(ups, "alarm_control"); }
inline std::string getBatteryAlarm(const std::string & ups) const { return getStr(ups, "battery_alarm"); }
inline std::string getBatteryOpenStatusCheck(const std::string & ups)const { return getStr(ups, "battery_open_status_check"); }
inline std::string getBypassAlarm(const std::string & ups) const { return getStr(ups, "bypass_alarm"); }
inline std::string getBypassForbidding(const std::string & ups) const { return getStr(ups, "bypass_forbidding"); }
inline std::string getBypassWhenOff(const std::string & ups) const { return getStr(ups, "bypass_when_off"); }
inline std::string getConstantPhaseAngle(const std::string & ups) const { return getStr(ups, "constant_phase_angle"); }
inline std::string getConverterMode(const std::string & ups) const { return getStr(ups, "converter_mode"); }
inline std::string getEcoMode(const std::string & ups) const { return getStr(ups, "eco_mode"); }
inline std::string getLimitedRuntimeOnBattery(const std::string & ups)const { return getStr(ups, "limited_runtime_on_battery"); }
inline std::string getSiteFaultDetection(const std::string & ups) const { return getStr(ups, "site_fault_detection"); }
inline long long int getAdvOrder(const std::string & ups) const { return getInt(ups, "advorder"); } // CHECKME
inline long long int getAsem_HB(const std::string & ups) const { return getInt(ups, "hb"); }
inline long long int getAsem_LB(const std::string & ups) const { return getInt(ups, "lb"); }
inline long long int getBatteryNumber(const std::string & ups) const { return getInt(ups, "battery_number"); }
inline long long int getBatteryPercentage(const std::string & ups) const { return getInt(ups, "batteryPercentage"); } // CHECKME
inline long long int getBattVoltMult(const std::string & ups) const { return getInt(ups, "battvoltmult"); } // CHECKME
inline long long int getBaudRate(const std::string & ups) const { return getInt(ups, "baud_rate"); } // CHECKME
inline long long int getBaudrate(const std::string & ups) const { return getInt(ups, "baudrate"); } // CHECKME
inline long long int getCablePower(const std::string & ups) const { return getInt(ups, "cablepower"); } // CHECKME
inline long long int getChargeTime(const std::string & ups) const { return getInt(ups, "chargetime"); } // CHECKME
inline long long int getDaysOff(const std::string & ups) const { return getInt(ups, "daysoff"); } // CHECKME
inline long long int getDaySweek(const std::string & ups) const { return getInt(ups, "daysweek"); } // CHECKME
inline long long int getDebugMin(const std::string & ups) const { return getInt(ups, "debug_min"); }
inline long long int getLibusbDebug(const std::string & ups) const { return getInt(ups, "LIBUSB_DEBUG"); }
inline long long int getFrequency(const std::string & ups) const { return getInt(ups, "frequency"); } // CHECKME
inline long long int getHourOff(const std::string & ups) const { return getInt(ups, "houroff"); } // CHECKME
inline long long int getHourOn(const std::string & ups) const { return getInt(ups, "houron"); } // CHECKME
inline long long int getI2C_address(const std::string & ups) const { return getInt(ups, "i2c_address"); }
inline long long int getIdleLoad(const std::string & ups) const { return getInt(ups, "idleload"); } // CHECKME
inline long long int getInputTimeout(const std::string & ups) const { return getInt(ups, "input_timeout"); } // CHECKME
inline long long int getInterruptPipeNoEventsTolerance(const std::string & ups) const { return getInt(ups, "interrupt_pipe_no_events_tolerance"); }
inline long long int getInterruptSize(const std::string & ups) const { return getInt(ups, "interruptsize"); }
inline long long int getLineVoltage(const std::string & ups) const { return getInt(ups, "linevoltage"); } // CHECKME
inline long long int getLoadpercentage(const std::string & ups) const { return getInt(ups, "loadPercentage"); } // CHECKME
inline long long int getMaxLoad(const std::string & ups) const { return getInt(ups, "max_load"); } // CHECKME
inline long long int getMaxPollsWithoutData(const std::string & ups) const { return getInt(ups, "max_polls_without_data"); }
inline long long int getMaxStartDelay(const std::string & ups) const { return getInt(ups, "maxstartdelay"); }
inline long long int getMFR(const std::string & ups) const { return getInt(ups, "mfr"); } // CHECKME
inline long long int getMinCharge(const std::string & ups) const { return getInt(ups, "mincharge"); } // CHECKME
inline long long int getMinRuntime(const std::string & ups) const { return getInt(ups, "minruntime"); } // CHECKME
inline long long int getModbus_ByteTimeoutSec(const std::string & ups) const { return getInt(ups, "mod_byte_to_s"); }
inline long long int getModbus_ByteTimeoutUsec(const std::string & ups) const { return getInt(ups, "mod_byte_to_us"); }
inline long long int getModbus_CHRG_addr(const std::string & ups) const { return getInt(ups, "CHRG_addr"); }
inline long long int getModbus_CHRG_noro(const std::string & ups) const { return getInt(ups, "CHRG_noro"); }
inline long long int getModbus_CHRG_regtype(const std::string & ups) const { return getInt(ups, "CHRG_regtype"); }
inline long long int getModbus_DISCHRG_addr(const std::string & ups) const { return getInt(ups, "DISCHRG_addr"); }
inline long long int getModbus_DISCHRG_noro(const std::string & ups) const { return getInt(ups, "DISCHRG_noro"); }
inline long long int getModbus_DISCHRG_regtype(const std::string & ups) const { return getInt(ups, "DISCHRG_regtype"); }
inline long long int getModbus_DataBits(const std::string & ups) const { return getInt(ups, "databits"); }
inline long long int getModbus_DeviceSlaveId(const std::string & ups) const { return getInt(ups, "dev_slave_id"); }
inline long long int getModbus_FSD_addr(const std::string & ups) const { return getInt(ups, "FSD_addr"); }
inline long long int getModbus_FSD_noro(const std::string & ups) const { return getInt(ups, "FSD_noro"); }
inline long long int getModbus_FSD_pulse_duration(const std::string & ups) const { return getInt(ups, "FSD_pulse_duration"); }
inline long long int getModbus_FSD_regtype(const std::string & ups) const { return getInt(ups, "FSD_regtype"); }
inline long long int getModbus_HB_addr(const std::string & ups) const { return getInt(ups, "HB_addr"); }
inline long long int getModbus_HB_noro(const std::string & ups) const { return getInt(ups, "HB_noro"); }
inline long long int getModbus_HB_regtype(const std::string & ups) const { return getInt(ups, "HB_regtype"); }
inline long long int getModbus_LB_addr(const std::string & ups) const { return getInt(ups, "LB_addr"); }
inline long long int getModbus_LB_noro(const std::string & ups) const { return getInt(ups, "LB_noro"); }
inline long long int getModbus_LB_regtype(const std::string & ups) const { return getInt(ups, "LB_regtype"); }
inline long long int getModbus_OB_addr(const std::string & ups) const { return getInt(ups, "OB_addr"); }
inline long long int getModbus_OB_noro(const std::string & ups) const { return getInt(ups, "OB_noro"); }
inline long long int getModbus_OB_regtype(const std::string & ups) const { return getInt(ups, "OB_regtype"); }
inline long long int getModbus_OL_addr(const std::string & ups) const { return getInt(ups, "OL_addr"); }
inline long long int getModbus_OL_noro(const std::string & ups) const { return getInt(ups, "OL_noro"); }
inline long long int getModbus_OL_regtype(const std::string & ups) const { return getInt(ups, "OL_regtype"); }
inline long long int getModbus_RB_addr(const std::string & ups) const { return getInt(ups, "RB_addr"); }
inline long long int getModbus_RB_noro(const std::string & ups) const { return getInt(ups, "RB_noro"); }
inline long long int getModbus_RB_regtype(const std::string & ups) const { return getInt(ups, "RB_regtype"); }
inline long long int getModbus_ResponseTimeoutMsec(const std::string & ups)const { return getInt(ups, "response_timeout_ms"); }
inline long long int getModbus_ResponseTimeoutSec(const std::string & ups) const { return getInt(ups, "mod_resp_to_s"); }
inline long long int getModbus_ResponseTimeoutUsec(const std::string & ups)const { return getInt(ups, "mod_resp_to_us"); }
inline long long int getModbus_RioSlaveId(const std::string & ups) const { return getInt(ups, "rio_slave_id"); }
inline long long int getModbus_SerBaudRate(const std::string & ups) const { return getInt(ups, "ser_baud_rate"); }
inline long long int getModbus_SerDataBit(const std::string & ups) const { return getInt(ups, "ser_data_bit"); }
inline long long int getModbus_SerStopBit(const std::string & ups) const { return getInt(ups, "ser_stop_bit"); }
inline long long int getModbus_SlaveId(const std::string & ups) const { return getInt(ups, "slaveid"); }
inline long long int getModbus_StopBits(const std::string & ups) const { return getInt(ups, "stopbits"); }
inline long long int getNomBattVolt(const std::string & ups) const { return getInt(ups, "nombattvolt"); } // CHECKME
inline long long int getNumOfBytesFromUPS(const std::string & ups) const { return getInt(ups, "numOfBytesFromUPS"); } // CHECKME
inline long long int getOffDelay(const std::string & ups) const { return getInt(ups, "OffDelay"); } // CHECKME
inline long long int getOffdelay(const std::string & ups) const { return getInt(ups, "offdelay"); } // CHECKME
inline long long int getOnDelay(const std::string & ups) const { return getInt(ups, "OnDelay"); } // CHECKME
inline long long int getOndelay(const std::string & ups) const { return getInt(ups, "ondelay"); } // CHECKME
inline long long int getOnlineDischargeLogThrottleHovercharge(const std::string & ups)const { return getInt(ups, "onlinedischarge_log_throttle_hovercharge"); }
inline long long int getOnlineDischargeLogThrottleSec(const std::string & ups)const { return getInt(ups, "onlinedischarge_log_throttle_sec"); }
inline long long int getOutputPace(const std::string & ups) const { return getInt(ups, "output_pace"); } // CHECKME
inline long long int getOutputPhaseAngle(const std::string & ups) const { return getInt(ups, "output_phase_angle"); }
inline long long int getPinsShutdownMode(const std::string & ups) const { return getInt(ups, "pins_shutdown_mode"); }
inline long long int getPollFreq(const std::string & ups) const { return getInt(ups, "pollfreq"); } // CHECKME
inline long long int getPowerUp(const std::string & ups) const { return getInt(ups, "powerup"); } // CHECKME
inline long long int getPrgShut(const std::string & ups) const { return getInt(ups, "prgshut"); } // CHECKME
inline long long int getRebootDelay(const std::string & ups) const { return getInt(ups, "rebootdelay"); } // CHECKME
inline long long int getSDOrder(const std::string & ups) const { return getInt(ups, "sdorder"); } // TODO: Is that a number?
inline long long int getSDtime(const std::string & ups) const { return getInt(ups, "sdtime"); } // CHECKME
inline long long int getSemistaticFreq(const std::string & ups) const { return getInt(ups, "semistaticfreq"); }
inline long long int getShutdownDelay(const std::string & ups) const { return getInt(ups, "shutdown_delay"); } // CHECKME
inline long long int getShutdownDuration(const std::string & ups) const { return getInt(ups, "shutdown_duration"); }
inline long long int getShutdownTimer(const std::string & ups) const { return getInt(ups, "shutdown_timer"); }
inline long long int getSlaveAddress(const std::string & ups) const { return getInt(ups, "slave_address"); }
inline long long int getSnmpRetries(const std::string & ups) const { return getInt(ups, "snmp_retries"); }
inline long long int getSnmpTimeout(const std::string & ups) const { return getInt(ups, "snmp_timeout"); }
inline long long int getStartDelay(const std::string & ups) const { return getInt(ups, "startdelay"); } // CHECKME
inline long long int getTestTime(const std::string & ups) const { return getInt(ups, "testtime"); } // CHECKME
inline long long int getTimeout(const std::string & ups) const { return getInt(ups, "timeout"); } // CHECKME
inline long long int getUPSdelayShutdown(const std::string & ups) const { return getInt(ups, "ups.delay.shutdown"); } // CHECKME
inline long long int getUPSdelayStart(const std::string & ups) const { return getInt(ups, "ups.delay.start"); } // CHECKME
inline long long int getVoltage(const std::string & ups) const { return getInt(ups, "voltage"); } // CHECKME
inline long long int getWaitBeforeReconnect(const std::string & ups) const { return getInt(ups, "waitbeforereconnect"); }
/** belkinunv: both a flag (wait for AC power) and value (also wait for charge level) */
inline long long int getWait(const std::string & ups) const { return getInt(ups, "wait"); }
/** May be a flag or a number; 0 is among valid values (default -1 for unset) */
inline long long int getUsbSetAltInterface(const std::string & ups) const { return getInt(ups, "usb_set_altinterface", -1); } // CHECKME
// NUT specifies these as "hexnum" values (optionally with prefixed 0x but hex anyway)
inline long long int getUsbConfigIndex(const std::string & ups) const { return getIntHex(ups, "usb_config_index"); } // CHECKME
inline long long int getUsbHidDescIndex(const std::string & ups) const { return getIntHex(ups, "usb_hid_desc_index"); } // CHECKME
inline long long int getUsbHidRepIndex(const std::string & ups) const { return getIntHex(ups, "usb_hid_rep_index"); } // CHECKME
inline long long int getUsbHidEndpointIn(const std::string & ups) const { return getIntHex(ups, "usb_hid_ep_in"); } // CHECKME
inline long long int getUsbHidEndpointOut(const std::string & ups) const { return getIntHex(ups, "usb_hid_ep_out"); } // CHECKME
inline double getBatteryMax(const std::string & ups) const { return getDouble(ups, "battery_max"); }
inline double getBatteryMin(const std::string & ups) const { return getDouble(ups, "battery_min"); }
inline double getCSHackDelay(const std::string & ups) const { return getDouble(ups, "cshdelay"); }
inline double getMaxBypassFreq(const std::string & ups) const { return getDouble(ups, "max_bypass_freq"); }
inline double getMaxBypassVolt(const std::string & ups) const { return getDouble(ups, "max_bypass_volt"); }
inline double getMinBypassFreq(const std::string & ups) const { return getDouble(ups, "min_bypass_freq"); }
inline double getMinBypassVolt(const std::string & ups) const { return getDouble(ups, "min_bypass_volt"); }
// Flag - if exists then "true"
inline bool getCancelShutdown(const std::string & ups) const { return getFlag(ups, "CS"); }
inline bool getDumbTerm(const std::string & ups) const { return getFlag(ups, "dumbterm"); }
inline bool getExplore(const std::string & ups) const { return getFlag(ups, "explore"); }
inline bool getFakeLowBatt(const std::string & ups) const { return getFlag(ups, "fake_lowbatt"); }
inline bool getFlash(const std::string & ups) const { return getFlag(ups, "flash"); }
inline bool getIgnoreLB(const std::string & ups) const { return getFlag(ups, "ignorelb"); }
inline bool getNoHang(const std::string & ups) const { return getFlag(ups, "nohang"); }
inline bool getNoRating(const std::string & ups) const { return getFlag(ups, "norating"); }
inline bool getNoTransferOIDs(const std::string & ups) const { return getFlag(ups, "notransferoids"); }
inline bool getNoVendor(const std::string & ups) const { return getFlag(ups, "novendor"); }
inline bool getNoWarnNoImp(const std::string & ups) const { return getFlag(ups, "nowarn_noimp"); }
inline bool getOldMAC(const std::string & ups) const { return getFlag(ups, "oldmac"); }
inline bool getPollOnly(const std::string & ups) const { return getFlag(ups, "pollonly"); }
inline bool getSilent(const std::string & ups) const { return getFlag(ups, "silent"); }
inline bool getStatusOnly(const std::string & ups) const { return getFlag(ups, "status_only"); }
inline bool getSubscribe(const std::string & ups) const { return getFlag(ups, "subscribe"); }
inline bool getUseCRLF(const std::string & ups) const { return getFlag(ups, "use_crlf"); }
inline bool getUsePreLF(const std::string & ups) const { return getFlag(ups, "use_pre_lf"); }
inline bool getNolock(const std::string & ups) const { return getBool(ups, "nolock"); }
inline bool getCable(const std::string & ups) const { return getBool(ups, "cable"); }
inline bool getFullUpdate(const std::string & ups) const { return getBool(ups, "full_update"); }
inline bool getLangIDfix(const std::string & ups) const { return getBool(ups, "langid_fix"); }
inline bool getLoadOff(const std::string & ups) const { return getBool(ups, "load.off"); }
inline bool getLoadOn(const std::string & ups) const { return getBool(ups, "load.on"); }
inline void setAuthPassword(const std::string & ups, const std::string & auth_passwd) { setStr(ups, "authPassword", auth_passwd); }
inline void setAuthProtocol(const std::string & ups, const std::string & auth_proto) { setStr(ups, "authProtocol", auth_proto); }
inline void setAuthType(const std::string & ups, const std::string & authtype) { setStr(ups, "authtype", authtype); }
inline void setAWD(const std::string & ups, const std::string & awd) { setStr(ups, "awd", awd); }
inline void setBatText(const std::string & ups, const std::string & battext) { setStr(ups, "battext", battext); }
inline void setBus(const std::string & ups, const std::string & bus) { setStr(ups, "bus", bus); }
inline void setCommunity(const std::string & ups, const std::string & community) { setStr(ups, "community", community); }
inline void setDriver(const std::string & ups, const std::string & driver) { setStr(ups, "driver", driver); }
inline void setDescription(const std::string & ups, const std::string & desc) { setStr(ups, "desc", desc); }
inline void setFRUID(const std::string & ups, const std::string & fruid) { setStr(ups, "fruid", fruid); }
inline void setGenericGPIO_Rules(const std::string & ups, const std::string & val) { setStr(ups, "rules", val); }
inline void setGenericUPS_BYPASS(const std::string & ups, const std::string & bypass) { setStr(ups, "BYPASS", bypass); }
inline void setGenericUPS_CP(const std::string & ups, const std::string & cp) { setStr(ups, "CP", cp); }
inline void setGenericUPS_LB(const std::string & ups, const std::string & lb) { setStr(ups, "LB", lb); }
inline void setGenericUPS_OL(const std::string & ups, const std::string & ol) { setStr(ups, "OL", ol); }
inline void setGenericUPS_RB(const std::string & ups, const std::string & rb) { setStr(ups, "RB", rb); }
inline void setGenericUPS_SD(const std::string & ups, const std::string & sd) { setStr(ups, "SD", sd); }
inline void setGroup(const std::string & ups, const std::string & group) { setStr(ups, "group", group); }
inline void setLoadStatus(const std::string & ups, const std::string & load_status) { setStr(ups, "load.status", load_status); }
inline void setLogin(const std::string & ups, const std::string & login) { setStr(ups, "login", login); }
inline void setLowBatt(const std::string & ups, const std::string & lowbatt) { setStr(ups, "LowBatt", lowbatt); }
inline void setLowbatt(const std::string & ups, const std::string & lowbatt) { setStr(ups, "lowbatt", lowbatt); }
inline void setManufacturer(const std::string & ups, const std::string & manufacturer) { setStr(ups, "manufacturer", manufacturer); }
inline void setMethodOfFlowControl(const std::string & ups, const std::string & method) { setStr(ups, "methodOfFlowControl", method); }
inline void setMIBs(const std::string & ups, const std::string & mibs) { setStr(ups, "mibs", mibs); }
inline void setModbus_DeviceMfr(const std::string & ups, const std::string & val) { setStr(ups, "device_mfr", val); }
inline void setModbus_DeviceModel(const std::string & ups, const std::string & val) { setStr(ups, "device_model", val); }
inline void setModbus_Parity(const std::string & ups, const std::string & val) { setStr(ups, "parity", val); }
inline void setModbus_PortType(const std::string & ups, const std::string & val) { setStr(ups, "porttype", val); }
inline void setModbus_SerParity(const std::string & ups, const std::string & val) { setStr(ups, "ser_parity", val); }
inline void setModel(const std::string & ups, const std::string & model) { setStr(ups, "model", model); }
inline void setModelName(const std::string & ups, const std::string & modelname) { setStr(ups, "modelname", modelname); }
inline void setNotification(const std::string & ups, const std::string & notification) { setStr(ups, "notification", notification); }
inline void setPassword(const std::string & ups, const std::string & password) { setStr(ups, "password", password); }
inline void setPort(const std::string & ups, const std::string & port) { setStr(ups, "port", port); }
inline void setPrefix(const std::string & ups, const std::string & prefix) { setStr(ups, "prefix", prefix); }
inline void setPrivPassword(const std::string & ups, const std::string & priv_passwd) { setStr(ups, "privPassword", priv_passwd); }
inline void setPrivProtocol(const std::string & ups, const std::string & priv_proto) { setStr(ups, "privProtocol", priv_proto); }
inline void setProduct(const std::string & ups, const std::string & product) { setStr(ups, "product", product); }
inline void setProductID(const std::string & ups, const std::string & productid) { setStr(ups, "productid", productid); }
inline void setProtocol(const std::string & ups, const std::string & protocol) { setStr(ups, "protocol", protocol); }
inline void setRuntimeCal(const std::string & ups, const std::string & runtimecal) { setStr(ups, "runtimecal", runtimecal); }
inline void setSDtype(const std::string & ups, const std::string & sdtype) { setStr(ups, "sdtype", sdtype); }
inline void setSecLevel(const std::string & ups, const std::string & sec_level) { setStr(ups, "secLevel", sec_level); }
inline void setSecName(const std::string & ups, const std::string & sec_name) { setStr(ups, "secName", sec_name); }
inline void setSensorID(const std::string & ups, const std::string & sensorid) { setStr(ups, "sensorid", sensorid); }
inline void setSerial(const std::string & ups, const std::string & serial) { setStr(ups, "serial", serial); }
inline void setSerialNumber(const std::string & ups, const std::string & serialnumber) { setStr(ups, "serialnumber", serialnumber); }
inline void setShutdownArguments(const std::string & ups, const std::string & sd_args) { setStr(ups, "shutdownArguments", sd_args); }
inline void setSNMPversion(const std::string & ups, const std::string & snmp_version) { setStr(ups, "snmp_version", snmp_version); }
inline void setSubdriver(const std::string & ups, const std::string & subdriver) { setStr(ups, "subdriver", subdriver); }
inline void setSynchronous(const std::string & ups, const std::string & synchronous) { setStr(ups, "synchronous", synchronous); }
inline void setTtyMode(const std::string & ups, const std::string & val) { setStr(ups, "ttymode", val); }
inline void setType(const std::string & ups, const std::string & type) { setStr(ups, "type", type); }
inline void setUPStype(const std::string & ups, const std::string & upstype) { setStr(ups, "upstype", upstype); }
inline void setUpsId(const std::string & ups, const std::string & val) { setStr(ups, "upsid", val); }
inline void setUsbBusPort(const std::string & ups, const std::string & val) { setStr(ups, "busport", val); }
inline void setUsbDevice(const std::string & ups, const std::string & val) { setStr(ups, "device", val); }
inline void setUSD(const std::string & ups, const std::string & usd) { setStr(ups, "usd", usd); }
inline void setUsername(const std::string & ups, const std::string & username) { setStr(ups, "username", username); }
inline void setUser(const std::string & ups, const std::string & user) { setStr(ups, "user", user); }
inline void setValidationSequence(const std::string & ups, const std::string & valid_seq) { setStr(ups, "validationSequence", valid_seq); }
inline void setVendor(const std::string & ups, const std::string & vendor) { setStr(ups, "vendor", vendor); }
inline void setVendorID(const std::string & ups, const std::string & vendorid) { setStr(ups, "vendorid", vendorid); }
inline void setWorkRangeType(const std::string & ups, const std::string & val) { setStr(ups, "work_range_type", val); }
inline void setWUGrace(const std::string & ups, const std::string & wugrace) { setStr(ups, "wugrace", wugrace); }
inline void setADVorder(const std::string & ups, long long int advorder) { setInt(ups, "advorder", advorder); } // CHECKME
inline void setAsem_HB(const std::string & ups, long long int val) { setInt(ups, "hb", val); }
inline void setAsem_LB(const std::string & ups, long long int val) { setInt(ups, "lb", val); }
inline void setBatteryNumber(const std::string & ups, long long int val) { setInt(ups, "battery_number", val); }
inline void setBatteryPercentage(const std::string & ups, long long int batt) { setInt(ups, "batteryPercentage", batt); } // CHECKME
inline void setBattVoltMult(const std::string & ups, long long int mult) { setInt(ups, "battvoltmult", mult); } // CHECKME
inline void setBaudRate(const std::string & ups, long long int baud_rate) { setInt(ups, "baud_rate", baud_rate); } // CHECKME
inline void setBaudrate(const std::string & ups, long long int baudrate) { setInt(ups, "baudrate", baudrate); } // CHECKME
inline void setCablePower(const std::string & ups, long long int cablepower) { setInt(ups, "cablepower", cablepower); } // CHECKME
inline void setChargeTime(const std::string & ups, long long int chargetime) { setInt(ups, "chargetime", chargetime); } // CHECKME
inline void setDaysOff(const std::string & ups, long long int daysoff) { setInt(ups, "daysoff", daysoff); } // CHECKME
inline void setDaysWeek(const std::string & ups, long long int daysweek) { setInt(ups, "daysweek", daysweek); } // CHECKME
inline void setDebugMin(const std::string & ups, long long int val) { setInt(ups, "debug_min", val); }
inline void setLibusbDebug(const std::string & ups, long long int val) { setInt(ups, "LIBUSB_DEBUG", val); }
inline void setFrequency(const std::string & ups, long long int frequency) { setInt(ups, "frequency", frequency); } // CHECKME
inline void setHourOff(const std::string & ups, long long int houroff) { setInt(ups, "houroff", houroff); } // CHECKME
inline void setHourOn(const std::string & ups, long long int houron) { setInt(ups, "houron", houron); } // CHECKME
inline void setI2C_address(const std::string & ups, long long int val) { setInt(ups, "i2c_address", val); }
inline void setIdleLoad(const std::string & ups, long long int idleload) { setInt(ups, "idleload", idleload); } // CHECKME
inline void setInputTimeout(const std::string & ups, long long int timeout) { setInt(ups, "input_timeout", timeout); } // CHECKME
inline void setInterruptPipeNoEventsTolerance(const std::string & ups, long long int val) { setInt(ups, "interrupt_pipe_no_events_tolerance", val); }
inline void setInterruptSize(const std::string & ups, long long int val) { setInt(ups, "interruptsize", val); }
inline void setLineVoltage(const std::string & ups, long long int linevoltage) { setInt(ups, "linevoltage", linevoltage); } // CHECKME
inline void setLoadpercentage(const std::string & ups, long long int load) { setInt(ups, "loadPercentage", load); } // CHECKME
inline void setMaxLoad(const std::string & ups, long long int max_load) { setInt(ups, "max_load", max_load); } // CHECKME
inline void setMaxPollsWithoutData(const std::string & ups, long long int val) { setInt(ups, "max_polls_without_data", val); }
inline void setMaxStartDelay(const std::string & ups, long long int delay) { setInt(ups, "maxstartdelay", delay); }
inline void setMFR(const std::string & ups, long long int mfr) { setInt(ups, "mfr", mfr); } // CHECKME
inline void setMinCharge(const std::string & ups, long long int mincharge) { setInt(ups, "mincharge", mincharge); } // CHECKME
inline void setMinRuntime(const std::string & ups, long long int minruntime) { setInt(ups, "minruntime", minruntime); } // CHECKME
inline void setModbus_ByteTimeoutSec(const std::string & ups, long long int val) { setInt(ups, "mod_byte_to_s", val); }
inline void setModbus_ByteTimeoutUsec(const std::string & ups, long long int val) { setInt(ups, "mod_byte_to_us", val); }
inline void setModbus_CHRG_addr(const std::string & ups, long long int val) { setInt(ups, "CHRG_addr", val); }
inline void setModbus_CHRG_noro(const std::string & ups, long long int val) { setInt(ups, "CHRG_noro", val); }
inline void setModbus_CHRG_regtype(const std::string & ups, long long int val) { setInt(ups, "CHRG_regtype", val); }
inline void setModbus_DISCHRG_addr(const std::string & ups, long long int val) { setInt(ups, "DISCHRG_addr", val); }
inline void setModbus_DISCHRG_noro(const std::string & ups, long long int val) { setInt(ups, "DISCHRG_noro", val); }
inline void setModbus_DISCHRG_regtype(const std::string & ups, long long int val) { setInt(ups, "DISCHRG_regtype", val); }
inline void setModbus_DataBits(const std::string & ups, long long int val) { setInt(ups, "databits", val); }
inline void setModbus_DeviceSlaveId(const std::string & ups, long long int val) { setInt(ups, "dev_slave_id", val); }
inline void setModbus_FSD_addr(const std::string & ups, long long int val) { setInt(ups, "FSD_addr", val); }
inline void setModbus_FSD_noro(const std::string & ups, long long int val) { setInt(ups, "FSD_noro", val); }
inline void setModbus_FSD_pulse_duration(const std::string & ups, long long int val) { setInt(ups, "FSD_pulse_duration", val); }
inline void setModbus_FSD_regtype(const std::string & ups, long long int val) { setInt(ups, "FSD_regtype", val); }
inline void setModbus_HB_addr(const std::string & ups, long long int val) { setInt(ups, "HB_addr", val); }
inline void setModbus_HB_noro(const std::string & ups, long long int val) { setInt(ups, "HB_noro", val); }
inline void setModbus_HB_regtype(const std::string & ups, long long int val) { setInt(ups, "HB_regtype", val); }
inline void setModbus_LB_addr(const std::string & ups, long long int val) { setInt(ups, "LB_addr", val); }
inline void setModbus_LB_noro(const std::string & ups, long long int val) { setInt(ups, "LB_noro", val); }
inline void setModbus_LB_regtype(const std::string & ups, long long int val) { setInt(ups, "LB_regtype", val); }
inline void setModbus_OB_addr(const std::string & ups, long long int val) { setInt(ups, "OB_addr", val); }
inline void setModbus_OB_noro(const std::string & ups, long long int val) { setInt(ups, "OB_noro", val); }
inline void setModbus_OB_regtype(const std::string & ups, long long int val) { setInt(ups, "OB_regtype", val); }
inline void setModbus_OL_addr(const std::string & ups, long long int val) { setInt(ups, "OL_addr", val); }
inline void setModbus_OL_noro(const std::string & ups, long long int val) { setInt(ups, "OL_noro", val); }
inline void setModbus_OL_regtype(const std::string & ups, long long int val) { setInt(ups, "OL_regtype", val); }
inline void setModbus_RB_addr(const std::string & ups, long long int val) { setInt(ups, "RB_addr", val); }
inline void setModbus_RB_noro(const std::string & ups, long long int val) { setInt(ups, "RB_noro", val); }
inline void setModbus_RB_regtype(const std::string & ups, long long int val) { setInt(ups, "RB_regtype", val); }
inline void setModbus_ResponseTimeoutMsec(const std::string & ups, long long int val) { setInt(ups, "response_timeout_ms", val); }
inline void setModbus_ResponseTimeoutSec(const std::string & ups, long long int val) { setInt(ups, "mod_resp_to_s", val); }
inline void setModbus_ResponseTimeoutUsec(const std::string & ups, long long int val) { setInt(ups, "mod_resp_to_us", val); }
inline void setModbus_RioSlaveId(const std::string & ups, long long int val) { setInt(ups, "rio_slave_id", val); }
inline void setModbus_SerBaudRate(const std::string & ups, long long int val) { setInt(ups, "ser_baud_rate", val); }
inline void setModbus_SerDataBit(const std::string & ups, long long int val) { setInt(ups, "ser_data_bit", val); }
inline void setModbus_SerStopBit(const std::string & ups, long long int val) { setInt(ups, "ser_stop_bit", val); }
inline void setModbus_SlaveId(const std::string & ups, long long int val) { setInt(ups, "slaveid", val); }
inline void setModbus_StopBits(const std::string & ups, long long int val) { setInt(ups, "stopbits", val); }
inline void setNomBattVolt(const std::string & ups, long long int nombattvolt) { setInt(ups, "nombattvolt", nombattvolt); } // CHECKME
inline void setNumOfBytesFromUPS(const std::string & ups, long long int bytes) { setInt(ups, "numOfBytesFromUPS", bytes); } // CHECKME
inline void setOffDelay(const std::string & ups, long long int offdelay) { setInt(ups, "OffDelay", offdelay); } // CHECKME
inline void setOffdelay(const std::string & ups, long long int offdelay) { setInt(ups, "offdelay", offdelay); } // CHECKME
inline void setOnDelay(const std::string & ups, long long int ondelay) { setInt(ups, "OnDelay", ondelay); } // CHECKME
inline void setOndelay(const std::string & ups, long long int ondelay) { setInt(ups, "ondelay", ondelay); } // CHECKME
inline void setOnlineDischargeLogThrottleHovercharge(const std::string & ups, long long int val) { setInt(ups, "onlinedischarge_log_throttle_hovercharge", val); }
inline void setOnlineDischargeLogThrottleSec(const std::string & ups, long long int val) { setInt(ups, "onlinedischarge_log_throttle_sec", val); }
inline void setOutputPace(const std::string & ups, long long int output_pace) { setInt(ups, "output_pace", output_pace); } // CHECKME
inline void setOutputPhaseAngle(const std::string & ups, long long int val) { setInt(ups, "output_phase_angle", val); }
inline void setPinsShutdownMode(const std::string & ups, long long int val) { setInt(ups, "pins_shutdown_mode", val); }
inline void setPollFreq(const std::string & ups, long long int pollfreq) { setInt(ups, "pollfreq", pollfreq); } // CHECKME
inline void setPowerUp(const std::string & ups, long long int powerup) { setInt(ups, "powerup", powerup); } // CHECKME
inline void setPrgShut(const std::string & ups, long long int prgshut) { setInt(ups, "prgshut", prgshut); } // CHECKME
inline void setRebootDelay(const std::string & ups, long long int delay) { setInt(ups, "rebootdelay", delay); } // CHECKME
inline void setSDtime(const std::string & ups, long long int sdtime) { setInt(ups, "sdtime", sdtime); } // CHECKME
inline void setSDOrder(const std::string & ups, long long int ord) { setInt(ups, "sdorder", ord); }
inline void setSemistaticFreq(const std::string & ups, long long int val) { setInt(ups, "semistaticfreq", val); }
inline void setShutdownDelay(const std::string & ups, long long int delay) { setInt(ups, "shutdown_delay", delay); } // CHECKME
inline void setShutdownDuration(const std::string & ups, long long int val) { setInt(ups, "shutdown_duration", val); }
inline void setShutdownTimer(const std::string & ups, long long int val) { setInt(ups, "shutdown_timer", val); }
inline void setSlaveAddress(const std::string & ups, long long int val) { setInt(ups, "slave_address", val); }
inline void setSnmpRetries(const std::string & ups, long long int val) { setInt(ups, "snmp_retries", val); }
inline void setSnmpTimeout(const std::string & ups, long long int val) { setInt(ups, "snmp_timeout", val); }
inline void setStartDelay(const std::string & ups, long long int delay) { setInt(ups, "startdelay", delay); } // CHECKME
inline void setTestTime(const std::string & ups, long long int testtime) { setInt(ups, "testtime", testtime); } // CHECKME
inline void setTimeout(const std::string & ups, long long int timeout) { setInt(ups, "timeout", timeout); } // CHECKME
inline void setUPSdelayShutdown(const std::string & ups, long long int delay) { setInt(ups, "ups.delay.shutdown", delay); } // CHECKME
inline void setUPSdelayStart(const std::string & ups, long long int delay) { setInt(ups, "ups.delay.start", delay); } // CHECKME
inline void setVoltage(const std::string & ups, long long int voltage) { setInt(ups, "voltage", voltage); } // CHECKME
inline void setWaitBeforeReconnect(const std::string & ups, long long int val) { setInt(ups, "waitbeforereconnect", val); }
// Items below are "unused" - mostly set in
// drivers/nutdrv_qx_masterguard.c
inline void setFault1(const std::string & ups, const std::string & val) { setStr(ups, "fault_1", val); }
inline void setFault2(const std::string & ups, const std::string & val) { setStr(ups, "fault_2", val); }
inline void setFault3(const std::string & ups, const std::string & val) { setStr(ups, "fault_3", val); }
inline void setFault4(const std::string & ups, const std::string & val) { setStr(ups, "fault_4", val); }
inline void setFault5(const std::string & ups, const std::string & val) { setStr(ups, "fault_5", val); }
inline void setInputFaultVoltage(const std::string & ups, const std::string & val) { setStr(ups, "input_fault_voltage", val); }
inline void setNominalCellVoltage(const std::string & ups, const std::string & val) { setStr(ups, "nominal_cell_voltage",val); }
inline void setNumberOfBatteryCells(const std::string & ups, const std::string & val) { setStr(ups, "number_of_battery_cells", val); }
inline void setOutputVoltages(const std::string & ups, const std::string & val) { setStr(ups, "output_voltages", val); }
inline void setRechargeTime(const std::string & ups, const std::string & val) { setStr(ups, "recharge_time", val); }
inline void setRuntimeFull(const std::string & ups, const std::string & val) { setStr(ups, "runtime_full", val); }
inline void setRuntimeHalf(const std::string & ups, const std::string & val) { setStr(ups, "runtime_half", val); }
inline void setSeries(const std::string & ups, const std::string & val) { setStr(ups, "series", val); }
// Items below are essentially booleans (expected values
// are "enabled/disabled") -- refactoring planned per
// https://github.com/networkupstools/nut/issues/2421
inline void setAdvancedEcoMode(const std::string & ups, const std::string & val) { setStr(ups, "advanced_eco_mode", val); }
inline void setAlarmControl(const std::string & ups, const std::string & val) { setStr(ups, "alarm_control", val); }
inline void setBatteryAlarm(const std::string & ups, const std::string & val) { setStr(ups, "battery_alarm", val); }
inline void setBatteryOpenStatusCheck(const std::string & ups, const std::string & val) { setStr(ups, "battery_open_status_check", val); }
inline void setBypassAlarm(const std::string & ups, const std::string & val) { setStr(ups, "bypass_alarm", val); }
inline void setBypassForbidding(const std::string & ups, const std::string & val) { setStr(ups, "bypass_forbidding", val); }
inline void setBypassWhenOff(const std::string & ups, const std::string & val) { setStr(ups, "bypass_when_off", val); }
inline void setConstantPhaseAngle(const std::string & ups, const std::string & val) { setStr(ups, "constant_phase_angle",val); }
inline void setConverterMode(const std::string & ups, const std::string & val) { setStr(ups, "converter_mode", val); }
inline void setEcoMode(const std::string & ups, const std::string & val) { setStr(ups, "eco_mode", val); }
inline void setLimitedRuntimeOnBattery(const std::string & ups, const std::string & val) { setStr(ups, "limited_runtime_on_battery", val); }
inline void setSiteFaultDetection(const std::string & ups, const std::string & val) { setStr(ups, "site_fault_detection",val); }
/** belkinunv: both a flag (wait for AC power) and value (also wait for charge level) */
inline void setWait(const std::string & ups, long long int wait) { setInt(ups, "wait", wait); } // CHECKME
/** May be a flag or a number; 0 is among valid values (default -1 for unset) */
inline void setUsbSetAltInterface(const std::string & ups, long long int val = 0) { if (val >= 0) { setInt(ups, "usb_set_altinterface", val); } else { remove(ups, "usb_set_altinterface"); } } // CHECKME
// NUT specifies these as "hexnum" values (optionally with prefixed 0x but hex anyway)
inline void setUsbConfigIndex(const std::string & ups, long long int val) { setIntHex(ups, "usb_config_index", val); } // CHECKME
inline void setUsbHidDescIndex(const std::string & ups, long long int val) { setIntHex(ups, "usb_hid_desc_index", val); } // CHECKME
inline void setUsbHidRepIndex(const std::string & ups, long long int val) { setIntHex(ups, "usb_hid_rep_index", val); } // CHECKME
inline void setUsbHidEndpointIn(const std::string & ups, long long int val) { setIntHex(ups, "usb_hid_ep_in", val); } // CHECKME
inline void setUsbHidEndpointOut(const std::string & ups, long long int val) { setIntHex(ups, "usb_hid_ep_out", val); } // CHECKME
inline void setBatteryMax(const std::string & ups, double val) { setDouble(ups, "battery_max", val); }
inline void setBatteryMin(const std::string & ups, double val) { setDouble(ups, "battery_min", val); }
inline void setCSHackDelay(const std::string & ups, double val) { setDouble(ups, "cshdelay", val); }
inline void setMaxBypassFreq(const std::string & ups, double val) { setDouble(ups, "max_bypass_freq", val); }
inline void setMaxBypassVolt(const std::string & ups, double val) { setDouble(ups, "max_bypass_volt", val); }
inline void setMinBypassFreq(const std::string & ups, double val) { setDouble(ups, "min_bypass_freq", val); }
inline void setMinBypassVolt(const std::string & ups, double val) { setDouble(ups, "min_bypass_volt", val); }
// Flag - if exists then "true"; remove() to "unset" => "false"
inline void setCancelShutdown(const std::string & ups, bool set = true) { setFlag(ups, "CS", set); }
inline void setDumbTerm(const std::string & ups, bool set = true) { setFlag(ups, "dumbterm", set); }
inline void setExplore(const std::string & ups, bool set = true) { setFlag(ups, "explore", set); }
inline void setFakeLowBatt(const std::string & ups, bool set = true) { setFlag(ups, "fake_lowbatt", set); }
inline void setFlash(const std::string & ups, bool set = true) { setFlag(ups, "flash", set); }
inline void setIgnoreLB(const std::string & ups, bool set = true) { setFlag(ups, "ignorelb", set); }
inline void setNoHang(const std::string & ups, bool set = true) { setFlag(ups, "nohang", set); }
inline void setNoRating(const std::string & ups, bool set = true) { setFlag(ups, "norating", set); }
inline void setNoTransferOIDs(const std::string & ups, bool set = true) { setFlag(ups, "notransferoids", set); }
inline void setNoVendor(const std::string & ups, bool set = true) { setFlag(ups, "novendor", set); }
inline void setNoWarnNoImp(const std::string & ups, bool set = true) { setFlag(ups, "nowarn_noimp", set); }
inline void setOldMAC(const std::string & ups, bool set = true) { setFlag(ups, "oldmac", set); }
inline void setPollOnly(const std::string & ups, bool set = true) { setFlag(ups, "pollonly", set); }
inline void setSilent(const std::string & ups, bool set = true) { setFlag(ups, "silent", set); }
inline void setStatusOnly(const std::string & ups, bool set = true) { setFlag(ups, "status_only", set); } // aka OPTI_MINPOLL
inline void setSubscribe(const std::string & ups, bool set = true) { setFlag(ups, "subscribe", set); }
inline void setUseCRLF(const std::string & ups, bool set = true) { setFlag(ups, "use_crlf", set); }
inline void setUsePreLF(const std::string & ups, bool set = true) { setFlag(ups, "use_pre_lf", set); }
inline void setNolock(const std::string & ups, bool set = true) { setBool(ups, "nolock", set); }
inline void setCable(const std::string & ups, bool set = true) { setBool(ups, "cable", set); }
inline void setFullUpdate(const std::string & ups, bool set = true) { setBool(ups, "full_update", set); }
inline void setLangIDfix(const std::string & ups, bool set = true) { setBool(ups, "langid_fix", set); }
inline void setLoadOff(const std::string & ups, bool set = true) { setBool(ups, "load.off", set); }
inline void setLoadOn(const std::string & ups, bool set = true) { setBool(ups, "load.on", set); }
/** \} */
virtual ~UpsConfiguration() override;
}; // end of class UpsConfiguration
/** upsd users configuration */
class UpsdUsersConfiguration : public GenericConfiguration
{
public:
/** upsmon mode */
typedef enum {
UPSMON_UNDEF = 0, /**< Unknown mode */
UPSMON_PRIMARY, /**< Primary (legacy "Master") mode */
UPSMON_SECONDARY, /**< Secondary (legacy "Slave") mode */
} upsmon_mode_t;
/** User-specific configuration attributes getters and setters \{ */
inline std::string getPassword(const std::string & user) const { return getStr(user, "password"); }
/** Currently valid actions include "SET" and "FSD",
* but the method does not constrain the values */
inline ConfigParamList getActions(const std::string & user) const
{
ConfigParamList actions;
get(user, "actions", actions);
return actions;
}
/** Valid commands are "ALL" or a list of specific commands
* supported by the device (NUT driver dependent) */
inline ConfigParamList getInstantCommands(const std::string & user) const
{
ConfigParamList cmds;
get(user, "instcmds", cmds);
return cmds;
}
upsmon_mode_t getUpsmonMode() const;
inline void setPassword(const std::string & user, const std::string & passwd) { setStr(user, "password", passwd); }
inline void setActions(const std::string & user, const ConfigParamList & actions) { set(user, "actions", actions); }
inline void setInstantCommands(const std::string & user, const ConfigParamList & cmds) { set(user, "instcmds", cmds); }
inline void addActions(const std::string & user, const ConfigParamList & actions) { add(user, "actions", actions); }
inline void addInstantCommands(const std::string & user, const ConfigParamList & cmds) { add(user, "instcmds", cmds); }
/**
* \brief upsmon mode setter
*
* Note that the UPSMON_UNDEF mode isn't allowed as parameter
* (logically, if you set something, it shall be defined...)
*
* \param mode Mode
*/
/* TOTHINK: Do we need a writer (other method, optional parameter
* to this one) for obsolete wordings of the upsmon mode?
* Note: reader in the getter accepts both old and new values. */
void setUpsmonMode(upsmon_mode_t mode);
/** \} */
/** Serialisable interface implementation overload \{ */
bool parseFrom(NutStream & istream) override;
bool writeTo(NutStream & ostream) const override;
/** \} */
}; // end of class UpsdUsersConfiguration
} /* namespace nut */
#endif /* __cplusplus */
#endif /* NUTCONF_H_SEEN */
|