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
|
<html>
<head>
<title>firstworks Programming with Rudiments using the Utility Classes</title>
<link href="../css/styles.css" rel="stylesheet">
</head>
<body>
<span class="heading">Programming with Rudiments using the Utility Classes</span><br><br>
<ul>
<li><a href="#environment">Using the Environment Class</a></li>
<li><a href="#commandline">Using the Command Line Class</a></li>
<li><a href="#parameterstring">Using the Parameter String Class</a></li>
<li><a href="#datetime">Using the Date/Time Class</a></li>
<li><a href="#timezonefile">Using the Timezonefile Class</a></li>
<li><a href="#filesystem">Using the Filesystem Class</a></li>
<li><a href="#logger">Using the Logger Class</a></li>
<li><a href="#memorypool">Using the Memory Pool Class</a></li>
<li><a href="#permissions">Using the Permissions Class</a></li>
<li><a href="#randomnumber">Using the Random Number Class</a></li>
<li><a href="#regularexpression">Using the Regular Expression Class</a></li>
<li><a href="#semaphoreset">Using the Semaphore Set Class</a></li>
<li><a href="#sharedmemory">Using the Shared Memory Class</a></li>
<li><a href="#signal">Using the Signal Classes</a></li>
<li><a href="#stringbuffer">Using the String Buffer Class</a></li>
<li><a href="#variablebuffer">Using the Variable Buffer Class</a></li>
<li><a href="#charstring">Using the Charstring Class</a></li>
<li><a href="#xmlsax">Using the XML SAX Class</a></li>
<li><a href="#xmldom">Using the XML DOM Classes</a></li>
<li><a href="#dtd">Using the DTD Class</a></li>
<li><a href="#passwdentry">Using the Password Entry Class</a></li>
<li><a href="#shadowentry">Using the Shadow Entry Class</a></li>
<li><a href="#groupentry">Using the Group Entry Class</a></li>
<li><a href="#hostentry">Using the Host Entry Class</a></li>
<li><a href="#protocolentry">Using the Protocol Entry Class</a></li>
<li><a href="#serviceentry">Using the Service Entry Class</a></li>
<li><a href="#rpcentry">Using the RPC Entry Class</a></li>
<li><a href="#linkedlist">Using the Linkedlist Class</a></li>
<li><a href="#dictionary">Using the Dictionary Class</a></li>
</ul>
<a name="environment"></a>
<span class="heading">Using the Environment Class</span><br><br>
<p>The environment class allows you to get or set the value of environment
variables. The following example gets, sets and resets the environment
variable TEST.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2003 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/environment.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdlib.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
environment env;
<font color="#0000f8">// print the environment variable "TEST"</font>
printf(<font color="#f800f8">"TEST=</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,env.getValue(<font color="#f800f8">"TEST"</font>));
<font color="#0000f8">// set the value of "TEST" to "value"</font>
<font color="#a02828"><b>if</b></font> (env.setValue(<font color="#f800f8">"TEST"</font>,<font color="#f800f8">"value"</font>)) {
printf(<font color="#f800f8">"TEST=</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,env.getValue(<font color="#f800f8">"TEST"</font>));
} <font color="#a02828"><b>else</b></font> {
printf(<font color="#f800f8">"setValue() failed</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#0000f8">// set the value of "TEST" to "newvalue"</font>
<font color="#a02828"><b>if</b></font> (env.setValue(<font color="#f800f8">"TEST"</font>,<font color="#f800f8">"newvalue"</font>)) {
printf(<font color="#f800f8">"TEST=</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,env.getValue(<font color="#f800f8">"TEST"</font>));
} <font color="#a02828"><b>else</b></font> {
printf(<font color="#f800f8">"setValue() failed</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#0000f8">// remove "TEST" from the environment</font>
env.remove(<font color="#f800f8">"TEST"</font>);
<font color="#0000f8">// print the (non-existent) environment variable "TEST"</font>
printf(<font color="#f800f8">"TEST=</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,env.getValue(<font color="#f800f8">"TEST"</font>));
}
</pre>
<a name="commandline"></a>
<span class="heading">Using the Command Line Class</span><br><br>
<p>Most programs take command line options in the option/value pair format:</p>
<p>program -option value -option value ...</p>
<p>The commandline class makes it easy to deal with command line options of
this format. Below is some code illustrating the use of the commandline
class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/commandline.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdlib.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
commandline cmdline(argv,argc);
<font color="#0000f8">// if -help was specified, display a usage message</font>
<font color="#a02828"><b>if</b></font> (cmdline.found(<font color="#f800f8">"-help"</font>)) {
printf(<font color="#f800f8">"usage: divide -divisor number -dividend number</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
exit(<font color="#f800f8">0</font>);
}
<font color="#0000f8">// If -divisor and -dividend are supplied, use them. Otherwise</font>
<font color="#0000f8">// display an error message.</font>
<font color="#a02828"><b>if</b></font> (cmdline.found(<font color="#f800f8">"-divisor"</font>) && cmdline.found(<font color="#f800f8">"-dividend"</font>)) {
<font color="#288850"><b>double</b></font> divisor=atof(cmdline.value(<font color="#f800f8">"-divisor"</font>));
<font color="#288850"><b>double</b></font> dividend=atof(cmdline.value(<font color="#f800f8">"-dividend"</font>));
printf(<font color="#f800f8">"</font><font color="#6858c8">%0.2f</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,divisor/dividend);
} <font color="#a02828"><b>else</b></font> {
printf(<font color="#f800f8">"You must supply a divisor and a dividend.</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
}
</pre>
<a name="parameterstring"></a>
<span class="heading">Using the Parameter String Class</span><br><br>
<p>Sometimes a function needs to take an arbitrary set of parameters. For
example, a function for connecting to a database may need host, port, socket,
username and password, any of which could be omitted depending on the
database. Though C++ support methods which take an arbitrary number of
parameters, sometimes it is more convenient to for the method to accept a
single string parameter with name/value pairs in it instead.</p>
<p>The parameterstring class provides methods for parsing and accessing
a parameter string of the following form:</p>
<blockquote>
name1='value1';name2='value2';name3='value3'
</blockquote>
<p>The single quotes are optional. If a parameter needs to contain a single
quote, then it can be escaped as follows:</p>
<blockquote>
name='\'value\''
</blockquote>
<p>Backslashes can be similarly escaped:</p>
<blockquote>
name='\\value\\'
</blockquote>
<pre>
...
</pre>
<a name="datetime"></a>
<span class="heading">Using the Date/Time Class</span><br><br>
<p>One of the most difficult things to do in a Unix environment is deal with
dates and times. The "standard" functions and structures associated with
dates and times are complex, vary widely from platform to platform and in
many cases are not thread safe. The datetime class attempts to rectify this
situation.</p>
<p>The datetime class allows you to query and set the system clock. If your
platform has a working real-time-clock (/dev/rtc), then you can query or set
the hardware clock as well. Note that your program must run as root in order
to set the system or hardware clock. Since it is common for the system clock
to be set to the local time zone and the hardware clock to be set to GMT,
a method is provided for converting the hardware clock time to the system's
time zone.</p>
<p>Additionally there is a method for switching the time zone of the time
currently represented in the class.</p>
<p>The datetime class also provides methods for converting between several
common ways of representing time. Such as a formatted string, the number of
seconds since 1970 and "struct tm".</p>
<p>There are also methods for adding discrete amounts of time to the time
currently stored in the class. You can, for example add 150 seconds to
"12:30:50 01/02/2003 EST" and get "12:32:20 01/02/2003 EST". You can add
negative numbers to subtract time.</p>
<p>Below is some code illustrating the use of the datetime class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/datetime.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdlib.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// set current time zone to America/New_York</font>
printf(<font color="#f800f8">"setting TZ=America/New_York...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
environment env;
env.setValue(<font color="#f800f8">"TZ"</font>,<font color="#f800f8">"America/New_York"</font>);
<font color="#0000f8">// get the current date</font>
datetime dt;
dt.getSystemDateAndTime();
<font color="#0000f8">// Write out the different parts of the date.</font>
printf(<font color="#f800f8">"Hour : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getHour());
printf(<font color="#f800f8">"Minutes : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getMinutes());
printf(<font color="#f800f8">"Seconds : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getSeconds());
printf(<font color="#f800f8">"Month : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getMonth());
printf(<font color="#f800f8">"DayOfMonth : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getDayOfMonth());
printf(<font color="#f800f8">"DayOfWeek : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getDayOfWeek());
printf(<font color="#f800f8">"DayOfYear : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getDayOfYear());
printf(<font color="#f800f8">"Year : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getYear());
printf(<font color="#f800f8">"Daylight Savings Time : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.isDaylightSavingsTime());
printf(<font color="#f800f8">"Time Zone : </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getTimeZoneString());
printf(<font color="#f800f8">"Offset from GMT : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getTimeZoneOffset());
printf(<font color="#f800f8">"Seconds since 1970 : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getEpoch());
printf(<font color="#f800f8">"Date String : </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getString());
<font color="#0000f8">// use static methods to translate between formats</font>
<font color="#288850"><b>char</b></font> *string=datetime::getString(dt.getEpoch());
printf(<font color="#f800f8">"String from Epoch : </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,string);
<font color="#a02828"><b>delete</b></font>[] string;
string=datetime::getString(dt.getTm());
printf(<font color="#f800f8">"String from tm : </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,string);
<font color="#0000f8">// use static methods to translate between formats</font>
<font color="#288850"><b>time_t</b></font> epoch=datetime::getEpoch(string);
printf(<font color="#f800f8">"Epoch from String : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,epoch);
<font color="#a02828"><b>delete</b></font>[] string;
epoch=datetime::getEpoch(dt.getTm());
printf(<font color="#f800f8">"Epoch from tm : </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,epoch);
<font color="#0000f8">// get time from hardware clock</font>
dt.getHardwareDateAndTime(<font color="#f800f8">"GMT"</font>);
printf(<font color="#f800f8">"Hardware Clock (assuming GMT): </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getString());
<font color="#0000f8">// get time from hardware clock adjusting for timezone</font>
dt.getAdjustedHardwareDateAndTime(<font color="#f800f8">"GMT"</font>);
printf(<font color="#f800f8">"Adjusted Hardware Clock : </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getString());
<font color="#0000f8">// switch time zones</font>
dt.adjustTimeZone(<font color="#f800f8">"MST"</font>);
printf(<font color="#f800f8">"Adjusting time zone to Mountain time: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dt.getString());
}
</pre>
<a name="timezonefile"></a>
<span class="heading">Using the Timezonefile Class</span><br><br>
<p>While I was working on timezone support in the datetime class I originally
thought that it might be useful to be able to parse timezone files. I could not
find any standard C functions for parsing them, so I wrote a class that parses
them.</p>
<p>It turned out to be of very limited value, but it works and I never removed
it. So, if you need such functionality, it exists.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#ff00ff"><rudiments/timezonefile.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdlib.h></font>
<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>char</b></font> **argv) {
<font color="#0000ff">// parse the timezone file specified in the first argument</font>
timezonefile tz;
<font color="#a52a2a"><b>if</b></font> (!tz.parseFile(argv[<font color="#ff00ff">1</font>])) {
exit(<font color="#ff00ff">1</font>);
}
<font color="#0000ff">// print using built-in method</font>
tz.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// print manually</font>
printf(<font color="#ff00ff">"ttisgmtcnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getIsGMTCount());
printf(<font color="#ff00ff">"ttisstdcnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getIsSTDCount());
printf(<font color="#ff00ff">"leapcnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getLeapCount());
printf(<font color="#ff00ff">"timecnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getTimeCount());
printf(<font color="#ff00ff">"typecnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getTypeCount());
printf(<font color="#ff00ff">"charcnt: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,tz.getCharacterCount());
<font color="#2e8b57"><b>int</b></font> i;
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getTimeCount(); i++) {
printf(<font color="#ff00ff">"transitiontime[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,tz.getTransitionTime(i));
}
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getTimeCount(); i++) {
printf(<font color="#ff00ff">"localtime[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,tz.getLocalTimes(i));
}
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getTypeCount(); i++) {
printf(<font color="#ff00ff">"ttinfo[</font><font color="#6a5acd">%d</font><font color="#ff00ff">] {</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i);
printf(<font color="#ff00ff">" tt_gmtoff: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
tz.getTimeTypeInfo(i)->tt_gmtoff);
printf(<font color="#ff00ff">" tt_isdst: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
tz.getTimeTypeInfo(i)->tt_isdst);
printf(<font color="#ff00ff">" tt_abbrind: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
tz.getTimeTypeInfo(i)->tt_abbrind);
printf(<font color="#ff00ff">"}</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
}
printf(<font color="#ff00ff">"rawtimezonestring: "</font>);
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> i=<font color="#ff00ff">0</font>; i<tz.getCharacterCount(); i++) {
<font color="#a52a2a"><b>if</b></font> (tz.getRawTimeZoneString()[i]==(<font color="#2e8b57"><b>char</b></font>)<font color="#ff00ff">NULL</font>) {
printf(<font color="#ff00ff">" "</font>);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">%c</font><font color="#ff00ff">"</font>,tz.getRawTimeZoneString()[i]);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getLeapCount(); i++) {
printf(<font color="#ff00ff">"leapsecondtime[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,
tz.getLeapSecondTime(i));
printf(<font color="#ff00ff">"totalleapseconds[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,
tz.getTotalLeapSeconds(i));
}
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> counter=<font color="#ff00ff">0</font>; counter<tz.getTypeCount(); counter++) {
printf(<font color="#ff00ff">"timezonestrings[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]=</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,counter,
tz.getTimeZoneString(counter));
}
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getIsSTDCount(); i++) {
printf(<font color="#ff00ff">"transstdwall[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,
tz.getStandardOrWallIndicator(i));
}
<font color="#a52a2a"><b>for</b></font> (i=<font color="#ff00ff">0</font>; i<tz.getIsGMTCount(); i++) {
printf(<font color="#ff00ff">"transutclocal[</font><font color="#6a5acd">%d</font><font color="#ff00ff">]: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,i,
tz.getUTCOrLocalIndicator(i));
}
}
</pre>
<a name="filesystem"></a>
<span class="heading">Using the Filesystem Class</span><br><br>
<p>The filesystem class provides methods for collecting statistics about a
filesystem. The "standard" function for getting filesystem statistics
is either statfs or statvfs. Few operating systems implement statvfs and the
structure returned by statfs varies greatly between operating systems. The
filesystem class attempts to remedy this situation. However, no operating
system supports every method in the filesystem class.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#ff00ff"><rudiments/filesystem.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdio.h></font>
<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argv, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argc) {
filesystem fs;
fs.initialize(<font color="#ff00ff">"/"</font>);
printf(<font color="#ff00ff">"root fileststem stats:</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" type: 0x</font><font color="#6a5acd">%08x</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getType());
printf(<font color="#ff00ff">" block size: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getBlockSize());
printf(<font color="#ff00ff">" optimum tranfer block size: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getOptimumTransferBlockSize());
printf(<font color="#ff00ff">" total blocks: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getTotalBlocks());
printf(<font color="#ff00ff">" free blocks: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getFreeBlocks());
printf(<font color="#ff00ff">" available blocks: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getAvailableBlocks());
printf(<font color="#ff00ff">" total nodes: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getTotalFileNodes());
printf(<font color="#ff00ff">" free nodes: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getFreeFileNodes());
printf(<font color="#ff00ff">" available nodes: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getAvailableFileNodes());
printf(<font color="#ff00ff">" filesystem id: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getFileSystemId());
printf(<font color="#ff00ff">" maximum file name length: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getMaximumFileNameLength());
printf(<font color="#ff00ff">" owner: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getOwner());
printf(<font color="#ff00ff">" sync writes: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getSyncWrites());
printf(<font color="#ff00ff">" async writes: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getAsyncWrites());
printf(<font color="#ff00ff">" fs type name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getTypeName());
printf(<font color="#ff00ff">" mount point: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getMountPoint());
printf(<font color="#ff00ff">" sync reads: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getSyncReads());
printf(<font color="#ff00ff">" async reads: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getAsyncReads());
printf(<font color="#ff00ff">" device name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getDeviceName());
printf(<font color="#ff00ff">" fs specific string: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
fs.getFilesystemSpecificString());
}
</pre>
<a name="logger"></a>
<span class="heading">Using the Logger Class</span><br><br>
<p>The logger class and associated logdestination classes provide a framework
for generating log messages from applications. An application can define a set
of logdestinations and attach them to an instance of the logger class. Then,
when the application calls one of the write() methods of the logger class, the
log message is written to each of the logdestinations. For example, an
application could simultaneously log to stderr and to a file. Currently stdout,
stderr, file and syslog logdestinations are supported. If an application needs
to send one set of log messages to one destination and another set to a
different destinations, it can create two instances of the logger class and use
one for each set of messages.</p>
<p>The following example illustrates use of the logger class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/logger.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
logger lg;
syslogdestination sd;
filedestination fd;
stdoutdestination sod;
stderrdestination sed;
<font color="#0000f8">// initialize and add a syslog log destination</font>
sd.open(<font color="#f800f8">"logtest"</font>,LOG_CONS,LOG_USER,LOG_INFO);
lg.addLogDestination(&sd);
<font color="#0000f8">// initialize and add a file log destination</font>
fd.open(<font color="#f800f8">"test.log"</font>);
lg.addLogDestination(&fd);
<font color="#0000f8">// add a standard output log destination</font>
lg.addLogDestination(&sod);
<font color="#0000f8">// add a standard error log destination</font>
lg.addLogDestination(&sed);
<font color="#0000f8">// write a string, character, long and float value to the log, along</font>
<font color="#0000f8">// with a standard log header for each</font>
<font color="#288850"><b>char</b></font> *header=logger::logHeader(<font color="#f800f8">"logtest"</font>);
lg.write(header,<font color="#f800f8">0</font>,<font color="#f800f8">"test"</font>);
lg.write(header,<font color="#f800f8">0</font>,<font color="#f800f8">'t'</font>);
lg.write(header,<font color="#f800f8">0</font>,(<font color="#288850"><b>long</b></font>)<font color="#f800f8">12345</font>);
lg.write(header,<font color="#f800f8">0</font>,<font color="#f800f8">123.45</font>);
<font color="#a02828"><b>delete</b></font>[] header;
<font color="#0000f8">// remove all log destinations</font>
lg.removeAllLogDestinations();
<font color="#0000f8">// add each of the log destinations back</font>
lg.addLogDestination(&sd);
lg.addLogDestination(&fd);
lg.addLogDestination(&sod);
lg.addLogDestination(&sed);
<font color="#0000f8">// remove them one by one</font>
lg.removeLogDestination(&sd);
lg.removeLogDestination(&fd);
lg.removeLogDestination(&sod);
lg.removeLogDestination(&sed);
lg.removeAllLogDestinations();
<font color="#0000f8">// close the syslog log destination</font>
sd.close();
<font color="#0000f8">// close the file log destination</font>
fd.close();
}
</pre>
<a name="memorypool"></a>
<span class="heading">Using the Memory Pool Class</span><br><br>
<p>The memory pool class implements a pool of memory that starts with an
initial buffer and grows dynamically as needed. Each time the pool is freed,
the dynamic buffers are deallocated. After a configurable number of free's,
the initial buffer is resized to the average amount of memory that was
requested between free's since the last time it resized.</p>
<p>The memory pool class is especially useful for applications that do the same
task over and over where varying amounts of memory are required during each
iteration. The class is particularly efficient in cases where memory
requirements are fairly constant between iterations with sporadic requirements
for lots of memory or where the memory requirements steadily get larger or
smaller across iterations.</p>
<p>Using a memory pool can be faster than allocating memory on demand, then
deallocating it later and more efficient than using static buffers that are
large enough to contain the largest possible data.</p>
<p>The following code connects to a server on the local machine and reads
variable/value pairs from it.</p>
<PRE>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/memorypool.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/inetclientsocket.h></font>
<font color="#a020f0">#define OPTIMISTIC_VARIABLE_COUNT </font><font color="#f800f8">5</font>
<font color="#a020f0">#define OPTIMISTIC_VARIABLE_LENGTH </font><font color="#f800f8">10</font>
<font color="#a020f0">#define OPTIMISTIC_VALUE_LENGTH </font><font color="#f800f8">20</font>
main() {
<font color="#0000f8">// calculate an optimistic initial size for the memory pool</font>
<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>long</b></font> initialsize=OPTIMISTIC_VARIABLE_COUNT*
((<font color="#f800f8">2</font>*<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>char</b></font> *))+
OPTIMISTIC_VARIABLE_LENGTH+<font color="#f800f8">1</font>+
OPTIMISTIC_VALUE_LENGTH+<font color="#f800f8">1</font>);
<font color="#0000f8">// create a memory pool: grow by 50 bytes when necessary and</font>
<font color="#0000f8">// re-evaluate the initial size every 10 iterations</font>
memorypool *mp=<font color="#a02828"><b>new</b></font> memorypool(initialsize,<font color="#f800f8">50</font>,<font color="#f800f8">10</font>);
<font color="#0000f8">// create an inet client socket, connect to localhost on port 1000</font>
inetclientsocket *cis=<font color="#a02828"><b>new</b></font> inetclientsocket();
cis->connectToServer(<font color="#f800f8">"localhost"</font>,<font color="#f800f8">1000</font>,<font color="#f800f8">0</font>,<font color="#f800f8">1</font>);
<font color="#a02828"><b>for</b></font> (;;) {
<font color="#0000f8">// get the number of fields</font>
<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>short</b></font> fieldcount;
<font color="#a02828"><b>if</b></font> (cis->read(&fieldcount)!=<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>short</b></font>)) {
<font color="#a02828"><b>break</b></font>;
}
<font color="#0000f8">// if the fieldcount is 0, that's the end</font>
<font color="#a02828"><b>if</b></font> (fieldcount==<font color="#f800f8">0</font>) {
mp->free();
<font color="#a02828"><b>break</b></font>;
}
<font color="#0000f8">// create arrays of pointers to the variables/values</font>
<font color="#288850"><b>char</b></font> **vars=(<font color="#288850"><b>char</b></font> **)mp->malloc(fieldcount*<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>char</b></font> *));
<font color="#288850"><b>char</b></font> **vals=(<font color="#288850"><b>char</b></font> **)mp->malloc(fieldcount*<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>char</b></font> *));
<font color="#0000f8">// get the fields</font>
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>short</b></font> i=<font color="#f800f8">0</font>; i<fieldcount; i++) {
<font color="#0000f8">// get the length of the variable</font>
<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>short</b></font> length;
<font color="#a02828"><b>if</b></font> (cis->read(&length)!=<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>short</b></font>)) {
<font color="#a02828"><b>break</b></font>;
}
<font color="#0000f8">// get the variable and null-terminate it</font>
vars[i]=mp->malloc(length+<font color="#f800f8">1</font>);
<font color="#a02828"><b>if</b></font> (cis->read(vars[i],length)!=length) {
<font color="#a02828"><b>break</b></font>;
}
vars[i][length]=(<font color="#288850"><b>char</b></font>)<font color="#f800f8">NULL</font>;
<font color="#0000f8">// get the length of the value</font>
<font color="#a02828"><b>if</b></font> (cis->read(&length)!=<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>short</b></font>)) {
<font color="#a02828"><b>break</b></font>;
}
<font color="#0000f8">// get the value and null-terminate it</font>
vals[i]=mp->malloc(length+<font color="#f800f8">1</font>);
<font color="#a02828"><b>if</b></font> (cis->read(vals[i],length)!=length) {
<font color="#a02828"><b>break</b></font>;
}
vals[i][length]=(<font color="#288850"><b>char</b></font>)<font color="#f800f8">NULL</font>;
}
<font color="#0000f8">// do something interesting with the variable/value pairs here...</font>
<font color="#0000f8">// free the memory pool</font>
mp->free();
}
cis->close();
<font color="#a02828"><b>delete</b></font> cis;
<font color="#a02828"><b>delete</b></font> mp;
}
</PRE>
<a name="permissions"></a>
<span class="heading">Using the Permissions Class</span><br><br>
<p>The permissions class provides simple methods for generating permissions.
The output of these methods can be used whenever a function takes an argument
of type mode_t. Below is some code illustrating the use of the permissions
class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/permissions.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/types.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/stat.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><fcntl.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// Create a file with rw-r--r-- permissions</font>
<font color="#288850"><b>int</b></font> fd=open(<font color="#f800f8">"/tmp/tempfile"</font>,O_RDWR|O_CREAT,
permissions::evalPermString(<font color="#f800f8">"rw-r--r--"</font>));
<font color="#0000f8">// change the permissions to rw-rw-r--</font>
permissions::setFilePermissions(fd,
permissions::evalPermString(<font color="#f800f8">"rw-rw-r--"</font>));
<font color="#0000f8">// close and delete the file</font>
close(fd);
unlink(<font color="#f800f8">"/tmp/tempfile"</font>);
<font color="#0000f8">// do the same as above using different methods</font>
fd=open(<font color="#f800f8">"/tmp/tempfile"</font>,O_RDWR|O_CREAT,
permissions::ownerReadWrite()|
permissions::groupRead()|
permissions::othersRead());
permissions::setFilePermissions(fd,
permissions::ownerReadWrite()|
permissions::groupReadWrite()|
permissions::othersRead());
close(fd);
unlink(<font color="#f800f8">"/tmp/tempfile"</font>);
}
</pre>
<a name="randomnumber"></a>
<span class="heading">Using the Random Number Class</span><br><br>
<p>Functions for generating random numbers vary from platform to platform.
The randomnumber class attempts to rectify this situation. Below is some code
illustrating the use of the randomnumber class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdlib.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/datetime.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/randomnumber.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// it's common to seed a random number generator with the number of</font>
<font color="#0000f8">// seconds since 1970 (the epoch), so we'll get the current date.</font>
datetime dt;
printf(<font color="#f800f8">"A random number between 0 and </font><font color="#6858c8">%d</font><font color="#f800f8">: "</font>,<font color="#f800f8">RAND_MAX</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,randomnumber::generateNumber(dt.getEpoch()));
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"A random number between 100 and 1000: "</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,randomnumber::generateScaledNumber(dt.getEpoch(),<font color="#f800f8">100</font>,<font color="#f800f8">1000</font>));
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"Another random number between 100 and 1000: "</font>);
<font color="#288850"><b>int</b></font> basenumber=randomnumber::generateNumber(dt.getEpoch()+<font color="#f800f8">1</font>);
<font color="#288850"><b>int</b></font> scalednumber=randomnumber::scaleNumber(basenumber,<font color="#f800f8">100</font>,<font color="#f800f8">1000</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,scalednumber);
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"A random number between -100 and -1000: "</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,randomnumber::generateScaledNumber(dt.getEpoch(),
-<font color="#f800f8">100</font>,-<font color="#f800f8">1000</font>));
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"Another random number between -100 and -1000: "</font>);
basenumber=randomnumber::generateNumber(dt.getEpoch()+<font color="#f800f8">1</font>);
scalednumber=randomnumber::scaleNumber(basenumber,-<font color="#f800f8">100</font>,-<font color="#f800f8">1000</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,scalednumber);
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"A random number between -100 and 100: "</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,randomnumber::generateScaledNumber(dt.getEpoch(),-<font color="#f800f8">100</font>,<font color="#f800f8">100</font>));
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">"Another random number between -100 and 100: "</font>);
basenumber=randomnumber::generateNumber(dt.getEpoch()+<font color="#f800f8">1</font>);
scalednumber=randomnumber::scaleNumber(basenumber,-<font color="#f800f8">100</font>,<font color="#f800f8">100</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8">"</font>,scalednumber);
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
<a name="regularexpression"></a>
<span class="heading">Using the Regular Expression Class</span><br><br>
<p>Regular expressions allow a programmer to perform complex string matching
but methods for using regular expressions vary from platform to platform. The
regularexpression class attempts to rectify this situation. Below is some code
illustrating the use of the regularexpression class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/regularexpression.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// A quick match...</font>
<font color="#a02828"><b>if</b></font> (regularexpression::match(<font color="#f800f8">"Hello Dave!"</font>,<font color="#f800f8">".*Dave.*"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#0000f8">// If you need to match over and over...</font>
regularexpression re(<font color="#f800f8">".*Dave.*"</font>);
<font color="#a02828"><b>if</b></font> (re.match(<font color="#f800f8">"Hello Dave!"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#a02828"><b>if</b></font> (re.match(<font color="#f800f8">"Goodbye Dave!"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#a02828"><b>if</b></font> (re.match(<font color="#f800f8">"Dave is a jerk!"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#a02828"><b>if</b></font> (re.match(<font color="#f800f8">"Dave writes cool software!"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#a02828"><b>if</b></font> (re.match(<font color="#f800f8">"See ya later Dave!"</font>)) {
printf(<font color="#f800f8">"The string contains .*Dave.*</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
}
</pre>
<a name="semaphoreset"></a>
<span class="heading">Using the Semaphore Set Class</span><br><br>
<p>Semaphores allow seperate processes or threads to synchronize activities.
The standard functions and structures for managing semaphores are complex.
The sempahoreset class attempts to rectify this situation. Below is some code
illustrating the use of the semaphoreset class.</p>
<p>There are methods in the semaphoreset class that allow you to get and
set user/group ownership and permissions of a semaphore set that are not
documented here, but they are straightforward and rarely used.</p>
<p>The first program prints out 1 and 3, the second program prints out 2 and 4.
They use a set of 2 semaphores to synchronize these activities. No matter
what order the programs are started in, they will always print out
<p>1<br>2<br>3<br>4<br>1<br>2<br>3<br>4<br>etc.</p>
<p>These programs must both be run to the background.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/types.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/ipc.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/semaphoreset.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/permissions.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/file.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// create a file called /tmp/sem</font>
unlink(<font color="#f800f8">"/tmp/sem"</font>);
file fd;
fd.create(<font color="#f800f8">"/tmp/sem"</font>,permissions::evalPermString(<font color="#f800f8">"rw-------"</font>));
fd.close();
<font color="#0000f8">// Create a semaphore set keyed to /tmp/sem containing 2 individual</font>
<font color="#0000f8">// semaphores. Initialize them to 0 and 1 respectively.</font>
<font color="#288850"><b>int</b></font> vals[<font color="#f800f8">2</font>]={<font color="#f800f8">0</font>,<font color="#f800f8">1</font>};
semaphoreset sem;
sem.create(ftok(<font color="#f800f8">"/tmp/sem"</font>,<font color="#f800f8">0</font>),
permissions::evalPermString(<font color="#f800f8">"rw-------"</font>),<font color="#f800f8">2</font>,vals);
<font color="#0000f8">// loop 10 times, printing 2 and 4, synchronizing with another process</font>
<font color="#0000f8">// using the semaphores.</font>
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<<font color="#f800f8">10</font>; i++) {
sem.wait(<font color="#f800f8">0</font>);
printf(<font color="#f800f8">"2</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
sem.signal(<font color="#f800f8">1</font>);
sem.wait(<font color="#f800f8">0</font>);
printf(<font color="#f800f8">"4</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
sem.signal(<font color="#f800f8">1</font>);
}
}
</pre>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/types.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/ipc.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/semaphoreset.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/permissions.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// attach to the semaphore set keyed to /tmp/sem containing 2 semaphores</font>
semaphoreset sem;
sem.attach(ftok(<font color="#f800f8">"/tmp/sem"</font>,<font color="#f800f8">0</font>),<font color="#f800f8">2</font>);
<font color="#0000f8">// loop 10 times, printing 1 and 2, synchronizing with another process</font>
<font color="#0000f8">// using the semaphores</font>
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<<font color="#f800f8">10</font>; i++) {
sem.wait(<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"1</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
sem.signal(<font color="#f800f8">0</font>);
sem.wait(<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"3</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
sem.signal(<font color="#f800f8">0</font>);
}
unlink(<font color="#f800f8">"/tmp/sem"</font>);
}
</pre>
<a name="sharedmemory"></a>
<span class="heading">Using the Shared Memory Class</span><br><br>
<p>Shared memory allows seperate processes to access a common block of memory.
The standard functions and structures for managing shared memory segments are
complex. The sharedmemory class attempts to rectify this situation. Below is
some code illustrating the use of the sharedmemory class.</p>
<p>There are methods in the sharedmemory class that allow you to get and
set user/group ownership and permissions of a segment that are not
documented here, but they are straightforward and rarely used.</p>
<p>This program puts some data into shared memory then goes to sleep, giving
another program time to access the segment.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/types.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/ipc.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/sharedmemory.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/permissions.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/file.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><string.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// create a file called /tmp/shm</font>
unlink(<font color="#f800f8">"/tmp/shm"</font>);
file fd;
fd.create(<font color="#f800f8">"/tmp/shm"</font>,permissions::evalPermString(<font color="#f800f8">"rw-------"</font>));
fd.close();
<font color="#0000f8">// create a shared memory segment, keyed to /tmp/shm, 128 bytes long</font>
sharedmemory shm;
shm.create(ftok(<font color="#f800f8">"/tmp/shm"</font>,<font color="#f800f8">0</font>),<font color="#f800f8">128</font>,
permissions::evalPermString(<font color="#f800f8">"rw-------"</font>));
<font color="#0000f8">// write a string into the shared memory</font>
<font color="#288850"><b>char</b></font> *shmptr=(<font color="#288850"><b>char</b></font> *)shm.getPointer();
strcpy(shmptr,<font color="#f800f8">"This string is in shared memory."</font>);
<font color="#0000f8">// sleep while another process accesses the shared memory...</font>
sleep(<font color="#f800f8">1000</font>);
}
</pre>
<p>This program reads the data from shared memory.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/types.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><sys/ipc.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/sharedmemory.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/permissions.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// attach to a shared memory segment keyed to /tmp/shm</font>
sharedmemory shm;
shm.attach(ftok(<font color="#f800f8">"/tmp/shm"</font>,<font color="#f800f8">0</font>));
<font color="#0000f8">// display the data contained in the shared memory segment</font>
<font color="#288850"><b>char</b></font> *shmptr=(<font color="#288850"><b>char</b></font> *)shm.getPointer();
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,shmptr);
}
</pre>
<a name="signal"></a>
<span class="heading">Using the Signal Classes</span><br><br>
<p>Signals allow processes to interrupt the execution of other processes.
Signal handlers allow processes to intercept and react to the signals sent to
them.</p>
<p>Rudiments provides 3 classes for working with signals: signalset,
signalmanager and signalhandler.
<p>A signalset is just a collection of signals. The signalset class allows
a programmer to build up a collection of signals.</p>
<p>The signalmanager class provides methods for sending signals, ignoring
signals, waiting for signals and examining blocked signals.</p>
<p>The signalhandler class provides methods for catching and handling
signals.</p>
<p>Below is some code illustrating the use of all three classes. Note that
you'll have to kill this program with a -9.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2001 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/signalclasses.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><unistd.h></font>
<font color="#288850"><b>void</b></font> handleSigusr1() {
printf(<font color="#f800f8">"Got a SIGUSR1!</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// this program will ignore all signals except SIGUSR1</font>
signalset ignoreset;
ignoreset.addAllSignals();
ignoreset.removeSignal(<font color="#f800f8">SIGUSR1</font>);
signalmanager::ignoreSignals(ignoreset.getSignalSet());
<font color="#0000f8">// when it gets a SIGUSR1, it will run the handleSigusr1() function</font>
signalhandler shandler(<font color="#f800f8">SIGUSR1</font>,(<font color="#288850"><b>void</b></font> *)&handleSigusr1);
<font color="#0000f8">// Loop forever, each time waiting for a signal not in the ignoreset</font>
<font color="#0000f8">// to be sent. Since SIGUSR1 is the only signal not in the ignoreset,</font>
<font color="#0000f8">// waitForSignals will fall through only when SIGUSR1 is received.</font>
<font color="#a02828"><b>while</b></font>(<font color="#f800f8">1</font>) {
signalmanager::waitForSignals(ignoreset.getSignalSet());
}
}
</pre>
<a name="stringbuffer"></a>
<span class="heading">Using the String Buffer Class</span><br><br>
<p>The stringbuffer class allows you to manipulate strings of arbitrary length.
You can append data to a stringbuffer or write data at arbitrary positions in
the buffer.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/stringbuffer.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argc, <font color="#288850"><b>char</b></font> **argv) {
<font color="#0000f8">// create a stringbuffer</font>
stringbuffer strb;
<font color="#0000f8">// append some data to it</font>
strb.append(<font color="#f800f8">"hello "</font>)->append(<font color="#f800f8">"there, "</font>)->append(<font color="#f800f8">"goodbye"</font>);
<font color="#0000f8">// display the string length and data</font>
printf(<font color="#f800f8">"Length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,strb.getStringLength());
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,strb.getString());
<font color="#0000f8">// clear the stringbuffer</font>
strb.clear();
<font color="#0000f8">// append 12345 to the string</font>
strb.append(<font color="#f800f8">"12345"</font>);
<font color="#0000f8">// set position to 10 and write 12345 again, this will leave a gap</font>
<font color="#0000f8">// in the string between positions 5 and 10 with garbage in it</font>
strb.setPosition(<font color="#f800f8">10</font>);
strb.write(<font color="#f800f8">"12345"</font>);
<font color="#0000f8">// display the string length and the string</font>
printf(<font color="#f800f8">"Length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,strb.getStringLength());
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<<font color="#f800f8">15</font>; i++) {
printf(<font color="#f800f8">"</font><font color="#6858c8">%c</font><font color="#f800f8">"</font>,strb.getString()[i]);
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// clear the stringbuffer</font>
strb.clear();
<font color="#0000f8">// append an integer to the stringbuffer</font>
strb.append((<font color="#288850"><b>long</b></font>)<font color="#f800f8">1</font>)->append(<font color="#f800f8">" "</font>);
<font color="#0000f8">// append a character to the stringbuffer</font>
strb.append(<font color="#f800f8">'a'</font>)->append(<font color="#f800f8">" "</font>);
<font color="#0000f8">// append a floating point number to the stringbuffer</font>
strb.append((<font color="#288850"><b>double</b></font>)<font color="#f800f8">2.2</font>)->append(<font color="#f800f8">" "</font>);
<font color="#0000f8">// append a floating point number to the stringbuffer with precision</font>
<font color="#0000f8">// and scale</font>
strb.append(<font color="#f800f8">2.2</font>,<font color="#f800f8">2</font>,<font color="#f800f8">3</font>);
<font color="#0000f8">// display the string length and data</font>
printf(<font color="#f800f8">"Length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,strb.getStringLength());
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,strb.getString());
}
</pre>
<a name="variablebuffer"></a>
<span class="heading">Using the Variable Buffer Class</span><br><br>
<p>The variablebuffer class allows you to manipulate a buffer of arbitrary
length containing binary data. You can append data to a variablebuffer or
write data at arbitrary positions in the buffer.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/variablebuffer.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argc, <font color="#288850"><b>char</b></font> **argv) {
<font color="#0000f8">// create a variablebuffer</font>
variablebuffer varb(<font color="#f800f8">5</font>,<font color="#f800f8">5</font>);
<font color="#0000f8">// append some string data to the buffer</font>
varb.append((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)<font color="#f800f8">"hello there, goodbye</font><font color="#6858c8">\0</font><font color="#f800f8">"</font>,<font color="#f800f8">21</font>);
<font color="#0000f8">// display the buffer size and data</font>
printf(<font color="#f800f8">"Size: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,varb.getSize());
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,varb.getBuffer());
<font color="#0000f8">// clear the buffer</font>
varb.clear();
<font color="#0000f8">// append 12345 to the buffer</font>
varb.append((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)<font color="#f800f8">"12345"</font>,<font color="#f800f8">5</font>);
<font color="#0000f8">// set position to 10 and write 12345 again, this will leave a gap</font>
<font color="#0000f8">// in the buffer between positions 5 and 10 with garbage in it</font>
varb.setPosition(<font color="#f800f8">10</font>);
varb.write((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)<font color="#f800f8">"12345"</font>,<font color="#f800f8">5</font>);
<font color="#0000f8">// display the buffer size and the buffer</font>
printf(<font color="#f800f8">"Size: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,varb.getSize());
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<<font color="#f800f8">15</font>; i++) {
printf(<font color="#f800f8">"</font><font color="#6858c8">%c</font><font color="#f800f8">"</font>,varb.getBuffer()[i]);
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// clear the buffer</font>
varb.clear();
<font color="#0000f8">// append an integer to the buffer</font>
<font color="#288850"><b>long</b></font> number=<font color="#f800f8">1</font>;
varb.append((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)&number,<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>long</b></font>));
<font color="#0000f8">// append a character to the buffer</font>
<font color="#288850"><b>char</b></font> character=<font color="#f800f8">'a'</font>;
varb.append((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)&character,<font color="#a02828"><b>sizeof</b></font>(character));
<font color="#0000f8">// append a floating point number to the buffer</font>
<font color="#288850"><b>double</b></font> doublenumber=<font color="#f800f8">2.2</font>;
varb.append((<font color="#288850"><b>unsigned</b></font> <font color="#288850"><b>char</b></font> *)&doublenumber,<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>double</b></font>));
<font color="#0000f8">// display the size and data</font>
printf(<font color="#f800f8">"Size: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,varb.getSize());
<font color="#288850"><b>long</b></font> *numptr=(<font color="#288850"><b>long</b></font> *)(varb.getBuffer());
<font color="#288850"><b>char</b></font> *charptr=(<font color="#288850"><b>char</b></font> *)(varb.getBuffer()+<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>long</b></font>));
<font color="#288850"><b>double</b></font> *doubleptr=(<font color="#288850"><b>double</b></font> *)(varb.getBuffer()+
<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>long</b></font>)+<font color="#a02828"><b>sizeof</b></font>(<font color="#288850"><b>char</b></font>));
printf(<font color="#f800f8">"</font><font color="#6858c8">%d</font><font color="#f800f8"> </font><font color="#6858c8">%c</font><font color="#f800f8"> </font><font color="#6858c8">%f</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,*numptr,*charptr,*doubleptr);
}
</pre>
<a name="string"></a>
<span class="heading">Using the Charstring Class</span><br><br>
<p>The charstring class contains some commonly needed string manipulation and
evaluation functions. Below is some code illustrating the use of the string
class.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2003 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/charstring.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// create a new string 50 bytes long</font>
charstring s(<font color="#f800f8">50</font>);
<font color="#0000f8">// set every byte in the string to NULL</font>
s.zero();
<font color="#0000f8">// Append "hello there dave" to the string and display it.</font>
<font color="#0000f8">// The 3rd call to append() only appends the first 4 bytes of "dave !!!"</font>
s.append(<font color="#f800f8">"hello "</font>);
s.append(<font color="#f800f8">"there "</font>);
s.append(<font color="#f800f8">"dave !!!"</font>,<font color="#f800f8">4</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"\n</font><font color="#f800f8">"</font>,s.getString());
<font color="#0000f8">// Replace the contents of the string and display it over and over.</font>
<font color="#0000f8">// Note that the 2nd and 4th call to copyInto() only copy part of the</font>
<font color="#0000f8">// string passed into them.</font>
s.copyInto(<font color="#f800f8">"what's "</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"\n</font><font color="#f800f8">"</font>,s.getString());
s.copyInto(<font color="#f800f8">"up !!!"</font>,<font color="#f800f8">2</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"\n</font><font color="#f800f8">"</font>,s.getString());
s.copyInto(<font color="#f800f8">2</font>,<font color="#f800f8">" !!!"</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"\n</font><font color="#f800f8">"</font>,s.getString());
s.copyInto(<font color="#f800f8">6</font>,<font color="#f800f8">"!!!!!!"</font>,<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"\n</font><font color="#f800f8">"</font>,s.getString());
<font color="#0000f8">// clear the string again.</font>
s.zero();
<font color="#0000f8">// Append "hello" to the string.</font>
s.append(<font color="#f800f8">"hello"</font>);
<font color="#0000f8">// perform several comparisons, all of which should return 0</font>
printf(<font color="#f800f8">"compare: </font><font color="#6858c8">%d</font><font color="#f800f8">=0</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.compare(<font color="#f800f8">"hello"</font>));
printf(<font color="#f800f8">"compare: </font><font color="#6858c8">%d</font><font color="#f800f8">=0</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.compare(<font color="#f800f8">"hello"</font>,<font color="#f800f8">3</font>));
printf(<font color="#f800f8">"compare: </font><font color="#6858c8">%d</font><font color="#f800f8">=0</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.compareIgnoringCase(<font color="#f800f8">"HELLO"</font>));
printf(<font color="#f800f8">"compare: </font><font color="#6858c8">%d</font><font color="#f800f8">=0</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.compareIgnoringCase(<font color="#f800f8">"HELLO"</font>,<font color="#f800f8">3</font>));
<font color="#0000f8">// perform several contains() comparisons</font>
printf(<font color="#f800f8">"contains: </font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"</font><font color="#f800f8">=llo</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.contains(<font color="#f800f8">"llo"</font>));
printf(<font color="#f800f8">"contains: </font><font color="#6858c8">\"</font><font color="#6858c8">%s</font><font color="#6858c8">\"</font><font color="#f800f8">=llo</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,s.contains(<font color="#f800f8">'l'</font>));
<font color="#0000f8">// duplicate the string and display the duplicated string</font>
<font color="#288850"><b>char</b></font> *hello=s.duplicate();
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,hello);
<font color="#0000f8">// make sure to clean up what duplicate() returns</font>
<font color="#a02828"><b>delete</b></font>[] hello;
}
</pre>
<a name="xmlsax"></a>
<span class="heading">Using the XML SAX Class</span><br><br>
<p>The XML SAX class provides a callback-based framework for parsing XML
documents. The xmlsax class provides methods for parsing strings of XML or
XML files. When it encounters a tag, attribute or other XML component, it
calls one of it's callback methods. These methods may be overridden by
a child class to perform specific tasks. The xmlsax class is especially useful
if you can't afford to load the entire document into memory and use the XML DOM
class, or if you just need to extract specific data from an XML file.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/xmlsax.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>class</b></font> myxmlsax : <font color="#a02828"><b>public</b></font> xmlsax {
<font color="#a02828"><b>public</b></font>:
myxmlsax();
<font color="#a02828"><b>private</b></font>:
<font color="#288850"><b>int</b></font> xmlVersionStart();
<font color="#288850"><b>int</b></font> xmlVersionEnd();
<font color="#288850"><b>int</b></font> doctypeStart(<font color="#288850"><b>char</b></font> *name);
<font color="#288850"><b>int</b></font> externalSubset(<font color="#288850"><b>char</b></font> *filename);
<font color="#288850"><b>int</b></font> doctypeEnd();
<font color="#288850"><b>int</b></font> tagStart(<font color="#288850"><b>char</b></font> *name);
<font color="#288850"><b>int</b></font> attributeName(<font color="#288850"><b>char</b></font> *name);
<font color="#288850"><b>int</b></font> attributeValue(<font color="#288850"><b>char</b></font> *value);
<font color="#288850"><b>int</b></font> text(<font color="#288850"><b>char</b></font> *string);
<font color="#288850"><b>int</b></font> tagEnd(<font color="#288850"><b>char</b></font> *name);
<font color="#288850"><b>int</b></font> comment(<font color="#288850"><b>char</b></font> *string);
<font color="#288850"><b>int</b></font> cdata(<font color="#288850"><b>char</b></font> *string);
<font color="#288850"><b>void</b></font> indent(<font color="#288850"><b>int</b></font> spaces);
<font color="#288850"><b>int</b></font> ind;
};
myxmlsax::myxmlsax() : xmlsax() {
ind=<font color="#f800f8">0</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::xmlVersionStart() {
printf(<font color="#f800f8">"XML version start:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::xmlVersionEnd() {
printf(<font color="#f800f8">"XML version end:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::doctypeStart(<font color="#288850"><b>char</b></font> *name) {
printf(<font color="#f800f8">"DOCTYPE start: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,name);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::externalSubset(<font color="#288850"><b>char</b></font> *filename) {
printf(<font color="#f800f8">" external subset: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,filename);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::doctypeEnd() {
printf(<font color="#f800f8">"DOCTYPE end:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>void</b></font> myxmlsax::indent(<font color="#288850"><b>int</b></font> spaces) {
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<spaces; i++) {
printf(<font color="#f800f8">" "</font>);
}
}
<font color="#288850"><b>int</b></font> myxmlsax::tagStart(<font color="#288850"><b>char</b></font> *name) {
indent(ind);
printf(<font color="#f800f8">"tagStart: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,name);
ind++;
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::attributeName(<font color="#288850"><b>char</b></font> *name) {
indent(ind+<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"attribute name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,name);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::attributeValue(<font color="#288850"><b>char</b></font> *value) {
indent(ind+<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"attribute value: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,value);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::text(<font color="#288850"><b>char</b></font> *string) {
indent(ind+<font color="#f800f8">1</font>);
printf(<font color="#f800f8">"text: </font><font color="#6858c8">\n</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,string);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::tagEnd(<font color="#288850"><b>char</b></font> *name) {
ind--;
indent(ind);
printf(<font color="#f800f8">"tagEnd: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,name);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::comment(<font color="#288850"><b>char</b></font> *string) {
indent(ind);
printf(<font color="#f800f8">"comment: </font><font color="#6858c8">\n</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,string);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> myxmlsax::cdata(<font color="#288850"><b>char</b></font> *string) {
indent(ind);
printf(<font color="#f800f8">"cdata: </font><font color="#6858c8">\n</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,string);
<font color="#a02828"><b>return</b></font> <font color="#f800f8">1</font>;
}
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
myxmlsax x;
x.parseFile(<font color="#f800f8">"xmls.xml"</font>);
}
</pre>
<a name="xmldom"></a>
<span class="heading">Using the XML DOM Class</span><br><br>
<p>The XML DOM and XML DOM Node classes provide a framework for DOM parsing of
XML documents. The xmldom class provides methods for parsing the document
and accessing it's root node. Each node of the document is represented by an
instance of the xmldomnode class. The xmldomnode class provides methods for
accessing a node's data, attributes, child nodes, parent nodes and sibling
nodes. Since the xmldom class creates a representation of the XML document
in memory, it should not be used to process arbitrarily large documents which
could exhaust system memory.</p>
<p>The following XML file contains an address book.</p>
<PRE>
<font color="#0000f8"><?</font><font color="#288850"><b>xml</b></font><font color="#288850"><b> </b></font><font color="#288850"><b>version</b></font>=<font color="#f800f8">"1.0"</font><font color="#0000f8">?></font>
<font color="#008888"><!</font><font color="#a02828"><b>DOCTYPE</b></font> instances <font color="#a02828"><b>SYSTEM</b></font> <font color="#f800f8">"adbook.dtd"</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">addressbook</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">person</font><font color="#008888"> </font><font color="#288850"><b>firstname</b></font>=<font color="#f800f8">"David"</font><font color="#008888"> </font><font color="#288850"><b>middlename</b></font>=<font color="#f800f8">"Lee"</font><font color="#008888"> </font><font color="#288850"><b>lastname</b></font>=<font color="#f800f8">"Muse"</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">phones</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">phone</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"home"</font><font color="#008888"> </font><font color="#288850"><b>number</b></font>=<font color="#f800f8">"1-222-333-4444"</font><font color="#008888">/></font>
<font color="#008888"><</font><font color="#008888">phone</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"work"</font><font color="#008888"> </font><font color="#288850"><b>number</b></font>=<font color="#f800f8">"1-333-444-5555"</font><font color="#008888">/></font>
<font color="#008888"><</font><font color="#008888">phone</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"mobile"</font><font color="#008888"> </font><font color="#288850"><b>number</b></font>=<font color="#f800f8">"1-444-555-6666"</font><font color="#008888">/></font>
<font color="#008888"></phones></font>
<font color="#008888"><</font><font color="#008888">addresses</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">address</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"home"</font><font color="#008888"> </font><font color="#288850"><b>address</b></font>=<font color="#f800f8">"1234 homestreet dr."</font><font color="#008888"> </font><font color="#288850"><b>city</b></font>=<font color="#f800f8">"mycity"</font><font color="#008888"> </font><font color="#288850"><b>state</b></font>=<font color="#f800f8">"GA"</font><font color="#008888"> </font><font color="#288850"><b>zip</b></font>=<font color="#f800f8">"12345"</font><font color="#008888">/></font>
<font color="#008888"><</font><font color="#008888">address</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"work"</font><font color="#008888"> </font><font color="#288850"><b>address</b></font>=<font color="#f800f8">"2345 workstreet dr."</font><font color="#008888"> </font><font color="#288850"><b>city</b></font>=<font color="#f800f8">"mycity"</font><font color="#008888"> </font><font color="#288850"><b>state</b></font>=<font color="#f800f8">"GA"</font><font color="#008888"> </font><font color="#288850"><b>zip</b></font>=<font color="#f800f8">"23456"</font><font color="#008888">/></font>
<font color="#008888"></addresses></font>
<font color="#008888"><</font><font color="#008888">emails</font><font color="#008888">></font>
<font color="#008888"><</font><font color="#008888">email</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"home"</font><font color="#008888"> </font><font color="#288850"><b>address</b></font>=<font color="#f800f8">"dmuse@firstworks.com"</font><font color="#008888">/></font>
<font color="#008888"><</font><font color="#008888">email</font><font color="#008888"> </font><font color="#288850"><b>location</b></font>=<font color="#f800f8">"work"</font><font color="#008888"> </font><font color="#288850"><b>address</b></font>=<font color="#f800f8">"dmuse@workemail.com"</font><font color="#008888">/></font>
<font color="#008888"></emails></font>
<font color="#008888"></person></font>
<font color="#008888"></addressbook></font>
</PRE>
<p>The following program parses the addressbook and prints it to the screen.</p>
<PRE>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/xmldom.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><iostream.h></font>
<font color="#288850"><b>int</b></font> main() {
xmldom x;
x.parseFile(<font color="#f800f8">"addressbook.xml"</font>);
x.getRootNode()->cascadeOnDelete();
xmldomnode *addressbook=x.getRootNode()->getChild(<font color="#f800f8">"addressbook"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; i<addressbook->getChildCount(); i++) {
xmldomnode *person=addressbook->getChild(i);
<font color="#a02828"><b>if</b></font> (person->getType()!=TAG_XMLDOMNODETYPE) {
<font color="#a02828"><b>continue</b></font>;
}
cout << person->getAttribute(<font color="#f800f8">"firstname"</font>)->getValue() << <font color="#f800f8">" "</font>;
cout << person->getAttribute(<font color="#f800f8">"middlename"</font>)->getValue() << <font color="#f800f8">" "</font>;
cout << person->getAttribute(<font color="#f800f8">"lastname"</font>)->getValue() << endl;
xmldomnode *phones=person->getChild(<font color="#f800f8">"phones"</font>);
cout << <font color="#f800f8">"Phones:"</font> << endl;
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> j=<font color="#f800f8">0</font>; j<phones->getChildCount(); j++) {
xmldomnode *phone=phones->getChild(j);
<font color="#a02828"><b>if</b></font> (phone->getType()!=TAG_XMLDOMNODETYPE) {
<font color="#a02828"><b>continue</b></font>;
}
cout << <font color="#f800f8">" "</font>;
cout << phone->getAttribute(<font color="#f800f8">"location"</font>)->
getValue() << <font color="#f800f8">": "</font>;
cout << phone->getAttribute(<font color="#f800f8">"number"</font>)->
getValue() << endl;
}
cout << endl;
xmldomnode *addresses=person->getChild(<font color="#f800f8">"addresses"</font>);
cout << <font color="#f800f8">"Addresses:"</font> << endl;
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> j=<font color="#f800f8">0</font>; j<addresses->getChildCount(); j++) {
xmldomnode *address=addresses->getChild(j);
<font color="#a02828"><b>if</b></font> (address->getType()!=TAG_XMLDOMNODETYPE) {
<font color="#a02828"><b>continue</b></font>;
}
cout << <font color="#f800f8">" "</font>;
cout << address->getAttribute(<font color="#f800f8">"location"</font>)->
getValue() << <font color="#f800f8">": "</font>;
cout << address->getAttribute(<font color="#f800f8">"address"</font>)->
getValue() << <font color="#f800f8">" "</font>;
cout << address->getAttribute(<font color="#f800f8">"city"</font>)->
getValue() << <font color="#f800f8">", "</font>;
cout << address->getAttribute(<font color="#f800f8">"state"</font>)->
getValue() << <font color="#f800f8">" "</font>;
cout << address->getAttribute(<font color="#f800f8">"zip"</font>)->
getValue() << endl;
}
cout << endl;
xmldomnode *emails=person->getChild(<font color="#f800f8">"emails"</font>);
cout << <font color="#f800f8">"Emails:"</font> << endl;
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> j=<font color="#f800f8">0</font>; j<emails->getChildCount(); j++) {
xmldomnode *email=emails->getChild(j);
<font color="#a02828"><b>if</b></font> (email->getType()!=TAG_XMLDOMNODETYPE) {
<font color="#a02828"><b>continue</b></font>;
}
cout << <font color="#f800f8">" "</font>;
cout << email->getAttribute(<font color="#f800f8">"location"</font>)->
getValue() << <font color="#f800f8">": "</font>;
cout << email->getAttribute(<font color="#f800f8">"address"</font>)->
getValue() << endl;
}
cout << endl;
}
}
</PRE>
<p>Here is the output of the program above.</p>
<blockquote>
<PRE>
David Lee Muse
Phones:
home: 1-222-333-4444
work: 1-333-444-5555
mobile: 1-444-555-6666
Addresses:
home: 1234 homestreet dr. mycity, GA 12345
work: 2345 workstreet dr. mycity, GA 23456
Emails:
home: dmuse@firstworks.com
work: dmuse@workemail.com
</PRE>
</blockquote>
<a name="dtd"></a>
<span class="heading">Using the DTD Class</span><br><br>
<p>The DTD class provides methods for parsing an XML DTD. The result is an
XML DOM tree representing the DTD. Once parsed, the tree can be accessed
using the xmldom and xmldomnode classes.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/dtd.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// display the contents of dtd.dtd</font>
dtd d;
d.parseFile(<font color="#f800f8">"dtd.dtd"</font>);
printf(<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,d.xml()->getString());
}
</pre>
<a name="passwdentry"></a>
<span class="heading">Using the Password Entry Class</span><br><br>
<p>The passwdentry class allows you to look up entries from /etc/passwd or
from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/passwdentry.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// get the password entry for "root"</font>
passwdentry pwent;
pwent.initialize(<font color="#f800f8">"root"</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getName());
printf(<font color="#f800f8">" Password: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getPassword());
printf(<font color="#f800f8">" User Id: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getUserId());
printf(<font color="#f800f8">" Primary Group: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getPrimaryGroup());
printf(<font color="#f800f8">" Real Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getRealName());
printf(<font color="#f800f8">" Home Directory: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getHomeDirectory());
printf(<font color="#f800f8">" Shell: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getShell());
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
pwent.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// get the password entry for user id 0</font>
pwent.initialize((uid_t)<font color="#f800f8">0</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getName());
printf(<font color="#f800f8">" Password: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getPassword());
printf(<font color="#f800f8">" User Id: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getUserId());
printf(<font color="#f800f8">" Primary Group: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getPrimaryGroup());
printf(<font color="#f800f8">" Real Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getRealName());
printf(<font color="#f800f8">" Home Directory: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getHomeDirectory());
printf(<font color="#f800f8">" Shell: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pwent.getShell());
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
pwent.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
<a name="shadowentry"></a>
<span class="heading">Using the Shadow Entry Class</span><br><br>
<p>The shadowentry class allows you to look up entries from /etc/shadow or
from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#ff00ff"><rudiments/shadowentry.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdio.h></font>
<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argv, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argc) {
<font color="#0000ff">// get the shadow entry for "root"</font>
shadowentry spent;
spent.initialize(<font color="#ff00ff">"root"</font>);
<font color="#0000ff">// print the components individually</font>
printf(<font color="#ff00ff">"Individually...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" Name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,spent.getName());
printf(<font color="#ff00ff">" Encrypted Password: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,spent.getEncryptedPassword());
printf(<font color="#ff00ff">" Last Change: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getLastChangeDate());
printf(<font color="#ff00ff">" Days Before Change Allowed: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getDaysBeforeChangeAllowed());
printf(<font color="#ff00ff">" Days Before Change Required: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getDaysBeforeChangeRequired());
printf(<font color="#ff00ff">" Days Before Expiration Warning: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getDaysBeforeExpirationWarning());
printf(<font color="#ff00ff">" Days Of Inactivity Allowed: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getDaysOfInactivityAllowed());
printf(<font color="#ff00ff">" Expiration Date: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,
spent.getExpirationDate());
printf(<font color="#ff00ff">" Flag: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,spent.getFlag());
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// use the built in print method</font>
printf(<font color="#ff00ff">"Built In...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
spent.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
}
</pre>
<a name="groupentry"></a>
<span class="heading">Using the Group Entry Class</span><br><br>
<p>The groupentry class allows you to look up entries from /etc/group or
from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/private/config.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/groupentry.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// get the group entry for "bin"</font>
groupentry grent;
grent.initialize(<font color="#f800f8">"bin"</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getName());
printf(<font color="#f800f8">" Password: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getPassword());
printf(<font color="#f800f8">" Group Id: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getGroupId());
printf(<font color="#f800f8">" Members:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; grent.getMembers()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getMembers()[i]);
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built in...:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
grent.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// get the group entry for group id 1</font>
grent.initialize((gid_t)<font color="#f800f8">1</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getName());
printf(<font color="#f800f8">" Password: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getPassword());
printf(<font color="#f800f8">" Group Id: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getGroupId());
printf(<font color="#f800f8">" Members:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; grent.getMembers()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,grent.getMembers()[i]);
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built in...:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
grent.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
<a name="hostentry"></a>
<span class="heading">Using the Host Entry Class</span><br><br>
<p>The hostentry class allows you to look up entries from /etc/hosts or
from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/hostentry.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#0000f8">// this function takes addr[]={127,1,1,0} and returns "127.1.1.0"</font>
<font color="#288850"><b>char</b></font> *getAddressString(<font color="#288850"><b>int</b></font> length, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> *addr) {
<font color="#288850"><b>char</b></font> *address=<font color="#a02828"><b>new</b></font> <font color="#288850"><b>char</b></font>[(length*<font color="#f800f8">4</font>)+<font color="#f800f8">1</font>];
address[<font color="#f800f8">0</font>]=(<font color="#288850"><b>char</b></font>)<font color="#f800f8">NULL</font>;
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> byte=<font color="#f800f8">0</font>; byte<length; byte++) {
sprintf(address,<font color="#f800f8">"</font><font color="#6858c8">%s%d</font><font color="#f800f8">"</font>,address,addr[byte]);
<font color="#a02828"><b>if</b></font> (byte<length-<font color="#f800f8">1</font>) {
sprintf(address,<font color="#f800f8">"</font><font color="#6858c8">%s</font><font color="#f800f8">."</font>,address);
}
}
<font color="#a02828"><b>return</b></font> address;
}
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// get the host information for "localhost"</font>
hostentry he;
he.initialize(<font color="#f800f8">"localhost"</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getName());
printf(<font color="#f800f8">" Alias list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; he.getAliasList()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAliasList()[i]);
}
printf(<font color="#f800f8">" Address type: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAddressType());
printf(<font color="#f800f8">" Address length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAddressLength());
printf(<font color="#f800f8">" Address list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; he.getAddressList()[i]; i++) {
<font color="#288850"><b>char</b></font> *addr=getAddressString(he.getAddressLength(),
he.getAddressList()[i]);
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,addr);
<font color="#a02828"><b>delete</b></font>[] addr;
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
he.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// get the host information for "127.0.0.1"</font>
<font color="#288850"><b>char</b></font> address[]={<font color="#f800f8">127</font>,<font color="#f800f8">0</font>,<font color="#f800f8">0</font>,<font color="#f800f8">1</font>};
he.initialize(address,<font color="#f800f8">4</font>,AF_INET);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getName());
printf(<font color="#f800f8">" Alias list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; he.getAliasList()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAliasList()[i]);
}
printf(<font color="#f800f8">" Address type: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAddressType());
printf(<font color="#f800f8">" Address length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,he.getAddressLength());
printf(<font color="#f800f8">" Address list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; he.getAddressList()[i]; i++) {
<font color="#288850"><b>char</b></font> *addr=getAddressString(he.getAddressLength(),
he.getAddressList()[i]);
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,addr);
<font color="#a02828"><b>delete</b></font>[] addr;
}
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
he.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
<a name="protocolentry"></a>
<span class="heading">Using the Protocol Entry Class</span><br><br>
<p>The protocolentry class allows you to look up entries from /etc/protocols
or from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2002 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/protocolentry.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// get the protocol information for "tcp"</font>
protocolentry pe;
pe.initialize(<font color="#f800f8">"tcp"</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getName());
printf(<font color="#f800f8">" Alias list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; pe.getAliasList()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getAliasList()[i]);
}
printf(<font color="#f800f8">" Number: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getNumber());
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
pe.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// get the protocol information for protocol number 6</font>
pe.initialize(<font color="#f800f8">6</font>);
<font color="#0000f8">// print the components individually</font>
printf(<font color="#f800f8">"Individually...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
printf(<font color="#f800f8">" Name: </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getName());
printf(<font color="#f800f8">" Alias list:</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#a02828"><b>for</b></font> (<font color="#288850"><b>int</b></font> i=<font color="#f800f8">0</font>; pe.getAliasList()[i]; i++) {
printf(<font color="#f800f8">" </font><font color="#6858c8">%s</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getAliasList()[i]);
}
printf(<font color="#f800f8">" Number: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,pe.getNumber());
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// use the built in print method</font>
printf(<font color="#f800f8">"Built In...</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
pe.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
<a name="serviceentry"></a>
<span class="heading">Using the Service Entry Class</span><br><br>
<p>The serviceentry class allows you to look up entries from /etc/services
or from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#ff00ff"><rudiments/serviceentry.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdio.h></font>
<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argv, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argc) {
<font color="#0000ff">// get the service information for "smtp","tcp"</font>
serviceentry se;
se.initialize(<font color="#ff00ff">"smtp"</font>,<font color="#ff00ff">"tcp"</font>);
<font color="#0000ff">// print the components individually</font>
printf(<font color="#ff00ff">"Individually...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" Name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getName());
printf(<font color="#ff00ff">" Port: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getPort());
printf(<font color="#ff00ff">" Protocol: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getProtocol());
printf(<font color="#ff00ff">" Alias list:</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> i=<font color="#ff00ff">0</font>; se.getAliasList()[i]; i++) {
printf(<font color="#ff00ff">" </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getAliasList()[i]);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// use the built in print method</font>
printf(<font color="#ff00ff">"Built In...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
se.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// get the service information for the service on port 25, "tcp"</font>
se.initialize(<font color="#ff00ff">25</font>,<font color="#ff00ff">"tcp"</font>);
<font color="#0000ff">// print the components individually</font>
printf(<font color="#ff00ff">"Individually...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" Name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getName());
printf(<font color="#ff00ff">" Port: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getPort());
printf(<font color="#ff00ff">" Protocol: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getProtocol());
printf(<font color="#ff00ff">" Alias list:</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> i=<font color="#ff00ff">0</font>; se.getAliasList()[i]; i++) {
printf(<font color="#ff00ff">" </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,se.getAliasList()[i]);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// use the built in print method</font>
printf(<font color="#ff00ff">"Built In...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
se.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
}
</pre>
<a name="rpcentry"></a>
<span class="heading">Using the RPC Entry Class</span><br><br>
<p>The rpcentry class allows you to look up entries from /etc/rpc
or from elsewhere if you're using the Name Service Switch.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#ff00ff"><rudiments/rpcentry.h></font>
<font color="#a020f0">#include </font><font color="#ff00ff"><stdio.h></font>
<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argv, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argc) {
<font color="#0000ff">// get the rpc information for "portmap"</font>
rpcentry re;
re.initialize(<font color="#ff00ff">"portmap"</font>);
<font color="#0000ff">// print the components individually</font>
printf(<font color="#ff00ff">"Individually...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" Name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getName());
printf(<font color="#ff00ff">" Number: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getNumber());
printf(<font color="#ff00ff">" Alias list:</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> i=<font color="#ff00ff">0</font>; re.getAliasList()[i]; i++) {
printf(<font color="#ff00ff">" </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getAliasList()[i]);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// use the built in print method</font>
printf(<font color="#ff00ff">"Built In...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
re.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// get the protocol information for protocol number 100000</font>
re.initialize(<font color="#ff00ff">100000</font>);
<font color="#0000ff">// print the components individually</font>
printf(<font color="#ff00ff">"Individually...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
printf(<font color="#ff00ff">" Name: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getName());
printf(<font color="#ff00ff">" Number: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getNumber());
printf(<font color="#ff00ff">" Alias list:</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#a52a2a"><b>for</b></font> (<font color="#2e8b57"><b>int</b></font> i=<font color="#ff00ff">0</font>; re.getAliasList()[i]; i++) {
printf(<font color="#ff00ff">" </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>,re.getAliasList()[i]);
}
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
<font color="#0000ff">// use the built in print method</font>
printf(<font color="#ff00ff">"Built In...</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
re.print();
printf(<font color="#ff00ff">"</font><font color="#6a5acd">\n</font><font color="#ff00ff">"</font>);
}
</pre>
<a name="linkedlist"></a>
<span class="heading">Using the Linkedlist Class</span><br><br>
<p>The linkedlist class allows you to store arbitrary data in a doubly-linked
list.</p>
<p>Since lists of strings are commonly used, a stringlist typedef is
provided for convenience.</p>
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/linkedlist.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argc, <font color="#288850"><b>char</b></font> **argv) {
<font color="#0000f8">// create a list of integers</font>
linkedlist<<font color="#288850"><b>int</b></font>> intl;
<font color="#0000f8">// append values to the list, displaying the list after each append</font>
printf(<font color="#f800f8">"append(0)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.append(<font color="#f800f8">0</font>);
intl.print();
printf(<font color="#f800f8">"append(1)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.append(<font color="#f800f8">1</font>);
intl.print();
printf(<font color="#f800f8">"append(3)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.append(<font color="#f800f8">3</font>);
intl.print();
<font color="#0000f8">// insert a value into the middle of the list, display the list</font>
printf(<font color="#f800f8">"insert(2,2)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.insert(<font color="#f800f8">2</font>,<font color="#f800f8">2</font>);
intl.print();
<font color="#0000f8">// remove values from the list, displaying the list after each removal</font>
printf(<font color="#f800f8">"removeByIndex(0)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.removeByIndex(<font color="#f800f8">0</font>);
intl.print();
printf(<font color="#f800f8">"removeByData(3)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.removeByData(<font color="#f800f8">3</font>);
intl.print();
<font color="#0000f8">// change a value in the list, display the list</font>
printf(<font color="#f800f8">"setDataByIndex(1,50)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.setDataByIndex(<font color="#f800f8">1</font>,<font color="#f800f8">50</font>);
intl.print();
<font color="#0000f8">// clear the list, display the list</font>
printf(<font color="#f800f8">"clear()</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
intl.clear();
intl.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// create a list of strings</font>
stringlist strl;
<font color="#0000f8">// append values to the list, displaying the list after each append</font>
printf(<font color="#f800f8">"append(zero)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.append(<font color="#f800f8">"zero"</font>);
strl.print();
printf(<font color="#f800f8">"append(one)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.append(<font color="#f800f8">"one"</font>);
strl.print();
printf(<font color="#f800f8">"append(three)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.append(<font color="#f800f8">"three"</font>);
strl.print();
<font color="#0000f8">// insert a value into the middle of the list, display the list</font>
printf(<font color="#f800f8">"insert(2,two)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.insert(<font color="#f800f8">2</font>,<font color="#f800f8">"two"</font>);
strl.print();
<font color="#0000f8">// remove values from the list, displaying the list after each removal</font>
printf(<font color="#f800f8">"removeByIndex(0)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.removeByIndex(<font color="#f800f8">0</font>);
strl.print();
printf(<font color="#f800f8">"removeByData(three)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.removeByData(<font color="#f800f8">"three"</font>);
strl.print();
<font color="#0000f8">// change a value in the list, display the list</font>
printf(<font color="#f800f8">"setDataByIndex(1,fifty)</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.setDataByIndex(<font color="#f800f8">1</font>,<font color="#f800f8">"fifty"</font>);
strl.print();
<font color="#0000f8">// clear the list, display the list</font>
printf(<font color="#f800f8">"clear()</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
strl.clear();
strl.print();
}
</pre>
<a name="dictionary"></a>
<span class="heading">Using the Dictionary Class</span><br><br>
<p>The dictionary class allows you to store arbitrary key/value-pair data.</p>
<p>Since dictionaries with string and long integer keys and dictionaries with
string keys and values are commonly used, convenience classes are provided
for each.</p>
<pre>
<font color="#0000f8">// Copyright (c) 2003 David Muse</font>
<font color="#0000f8">// See the file COPYING for more information</font>
<font color="#a020f0">#include </font><font color="#f800f8"><rudiments/dictionary.h></font>
<font color="#a020f0">#include </font><font color="#f800f8"><stdio.h></font>
<font color="#288850"><b>int</b></font> main(<font color="#288850"><b>int</b></font> argv, <font color="#288850"><b>const</b></font> <font color="#288850"><b>char</b></font> **argc) {
<font color="#0000f8">// create a dictionary containing string keys and string values</font>
namevaluepairs dict;
<font color="#0000f8">// add values to the dictionary</font>
dict.setData(<font color="#f800f8">"1"</font>,<font color="#f800f8">"one"</font>);
dict.setData(<font color="#f800f8">"2"</font>,<font color="#f800f8">"two"</font>);
dict.setData(<font color="#f800f8">"3"</font>,<font color="#f800f8">"three"</font>);
dict.setData(<font color="#f800f8">"4"</font>,<font color="#f800f8">"four"</font>);
<font color="#0000f8">// display the length and contents of the dictionary</font>
printf(<font color="#f800f8">"length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,dict.getList()->getLength());
dict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// remove values, displaying the dictionary after each removal</font>
dict.removeData(<font color="#f800f8">"3"</font>);
dict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
dict.removeData(<font color="#f800f8">"2"</font>);
dict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
dict.removeData(<font color="#f800f8">"4"</font>);
dict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
dict.removeData(<font color="#f800f8">"1"</font>);
dict.print();
<font color="#0000f8">// create a dictionary containing long integer keys and string values</font>
numericdictionary<<font color="#288850"><b>char</b></font> *> numdict;
<font color="#0000f8">// add values to the dictionary</font>
numdict.setData(<font color="#f800f8">1</font>,<font color="#f800f8">"one"</font>);
numdict.setData(<font color="#f800f8">2</font>,<font color="#f800f8">"two"</font>);
numdict.setData(<font color="#f800f8">3</font>,<font color="#f800f8">"three"</font>);
numdict.setData(<font color="#f800f8">4</font>,<font color="#f800f8">"four"</font>);
<font color="#0000f8">// display the length and contents of the dictionary</font>
printf(<font color="#f800f8">"length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,numdict.getList()->getLength());
numdict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// remove values, displaying the dictionary after each removal</font>
numdict.removeData(<font color="#f800f8">3</font>);
numdict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
numdict.removeData(<font color="#f800f8">2</font>);
numdict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
numdict.removeData(<font color="#f800f8">4</font>);
numdict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
numdict.removeData(<font color="#f800f8">1</font>);
numdict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// create a dictionary containing double precision</font>
<font color="#0000f8">// floating point keys and string values</font>
dictionary<<font color="#288850"><b>double</b></font>,<font color="#288850"><b>char</b></font> *> doubledict;
<font color="#0000f8">// add values to the dictionary</font>
doubledict.setData(<font color="#f800f8">1.1</font>,<font color="#f800f8">"one point one"</font>);
doubledict.setData(<font color="#f800f8">2.2</font>,<font color="#f800f8">"two point two"</font>);
doubledict.setData(<font color="#f800f8">3.3</font>,<font color="#f800f8">"three point three"</font>);
doubledict.setData(<font color="#f800f8">4.4</font>,<font color="#f800f8">"four point four"</font>);
<font color="#0000f8">// display the length and contents of the dictionary</font>
printf(<font color="#f800f8">"length: </font><font color="#6858c8">%d</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>,doubledict.getList()->getLength());
doubledict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
<font color="#0000f8">// remove values, displaying the dictionary after each removal</font>
doubledict.removeData(<font color="#f800f8">3.3</font>);
doubledict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
doubledict.removeData(<font color="#f800f8">2.2</font>);
doubledict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
doubledict.removeData(<font color="#f800f8">4.4</font>);
doubledict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
doubledict.removeData(<font color="#f800f8">1.1</font>);
doubledict.print();
printf(<font color="#f800f8">"</font><font color="#6858c8">\n</font><font color="#f800f8">"</font>);
}
</pre>
</body>
</html>
|