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
|
<?xml version="1.0" encoding="utf-8"?>
<mxmldoc xmlns="http://www.easysw.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.minixml.org/mxmldoc.xsd">
<function name="mxmlAdd">
<description>Add a node to a tree.
Adds the specified node to the parent. If the child argument is not
NULL, puts the new node before or after the specified child depending
on the value of the where argument. If the child argument is NULL,
puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
or at the end of the child list (MXML_ADD_AFTER). The constant
MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node</description>
</argument>
<argument name="where" direction="I">
<type>int</type>
<description>Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER</description>
</argument>
<argument name="child" direction="I">
<type>mxml_node_t *</type>
<description>Child node for where or MXML_ADD_TO_PARENT</description>
</argument>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to add</description>
</argument>
</function>
<function name="mxmlDelete">
<description>Delete a node and all of its children.
If the specified node has a parent, this function first removes the
node from its parent using the mxmlRemove() function.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to delete</description>
</argument>
</function>
<function name="mxmlElementDeleteAttr">
<description>Delete an attribute.
@since Mini-XML 2.4@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Attribute name</description>
</argument>
</function>
<function name="mxmlElementGetAttr">
<returnvalue>
<type>const char *</type>
<description>Attribute value or NULL</description>
</returnvalue>
<description>Get an attribute.
This function returns NULL if the node is not an element or the
named attribute does not exist.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
</function>
<function name="mxmlElementSetAttr">
<description>Set an attribute.
If the named attribute already exists, the value of the attribute
is replaced by the new string value. The string value is copied
into the element node. This function does nothing if the node is
not an element.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value</description>
</argument>
</function>
<function name="mxmlElementSetAttrf">
<description>Set an attribute with a formatted value.
If the named attribute already exists, the value of the attribute
is replaced by the new formatted string. The formatted string value is
copied into the element node. This function does nothing if the node
is not an element.
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
<argument name="format" direction="I">
<type>const char *</type>
<description>Printf-style attribute value</description>
</argument>
<argument name="..." direction="I">
<type /> <description>Additional arguments as needed</description>
</argument>
</function>
<function name="mxmlEntityAddCallback">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Add a callback to convert entities to Unicode.</description>
<argument name="cb" direction="I">
<type>mxml_entity_cb_t</type>
<description>Callback function to add</description>
</argument>
</function>
<function name="mxmlEntityGetName">
<returnvalue>
<type>const char *</type>
<description>Entity name or NULL</description>
</returnvalue>
<description>Get the name that corresponds to the character value.
If val does not need to be represented by a named entity, NULL is returned.</description>
<argument name="val" direction="I">
<type>int</type>
<description>Character value</description>
</argument>
</function>
<function name="mxmlEntityGetValue">
<returnvalue>
<type>int</type>
<description>Character value or -1 on error</description>
</returnvalue>
<description>Get the character corresponding to a named entity.
The entity name can also be a numeric constant. -1 is returned if the
name is not known.</description>
<argument name="name" direction="I">
<type>const char *</type>
<description>Entity name</description>
</argument>
</function>
<function name="mxmlEntityRemoveCallback">
<description>Remove a callback.</description>
<argument name="cb" direction="I">
<type>mxml_entity_cb_t</type>
<description>Callback function to remove</description>
</argument>
</function>
<function name="mxmlFindElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>Element node or NULL</description>
</returnvalue>
<description>Find the named element.
The search is constrained by the name, attribute name, and value; any
NULL names or values are treated as wildcards, so different kinds of
searches can be implemented by looking for all elements of a given name
or all elements with a specific attribute. The descend argument determines
whether the search descends into child nodes; normally you will use
MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
additional direct descendents of the node. The top node argument
constrains the search to a particular node's children.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Current node</description>
</argument>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Element name or NULL for any</description>
</argument>
<argument name="attr" direction="I">
<type>const char *</type>
<description>Attribute name, or NULL for none</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value, or NULL for any</description>
</argument>
<argument name="descend" direction="I">
<type>int</type>
<description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description>
</argument>
</function>
<function name="mxmlFindPath">
<returnvalue>
<type>mxml_node_t *</type>
<description>Found node or NULL</description>
</returnvalue>
<description>Find a node with the given path.
The "path" is a slash-separated list of element names. The name "*" is
considered a wildcard for one or more levels of elements. For example,
"foo/one/two", "bar/two/one", "*/one", and so forth.
The first child node of the found node is returned if the given node has
children and the first child is a value node.
@since Mini-XML 2.7@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="path" direction="I">
<type>const char *</type>
<description>Path to element</description>
</argument>
</function>
<function name="mxmlGetCDATA">
<returnvalue>
<type>const char *</type>
<description>CDATA value or NULL</description>
</returnvalue>
<description>Get the value for a CDATA node.
@code NULL@ is returned if the node is not a CDATA element.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetCustom">
<returnvalue>
<type>const void *</type>
<description>Custom value or NULL</description>
</returnvalue>
<description>Get the value for a custom node.
@code NULL@ is returned if the node (or its first child) is not a custom
value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetElement">
<returnvalue>
<type>const char *</type>
<description>Element name or NULL</description>
</returnvalue>
<description>Get the name for an element node.
@code NULL@ is returned if the node is not an element node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetFirstChild">
<returnvalue>
<type>mxml_node_t *</type>
<description>First child or NULL</description>
</returnvalue>
<description>Get the first child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetInteger">
<returnvalue>
<type>int</type>
<description>Integer value or 0</description>
</returnvalue>
<description>Get the integer value from the specified node or its
first child.
0 is returned if the node (or its first child) is not an integer value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetLastChild">
<returnvalue>
<type>mxml_node_t *</type>
<description>Last child or NULL</description>
</returnvalue>
<description>Get the last child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetNextSibling">
<returnvalue>
<type>mxml_node_t *</type>
<description>Get the next node for the current parent.
@code NULL@ is returned if this is the last child for the current parent.
@since Mini-XML 2.7@</description>
</returnvalue>
<description>Return the node type...</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetOpaque">
<returnvalue>
<type>const char *</type>
<description>Opaque string or NULL</description>
</returnvalue>
<description>Get an opaque string value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not an opaque
value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetParent">
<returnvalue>
<type>mxml_node_t *</type>
<description>Parent node or NULL</description>
</returnvalue>
<description>Get the parent node.
@code NULL@ is returned for a root node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetPrevSibling">
<returnvalue>
<type>mxml_node_t *</type>
<description>Previous node or NULL</description>
</returnvalue>
<description>Get the previous node for the current parent.
@code NULL@ is returned if this is the first child for the current parent.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetReal">
<returnvalue>
<type>double</type>
<description>Real value or 0.0</description>
</returnvalue>
<description>Get the real value for a node or its first child.
0.0 is returned if the node (or its first child) is not a real value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetRefCount">
<returnvalue>
<type>int</type>
<description>Reference count</description>
</returnvalue>
<description>Get the current reference (use) count for a node.
The initial reference count of new nodes is 1. Use the @link mxmlRetain@
and @link mxmlRelease@ functions to increment and decrement a node's
reference count.
@since Mini-XML 2.7@.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlGetText">
<returnvalue>
<type>const char *</type>
<description>Text string or NULL</description>
</returnvalue>
<description>Get the text value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not a text node.
The "whitespace" argument can be NULL.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
<argument name="whitespace" direction="O">
<type>int *</type>
<description>1 if string is preceded by whitespace, 0 otherwise</description>
</argument>
</function>
<function name="mxmlGetType">
<returnvalue>
<type>mxml_type_t</type>
<description>Type of node</description>
</returnvalue>
<description>Get the node type.
@code MXML_IGNORE@ is returned if "node" is @code NULL@.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetUserData">
<returnvalue>
<type>void *</type>
<description>User data pointer</description>
</returnvalue>
<description>Get the user data pointer for a node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlIndexDelete">
<description>Delete an index.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to delete</description>
</argument>
</function>
<function name="mxmlIndexEnum">
<returnvalue>
<type>mxml_node_t *</type>
<description>Next node or NULL if there is none</description>
</returnvalue>
<description>Return the next node in the index.
Nodes are returned in the sorted order of the index.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to enumerate</description>
</argument>
</function>
<function name="mxmlIndexFind">
<returnvalue>
<type>mxml_node_t *</type>
<description>Node or NULL if none found</description>
</returnvalue>
<description>Find the next matching node.
You should call mxmlIndexReset() prior to using this function for
the first time with a particular set of "element" and "value"
strings. Passing NULL for both "element" and "value" is equivalent
to calling mxmlIndexEnum().</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to search</description>
</argument>
<argument name="element" direction="I">
<type>const char *</type>
<description>Element name to find, if any</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value, if any</description>
</argument>
</function>
<function name="mxmlIndexGetCount">
<returnvalue>
<type>int</type>
<description>Number of nodes in index</description>
</returnvalue>
<description>Get the number of nodes in an index.
@since Mini-XML 2.7@</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index of nodes</description>
</argument>
</function>
<function name="mxmlIndexNew">
<returnvalue>
<type>mxml_index_t *</type>
<description>New index</description>
</returnvalue>
<description>Create a new index.
The index will contain all nodes that contain the named element and/or
attribute. If both "element" and "attr" are NULL, then the index will
contain a sorted list of the elements in the node tree. Nodes are
sorted by element name and optionally by attribute value if the "attr"
argument is not NULL.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>XML node tree</description>
</argument>
<argument name="element" direction="I">
<type>const char *</type>
<description>Element to index or NULL for all</description>
</argument>
<argument name="attr" direction="I">
<type>const char *</type>
<description>Attribute to index or NULL for none</description>
</argument>
</function>
<function name="mxmlIndexReset">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if there is none</description>
</returnvalue>
<description>Reset the enumeration/find pointer in the index and
return the first node in the index.
This function should be called prior to using mxmlIndexEnum() or
mxmlIndexFind() for the first time.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to reset</description>
</argument>
</function>
<function name="mxmlLoadFd">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file descriptor into an XML node tree.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fd" direction="I">
<type>int</type>
<description>File descriptor to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlLoadFile">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file into an XML node tree.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fp" direction="I">
<type>FILE *</type>
<description>File to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlLoadString">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the string has errors.</description>
</returnvalue>
<description>Load a string into an XML node tree.
The nodes in the specified string are added to the specified top node.
If no top node is provided, the XML string MUST be well-formed with a
single parent node like <?xml> for the entire string. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="s" direction="I">
<type>const char *</type>
<description>String to load</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlNewCDATA">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new CDATA node.
The new CDATA node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
CDATA node has no parent. The data string must be nul-terminated and
is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
@since Mini-XML 2.3@</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="data" direction="I">
<type>const char *</type>
<description>Data string</description>
</argument>
</function>
<function name="mxmlNewCustom">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new custom data node.
The new custom node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
element node has no parent. NULL can be passed when the data in the
node is not dynamically allocated or is separately managed.
@since Mini-XML 2.1@</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="data" direction="I">
<type>void *</type>
<description>Pointer to data</description>
</argument>
<argument name="destroy" direction="I">
<type>mxml_custom_destroy_cb_t</type>
<description>Function to destroy data</description>
</argument>
</function>
<function name="mxmlNewElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new element node.
The new element node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
element node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of element</description>
</argument>
</function>
<function name="mxmlNewInteger">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new integer node.
The new integer node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
integer node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="integer" direction="I">
<type>int</type>
<description>Integer value</description>
</argument>
</function>
<function name="mxmlNewOpaque">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new opaque string.
The new opaque node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
opaque node has no parent. The opaque string must be nul-terminated and
is copied into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="opaque" direction="I">
<type>const char *</type>
<description>Opaque string</description>
</argument>
</function>
<function name="mxmlNewReal">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new real number node.
The new real number node is added to the end of the specified parent's
child list. The constant MXML_NO_PARENT can be used to specify that
the new real number node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="real" direction="I">
<type>double</type>
<description>Real number value</description>
</argument>
</function>
<function name="mxmlNewText">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new text fragment node.
The new text node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
text node has no parent. The whitespace parameter is used to specify
whether leading whitespace is present before the node. The text
string must be nul-terminated and is copied into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="string" direction="I">
<type>const char *</type>
<description>String</description>
</argument>
</function>
<function name="mxmlNewTextf">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new formatted text fragment node.
The new text node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
text node has no parent. The whitespace parameter is used to specify
whether leading whitespace is present before the node. The format
string must be nul-terminated and is formatted into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="format" direction="I">
<type>const char *</type>
<description>Printf-style frmat string</description>
</argument>
<argument name="..." direction="I">
<type /> <description>Additional args as needed</description>
</argument>
</function>
<function name="mxmlNewXML">
<returnvalue>
<type>mxml_node_t *</type>
<description>New ?xml node</description>
</returnvalue>
<description>Create a new XML document tree.
The "version" argument specifies the version number to put in the
?xml element node. If NULL, version 1.0 is assumed.
@since Mini-XML 2.3@</description>
<argument name="version" direction="I">
<type>const char *</type>
<description>Version number to use</description>
</argument>
</function>
<function name="mxmlRelease">
<returnvalue>
<type>int</type>
<description>New reference count</description>
</returnvalue>
<description>Release a node.
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete().
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlRemove">
<description>Remove a node from its parent.
Does not free memory used by the node - use mxmlDelete() for that.
This function does nothing if the node has no parent.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to remove</description>
</argument>
</function>
<function name="mxmlRetain">
<returnvalue>
<type>int</type>
<description>New reference count</description>
</returnvalue>
<description>Retain a node.
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlSAXLoadFd">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file descriptor into an XML node tree
using a SAX callback.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fd" direction="I">
<type>int</type>
<description>File descriptor to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_cb" direction="I">
<type>mxml_sax_cb_t</type>
<description>SAX callback or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_data" direction="I">
<type>void *</type>
<description>SAX user data</description>
</argument>
</function>
<function name="mxmlSAXLoadFile">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file into an XML node tree
using a SAX callback.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fp" direction="I">
<type>FILE *</type>
<description>File to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_cb" direction="I">
<type>mxml_sax_cb_t</type>
<description>SAX callback or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_data" direction="I">
<type>void *</type>
<description>SAX user data</description>
</argument>
</function>
<function name="mxmlSAXLoadString">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the string has errors.</description>
</returnvalue>
<description>Load a string into an XML node tree
using a SAX callback.
The nodes in the specified string are added to the specified top node.
If no top node is provided, the XML string MUST be well-formed with a
single parent node like <?xml> for the entire string. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="s" direction="I">
<type>const char *</type>
<description>String to load</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_cb" direction="I">
<type>mxml_sax_cb_t</type>
<description>SAX callback or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_data" direction="I">
<type>void *</type>
<description>SAX user data</description>
</argument>
</function>
<function name="mxmlSaveAllocString">
<returnvalue>
<type>char *</type>
<description>Allocated string or NULL</description>
</returnvalue>
<description>Save an XML tree to an allocated string.
This function returns a pointer to a string containing the textual
representation of the XML node tree. The string should be freed
using the free() function when you are done with it. NULL is returned
if the node would produce an empty string or if the string cannot be
allocated.
The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If MXML_NO_CALLBACK
is specified, whitespace will only be added before MXML_TEXT nodes
with leading whitespace and before attribute names inside opening
element tags.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to write</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_save_cb_t</type>
<description>Whitespace callback or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlSaveFd">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on error.</description>
</returnvalue>
<description>Save an XML tree to a file descriptor.
The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If MXML_NO_CALLBACK
is specified, whitespace will only be added before MXML_TEXT nodes
with leading whitespace and before attribute names inside opening
element tags.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to write</description>
</argument>
<argument name="fd" direction="I">
<type>int</type>
<description>File descriptor to write to</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_save_cb_t</type>
<description>Whitespace callback or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlSaveFile">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on error.</description>
</returnvalue>
<description>Save an XML tree to a file.
The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If MXML_NO_CALLBACK
is specified, whitespace will only be added before MXML_TEXT nodes
with leading whitespace and before attribute names inside opening
element tags.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to write</description>
</argument>
<argument name="fp" direction="I">
<type>FILE *</type>
<description>File to write to</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_save_cb_t</type>
<description>Whitespace callback or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlSaveString">
<returnvalue>
<type>int</type>
<description>Size of string</description>
</returnvalue>
<description>Save an XML node tree to a string.
This function returns the total number of bytes that would be
required for the string but only copies (bufsize - 1) characters
into the specified buffer.
The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If MXML_NO_CALLBACK
is specified, whitespace will only be added before MXML_TEXT nodes
with leading whitespace and before attribute names inside opening
element tags.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to write</description>
</argument>
<argument name="buffer" direction="I">
<type>char *</type>
<description>String buffer</description>
</argument>
<argument name="bufsize" direction="I">
<type>int</type>
<description>Size of string buffer</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_save_cb_t</type>
<description>Whitespace callback or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlSetCDATA">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the element name of a CDATA node.
The node is not changed if it (or its first child) is not a CDATA element node.
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="data" direction="I">
<type>const char *</type>
<description>New data string</description>
</argument>
</function>
<function name="mxmlSetCustom">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the data and destructor of a custom data node.
The node is not changed if it (or its first child) is not a custom node.
@since Mini-XML 2.1@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="data" direction="I">
<type>void *</type>
<description>New data pointer</description>
</argument>
<argument name="destroy" direction="I">
<type>mxml_custom_destroy_cb_t</type>
<description>New destructor function</description>
</argument>
</function>
<function name="mxmlSetCustomHandlers">
<description>Set the handling functions for custom data.
The load function accepts a node pointer and a data string and must
return 0 on success and non-zero on error.
The save function accepts a node pointer and must return a malloc'd
string on success and NULL on error.</description>
<argument name="load" direction="I">
<type>mxml_custom_load_cb_t</type>
<description>Load function</description>
</argument>
<argument name="save" direction="I">
<type>mxml_custom_save_cb_t</type>
<description>Save function</description>
</argument>
</function>
<function name="mxmlSetElement">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the name of an element node.
The node is not changed if it is not an element node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>New name string</description>
</argument>
</function>
<function name="mxmlSetErrorCallback">
<description>Set the error message callback.</description>
<argument name="cb" direction="I">
<type>mxml_error_cb_t</type>
<description>Error callback function</description>
</argument>
</function>
<function name="mxmlSetInteger">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of an integer node.
The node is not changed if it (or its first child) is not an integer node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="integer" direction="I">
<type>int</type>
<description>Integer value</description>
</argument>
</function>
<function name="mxmlSetOpaque">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of an opaque node.
The node is not changed if it (or its first child) is not an opaque node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="opaque" direction="I">
<type>const char *</type>
<description>Opaque string</description>
</argument>
</function>
<function name="mxmlSetReal">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a real number node.
The node is not changed if it (or its first child) is not a real number node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="real" direction="I">
<type>double</type>
<description>Real number value</description>
</argument>
</function>
<function name="mxmlSetText">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a text node.
The node is not changed if it (or its first child) is not a text node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="string" direction="I">
<type>const char *</type>
<description>String</description>
</argument>
</function>
<function name="mxmlSetTextf">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a text node to a formatted string.
The node is not changed if it (or its first child) is not a text node.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="format" direction="I">
<type>const char *</type>
<description>Printf-style format string</description>
</argument>
<argument name="..." direction="I">
<type /> <description>Additional arguments as needed</description>
</argument>
</function>
<function name="mxmlSetUserData">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Set the user data pointer for a node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to set</description>
</argument>
<argument name="data" direction="I">
<type>void *</type>
<description>User data pointer</description>
</argument>
</function>
<function name="mxmlSetWrapMargin">
<description>Set the wrap margin when saving XML data.
Wrapping is disabled when "column" is 0.
@since Mini-XML 2.3@</description>
<argument name="column" direction="I">
<type>int</type>
<description>Column for wrapping, 0 to disable wrapping</description>
</argument>
</function>
<function name="mxmlWalkNext">
<returnvalue>
<type>mxml_node_t *</type>
<description>Next node or NULL</description>
</returnvalue>
<description>Walk to the next logical node in the tree.
The descend argument controls whether the first child is considered
to be the next node. The top node argument constrains the walk to
the node's children.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Current node</description>
</argument>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="descend" direction="I">
<type>int</type>
<description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description>
</argument>
</function>
<function name="mxmlWalkPrev">
<returnvalue>
<type>mxml_node_t *</type>
<description>Previous node or NULL</description>
</returnvalue>
<description>Walk to the previous logical node in the tree.
The descend argument controls whether the previous node's last child
is considered to be the previous node. The top node argument constrains
the walk to the node's children.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Current node</description>
</argument>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="descend" direction="I">
<type>int</type>
<description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description>
</argument>
</function>
<struct name="mxml_attr_s">
<description>An XML element attribute value. @private@</description>
<variable name="name">
<type>char *</type>
<description>Attribute name</description>
</variable>
<variable name="value">
<type>char *</type>
<description>Attribute value</description>
</variable>
</struct>
<typedef name="mxml_attr_t">
<type>struct mxml_attr_s</type>
<description>An XML element attribute value. @private@</description>
</typedef>
<typedef name="mxml_custom_destroy_cb_t">
<type>void(*)(void *)</type>
<description>Custom data destructor</description>
</typedef>
<typedef name="mxml_custom_load_cb_t">
<type>int(*)(mxml_node_t *, const char *)</type>
<description>Custom data load callback function</description>
</typedef>
<struct name="mxml_custom_s">
<description>An XML custom value. @private@</description>
<variable name="data">
<type>void *</type>
<description>Pointer to (allocated) custom data</description>
</variable>
<variable name="destroy">
<type>mxml_custom_destroy_cb_t</type>
<description>Pointer to destructor function</description>
</variable>
</struct>
<typedef name="mxml_custom_save_cb_t">
<type>char *(*)(mxml_node_t *)</type>
<description>Custom data save callback function</description>
</typedef>
<typedef name="mxml_custom_t">
<type>struct mxml_custom_s</type>
<description>An XML custom value. @private@</description>
</typedef>
<struct name="mxml_element_s">
<description>An XML element value. @private@</description>
<variable name="attrs">
<type>mxml_attr_t *</type>
<description>Attributes</description>
</variable>
<variable name="name">
<type>char *</type>
<description>Name of element</description>
</variable>
<variable name="num_attrs">
<type>int</type>
<description>Number of attributes</description>
</variable>
</struct>
<typedef name="mxml_element_t">
<type>struct mxml_element_s</type>
<description>An XML element value. @private@</description>
</typedef>
<typedef name="mxml_entity_cb_t">
<type>int(*)(const char *)</type>
<description>Entity callback function</description>
</typedef>
<typedef name="mxml_error_cb_t">
<type>void(*)(const char *)</type>
<description>Error callback function</description>
</typedef>
<struct name="mxml_index_s">
<description>An XML node index. @private@</description>
<variable name="alloc_nodes">
<type>int</type>
<description>Allocated nodes in index</description>
</variable>
<variable name="attr">
<type>char *</type>
<description>Attribute used for indexing or NULL</description>
</variable>
<variable name="cur_node">
<type>int</type>
<description>Current node</description>
</variable>
<variable name="nodes">
<type>mxml_node_t **</type>
<description>Node array</description>
</variable>
<variable name="num_nodes">
<type>int</type>
<description>Number of nodes in index</description>
</variable>
</struct>
<typedef name="mxml_index_t">
<type>struct mxml_index_s</type>
<description>An XML node index.</description>
</typedef>
<typedef name="mxml_load_cb_t">
<type>mxml_type_t(*)(mxml_node_t *)</type>
<description>Load callback function</description>
</typedef>
<struct name="mxml_node_s">
<description>An XML node. @private@</description>
<variable name="child">
<type>struct mxml_node_s *</type>
<description>First child node</description>
</variable>
<variable name="last_child">
<type>struct mxml_node_s *</type>
<description>Last child node</description>
</variable>
<variable name="next">
<type>struct mxml_node_s *</type>
<description>Next node under same parent</description>
</variable>
<variable name="parent">
<type>struct mxml_node_s *</type>
<description>Parent node</description>
</variable>
<variable name="prev">
<type>struct mxml_node_s *</type>
<description>Previous node under same parent</description>
</variable>
<variable name="ref_count">
<type>int</type>
<description>Use count</description>
</variable>
<variable name="type">
<type>mxml_type_t</type>
<description>Node type</description>
</variable>
<variable name="user_data">
<type>void *</type>
<description>User data</description>
</variable>
<variable name="value">
<type>mxml_value_t</type>
<description>Node value</description>
</variable>
</struct>
<typedef name="mxml_node_t">
<type>struct mxml_node_s</type>
<description>An XML node.</description>
</typedef>
<typedef name="mxml_save_cb_t">
<type>const char *(*)(mxml_node_t *, int)</type>
<description>Save callback function</description>
</typedef>
<typedef name="mxml_sax_cb_t">
<type>void(*)(mxml_node_t *, mxml_sax_event_t, void *)</type>
<description>SAX callback function</description>
</typedef>
<enumeration name="mxml_sax_event_e">
<description>SAX event type.</description>
<constant name="MXML_SAX_CDATA">
<description>CDATA node</description>
</constant>
<constant name="MXML_SAX_COMMENT">
<description>Comment node</description>
</constant>
<constant name="MXML_SAX_DATA">
<description>Data node</description>
</constant>
<constant name="MXML_SAX_DIRECTIVE">
<description>Processing directive node</description>
</constant>
<constant name="MXML_SAX_ELEMENT_CLOSE">
<description>Element closed</description>
</constant>
<constant name="MXML_SAX_ELEMENT_OPEN">
<description>Element opened</description>
</constant>
</enumeration>
<typedef name="mxml_sax_event_t">
<type>enum mxml_sax_event_e</type>
<description>SAX event type.</description>
</typedef>
<struct name="mxml_text_s">
<description>An XML text value. @private@</description>
<variable name="string">
<type>char *</type>
<description>Fragment string</description>
</variable>
<variable name="whitespace">
<type>int</type>
<description>Leading whitespace?</description>
</variable>
</struct>
<typedef name="mxml_text_t">
<type>struct mxml_text_s</type>
<description>An XML text value. @private@</description>
</typedef>
<enumeration name="mxml_type_e">
<description>The XML node type.</description>
<constant name="MXML_CUSTOM">
<description>Custom data @since Mini-XML 2.1@</description>
</constant>
<constant name="MXML_ELEMENT">
<description>XML element with attributes</description>
</constant>
<constant name="MXML_IGNORE">
<description>Ignore/throw away node @since Mini-XML 2.3@</description>
</constant>
<constant name="MXML_INTEGER">
<description>Integer value</description>
</constant>
<constant name="MXML_OPAQUE">
<description>Opaque string</description>
</constant>
<constant name="MXML_REAL">
<description>Real value</description>
</constant>
<constant name="MXML_TEXT">
<description>Text fragment</description>
</constant>
</enumeration>
<typedef name="mxml_type_t">
<description>The XML node type.</description>
<type>enum mxml_type_e</type>
</typedef>
<typedef name="mxml_value_t">
<type>union mxml_value_u</type>
<description>An XML node value. @private@</description>
</typedef>
<union name="mxml_value_u">
<description>An XML node value. @private@</description>
<variable name="custom">
<type>mxml_custom_t</type>
<description>Custom data @since Mini-XML 2.1@</description>
</variable>
<variable name="element">
<type>mxml_element_t</type>
<description>Element</description>
</variable>
<variable name="integer">
<type>int</type>
<description>Integer number</description>
</variable>
<variable name="opaque">
<type>char *</type>
<description>Opaque string</description>
</variable>
<variable name="real">
<type>double</type>
<description>Real number</description>
</variable>
<variable name="text">
<type>mxml_text_t</type>
<description>Text fragment</description>
</variable>
</union>
</mxmldoc>
|