/usr/share/GNUstep/Documentation/Developer/BaseAdditions/Reference/GSXML.html is in gnustep-base-doc 1.24.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>The XML and HTML parsing system</title>
</head>
<body>
<font face="serif">
<a href="BaseAdditions.html">Up</a>
<br />
<h1><a name="title$GSXML">The XML and HTML parsing system</a></h1>
<h3>Authors</h3>
<dl>
<dt>Michael Pakhantsov (<a href="mailto:mishel@berest.dp.ua"><code>mishel@berest.dp.ua</code></a>)</dt>
<dd>
</dd>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 2000-2005 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">The XML and HTML parsing system</a>
</li>
<li>
<a href="#002000000000">Software documentation for the GSHTMLParser class</a>
</li>
<li>
<a href="#003000000000">Software documentation for the GSHTMLSAXHandler class</a>
</li>
<li>
<a href="#004000000000">Software documentation for the GSSAXHandler class</a>
</li>
<li>
<a href="#005000000000">Software documentation for the GSTreeSAXHandler class</a>
</li>
<li>
<a href="#006000000000">Software documentation for the GSXMLAttribute class</a>
</li>
<li>
<a href="#007000000000">Software documentation for the GSXMLDocument class</a>
</li>
<li>
<a href="#008000000000">Software documentation for the GSXMLNamespace class</a>
</li>
<li>
<a href="#009000000000">Software documentation for the GSXMLNode class</a>
</li>
<li>
<a href="#010000000000">Software documentation for the GSXMLParser class</a>
</li>
<li>
<a href="#011000000000">Software documentation for the GSXMLRPC class</a>
</li>
<li>
<a href="#012000000000">Software documentation for the GSXPathBoolean class</a>
</li>
<li>
<a href="#013000000000">Software documentation for the GSXPathContext class</a>
</li>
<li>
<a href="#014000000000">Software documentation for the GSXPathNodeSet class</a>
</li>
<li>
<a href="#015000000000">Software documentation for the GSXPathNumber class</a>
</li>
<li>
<a href="#016000000000">Software documentation for the GSXPathObject class</a>
</li>
<li>
<a href="#017000000000">Software documentation for the GSXPathString class</a>
</li>
<li>
<a href="#018000000000">Software documentation for the GSXMLDocument(XSLT)
category</a>
</li>
<li>
<a href="#019000000000">Software documentation for the GSXMLRPC(Delegate)
category</a>
</li>
<li>
<a href="#020000000000">Software documentation for the NSString(GSXML)
category</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">The XML and HTML parsing system</a></h1>
<p>
The GNUstep XML parser is a collection Objective-C classes
wrapping the C XML parsing library (libxml).
</p>
<p>
The underlying C library handles high performance parsing,
while the ObjectiveC classes provide ease of
use/integration.
</p>
<h1><a name="002000000000">
Software documentation for the GSHTMLParser class
</a></h1>
<h2><a name="class$GSHTMLParser">GSHTMLParser</a> : <a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
The GSHTMLParser class is a simple subclass of
GSXMLParser which should parse reasonably well
formed HTML documents. If you wish to parse XHTML
documents, you should use GSXMLParser... the
GSHTMLParser class is for older 'legacy'
documents.
</div>
<h1><a name="003000000000">
Software documentation for the GSHTMLSAXHandler class
</a></h1>
<h2><a name="class$GSHTMLSAXHandler">GSHTMLSAXHandler</a> : <a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
You may create a subclass of this class to handle
incremental parsing of html documents... this is
provided for handling legacy documents, as modern
html documents should use xhtml, and for those you
should simply subclass
<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>
</div>
<h1><a name="004000000000">
Software documentation for the GSSAXHandler class
</a></h1>
<h2><a name="class$GSSAXHandler">GSSAXHandler</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
XML SAX Handler.
</p>
<p>
</p>
<p>
GSSAXHandler is a callback-based interface to
the
<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>
which operates in a similar (though not identical)
manner to SAX.
</p>
<p>
</p>
<p>
Each GSSAXHandler object is associated with a
GSXMLParser object. As parsing progresses,
the methods of the GSSAXHandler are invoked by the
parser, so the handler is able to deal with the
elements and entities being parsed.
</p>
<p>
</p>
<p>
The callback methods in the GSSAXHandler class do
nothing - it is intended that you subclass
GSSAXHandler and override them.
</p>
<p>
</p>
<p>
If you create a GSXMLParser passing <code>nil</code>
as the GSSAXHandler, the parser will parse data to
create a
<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>
instance which you can then examine as a whole
... this is generally the preferred mechanism for
parsing as it permits the parser to validate
the parsed document againts a DTD, and your
software can then examine the document secure
in the knowledge that it contains the expected
structure. Use of a GSSAXHandler is
preferred for very large documents with
simple structure... in which case incremental
parsing is more efficient.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_GSSAXHandler_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler+handler">+handler</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-attribute$value$">-attribute:value:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-attributeDecl$name$type$typeDefValue$defaultValue$">-attributeDecl:name:type:typeDefValue:defaultValue:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-cdataBlock$">-cdataBlock:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-characters$">-characters:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-comment$">-comment:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-elementDecl$type$">-elementDecl:type:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-endDocument">-endDocument</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-endElement$">-endElement:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-endElement$prefix$href$">-endElement:prefix:href:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-entityDecl$type$public$system$content$">-entityDecl:type:public:system:content:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-error$">-error:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-error$colNumber$lineNumber$">-error:colNumber:lineNumber:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-externalSubset$externalID$systemID$">-externalSubset:externalID:systemID:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-fatalError$">-fatalError:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-fatalError$colNumber$lineNumber$">-fatalError:colNumber:lineNumber:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-getEntity$">-getEntity:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-getParameterEntity$">-getParameterEntity:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-globalNamespace$href$prefix$">-globalNamespace:href:prefix:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-hasExternalSubset">-hasExternalSubset</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-hasInternalSubset">-hasInternalSubset</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-ignoreWhitespace$">-ignoreWhitespace:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-internalSubset$externalID$systemID$">-internalSubset:externalID:systemID:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-isStandalone">-isStandalone</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-lib">-lib</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-loadEntity$at$">-loadEntity:at:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-namespaceDecl$href$prefix$">-namespaceDecl:href:prefix:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-notationDecl$public$system$">-notationDecl:public:system:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-parser">-parser</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-processInstruction$data$">-processInstruction:data:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-reference$">-reference:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-startDocument">-startDocument</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-startElement$attributes$">-startElement:attributes:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-startElement$prefix$href$attributes$namespaces$">-startElement:prefix:href:attributes:namespaces:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-unparsedEntityDecl$public$system$notationName$">-unparsedEntityDecl:public:system:notationName:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-warning$">-warning:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSSAXHandler-warning$colNumber$lineNumber$">-warning:colNumber:lineNumber:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSSAXHandler+handler">handler </a></h3>
+ (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*) <b>handler</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create a new SAX handler.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-attribute$value$">attribute: value: </a></h3>
- (void) <b>attribute:</b> (NSString*)name<b> value:</b> (NSString*)value;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Handle an attribute that has been read by the
parser.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-attributeDecl$name$type$typeDefValue$defaultValue$">attributeDecl: name: type: typeDefValue: defaultValue: </a></h3>
- (void) <b>attributeDecl:</b> (NSString*)nameElement<b> name:</b> (NSString*)name<b> type:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)type<b> typeDefValue:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)defType<b> defaultValue:</b> (NSString*)value;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> An attribute definition has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-cdataBlock$">cdataBlock: </a></h3>
- (void) <b>cdataBlock:</b> (NSData*)value;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when a cdata block has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-characters$">characters: </a></h3>
- (void) <b>characters:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Receiving some chars from the parser.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-comment$">comment: </a></h3>
- (void) <b>comment:</b> (NSString*)value;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> A comment has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-elementDecl$type$">elementDecl: type: </a></h3>
- (void) <b>elementDecl:</b> (NSString*)name<b> type:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)type;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> An element definition has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-endDocument">endDocument </a></h3>
- (void) <b>endDocument</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when the document end has been
detected.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-endElement$">endElement: </a></h3>
- (void) <b>endElement:</b> (NSString*)elementName;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when a closing tag has been processed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-endElement$prefix$href$">endElement: prefix: href: </a></h3>
- (void) <b>endElement:</b> (NSString*)elementName<b> prefix:</b> (NSString*)prefix<b> href:</b> (NSString*)href;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when a closing tag has been processed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-entityDecl$type$public$system$content$">entityDecl: type: public: system: content: </a></h3>
- (void) <b>entityDecl:</b> (NSString*)name<b> type:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)type<b> public:</b> (NSString*)publicId<b> system:</b> (NSString*)systemId<b> content:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> An entity definition has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-error$">error: </a></h3>
- (void) <b>error:</b> (NSString*)e;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when an error message needs to be output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-error$colNumber$lineNumber$">error: colNumber: lineNumber: </a></h3>
- (void) <b>error:</b> (NSString*)e<b> colNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)colNumber<b> lineNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)lineNumber;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when an error message needs to be output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-externalSubset$externalID$systemID$">externalSubset: externalID: systemID: </a></h3>
- (BOOL) <b>externalSubset:</b> (NSString*)name<b> externalID:</b> (NSString*)externalID<b> systemID:</b> (NSString*)systemID;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to find out whether there is an external
subset.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-fatalError$">fatalError: </a></h3>
- (void) <b>fatalError:</b> (NSString*)e;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when a fatal error message needs to be
output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-fatalError$colNumber$lineNumber$">fatalError: colNumber: lineNumber: </a></h3>
- (void) <b>fatalError:</b> (NSString*)e<b> colNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)colNumber<b> lineNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)lineNumber;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when a fatal error message needs to be
output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-getEntity$">getEntity: </a></h3>
- (void*) <b>getEntity:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
get an entity by <var>name</var>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-getParameterEntity$">getParameterEntity: </a></h3>
- (void*) <b>getParameterEntity:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
get a parameter entity by <var>name</var>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-globalNamespace$href$prefix$">globalNamespace: href: prefix: </a></h3>
- (void) <b>globalNamespace:</b> (NSString*)name<b> href:</b> (NSString*)href<b> prefix:</b> (NSString*)prefix;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> An old global namespace has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-hasExternalSubset">hasExternalSubset </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>hasExternalSubset</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to find out whether there is an external
subset.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-hasInternalSubset">hasInternalSubset </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>hasInternalSubset</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to find out whether there is an internal
subset.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-ignoreWhitespace$">ignoreWhitespace: </a></h3>
- (void) <b>ignoreWhitespace:</b> (NSString*)ch;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Receiving some ignorable whitespaces from the
parser.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-internalSubset$externalID$systemID$">internalSubset: externalID: systemID: </a></h3>
- (BOOL) <b>internalSubset:</b> (NSString*)name<b> externalID:</b> (NSString*)externalID<b> systemID:</b> (NSString*)systemID;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to find out whether there is an internal
subset.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-isStandalone">isStandalone </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>isStandalone</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to detemrine if the document is standalone.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-lib">lib </a></h3>
- (void*) <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a pointer to the raw libxml data used by
this document. <br /> Only for use by libxml experts!
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-loadEntity$at$">loadEntity: at: </a></h3>
- (NSString*) <b>loadEntity:</b> (NSString*)publicId<b> at:</b> (NSString*)location;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called to return the filename from which an entity
should be loaded.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-namespaceDecl$href$prefix$">namespaceDecl: href: prefix: </a></h3>
- (void) <b>namespaceDecl:</b> (NSString*)name<b> href:</b> (NSString*)href<b> prefix:</b> (NSString*)prefix;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> An old global namespace has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-notationDecl$public$system$">notationDecl: public: system: </a></h3>
- (void) <b>notationDecl:</b> (NSString*)name<b> public:</b> (NSString*)publicId<b> system:</b> (NSString*)systemId;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> What to do when a notation declaration has
been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-parser">parser </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parser</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the parser object with which this handler is
associated. This may occasionally be useful.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-processInstruction$data$">processInstruction: data: </a></h3>
- (void) <b>processInstruction:</b> (NSString*)targetName<b> data:</b> (NSString*)PIdata;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> A processing instruction has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-reference$">reference: </a></h3>
- (void) <b>reference:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when an entity reference is detected.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-startDocument">startDocument </a></h3>
- (void) <b>startDocument</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when the document starts being
processed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-startElement$attributes$">startElement: attributes: </a></h3>
- (void) <b>startElement:</b> (NSString*)elementName<b> attributes:</b> (NSMutableDictionary*)elementAttributes;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> Called when an opening tag has been
processed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-startElement$prefix$href$attributes$namespaces$">startElement: prefix: href: attributes: namespaces: </a></h3>
- (void) <b>startElement:</b> (NSString*)elementName<b> prefix:</b> (NSString*)prefix<b> href:</b> (NSString*)href<b> attributes:</b> (NSMutableDictionary*)elementAttributes<b> namespaces:</b> (NSMutableDictionary*)elementNamespaces;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-unparsedEntityDecl$public$system$notationName$">unparsedEntityDecl: public: system: notationName: </a></h3>
- (void) <b>unparsedEntityDecl:</b> (NSString*)name<b> public:</b> (NSString*)publicId<b> system:</b> (NSString*)systemId<b> notationName:</b> (NSString*)notation;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
<br /> What to do when an unparsed entity
declaration is parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-warning$">warning: </a></h3>
- (void) <b>warning:</b> (NSString*)e;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when a warning message needs to be output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSSAXHandler-warning$colNumber$lineNumber$">warning: colNumber: lineNumber: </a></h3>
- (void) <b>warning:</b> (NSString*)e<b> colNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)colNumber<b> lineNumber:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)lineNumber;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Called when a warning message needs to be output.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSSAXHandler_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSSAXHandler Class</h2>
<h3><a name="ivariable$GSSAXHandler*isHtmlHandler">isHtmlHandler</a></h3>
@protected BOOL <b>isHtmlHandler</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSSAXHandler*lib">lib</a></h3>
@protected void* <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSSAXHandler*parser">parser</a></h3>
@protected GSXMLParser* <b>parser</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="005000000000">
Software documentation for the GSTreeSAXHandler class
</a></h1>
<h2><a name="class$GSTreeSAXHandler">GSTreeSAXHandler</a> : <a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
The default handler for parsing documents... this will
build a GSXMLDocument for you. This handler may not
currently be subclassed, though that capability may
be added at a later date.
</div>
<h1><a name="006000000000">
Software documentation for the GSXMLAttribute class
</a></h1>
<h2><a name="class$GSXMLAttribute">GSXMLAttribute</a> : <a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A class wrapping attributes of an XML element node.
Generally when examining a GSXMLDocument, you need
not concern yourself with GSXMLAttribute objects as you
will probably use the
<a rel="gsdoc" href="#method$GSXMLNode-objectForKey$">
[GSXMLNode -objectForKey:]
</a>
method to return the string value of any attribute you
are interested in.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLAttribute-value">-value</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLAttribute-value">value </a></h3>
- (NSString*) <b>value</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the string value of the attribute.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="007000000000">
Software documentation for the GSXMLDocument class
</a></h1>
<h2><a name="class$GSXMLDocument">GSXMLDocument</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCopying</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A GSXML document wraps the document structure of the
underlying libxml library.
</div>
<hr width="50%" align="left" />
<a href="#_GSXMLDocument_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$">+xsltTransformFile:stylesheet:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$params$">+xsltTransformFile:stylesheet:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$">+xsltTransformXml:stylesheet:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$params$">+xsltTransformXml:stylesheet:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)-xsltTransform$">-xsltTransform:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)-xsltTransform$params$">-xsltTransform:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument+documentWithVersion$">+documentWithVersion:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-description">-description</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-encoding">-encoding</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-lib">-lib</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-makeNodeWithNamespace$name$content$">-makeNodeWithNamespace:name:content:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-root">-root</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-setRoot$">-setRoot:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-version">-version</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-writeToFile$atomically$">-writeToFile:atomically:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument-writeToURL$atomically$">-writeToURL:atomically:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLDocument+documentWithVersion$">documentWithVersion: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>documentWithVersion:</b> (NSString*)version;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create a new document with the specified
<var>version</var>.
<pre>
id d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
[n1 makeComment: @" this is a comment "];
[n1 makePI: @"pi1" content: @"this is a process instruction"];
[n1 makeChildWithNamespace: nil name: @"key" content: @"Year Of Birth"];
[n1 makeChildWithNamespace: nil name: @"integer" content: @"65"];
[n1 makeChildWithNamespace: nil name: @"key" content: @"Pets Names"];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-description">description </a></h3>
- (NSString*) <b>description</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a string representation of the document (ie
the XML) or <code>nil</code> if the document does not
have reasonable contents.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-encoding">encoding </a></h3>
- (NSString*) <b>encoding</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the name of the encoding for this document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-lib">lib </a></h3>
- (void*) <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a pointer to the raw libxml data used by
this document. <br /> Only for use by libxml experts!
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-makeNodeWithNamespace$name$content$">makeNodeWithNamespace: name: content: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>makeNodeWithNamespace:</b> (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*)ns<b> name:</b> (NSString*)name<b> content:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creates a new node within the document.
<pre>
GSXMLNode *n1, *n2;
GSXMLDocument *d;
d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-root">root </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>root</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the root node of the document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-setRoot$">setRoot: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>setRoot:</b> (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*)node;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the root of the document. <br /> NB. The
<var>node</var> must have been created as part of the
receiving document (eg. using the
<a rel="gsdoc" href="#method$GSXMLDocument-makeNodeWithNamespace$name$content$">-makeNodeWithNamespace:name:content:</a>
method).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-version">version </a></h3>
- (NSString*) <b>version</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the version string for this document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-writeToFile$atomically$">writeToFile: atomically: </a></h3>
- (BOOL) <b>writeToFile:</b> (NSString*)filename<b> atomically:</b> (BOOL)useAuxilliaryFile;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Uses the
<a rel="gsdoc" href="#method$GSXMLDocument-description">
-description
</a>
method to produce a string representation of the
document and writes that to <var>filename</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument-writeToURL$atomically$">writeToURL: atomically: </a></h3>
- (BOOL) <b>writeToURL:</b> (NSURL*)url<b> atomically:</b> (BOOL)useAuxilliaryFile;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Uses the
<a rel="gsdoc" href="#method$GSXMLDocument-description">
-description
</a>
method to produce a string representation of the
document and writes that to <var>url</var>.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSXMLDocument_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXMLDocument Class</h2>
<h3><a name="ivariable$GSXMLDocument*_ownsLib">_ownsLib</a></h3>
@protected BOOL <b>_ownsLib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLDocument*_parent">_parent</a></h3>
@protected id <b>_parent</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLDocument*lib">lib</a></h3>
@protected void* <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="008000000000">
Software documentation for the GSXMLNamespace class
</a></h1>
<h2><a name="class$GSXMLNamespace">GSXMLNamespace</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCopying</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A GSXMLNamespace object wraps part of the document
structure of the underlying libxml library.
</div>
<hr width="50%" align="left" />
<a href="#_GSXMLNamespace_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace+descriptionFromType$">+descriptionFromType:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace+typeFromDescription$">+typeFromDescription:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-href">-href</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-lib">-lib</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-next">-next</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-prefix">-prefix</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-type">-type</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNamespace-typeDescription">-typeDescription</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLNamespace+descriptionFromType$">descriptionFromType: </a></h3>
+ (NSString*) <b>descriptionFromType:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)type;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the string representation of the specified
numeric <var>type</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace+typeFromDescription$">typeFromDescription: </a></h3>
+ (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>typeFromDescription:</b> (NSString*)desc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the numeric constant value for the namespace
type named. This method is inefficient, so the
returned value should be saved for re-use later.
The possible values are -
<ul>
<li>
XML_LOCAL_NAMESPACE
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-href">href </a></h3>
- (NSString*) <b>href</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the namespace reference
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-lib">lib </a></h3>
- (void*) <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a pointer to the raw libxml data used by
this document. <br /> Only for use by libxml experts!
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-next">next </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*) <b>next</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
return the next namespace.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-prefix">prefix </a></h3>
- (NSString*) <b>prefix</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the namespace prefix.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-type">type </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>type</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return type of namespace
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNamespace-typeDescription">typeDescription </a></h3>
- (NSString*) <b>typeDescription</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return string representation of the type of the
namespace.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSXMLNamespace_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXMLNamespace Class</h2>
<h3><a name="ivariable$GSXMLNamespace*_parent">_parent</a></h3>
@protected id <b>_parent</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLNamespace*lib">lib</a></h3>
@protected void* <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="009000000000">
Software documentation for the GSXMLNode class
</a></h1>
<h2><a name="class$GSXMLNode">GSXMLNode</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCopying</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A GSXMLNode object wraps part of the document structure of
the underlying libxml library. It may have a parent,
siblings, and children.
</div>
<hr width="50%" align="left" />
<a href="#_GSXMLNode_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode+descriptionFromType$">+descriptionFromType:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode+typeFromDescription$">+typeFromDescription:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-attributes">-attributes</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-content">-content</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-description">-description</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-document">-document</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-escapedContent">-escapedContent</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-firstAttribute">-firstAttribute</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-firstChild">-firstChild</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-firstChildElement">-firstChildElement</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-isElement">-isElement</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-isText">-isText</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-lib">-lib</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makeAttributeWithName$value$">-makeAttributeWithName:value:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makeChildWithNamespace$name$content$">-makeChildWithNamespace:name:content:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makeComment$">-makeComment:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makeNamespaceHref$prefix$">-makeNamespaceHref:prefix:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makePI$content$">-makePI:content:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-makeText$">-makeText:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-name">-name</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-namespace">-namespace</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-namespaceDefinitions">-namespaceDefinitions</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-next">-next</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-nextElement">-nextElement</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-objectForKey$">-objectForKey:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-parent">-parent</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-previous">-previous</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-previousElement">-previousElement</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-propertiesAsDictionaryWithKeyTransformationSel$">-propertiesAsDictionaryWithKeyTransformationSel:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-setNamespace$">-setNamespace:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-setObject$forKey$">-setObject:forKey:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-type">-type</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLNode-typeDescription">-typeDescription</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLNode+descriptionFromType$">descriptionFromType: </a></h3>
+ (NSString*) <b>descriptionFromType:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)type;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the string constant value for the node
<var>type</var> given.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode+typeFromDescription$">typeFromDescription: </a></h3>
+ (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>typeFromDescription:</b> (NSString*)desc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Converts a node type string to a numeric
constant which can be compared with the result
of the <a rel="gsdoc" href="#method$GSXMLNode-type">-type</a>
method to determine what sort of node an instance
is. Because this method is quite inefficient, you
should cache the numeric type returned and re-use
the cached value.
</p>
<p>
The node type names are -
<ul>
<li>
XML_ELEMENT_NODE
</li>
<li>
XML_ATTRIBUTE_NODE
</li>
<li>
XML_TEXT_NODE
</li>
<li>
XML_CDATA_SECTION_NODE
</li>
<li>
XML_ENTITY_REF_NODE
</li>
<li>
XML_ENTITY_NODE
</li>
<li>
XML_PI_NODE
</li>
<li>
XML_COMMENT_NODE
</li>
<li>
XML_DOCUMENT_NODE
</li>
<li>
XML_DOCUMENT_TYPE_NODE
</li>
<li>
XML_DOCUMENT_FRAG_NODE
</li>
<li>
XML_NOTATION_NODE
</li>
<li>
XML_HTML_DOCUMENT_NODE
</li>
<li>
XML_DTD_NODE
</li>
<li>
XML_ELEMENT_DECL
</li>
<li>
XML_ATTRIBUTE_DECL
</li>
<li>
XML_ENTITY_DECL
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-attributes">attributes </a></h3>
- (NSDictionary*) <b>attributes</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Return attributes and values as a dictionary
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-content">content </a></h3>
- (NSString*) <b>content</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return node content as a string. This should return
meaningful information for text nodes and for
entity nodes containing only text nodes. <br /> If
entity substitution was not enabled during parsing,
an element containing text may actually contain both
text nodes and entity reference nodes, in this case
you should not use this method to get the content of
the element, but should examine the child nodes of the
element individually and perform any entity
reference you need to do explicitly. <br /> NB.
There are five standard entities which are
automatically substituted into the content
text rather than appearing as entity nodes in their
own right. These are '<', '>', ''', '"'
and '&'. If you with to receive content in which
these characters are represented by the original
entity escapes, you need to use the
<a rel="gsdoc" href="#method$GSXMLNode-escapedContent">
-escapedContent
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-description">description </a></h3>
- (NSString*) <b>description</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a string representation of the node and all
its children (ie the XML text) or <code>nil</code> if
the node does not have reasonable contents.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-document">document </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>document</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the document in which this node exists.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-escapedContent">escapedContent </a></h3>
- (NSString*) <b>escapedContent</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This performs the same function as the
<a rel="gsdoc" href="#method$GSXMLNode-content">
-content
</a>
method, but retains escaped character information
(the standard five entities &lt;, &gt;,
&apos;, &quot;, and &amp;) which
are normally replaced with their standard equivalents
(<, >, ', ", and &).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-firstAttribute">firstAttribute </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLAttribute">GSXMLAttribute</a>*) <b>firstAttribute</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the first attribute in this node.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-firstChild">firstChild </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>firstChild</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the first child node of this node.
<pre>
- (GSXMLNode*) elementRecursive: (GSXMLNode*)node
{
while (node != nil)
{
if ([node type] == XML_ELEMENT_NODE)
{
return node;
}
if ([node firstChild] != nil)
{
node = [self elementRecursive: [node firstChild]];
}
else
{
node = [node next];
}
}
return node;
}
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-firstChildElement">firstChildElement </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>firstChildElement</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the first child element of this node. If you
wish to step through all children of the node
(including non-element nodes) you should use the
<a rel="gsdoc" href="#method$GSXMLNode-firstChild">
-firstChild
</a>
method instead.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-isElement">isElement </a></h3>
- (BOOL) <b>isElement</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method, equivalent to calling
<a rel="gsdoc" href="#method$GSXMLNode-type">
-type
</a>
and comparing it with the result of passing
"XML_ELEMENT_NODE" to
<a rel="gsdoc" href="#method$GSXMLNode+typeFromDescription$">
+typeFromDescription:
</a>
(but faster).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-isText">isText </a></h3>
- (BOOL) <b>isText</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method, equivalent to calling
<a rel="gsdoc" href="#method$GSXMLNode-type">
-type
</a>
and comparing it with the result of passing
"XML_TEXT_NODE" to
<a rel="gsdoc" href="#method$GSXMLNode+typeFromDescription$">
+typeFromDescription:
</a>
(but faster).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-lib">lib </a></h3>
- (void*) <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a pointer to the raw libxml data used by
this document. <br /> Only for use by libxml experts!
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makeAttributeWithName$value$">makeAttributeWithName: value: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLAttribute">GSXMLAttribute</a>*) <b>makeAttributeWithName:</b> (NSString*)name<b> value:</b> (NSString*)value;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create and return an attribute (unless the named
attribute already exists, in which case we update
them <var>value</var> of the existing attribute and
return it.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makeChildWithNamespace$name$content$">makeChildWithNamespace: name: content: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>makeChildWithNamespace:</b> (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*)ns<b> name:</b> (NSString*)name<b> content:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Creation of a new child element, added at the
end of parent children list. <var>ns</var> and
<var>content</var> parameters are optional (may be
<code>nil</code>). If <var>content</var> is non
<code>nil</code>, a child list containing the
TEXTs and ENTITY_REFs node will be created. Return
previous node.
</p>
<p>
<pre>
GSXMLNode *n1, *n2;
GSXMLDocument *d, *d1;
d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil
name: @"plist"
content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil
name: @"dict"
content: nil];
[n1 makeChildWithNamespace: nil name: @"key" content: @"Year Of Birth"];
[n1 makeChildWithNamespace: nil name: @"integer" content: @"65"];
[n1 makeChildWithNamespace: nil name: @"key" content: @"Pets Names"];
[n1 makeChildWithNamespace: nil name: @"array" content: nil];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makeComment$">makeComment: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>makeComment:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new comment element, added at the
end of parent children list.
<pre>
d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
[n1 makeComment: @" this is a comment "];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makeNamespaceHref$prefix$">makeNamespaceHref: prefix: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*) <b>makeNamespaceHref:</b> (NSString*)href<b> prefix:</b> (NSString*)prefix;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create a namespace attached to this node.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makePI$content$">makePI: content: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>makePI:</b> (NSString*)name<b> content:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new process instruction element,
added at the end of parent children list.
<pre>
d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
[n1 makeComment: @" this is a comment "];
[n1 makePI: @"pi1" content: @"this is a process instruction"];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-makeText$">makeText: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>makeText:</b> (NSString*)content;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new text element, added at the end
of parent children list.
<pre>
d = [GSXMLDocument documentWithVersion: @"1.0"];
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
[[d root] setObject: @"0.9" forKey: @"version"];
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
[n1 makeText: @" this is a text "];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-name">name </a></h3>
- (NSString*) <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the node-name
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-namespace">namespace </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*) <b>namespace</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the namespace of the node.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-namespaceDefinitions">namespaceDefinitions </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*) <b>namespaceDefinitions</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return namespace definitions for the node
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-next">next </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>next</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the next node at this level. This method can
return any type of node, and it may be more
convenient to use the
<a rel="gsdoc" href="#method$GSXMLNode-nextElement">
-nextElement
</a>
node if you are parsing a document where you wish to
ignore non-element nodes such as whitespace text
separating elements.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-nextElement">nextElement </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>nextElement</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the next element node, skipping past any
other node types (such as text nodes). If there is no
element node to be returned, this method returns
<code>nil</code>. <br /> NB. This method is not
available in java, as the method name conflicts
with that of java's Enumerator class.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-objectForKey$">objectForKey: </a></h3>
- (NSString*) <b>objectForKey:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the attribute value for the specified
<var>key</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-parent">parent </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>parent</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the parent of this node.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-previous">previous </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>previous</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the previous node at this level.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-previousElement">previousElement </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>previousElement</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the previous element node at this level.
<br /> NB. This method is not available in java, as
the method name conflicts with that of java's
Enumerator class.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-propertiesAsDictionaryWithKeyTransformationSel$">propertiesAsDictionaryWithKeyTransformationSel: </a></h3>
- (NSMutableDictionary*) <b>propertiesAsDictionaryWithKeyTransformationSel:</b> (SEL)keyTransformSel;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Return attributes and values as a dictionary, but
applies the specified selector to each key before
adding the key and value to the dictionary. The
selector must be a method of NSString taking no
arguments and returning an object suitable for
use as a dictionary key.
</p>
<p>
</p>
<p>
This method exists for the use of GSWeb... it is
probably not of much use elsewhere.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-setNamespace$">setNamespace: </a></h3>
- (void) <b>setNamespace:</b> (<a rel="gsdoc" href="#class$GSXMLNamespace">GSXMLNamespace</a>*)space;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the namespace of the receiver to the value
specified. <br /> Supplying a <code>nil</code>
namespace removes any namespace previously set or
any namespace that the node inherited from a parent
when it was created.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-setObject$forKey$">setObject: forKey: </a></h3>
- (void) <b>setObject:</b> (NSString*)value<b> forKey:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set (or reset) an attribute carried by a node.
<pre>
[n1 setObject: @"prop1" forKey: @"name1"];
[n1 setObject: @"prop2" forKey: @"name2"];
[n1 setObject: @"prop3" forKey: @"name3"];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-type">type </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>type</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return node-type. The most efficient way of testing
node types is to use this method and compare the
return value with a value you previously obtained
using the
<a rel="gsdoc" href="#method$GSXMLNode+typeFromDescription$">
+typeFromDescription:
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLNode-typeDescription">typeDescription </a></h3>
- (NSString*) <b>typeDescription</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return node type as a string.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSXMLNode_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXMLNode Class</h2>
<h3><a name="ivariable$GSXMLNode*_parent">_parent</a></h3>
@protected id <b>_parent</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLNode*lib">lib</a></h3>
@protected void* <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="010000000000">
Software documentation for the GSXMLParser class
</a></h1>
<h2><a name="class$GSXMLParser">GSXMLParser</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
The XML parser object is the pivotal part of parsing an
XML document - it will either build a tree representing
the document (if initialized without a GSSAXHandler),
or will cooperate with a GSSAXHandler object to provide
parsing without the overhead of building a tree.
</p>
<p>
</p>
<p>
The parser may be initialized with an input source (in
which case it will expect to be asked to parse the
entire input in a single operation), or without. If
it is initialised without an input source, incremental
parsing can be done by feeding successive parts of
the XML document into the parser as NSData objects.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_GSXMLParser_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+loadEntity$at$">+loadEntity:at:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parser">+parser</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithContentsOfFile$">+parserWithContentsOfFile:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithContentsOfURL$">+parserWithContentsOfURL:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithData$">+parserWithData:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithSAXHandler$">+parserWithSAXHandler:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithSAXHandler$withContentsOfFile$">+parserWithSAXHandler:withContentsOfFile:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithSAXHandler$withContentsOfURL$">+parserWithSAXHandler:withContentsOfURL:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+parserWithSAXHandler$withData$">+parserWithSAXHandler:withData:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+setDTDs$">+setDTDs:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser+xmlEncodingStringForStringEncoding$">+xmlEncodingStringForStringEncoding:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-abortParsing">-abortParsing</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-columnNumber">-columnNumber</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-doValidityChecking$">-doValidityChecking:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-document">-document</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-errNo">-errNo</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-getWarnings$">-getWarnings:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-initWithSAXHandler$">-initWithSAXHandler:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-initWithSAXHandler$withContentsOfFile$">-initWithSAXHandler:withContentsOfFile:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-initWithSAXHandler$withContentsOfURL$">-initWithSAXHandler:withContentsOfURL:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-initWithSAXHandler$withData$">-initWithSAXHandler:withData:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-keepBlanks$">-keepBlanks:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-lineNumber">-lineNumber</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-messages">-messages</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-parse">-parse</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-parse$">-parse:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-publicID">-publicID</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-saveMessages$">-saveMessages:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-substituteEntities$">-substituteEntities:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLParser-systemID">-systemID</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLParser+loadEntity$at$">loadEntity: at: </a></h3>
+ (NSString*) <b>loadEntity:</b> (NSString*)publicId<b> at:</b> (NSString*)location;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method controls the loading of external
entities into the system. If it returns an empty
string, the entity is not loaded. If it returns a
filename, the entity is loaded from that file.
If it returns <code>nil</code>, the default entity
loading mechanism is used.
</p>
<p>
</p>
<p>
The default entity loading mechanism is to construct
a file name from the locationURL, by replacing all path
separators with underscores, then attempt to
locate that file in the DTDs resource directory of
the main bundle, and all the standard system
locations.
</p>
<p>
</p>
<p>
As a special case, the default loader examines the
publicID and if it is a GNUstep DTD, the loader
constructs a special name from the ID (by
replacing dots with underscores and spaces with
hyphens) and looks for a file with that name and
a '.dtd' extension in the GNUstep bundles.
</p>
<p>
</p>
<p>
NB. This method will only be called if there is no
SAX handler in use, or if the corresponding method in
the SAX handler returns <code>nil</code>.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parser">parser </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parser</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser (for incremental parsing)
by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$">
-initWithSAXHandler:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithContentsOfFile$">parserWithContentsOfFile: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithContentsOfFile:</b> (NSString*)path;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withContentsOfFile$">-initWithSAXHandler:withContentsOfFile:</a>
<pre>
GSXMLParser *p = [GSXMLParser parserWithContentsOfFile: @"macos.xml"];
if ([p parse])
{
[[p document] dump];
}
else
{
printf("error parse file\n");
}
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithContentsOfURL$">parserWithContentsOfURL: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithContentsOfURL:</b> (NSURL*)url;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withContentsOfURL$">-initWithSAXHandler:withContentsOfURL:</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithData$">parserWithData: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithData:</b> (NSData*)data;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withData$">
-initWithSAXHandler:withData:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithSAXHandler$">parserWithSAXHandler: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$">
-initWithSAXHandler:
</a>
</p>
<p>
</p>
<p>
If the <var>handler</var> object supplied is
<code>nil</code>, the parser will build a tree
representing the parsed file rather than
attempting to get the <var>handler</var> to
deal with the parsed elements and entities.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithSAXHandler$withContentsOfFile$">parserWithSAXHandler: withContentsOfFile: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withContentsOfFile:</b> (NSString*)path;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withContentsOfFile$">-initWithSAXHandler:withContentsOfFile:</a>
<pre>
NSAutoreleasePool *arp = [NSAutoreleasePool new];
GSSAXHandler *h = [GSDebugSAXHandler handler];
GSXMLParser *p = [GSXMLParser parserWithSAXHandler: h
withContentsOfFile: @"macos.xml"];
if ([p parse])
{
printf("ok\n");
}
RELEASE(arp);
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithSAXHandler$withContentsOfURL$">parserWithSAXHandler: withContentsOfURL: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withContentsOfURL:</b> (NSURL*)url;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withContentsOfURL$">-initWithSAXHandler:withContentsOfURL:</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+parserWithSAXHandler$withData$">parserWithSAXHandler: withData: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLParser">GSXMLParser</a>*) <b>parserWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withData:</b> (NSData*)data;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Creation of a new Parser by calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$withData$">
-initWithSAXHandler:withData:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+setDTDs$">setDTDs: </a></h3>
+ (void) <b>setDTDs:</b> (NSString*)aPath;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets a directory in which to look for DTDs when
resolving external references. Can be used whjen
DTDs have not been installed in the normal locatioons.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser+xmlEncodingStringForStringEncoding$">xmlEncodingStringForStringEncoding: </a></h3>
+ (NSString*) <b>xmlEncodingStringForStringEncoding:</b> (NSStringEncoding)encoding;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the name of the string <var>encoding</var>
(for XML) to use for the specified OpenStep
<var>encoding</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-abortParsing">abortParsing </a></h3>
- (void) <b>abortParsing</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
If called by a SAX callback routine, this method will
terminate the parsiong process.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-columnNumber">columnNumber </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>columnNumber</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
If executed during a parse operation, returns the
current column number.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-doValidityChecking$">doValidityChecking: </a></h3>
- (BOOL) <b>doValidityChecking:</b> (BOOL)yesno;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets whether the document needs to be validated.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-document">document </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>document</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the document produced as a result of parsing
data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-errNo">errNo </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>errNo</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return error code for last parse operation.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-getWarnings$">getWarnings: </a></h3>
- (BOOL) <b>getWarnings:</b> (BOOL)yesno;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets whether warnings are generated.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-initWithSAXHandler$">initWithSAXHandler: </a></h3>
- (id) <b>initWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
</p>
<p>
Initialisation of a new Parser with SAX
<var>handler</var>.
</p>
<p>
</p>
<p>
If the <var>handler</var> object supplied is
<code>nil</code>, the parser will use an instance
of
<a rel="gsdoc" href="#class$GSTreeSAXHandler">GSTreeSAXHandler</a>
to build a tree representing the parsed file. This
tree will then be available (via the
<a rel="gsdoc" href="#method$GSXMLParser-document">
-document
</a>
method) as a
<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>
on completion of parsing. </p>
<p>
</p>
<p>
The source for the parsing process is not
specified - so parsing must be done
incrementally by feeding data to the
parser.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-initWithSAXHandler$withContentsOfFile$">initWithSAXHandler: withContentsOfFile: </a></h3>
- (id) <b>initWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withContentsOfFile:</b> (NSString*)path;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Initialisation of a new Parser with SAX
<var>handler</var> (if not <code>nil</code>) by
calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$">
-initWithSAXHandler:
</a>
</p>
<p>
</p>
<p>
Sets the input source for the parser to be the
specified file - so parsing of the entire file
will be performed rather than incremental parsing.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-initWithSAXHandler$withContentsOfURL$">initWithSAXHandler: withContentsOfURL: </a></h3>
- (id) <b>initWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withContentsOfURL:</b> (NSURL*)url;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Initialisation of a new Parser with SAX
<var>handler</var> (if not <code>nil</code>) by
calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$">
-initWithSAXHandler:
</a>
</p>
<p>
</p>
<p>
Sets the input source for the parser to be the
specified URL - so parsing of the entire
document will be performed rather than
incremental parsing.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-initWithSAXHandler$withData$">initWithSAXHandler: withData: </a></h3>
- (id) <b>initWithSAXHandler:</b> (<a rel="gsdoc" href="#class$GSSAXHandler">GSSAXHandler</a>*)handler<b> withData:</b> (NSData*)data;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Initialisation of a new Parser with SAX
<var>handler</var> (if not <code>nil</code>) by
calling
<a rel="gsdoc" href="#method$GSXMLParser-initWithSAXHandler$">
-initWithSAXHandler:
</a>
</p>
<p>
</p>
<p>
Sets the input source for the parser to be the
specified <var>data</var> object (which must
contain an XML document), so parsing of the
entire document will be performed rather than
incremental parsing.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-keepBlanks$">keepBlanks: </a></h3>
- (BOOL) <b>keepBlanks:</b> (BOOL)yesno;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set and return the previous value for blank text nodes
support. ignorableWhitespace nodes are only
generated when running the parser in validating
mode and when the current element doesn't allow CDATA
or mixed content.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-lineNumber">lineNumber </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>lineNumber</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
If executed during a parse operation, returns the
current line number.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-messages">messages </a></h3>
- (NSString*) <b>messages</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the string into which warning and error
messages are saved, or <code>nil</code> if they
are being written to stderr.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-parse">parse </a></h3>
- (BOOL) <b>parse</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Parse source. Return <code>YES</code> if parsed,
otherwise <code>NO</code>. This method should be
called once to parse the entire document.
<pre>
GSXMLParser *p = [GSXMLParser parserWithContentsOfFile:@"macos.xml"];
if ([p parse])
{
[[p doc] dump];
}
else
{
printf("error parse file\n");
}
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-parse$">parse: </a></h3>
- (BOOL) <b>parse:</b> (NSData*)data;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Pass <var>data</var> to the parser for incremental
parsing. This method should be called many
times, with each call passing another block of
<var>data</var> from the same document. After the
whole of the document has been parsed, the method
should be called with an empty or <code>nil</code>
<var>data</var> object to indicate end of parsing.
On this final call, the return value indicates whether
the document was valid or not.
</p>
<p>
<pre>
GSXMLParser *p = [GSXMLParser parserWithSAXHandler: nil source: nil];
while ((data = getMoreData()) != nil)
{
if ([p parse: data] == NO)
{
NSLog(@"parse error");
}
}
// Do something with document parsed
[p parse: nil]; // Completed parsing of document.
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-publicID">publicID </a></h3>
- (NSString*) <b>publicID</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the public ID of the document being parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-saveMessages$">saveMessages: </a></h3>
- (void) <b>saveMessages:</b> (BOOL)yesno;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets up (or removes) a mutable string to which error
and warning messages are saved. Using an argument of
<code>NO</code> will cause these messages to be
written to stderr (the default). <br /> NB. A SAX
handler which overrides the error and warning
logging messages may stop this mechanism operating.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-substituteEntities$">substituteEntities: </a></h3>
- (BOOL) <b>substituteEntities:</b> (BOOL)yesno;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set and return the previous value for entity support.
Initially the parser always keeps entity
references instead of substituting entity values
in the output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLParser-systemID">systemID </a></h3>
- (NSString*) <b>systemID</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the system ID of the document being parsed.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSXMLParser_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXMLParser Class</h2>
<h3><a name="ivariable$GSXMLParser*lib">lib</a></h3>
@protected void* <b>lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLParser*messages">messages</a></h3>
@protected NSMutableString* <b>messages</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLParser*saxHandler">saxHandler</a></h3>
@protected GSSAXHandler* <b>saxHandler</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXMLParser*src">src</a></h3>
@protected id <b>src</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="011000000000">
Software documentation for the GSXMLRPC class
</a></h1>
<h2><a name="class$GSXMLRPC">GSXMLRPC</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSURLHandleClient</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
The GSXMLRPC class provides methods for constructing
and parsing XMLRPC method call and response documents
... so that calls may be constructed of standard
objects.
</p>
<p>
</p>
<p>
The correspondence between XMLRPC values and
Objective-C objects is as follows -
</p>
<p>
<ul>
<li>
<strong>i4</strong> (or
<em><strong>int</strong></em>) is an
NSNumber
other than a real/float or boolean.
</li>
<li>
<strong>boolean</strong> is an
NSNumber
created as a BOOL.
</li>
<li>
<strong>string</strong> is an
NSString
object.
</li>
<li>
<strong>double</strong> is an
NSNumber
created as a <strong>float</strong> or
<strong>double</strong>.
</li>
<li>
<strong>dateTime.iso8601</strong> is an
NSDate
object.
</li>
<li>
<strong>base64</strong> is an
NSData
object.
</li>
<li>
<strong>array</strong> is an
NSArray
object.
</li>
<li>
<strong>struct</strong> is an
NSDictionary
object.
</li>
</ul>
</p>
<p>
If you attempt to use any other type of
object in the construction of an
XMLRPC document, the
[NSObject -description]
method of that object will be used to create a striong, and the resulting object will be encoded as an XMLRPC <em>string</em> element.
</p>
<p>
</p>
<p>
In particular, the names of members in a
<em>struct</em> must be strings, so if
you provide an
NSDictionary
object to represent a <em>struct</em> the keys of the dictionary will be converted to strings if necessary. </p>
<p>
</p>
<p>
The class also provides a method for
making a synchronous XMLRPC method
call (with timeout), or an
asynchronous call in which
the call completion is handled by a
delegate.
</p>
<p>
</p>
<p>
You may also use the class to
implement an XMLRPC server, by
calling the
<a rel="gsdoc" href="#method$GSXMLRPC-parseMethod$params$">-parseMethod:params:</a>
method to parse the data POSTed to your server, and <a rel="gsdoc" href="#method$GSXMLRPC-buildResponseWithParams$">-buildResponseWithParams:</a>
(or -buildResponseWithFaultCode:andString:) to produce the data to be sent back to the client.
</p>
<p>
</p>
<p>
In order to simply make a synchronous
XMLRPC call to a server, all you
need to do is write code like:
</p>
<p>
<pre>
GSXMLRPC *server = [[GSXMLRPC alloc] initWithURL: @"http://server/path"];
id result = [server makeMethodCall: name params: p timeout: 30];
</pre>
</p>
<p>
Saying that you want to call the specified method
('name') on the server, passing the parameters
('p') and with a 30 second timeout. <br /> If there
is a network or http-level error or a timeout, the
result will be an error string, otherwise it will be
an array (on success) or a dictionary containing the
fault details.
</p>
<p>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC(Delegate)-completedXMLRPC$">-completedXMLRPC:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-URLHandle$resourceDataDidBecomeAvailable$">-URLHandle:resourceDataDidBecomeAvailable:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-URLHandle$resourceDidFailLoadingWithReason$">-URLHandle:resourceDidFailLoadingWithReason:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-URLHandleResourceDidBeginLoading$">-URLHandleResourceDidBeginLoading:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-URLHandleResourceDidCancelLoading$">-URLHandleResourceDidCancelLoading:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-URLHandleResourceDidFinishLoading$">-URLHandleResourceDidFinishLoading:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-buildMethod$params$">-buildMethod:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-buildMethodCall$params$">-buildMethodCall:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-buildResponseWithFaultCode$andString$">-buildResponseWithFaultCode:andString:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-buildResponseWithParams$">-buildResponseWithParams:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-compact">-compact</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-delegate">-delegate</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-initWithURL$">-initWithURL:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-initWithURL$certificate$privateKey$password$">-initWithURL:certificate:privateKey:password:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-makeMethodCall$params$timeout$">-makeMethodCall:params:timeout:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-parseMethod$params$">-parseMethod:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-parseResponse$params$">-parseResponse:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-result">-result</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-sendMethodCall$params$timeout$">-sendMethodCall:params:timeout:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-setCompact$">-setCompact:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-setDebug$">-setDebug:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-setDelegate$">-setDelegate:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-setTimeZone$">-setTimeZone:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-timeZone">-timeZone</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC-timeout$">-timeout:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLRPC-URLHandle$resourceDataDidBecomeAvailable$">URLHandle: resourceDataDidBecomeAvailable: </a></h3>
- (void) <b>URLHandle:</b> (NSURLHandle*)sender<b> resourceDataDidBecomeAvailable:</b> (NSData*)newData;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Allows GSXMLRPC to act as a client of NSURLHandle.
Internal use only.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-URLHandle$resourceDidFailLoadingWithReason$">URLHandle: resourceDidFailLoadingWithReason: </a></h3>
- (void) <b>URLHandle:</b> (NSURLHandle*)sender<b> resourceDidFailLoadingWithReason:</b> (NSString*)reason;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Allows GSXMLRPC to act as a client of NSURLHandle.
Internal use only.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-URLHandleResourceDidBeginLoading$">URLHandleResourceDidBeginLoading: </a></h3>
- (void) <b>URLHandleResourceDidBeginLoading:</b> (NSURLHandle*)sender;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Allows GSXMLRPC to act as a client of NSURLHandle.
Internal use only.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-URLHandleResourceDidCancelLoading$">URLHandleResourceDidCancelLoading: </a></h3>
- (void) <b>URLHandleResourceDidCancelLoading:</b> (NSURLHandle*)sender;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Allows GSXMLRPC to act as a client of NSURLHandle.
Internal use only.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-URLHandleResourceDidFinishLoading$">URLHandleResourceDidFinishLoading: </a></h3>
- (void) <b>URLHandleResourceDidFinishLoading:</b> (NSURLHandle*)sender;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Allows GSXMLRPC to act as a client of NSURLHandle.
Internal use only.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-buildMethod$params$">buildMethod: params: </a></h3>
- (NSData*) <b>buildMethod:</b> (NSString*)method<b> params:</b> (NSArray*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Given a <var>method</var> name and an array of
parameters, this <var>method</var> constructs
the XML document for the corresponding XMLRPC call and
returns the document as an NSData object containing
UTF-8 text. <br /> The <var>params</var> array may be
empty or <code>nil</code> if there are no parameters
to be passed. <br /> The <var>method</var> returns
<code>nil</code> if passed an invalid
<var>method</var> name (a <var>method</var> name may
contain any of the ascii alphanumeric characters
and underscore, fullstop, colon, or slash). <br /> This
<var>method</var> is used internally when sending an
XMLRPC <var>method</var> call to a remote system,
but you can also call it yourself.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-buildMethodCall$params$">buildMethodCall: params: </a></h3>
- (NSString*) <b>buildMethodCall:</b> (NSString*)method<b> params:</b> (NSArray*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Given a <var>method</var> name and an array of
parameters, this <var>method</var> constructs
the XML document for the corresponding XMLRPC call and
returns the document as a string. <br /> The
<var>params</var> array may be empty or
<code>nil</code> if there are no parameters to be
passed. <br /> The <var>method</var> returns
<code>nil</code> if passed an invalid
<var>method</var> name (a <var>method</var> name may
contain any of the ascii alphanumeric characters
and underscore, fullstop, colon, or slash). <br />
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-buildResponseWithFaultCode$andString$">buildResponseWithFaultCode: andString: </a></h3>
- (NSString*) <b>buildResponseWithFaultCode:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)code<b> andString:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Constructs an XML document for an XMLRPC fault
response with the specified <var>code</var> and
string. The resulting document is returned as a
string. <br /> This method is intended for use by
applications acting as XMLRPC servers.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-buildResponseWithParams$">buildResponseWithParams: </a></h3>
- (NSString*) <b>buildResponseWithParams:</b> (NSArray*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Builds an XMLRPC response with the specified array
of parameters and returns the document as a string.
<br /> The <var>params</var> array may be empty or
<code>nil</code> if there are no parameters to be
returned (an empty <var>params</var> element will
be created). <br /> This method is intended for use by
applications acting as XMLRPC servers.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-compact">compact </a></h3>
- (BOOL) <b>compact</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the value set by a prior call to
<a rel="gsdoc" href="#method$GSXMLRPC-setCompact$">
-setCompact:
</a>
(or <code>NO</code>... the default).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-delegate">delegate </a></h3>
- (id) <b>delegate</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the delegate previously set by the
<a rel="gsdoc" href="#method$GSXMLRPC-setDelegate$">
-setDelegate:
</a>
method. <br /> The delegate handles completion of
asynchronous method calls to the URL specified
when the receiver was initialised (if any).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-initWithURL$">initWithURL: </a></h3>
- (id) <b>initWithURL:</b> (NSString*)url;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Initialise the receiver to make XMLRPC calls to
the specified URL. <br /> This method just calls
<a rel="gsdoc" href="#method$GSXMLRPC-initWithURL$certificate$privateKey$password$">-initWithURL:certificate:privateKey:password:</a>
with <code>nil</code> arguments for the SSL credentials.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-initWithURL$certificate$privateKey$password$">initWithURL: certificate: privateKey: password: </a></h3>
- (id) <b>initWithURL:</b> (NSString*)url<b> certificate:</b> (NSString*)cert<b> privateKey:</b> (NSString*)pKey<b> password:</b> (NSString*)pwd;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialise the receiver to make XMLRPC calls to
the specified <var>url</var> and (optionally) with the
specified SSL parameters. <br /> The
<var>url</var> argument may be <code>nil</code>, in
which case the receiver will be unable to make XMLRPC
calls, but can be used to parse incoming requests
and build responses. <br /> If the SSL credentials are
non-nil, connections to the remote server will be
authenticated using the supplied certificate
so that the remote system knows who is contacting it.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-makeMethodCall$params$timeout$">makeMethodCall: params: timeout: </a></h3>
- (id) <b>makeMethodCall:</b> (NSString*)method<b> params:</b> (NSArray*)params<b> timeout:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)seconds;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#method$GSXMLRPC-sendMethodCall$params$timeout$">
-sendMethodCall:params:timeout:
</a>
and waits for the response. <br /> Returns the response
parameters (an array), the response fault (a
dictionary), or a failure reason (a string).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-parseMethod$params$">parseMethod: params: </a></h3>
- (NSString*) <b>parseMethod:</b> (NSData*)request<b> params:</b> (NSMutableArray*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Parses XML data containing an XMLRPC method call.
<br /> Returns the name of the method call. <br />
Empties, and then places the method parameters (if
any) in the <var>params</var> argument. <br /> NB. Any
containers (arrays or dictionaries) in the
parsed parameters will be mutable, so you can modify
this data structure as you like. <br /> Raises an
exception if parsing fails. <br /> This method is
intended for the use of XMLRPC server
applications.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-parseResponse$params$">parseResponse: params: </a></h3>
- (NSDictionary*) <b>parseResponse:</b> (NSData*)resp<b> params:</b> (NSMutableArray*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Parses XML data containing an XMLRPC method
response. <br /> Returns <code>nil</code> for
success, the fault dictionary on failure. <br />
Places the response parameters (if any) in the
<var>params</var> argument. <br /> NB. Any containers
(arrays or dictionaries) in the parsed parameters
will be mutable, so you can modify this data structure
as you like. <br /> Raises an exception if parsing
fails. <br /> Used internally when making a method
call to a remote server.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-result">result </a></h3>
- (id) <b>result</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the result of the last method call, or
<code>nil</code> if there has been no method call or
one is in progress. <br /> The result may be one of -
<ul>
<li>
A mutable array... the parameters of a success
response.
</li>
<li>
A dictionary... containing a fault response.
</li>
<li>
A string... describing a low-level failure (eg.
timeout).
</li>
</ul>
NB. Any containers (arrays or dictionaries) in the
parsed parameters of a success response will be
mutable, so you can modify this data structure as
you like.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-sendMethodCall$params$timeout$">sendMethodCall: params: timeout: </a></h3>
- (BOOL) <b>sendMethodCall:</b> (NSString*)method<b> params:</b> (NSArray*)params<b> timeout:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)seconds;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Send an asynchronous XMLRPC <var>method</var> call
with the specified timeout. <br /> A delegate should
have been set to handle the result of this call, but
if one was not set the state of the asynchronous call
may be polled by calling the
<a rel="gsdoc" href="#method$GSXMLRPC-result">
-result
</a>
<var>method</var>, which will return <code>nil</code>
as <strong>long</strong> as the call has not completed.
<br /> The call may be cancelled by calling the
<a rel="gsdoc" href="#method$GSXMLRPC-timeout$">
-timeout:
</a>
<var>method</var> <br /> This <var>method</var>
returns <code>YES</code> if the call was started,
<code>NO</code> if it could not be started (eg
because another call is in progress or because of
bad arguments). <br /> NB. For the asynchronous
operation to proceed, the current
NSRunLoop
must be run.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-setCompact$">setCompact: </a></h3>
- (void) <b>setCompact:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Specify whether to generate compact XML (omit
indentation and other white space and omit
<string> element markup). <br />
Compact representation saves some space (can be
important when sent over slow/low bandwidth
connections), but sacrifices readability.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-setDebug$">setDebug: </a></h3>
- (void) <b>setDebug:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Specify whether to perform debug trace on I/O
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-setDelegate$">setDelegate: </a></h3>
- (void) <b>setDelegate:</b> (id)aDelegate;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the delegate object which will receive callbacks
when an XMLRPC call completes. <br /> NB. this
delegate is <em>not</em> retained, and should be
removed before it is deallocated (call
<a rel="gsdoc" href="#method$GSXMLRPC-setDelegate$">
-setDelegate:
</a>
again with a <code>nil</code> argument to remove the
delegate).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-setTimeZone$">setTimeZone: </a></h3>
- (void) <b>setTimeZone:</b> (NSTimeZone*)timeZone;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the time zone for use when sending/receiving
date/time values. <br /> The XMLRPC specification
says that timezone is server dependent so you will
need to set it according to the server you are
connecting to. <br /> If this is not set, UCT is
assumed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-timeZone">timeZone </a></h3>
- (NSTimeZone*) <b>timeZone</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the time zone currently set.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLRPC-timeout$">timeout: </a></h3>
- (void) <b>timeout:</b> (NSTimer*)t;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Handles timeouts, passing information to delegate
... you don't need to call this method, but you
<em>may</em> call it in order to cancel an
asynchronous request as if it had timed out.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="012000000000">
Software documentation for the GSXPathBoolean class
</a></h1>
<h2><a name="class$GSXPathBoolean">GSXPathBoolean</a> : <a rel="gsdoc" href="#class$GSXPathObject">GSXPathObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
For XPath queries returning true/false.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathBoolean-booleanValue">-booleanValue</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXPathBoolean-booleanValue">booleanValue </a></h3>
- (BOOL) <b>booleanValue</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the the value of the receiver... YES/NO,
true/false.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="013000000000">
Software documentation for the GSXPathContext class
</a></h1>
<h2><a name="class$GSXPathContext">GSXPathContext</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Use of the GSXPathContext class is simple... you just
need to look up xpath to learn the syntax of xpath
expressions, then you can apply those
expressions to a context to retrieve data from
a document.
</p>
<p>
<pre>
GSXMLParser *p = [GSXMLParser parserWithContentsOfFile: @"xp.xml"];
if ([p parse])
{
GSXMLDocument *d = [p document];
GSXPathContext *c = [[GSXPathContext alloc] initWithDocument: document];
GSXPathString *result = [c evaluateExpression: @"string(/body/text())"];
GSPrintf(stdout, @"Got %@", [result stringValue]);
}
else
{
GSPrintf(stderr, "error parsing file\n");
}
</pre>
</div>
<hr width="50%" align="left" />
<a href="#_GSXPathContext_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathContext-evaluateExpression$">-evaluateExpression:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathContext-initWithDocument$">-initWithDocument:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathContext-registerNamespaceWithPrefix$href$">-registerNamespaceWithPrefix:href:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXPathContext-evaluateExpression$">evaluateExpression: </a></h3>
- (<a rel="gsdoc" href="#class$GSXPathObject">GSXPathObject</a>*) <b>evaluateExpression:</b> (NSString*)XPathExpression;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Evaluates the supplied expression and returns the
resulting node or node set. If the expression is
invalid, returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXPathContext-initWithDocument$">initWithDocument: </a></h3>
- (id) <b>initWithDocument:</b> (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*)d;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Initialises the receiver as an xpath parser for
the supplied document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXPathContext-registerNamespaceWithPrefix$href$">registerNamespaceWithPrefix: href: </a></h3>
- (BOOL) <b>registerNamespaceWithPrefix:</b> (NSString*)prefix<b> href:</b> (NSString*)href;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSXPathContext_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXPathContext Class</h2>
<h3><a name="ivariable$GSXPathContext*_document">_document</a></h3>
@protected GSXMLDocument* <b>_document</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXPathContext*_lib">_lib</a></h3>
@protected void* <b>_lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="014000000000">
Software documentation for the GSXPathNodeSet class
</a></h1>
<h2><a name="class$GSXPathNodeSet">GSXPathNodeSet</a> : <a rel="gsdoc" href="#class$GSXPathObject">GSXPathObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
For XPath queries returning a node set. <br /> An XPATH
node set is an ordered set of nodes returned as a result
of an expression. The order of the nodes in the set is the
same as the order in the xml document from which they
were extracted.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathNodeSet-count">-count</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathNodeSet-length">-length</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathNodeSet-nodeAtIndex$">-nodeAtIndex:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXPathNodeSet-count">count </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>count</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the number of nodes in the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXPathNodeSet-length">length </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>length</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Deprecated
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXPathNodeSet-nodeAtIndex$">nodeAtIndex: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLNode">GSXMLNode</a>*) <b>nodeAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Please note that <var>index</var> starts from 0.
<br /> Returns the node from the receiver at the
specified <var>index</var>, or <code>nil</code>
if no such node exists.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="015000000000">
Software documentation for the GSXPathNumber class
</a></h1>
<h2><a name="class$GSXPathNumber">GSXPathNumber</a> : <a rel="gsdoc" href="#class$GSXPathObject">GSXPathObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
For XPath queries returning a number.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathNumber-doubleValue">-doubleValue</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXPathNumber-doubleValue">doubleValue </a></h3>
- (double) <b>doubleValue</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the floating point (<strong>double</strong>
) value of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="016000000000">
Software documentation for the GSXPathObject class
</a></h1>
<h2><a name="class$GSXPathObject">GSXPathObject</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
XPath queries return a GSXPathObject. GSXPathObject in
itself is an abstract class; there are four types of
completely different GSXPathObject types, listed
below. I'm afraid you need to check the returned type
of each GSXPath query to make sure it's what you meant it
to be. <br />
</p>
<p>
You don't create GSXPathObject instances, instead the
XPATH system creates them and returns them as the
result of the
<a rel="gsdoc" href="#method$GSXPathContext-evaluateExpression$">[GSXPathContext -evaluateExpression:]</a>
method.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_GSXPathObject_ivars">Instance Variables</a>
<br/><br/>
<a name="_GSXPathObject_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSXPathObject Class</h2>
<h3><a name="ivariable$GSXPathObject*_context">_context</a></h3>
@protected GSXPathContext* <b>_context</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSXPathObject*_lib">_lib</a></h3>
@protected void* <b>_lib</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="017000000000">
Software documentation for the GSXPathString class
</a></h1>
<h2><a name="class$GSXPathString">GSXPathString</a> : <a rel="gsdoc" href="#class$GSXPathObject">GSXPathObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
For XPath queries returning a string.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXPathString-stringValue">-stringValue</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXPathString-stringValue">stringValue </a></h3>
- (NSString*) <b>stringValue</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the string value of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="018000000000">
Software documentation for the GSXMLDocument(XSLT)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>(<a name="category$GSXMLDocument(XSLT)">XSLT</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$">+xsltTransformFile:stylesheet:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$params$">+xsltTransformFile:stylesheet:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$">+xsltTransformXml:stylesheet:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$params$">+xsltTransformXml:stylesheet:params:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)-xsltTransform$">-xsltTransform:</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLDocument(XSLT)-xsltTransform$params$">-xsltTransform:params:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$">xsltTransformFile: stylesheet: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransformFile:</b> (NSString*)xmlFile<b> stylesheet:</b> (NSString*)xsltStylesheet;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the specified
file using the stylesheet provided. <br /> Returns an
autoreleased GSXMLDocument containing the
transformed XML, or <code>nil</code> on
failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)+xsltTransformFile$stylesheet$params$">xsltTransformFile: stylesheet: params: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransformFile:</b> (NSString*)xmlFile<b> stylesheet:</b> (NSString*)xsltStylesheet<b> params:</b> (NSDictionary*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the specified
file using the stylesheet and parameters provided. See
the libxslt documentation for details of the supported
parameters. <br /> Returns an autoreleased
GSXMLDocument containing the transformed XML,
or <code>nil</code> on failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$">xsltTransformXml: stylesheet: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransformXml:</b> (NSData*)xmlData<b> stylesheet:</b> (NSData*)xsltStylesheet;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the specified
file using the stylesheet provided. <br /> Returns an
autoreleased GSXMLDocument containing the
transformed XML, or <code>nil</code> on
failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)+xsltTransformXml$stylesheet$params$">xsltTransformXml: stylesheet: params: </a></h3>
+ (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransformXml:</b> (NSData*)xmlData<b> stylesheet:</b> (NSData*)xsltStylesheet<b> params:</b> (NSDictionary*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the specified
file using the stylesheet and parameters provided.See
the libxslt documentation for details of the supported
parameters. <br /> Returns an autoreleased
GSXMLDocument containing the transformed XML,
or <code>nil</code> on failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)-xsltTransform$">xsltTransform: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransform:</b> (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*)xsltStylesheet;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the current
document using the supplied stylesheet. <br />
Returns an autoreleased GSXMLDocument containing
the transformed XML, or <code>nil</code> on failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSXMLDocument(XSLT)-xsltTransform$params$">xsltTransform: params: </a></h3>
- (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*) <b>xsltTransform:</b> (<a rel="gsdoc" href="#class$GSXMLDocument">GSXMLDocument</a>*)xsltStylesheet<b> params:</b> (NSDictionary*)params;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Performs an XSLT transformation on the current
document using the supplied stylesheet and
paramaters (<var>params</var> may be
<code>nil</code>). See the libxslt documentation for
details of the supported parameters. <br /> Returns
an autoreleased GSXMLDocument containing the transformed
XML, or <code>nil</code> on failure.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="019000000000">
Software documentation for the GSXMLRPC(Delegate)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$GSXMLRPC">GSXMLRPC</a>(<a name="category$GSXMLRPC(Delegate)">Delegate</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Delegates should implement this method in order to
be informed of the success or failure of an XMLRPC method
call which was initiated by the
<a rel="gsdoc" href="#method$GSXMLRPC-sendMethodCall$params$timeout$">
-sendMethodCall:params:timeout:
</a>
method. <br />
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$GSXMLRPC(Delegate)-completedXMLRPC$">-completedXMLRPC:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSXMLRPC(Delegate)-completedXMLRPC$">completedXMLRPC: </a></h3>
- (void) <b>completedXMLRPC:</b> (<a rel="gsdoc" href="#class$GSXMLRPC">GSXMLRPC</a>*)sender;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
An empty method provided for subclasses to override.<br />
<div class="desc">
Called by the <var>sender</var> when an XMLRPC
method call completes (either success or failure).
The delegate may then call the
<a rel="gsdoc" href="#method$GSXMLRPC-result">
-result
</a>
method to retrieve the result of the method call
from the <var>sender</var>.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="020000000000">
Software documentation for the NSString(GSXML)
category
</a></h1>
<h2>NSString(<a name="category$NSString(GSXML)">GSXML</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSXML.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience methods for managing XML escape
sequences in an NSString.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSXML.html#method$NSString(GSXML)-stringByEscapingXML">-stringByEscapingXML</a></li>
<li><a rel="gsdoc" href="GSXML.html#method$NSString(GSXML)-stringByUnescapingXML">-stringByUnescapingXML</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSString(GSXML)-stringByEscapingXML">stringByEscapingXML </a></h3>
- (NSString*) <b>stringByEscapingXML</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Deals with standard XML internal entities. <br />
Converts the five XML special characters in the
receiver ('>', '<', '&', ''' and
'"') to their escaped equivalents, and
return the escaped string. <br /> Also converts
non-ascii characters to the corresponding numeric
entity escape sequences. <br /> You should perform
any non-standard entity substitution you require
<em>after</em> you have called this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSString(GSXML)-stringByUnescapingXML">stringByUnescapingXML </a></h3>
- (NSString*) <b>stringByUnescapingXML</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Deals with standard XML internal entities. <br />
Converts the five XML escape sequences
('&gt;', '&lt;', '&amp;',
'&apos;' and '&quot;') to the unicode
characters they represent, and returns the
unescaped string. <br /> Also converts numeric
entity escape sequences to the corresponding unicode
characters. <br /> You should perform any
non-standard entity substitution you require
<em>before</em> you have called this method.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="BaseAdditions.html">Up</a>
</font>
</body>
</html>
|