Roxen.git/server/etc/modules/RXML.pmod/module.pmod:ed775f34fa997dd8c5c7ce0fa6711dd75fddc70d

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 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 //! RXML parser and compiler framework. //! //! Created 1999-07-30 by Martin Stjernholm. //! //! $Id: module.pmod,v 1.143 2001/03/15 23:31:24 per Exp $ //! Kludge: Must use "RXML.refs" somewhere for the whole module to be //! loaded correctly. static object Roxen; class RequestID { }; //! API stability notes: //! //! The API in this file regarding the global functions and the Tag, //! TagSet, Context, Frame and Type classes and their descendants is //! intended to not change in incompatible ways. There are however //! some areas where incompatible changes still must be expected: //! //! o The namespace handling will likely change to conform to XML //! namespaces. The currently implemented system is inadequate then //! and will probably be removed. //! //! o The semantics for caching and reuse of Frame objects is //! deliberatily documented vaguely (see the class doc for the //! Frame class). The currently implemented behavior will change //! when the cache system becomes reality. So never assume that //! you'll always get fresh Frame instances every time a tag is //! evaluated. //! //! o The parser currently doesn't stream data according to the //! interface for streaming tags (but the implementation still //! follows the documented API for it). Therefore there's a risk //! that incompatible changes must be made in it due to design bugs //! when it's tested out. That is considered very unlikely, though. //! //! o The type system will be developed further, and the API in the //! Type class might change as advanced types gets implemented. //! Don't make assumptions about undocumented behavior. Declare //! data properly with the types RXML.t_xml, RXML.t_html and //! RXML.t_text to let the parser handle the necessary conversions //! instead of doing it yourself. Try to avoid implementing types. //! //! o Various utilities have FIXME's in their documentation. Needless //! to say they don't work as documented yet, and the doc should be //! considered as ideas only; it might work differently when it's //! actually implemented. //! //! Note that the API for parsers, p-code evaluators etc is not part //! of the "official" API. (The syntax _parsed_ by the currently //! implemented parsers is well defined, of course.) //#pragma strict_types // Disabled for now since it doesn't work well enough. #include <config.h> #include <request_trace.h> #ifdef RXML_OBJ_DEBUG # define MARK_OBJECT \ Debug.ObjectMarker __object_marker = Debug.ObjectMarker (this_object()) # define MARK_OBJECT_ONLY \ Debug.ObjectMarker __object_marker = Debug.ObjectMarker (0) #else # define MARK_OBJECT # define MARK_OBJECT_ONLY #endif #ifdef OBJ_COUNT_DEBUG // This debug mode gives every object a unique number in the // _sprintf() string. # ifndef RXML_OBJ_DEBUG # undef MARK_OBJECT # undef MARK_OBJECT_ONLY # define MARK_OBJECT \ mapping __object_marker = (["count": ++all_constants()->_obj_count]) # define MARK_OBJECT_ONLY \ mapping __object_marker = (["count": ++all_constants()->_obj_count]) # endif # define OBJ_COUNT (__object_marker ? "[" + __object_marker->count + "]" : "") #else # define OBJ_COUNT "" #endif #ifdef DEBUG # define TAG_DEBUG(frame, msg) (frame)->tag_debug ("%O: %s", (frame), (msg)) #else # define TAG_DEBUG(frame, msg) 0 #endif #define HASH_INT2(m, n) (n < 65536 ? (m << 16) + n : sprintf ("%x,%x", m, n)) class Tag //! Interface class for the static information about a tag. { constant is_RXML_Tag = 1; //! Interface. //!string name; //! The name of the tag. Required and considered constant. /*extern*/ int flags; //! Various bit flags that affect parsing; see the FLAG_* constants. //! RXML.Frame.flags is initialized from this. mapping(string:Type) req_arg_types = ([]); mapping(string:Type) opt_arg_types = ([]); //! The names and types of the required and optional arguments. If a //! type specifies a parser, it'll be used on the argument value. //! Note that the order in which arguments are parsed is arbitrary. Type def_arg_type = t_text (PEnt); //! The type used for arguments that isn't present in neither //! req_arg_types nor opt_arg_types. This default is a parser that //! only parses XML-style entities. Type content_type = t_same (PXml); //! The handled type of the content, if the tag gets any. //! //! This default is the special type @[RXML.t_same], which means the //! type is taken from the effective type of the result. The @[PXml] //! argument causes the standard XML parser to be used to read it, //! which means that the content is preparsed with XML syntax. Use //! no parser to get the raw text. //! //! Note: You probably want to change this to @[RXML.t_text] //! (without parser) if the tag is a processing instruction (see //! @[FLAG_PROC_INSTR]). array(Type) result_types = ({t_xml, t_html, t_text}); //! The possible types of the result, in order of precedence. If a //! result type has a parser, it'll be used to parse any strings in //! the exec array returned from @[Frame.do_enter] and similar //! callbacks. //! //! When the tag is used in content of some type, the content type //! may be a supertype of any type in @[result_types], but it may //! also be a subtype of any of them. The tag must therefore be //! prepared to produce result of more specific types than those //! declared here. I.e. the extreme case, @[RXML.t_any], means that //! this tag takes the responsibility to produce result of any type //! that's asked for, not that it has the liberty to produce results //! of any type it chooses. //!program Frame; //!object(Frame) Frame(); //! This program/function is used to clone the objects used as //! frames. A frame object must (in practice) inherit RXML.Frame. //! (It can, of course, be any function that requires no arguments //! and returns a new frame object.) This is not used for plugin //! tags. //!string plugin_name; //! If this is defined, this is a so-called plugin tag. That means //! it plugs in some sort of functionality in another Tag object //! instead of handling the actual tags of its own. It works as //! follows: //! //! o Instead of installing the callbacks for this tag, the parser //! uses another registered "socket" Tag object that got the same //! name as this one. Socket tags have the FLAG_SOCKET_TAG flag //! set to signify that they accept plugins. //! //! o When the socket tag is parsed or evaluated, it can get the //! Tag objects for the registered plugins with the function //! Frame.get_plugins(). It's then up to the socket tag to use //! the plugins according to some API it defines. //! //! o plugin_name is the name of the plugin. It's used as index in //! the mapping that the Frame.get_plugins() returns. //! //! o The plugin tag is registered in the tag set with the //! identifier //! //! name + "#" + plugin_name //! //! It overrides other plugin tags with that name according to //! the normal tag set rules, but, as said above, is never //! registered for actual parsing at all. //! //! It's undefined whether plugin tags override normal tags -- //! '#' should never be used in normal tag names. //! //! o It's not an error to register a plugin for which there is no //! socket. Such plugins are simply ignored. //! Services. inline final object/*(Frame)HMM*/ `() (mapping(string:mixed) args, void|mixed content) //! Make an initialized frame for the tag. Typically useful when //! returning generated tags from e.g. RXML.Frame.do_process(). The //! argument values and the content are normally not parsed. { Tag this = this_object(); object/*(Frame)HMM*/ frame = ([function(:object/*(Frame)HMM*/)] this->Frame)(); frame->tag = this; frame->flags = flags; frame->args = args; frame->content = zero_type (content) ? nil : content; frame->result = nil; return frame; } int eval_args (mapping(string:mixed) args, void|int dont_throw, void|Context ctx) //! Parses and evaluates the tag arguments according to //! req_arg_types and opt_arg_types. The args mapping contains the //! unparsed arguments on entry, and they get replaced by the parsed //! results. Arguments not mentioned in req_arg_types or //! opt_arg_types are not touched. RXML errors, such as missing //! argument, are thrown if dont_throw is zero or left out, //! otherwise zero is returned for such errors. ctx specifies the //! context to use; it defaults to the current context. { // Note: Code duplication in Frame._eval(). mapping(string:Type) atypes = args & req_arg_types; if (sizeof (atypes) < sizeof (req_arg_types)) if (dont_throw) return 0; else { array(string) missing = sort (indices (req_arg_types - atypes)); parse_error ("Required " + (sizeof (missing) > 1 ? "arguments " + String.implode_nicely (missing) + " are" : "argument " + missing[0] + " is") + " missing.\n"); } atypes += args & opt_arg_types; #ifdef MODULE_DEBUG if (mixed err = catch { #endif foreach (indices (atypes), string arg) args[arg] = atypes[arg]->eval (args[arg], ctx); // Should not unwind. #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err); } #endif return 1; } // Internals. array _handle_tag (TagSetParser parser, mapping(string:string) args, void|string content) // Callback for tag set parsers to handle non-PI tags. Returns a // sequence of result values to be added to the result queue. Note // that this function handles an unwind frame for the parser. { // Note: args may be zero since this is called from _handle_pi_tag(). Context ctx = parser->context; // FIXME: P-code generation. string splice_args; if (args && (splice_args = args["::"])) { // Somewhat kludgy solution for the time being. #ifdef MODULE_DEBUG if (mixed err = catch { #endif splice_args = t_string (PEnt)->eval (splice_args, ctx, 0, parser, 1); #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating splice argument.\n"); throw_fatal (err); } #endif m_delete (args, "::"); args += parser->parse_tag_args (splice_args); } object/*(Frame)HMM*/ frame; do { if (mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state) if (ustate[parser]) { frame = [object/*(Frame)HMM*/] ustate[parser][0]; m_delete (ustate, parser); if (!sizeof (ustate)) ctx->unwind_state = 0; break; } frame = `() (args, nil); TAG_DEBUG (frame, "New frame\n"); } while (0); // The break goes here. if (!zero_type (frame->raw_tag_text)) { if (splice_args) frame->raw_tag_text = t_xml->format_tag (parser->tag_name(), args, content, flags | FLAG_RAW_ARGS); else frame->raw_tag_text = parser->current_input(); } mixed err = catch { frame->_eval (parser, args, content); mixed res; if ((res = frame->result) == nil) return ({}); if (frame->result_type->name != parser->type->name) { TAG_DEBUG (frame, sprintf ( "Converting result from %s to %s of surrounding content\n", frame->result_type->name, parser->type->name)); res = parser->type->encode (res, frame->result_type); } return ({res}); }; if (objectp (err) && ([object] err)->thrown_at_unwind) { mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state; if (!ustate) ustate = ctx->unwind_state = ([]); #ifdef DEBUG if (err != frame) fatal_error ("Internal error: Unexpected unwind object catched.\n"); if (ustate[parser]) fatal_error ("Internal error: Clobbering unwind state for parser.\n"); #endif ustate[parser] = ({err}); throw (err = parser); } else { ctx->handle_exception (err, parser); // Will rethrow unknown errors. return ({}); } } array _handle_pi_tag (TagSetParser parser, string content) // Callback similar to _handle_tag() for tag set parsers to handle // PI tags. { sscanf (content, "%[ \t\n\r]%s", string ws, string rest); if (ws == "" && rest != "") // The parser didn't match a complete name, so this is a false // alarm for an unknown PI tag. return 0; return _handle_tag (parser, 0, content); } /* Can't define `== here due to Pike bugs.. int __hash() { return hash (this_object()->name); } int `== (mixed other) { return objectp (other) && other->is_RXML_Tag && other->name == this_object()->name; } */ MARK_OBJECT; string _sprintf() { return "RXML.Tag(" + [string] this_object()->name + (this_object()->plugin_name ? "#" + [string] this_object()->plugin_name : "") + ([int] this_object()->flags & FLAG_PROC_INSTR ? " [PI]" : "") + ")" + OBJ_COUNT; } } class TagSet //! Contains a set of tags. Tag sets can import other tag sets, and //! later changes are propagated. Parser instances (contexts) to parse //! data are created from this. TagSet objects may somewhat safely be //! destructed explicitly; the tags in a destructed tag set will not //! be active in parsers that are instantiated later, but will work in //! current instances. Element (i.e. non-PI) tags and PI tags have //! separate namespaces. //! //! Note: A Tag object may not be registered in more than one tag set //! at the same time. { string name; //! Used for identification only. string prefix; //! A namespace prefix that may precede the tags. If it's zero, it's //! up to the importing tag set(s). A ':' is always inserted between //! the prefix and the tag name. int prefix_req; //! The prefix must precede the tags. array(TagSet) imported = ({}); //! Other tag sets that will be used. The precedence is local tags //! first, then imported from left to right. It's not safe to //! destructively change entries in this array. function(Context:void) prepare_context; //! If set, this is a function that will be called before a new //! Context object is taken into use. It'll typically prepare //! predefined scopes and variables. The functions will be called in //! order of precedence; highest last. int generation = 1; //! A number that is increased every time something changes in this //! object or in some tag set it imports. int id_number; //! Unique number identifying this tag set. static void create (string _name, void|array(Tag) _tags) //! { id_number = ++tag_set_count; name = _name; if (_tags) add_tags (_tags); #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif } void add_tag (Tag tag) //! { #ifdef MODULE_DEBUG if (!stringp (tag->name)) error ("Trying to register a tag %O without a name.\n", tag); if (!functionp (tag->Frame) && !tag->plugin_name) error ("Trying to register a tag %O without a Frame class or function.\n", tag); if (tag->name[..3] != "!--#" && // Ugly special case for SSI tags. replace (tag->name, "#<>& \t\n\r" / "", ({""}) * 8) != tag->name) error ("Invalid character(s) in name for tag %O.\n", tag); #endif if (tag->flags & FLAG_PROC_INSTR) { if (!proc_instrs) proc_instrs = ([]); if (tag->plugin_name) proc_instrs[tag->name + "#" + tag->plugin_name] = tag; else proc_instrs[tag->name] = tag; } else if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag; changed(); } void add_tags (array(Tag) _tags) //! { foreach (_tags, Tag tag) { #ifdef MODULE_DEBUG if (!stringp (tag->name)) error ("Trying to register a tag %O without a name.\n", tag); if (!functionp (tag->Frame) && !tag->plugin_name) error ("Trying to register a tag %O without a Frame class or function.\n", tag); if (tag->name[..3] != "!--#" && // Ugly special case for SSI tags. replace (tag->name, "#<>& \t\n\r" / "", ({""}) * 8) != tag->name) error ("Invalid character(s) in name for tag %O.\n", tag); #endif if (tag->flags & FLAG_PROC_INSTR) { if (!proc_instrs) proc_instrs = ([]); if (tag->plugin_name) proc_instrs[tag->name + "#" + tag->plugin_name] = tag; else proc_instrs[tag->name] = tag; } else if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag; } changed(); } void remove_tag (string|Tag tag, void|int proc_instr) //! If tag is a Tag object, it's removed if this tag set contains //! it. If tag is a string, the tag with that name is removed. In //! the latter case, if proc_instr is nonzero the set of PI tags is //! searched, else the set of normal element tags. { if (stringp (tag)) if (proc_instr) { if (proc_instrs) m_delete (proc_instrs, tag); } else m_delete (tags, tag); else { string n; if (tag->flags & FLAG_PROC_INSTR) { if (proc_instrs && !zero_type (n = search (tags, [object(Tag)] tag))) m_delete (proc_instrs, n); } else if (!zero_type (n = search (tags, [object(Tag)] tag))) m_delete (tags, n); } changed(); } local Tag get_local_tag (string name, void|int proc_instr) //! Returns the Tag object for the given name in this tag set, if //! any. If proc_instr is nonzero the set of PI tags is searched, //! else the set of normal element tags. { return proc_instr ? proc_instrs && proc_instrs[name] : tags[name]; } local array(Tag) get_local_tags() //! Returns all the Tag objects in this tag set. { array(Tag) res = values (tags); if (proc_instrs) res += values (proc_instrs); return res; } local Tag get_tag (string name, void|int proc_instr) //! Returns the Tag object for the given name, if any, that's //! defined by this tag set (including its imported tag sets). If //! proc_instr is nonzero the set of PI tags is searched, else the //! set of normal element tags. { if (object(Tag) def = get_local_tag (name, proc_instr)) return def; foreach (imported, TagSet tag_set) if (object(Tag) tag = [object(Tag)] tag_set->get_tag (name, proc_instr)) return tag; return 0; } local int has_tag (Tag tag) //! Returns nonzero if the given tag is contained in this tag set //! (including its imported tag sets). { return !!get_tag (tag->name, tag->flags & FLAG_PROC_INSTR); } local multiset(string) get_tag_names() //! Returns the names of all non-PI tags that this tag set defines. { return `| ((multiset) indices (tags), @imported->get_tag_names()); } local multiset(string) get_proc_instr_names() //! Returns the names of all PI tags that this tag set defines. { return `| (proc_instrs ? (multiset) indices (proc_instrs) : (<>), @imported->get_proc_instr_names()); } local Tag get_overridden_tag (Tag overrider) //! Returns the tag definition that the given one overrides, or zero //! if none. { if (!mappingp (overridden_tag_lookup)) overridden_tag_lookup = set_weak_flag (([]), 1); Tag tag; if (zero_type (tag = overridden_tag_lookup[overrider])) { string overrider_name = overrider->plugin_name ? overrider->plugin_name + "#" + overrider->name : overrider->name; tag = overridden_tag_lookup[overrider] = overrider->flags & FLAG_PROC_INSTR ? find_overridden_proc_instr (overrider, overrider_name) : find_overridden_tag (overrider, overrider_name); } return tag; } local array(Tag) get_overridden_tags (string name, void|int proc_instr) //! Returns all tag definitions for the given name, i.e. including //! the overridden ones. A tag to the left overrides one to the //! right. If proc_instr is nonzero the set of PI tags is searched, //! else the set of normal element tags. { if (object(Tag) def = get_local_tag (name, proc_instr)) return ({def}) + imported->get_overridden_tags (name, proc_instr) * ({}); else return imported->get_overridden_tags (name, proc_instr) * ({}); } void add_string_entities (mapping(string:string) entities) //! Adds a set of entity replacements that are used foremost by the //! @[PXml] parser to decode simple entities like @tt{&@}. The //! indices are the entity names without @tt{&@} and @tt{;@}. { if (string_entities) string_entities |= entities; else string_entities = entities + ([]); changed(); } void clear_string_entities() //! { string_entities = 0; changed(); } local mapping(string:string) get_string_entities() //! Returns the set of entity replacements, including those from //! imported tag sets. { if (string_entities) return `+(@imported->get_string_entities(), string_entities); else return `+(@imported->get_string_entities(), ([])); } local mapping(string:Tag) get_plugins (string name, void|int proc_instr) //! Returns the registered plugins for the given tag name. Don't be //! destructive on the returned mapping. If proc_instr is nonzero, //! the function searches for processing instruction plugins, //! otherwise it searches for plugins to normal element tags. { mapping(string:Tag) res; if (proc_instr) { if (!pi_plugins) pi_plugins = ([]); if ((res = pi_plugins[name])) return res; low_get_pi_plugins (name + "#", res = ([])); return pi_plugins[name] = res; } else { if (!plugins) plugins = ([]); if ((res = plugins[name])) return res; low_get_plugins (name + "#", res = ([])); return plugins[name] = res; } } local int has_effective_tags (TagSet tset) //! This one deserves some explanation. { return tset == top_tag_set && !got_local_tags; } local mixed `->= (string var, mixed val) { switch (var) { case "imported": if (!val) return val; // Pike can call us with 0 as part of an optimization. filter (imported, "dont_notify", changed); imported = [array(TagSet)] val; imported->do_notify (changed); top_tag_set = sizeof (imported) && imported[0]; break; default: ::`->= (var, val); } changed(); return val; } local mixed `[]= (string var, mixed val) {return `->= (var, val);} Parser `() (Type top_level_type, void|RequestID id) //! Creates a new context for parsing content of the specified type, //! and returns the parser object for it. id is put into the //! context. { Context ctx = Context (this_object(), id); if (!prepare_funs) prepare_funs = get_prepare_funs(); (prepare_funs -= ({0})) (ctx); return ctx->new_parser (top_level_type); } void changed() //! Should be called whenever something is changed. Done //! automatically most of the time, however. { generation++; prepare_funs = 0; overridden_tag_lookup = 0; plugins = pi_plugins = 0; (notify_funcs -= ({0}))(); set_weak_flag (notify_funcs, 1); got_local_tags = sizeof (tags) || (proc_instrs && sizeof (proc_instrs)); } // Internals. void do_notify (function(:void) func) { notify_funcs |= ({func}); set_weak_flag (notify_funcs, 1); } void dont_notify (function(:void) func) { notify_funcs -= ({func}); set_weak_flag (notify_funcs, 1); } void destroy() { catch (changed()); } static mapping(string:Tag) tags = ([]), proc_instrs; // Static since we want to track changes in these. static mapping(string:string) string_entities; // Used by e.g. PXml to hold normal entities that should be replaced // during parsing. static TagSet top_tag_set; // The imported tag set with the highest priority. static int got_local_tags; // Nonzero if there are local element tags or PI tags. static array(function(:void)) notify_funcs = ({}); // Weak (when nonempty). static array(function(Context:void)) prepare_funs; /*static*/ array(function(Context:void)) get_prepare_funs() { if (prepare_funs) return prepare_funs; array(function(Context:void)) funs = ({}); for (int i = sizeof (imported) - 1; i >= 0; i--) funs += imported[i]->get_prepare_funs(); if (prepare_context) funs += ({prepare_context}); // We don't cache in prepare_funs; do that only at the top level. return funs; } static mapping(Tag:Tag) overridden_tag_lookup; /*static*/ Tag find_overridden_tag (Tag overrider, string overrider_name) { if (tags[overrider_name] == overrider) { foreach (imported, TagSet tag_set) if (object(Tag) overrider = tag_set->get_tag (overrider_name)) return overrider; } else { int found = 0; foreach (imported, TagSet tag_set) if (object(Tag) subtag = tag_set->get_tag (overrider_name)) if (found) return subtag; else if (subtag == overrider) if ((subtag = tag_set->find_overridden_tag ( overrider, overrider_name))) return subtag; else found = 1; } return 0; } /*static*/ Tag find_overridden_proc_instr (Tag overrider, string overrider_name) { if (proc_instrs && proc_instrs[overrider_name] == overrider) { foreach (imported, TagSet tag_set) if (object(Tag) overrider = tag_set->get_proc_instr (overrider_name)) return overrider; } else { int found = 0; foreach (imported, TagSet tag_set) if (object(Tag) subtag = tag_set->get_proc_instr (overrider_name)) if (found) return subtag; else if (subtag == overrider) if ((subtag = tag_set->find_overridden_proc_instr ( overrider, overrider_name))) return subtag; else found = 1; } return 0; } void call_prepare_funs (Context ctx) // Kludge function used from rxml.pike. { if (!prepare_funs) prepare_funs = get_prepare_funs(); (prepare_funs -= ({0})) (ctx); } static mapping(string:mapping(string:Tag)) plugins, pi_plugins; /*static*/ void low_get_plugins (string prefix, mapping(string:Tag) res) { for (int i = sizeof (imported) - 1; i >= 0; i--) imported[i]->low_get_plugins (prefix, res); foreach (indices (tags), string name) if (name[..sizeof (prefix) - 1] == prefix) { Tag tag = tags[name]; if (tag->plugin_name) res[[string] tag->plugin_name] = tag; } // We don't cache in plugins; do that only at the top level. } /*static*/ void low_get_pi_plugins (string prefix, mapping(string:Tag) res) { for (int i = sizeof (imported) - 1; i >= 0; i--) imported[i]->low_get_pi_plugins (prefix, res); if (proc_instrs) foreach (indices (proc_instrs), string name) if (name[..sizeof (prefix) - 1] == prefix) { Tag tag = proc_instrs[name]; if (tag->plugin_name) res[[string] tag->plugin_name] = tag; } // We don't cache in pi_plugins; do that only at the top level. } string _sprintf() { return sprintf ("RXML.TagSet(%O,%d)%s", name, id_number, OBJ_COUNT); } MARK_OBJECT_ONLY; } TagSet empty_tag_set; //! The empty tag set. class Value //! Interface for objects used as variable values that are evaluated //! when referenced. { mixed rxml_var_eval (Context ctx, string var, string scope_name, void|Type type) //! This is called to get the value of the variable. @[ctx], @[var] //! and @[scope_name] are set to where this @[Value] object was //! found. Note that @[scope_name] can be on the form //! @tt{scope.index1.index2...@} when this object was encountered //! through subindexing. Either @[RXML.nil] or the undefined value //! may be returned if the variable doesn't have a value. //! //! If the @[type] argument is given, it's the type the returned //! value should have. If the value can't be converted to that type, //! an RXML error should be thrown. If you don't want to do any //! special handling of this, it's enough to call //! @tt{@[type]->encode(value)@}, since the encode functions does //! just that. //! //! Some design discussion follows to justify the last paragraph; //! there are no more interface rules below. //! //! It may seem like forcing a lot of overhead upon the //! implementations having to call encode functions, but that's //! really not the case. In the case when a type check and //! conversion is wanted, i.e. when @[type] isn't zero, that work //! have to be done somewhere anyway, so letting the producer of the //! value do it instead of the caller both improves the chances for //! doing optimizations and gives more power to the producer. //! //! By using knowledge about the actual value, the producer can in //! many cases avoid the call to the encode function. A typical case //! is when the value is known to be an arbitrary literal string //! (not zero), which is preferably optimized like this: //! //! @example //! return type && type != RXML.t_text ? //! type->encode (my_string, RXML.t_text) : my_string; //! @endexample //! //! Also, by letting the producer know the type context of the value //! and handle the type conversion, it's possible for the producer //! to adapt the value according to the context it'll be used in, //! e.g. to return a powerful object if no type conversion is //! wanted, a simple text representation of it when the type is //! @[RXML.t_text], and a more nicely formatted representation when //! it's @[RXML.t_html]. //! //! @note The @[type] argument being @tt{void|Type@} means that the //! caller is free to leave out that argument, not that the function //! implementor is free to ignore it. { mixed val = rxml_const_eval (ctx, var, scope_name, type); ctx->set_var(var, val, scope_name); return val; } mixed rxml_const_eval (Context ctx, string var, string scope_name, void|Type type); //! If the variable value is the same throughout the life of the //! context, this method should be used instead of @[rxml_var_eval]. string _sprintf() {return "RXML.Value";} } class Scope //! Interface for objects that emulate a scope mapping. //! //! Note that the @tt{scope_name@} argument to the functions can be on //! the form @tt{scope.index1.index2...@} when this object was //! encountered through subindexing. { mixed `[] (string var, void|Context ctx, void|string scope_name, void|Type type) //! Called to get the value of a variable in the scope. @[var] is //! the name of it, @[ctx] and @[scope_name] are set to where this //! @[Scope] object was found. Either @[RXML.nil] or the undefined //! value may be returned if the variable doesn't exist in the //! scope. //! //! If the @[type] argument is given, it's the type the returned //! value should have, unless it's an object which implements //! @[Value.rxml_var_eval]. If the value can't be converted to that //! type, an RXML error should be thrown. If you don't want to do //! any special handling of this, it's enough to call //! @tt{@[type]->encode(value)@}, since the encode functions does //! just that. See @[Value.rxml_var_eval] for more discussion about //! this. //! //! @note The @[type] argument being @tt{void|Type@} means that the //! caller is free to leave out that argument, not that the function //! implementor is free to ignore it. {parse_error ("Cannot query variable" + _in_the_scope (scope_name) + ".\n");} mixed `[]= (string var, mixed val, void|Context ctx, void|string scope_name) //! Called to set the value of a variable in the scope. @[var] is //! the name of it, @[ctx] and @[scope_name] are set to where this //! @[Scope] object was found. //! //! An RXML error may be thrown if the value is not acceptable for //! the variable. It's undefined what happens if a variable is set //! to @[RXML.nil]; it should be avoided. {parse_error ("Cannot set variable" + _in_the_scope (scope_name) + ".\n");} array(string) _indices (void|Context ctx, void|string scope_name) //! Called to get a list of all defined variables in the scope. //! @[ctx] and @[scope_name] are set to where this @[Scope] object //! was found. //! //! There's no guarantee that the returned variable names produce a //! value (i.e. neither @[RXML.nil] nor the undefined value) when //! indexed. {parse_error ("Cannot list variables" + _in_the_scope (scope_name) + ".\n");} void _m_delete (string var, void|Context ctx, void|string scope_name) //! Called to delete a variable in the scope. @[var] is the name of //! it, @[ctx] and @[scope_name] are set to where this @[Scope] //! object was found. { if (m_delete != local::m_delete) m_delete (var, ctx, scope_name); // For compatibility with 2.1. else parse_error ("Cannot delete variable" + _in_the_scope (scope_name) + ".\n"); } void m_delete (string var, void|Context ctx, void|string scope_name) // For compatibility with 2.1. {_m_delete (var, ctx, scope_name);} private string _in_the_scope (string scope_name) { if (scope_name) if (scope_name != "_") return " in the scope " + scope_name; else return " in the current scope"; else return ""; } string _sprintf() {return "RXML.Scope";} } #define SCOPE_TYPE mapping(string:mixed)|object(Scope) class Context //! A parser context. This contains the current variable bindings and //! so on. The current context can always be retrieved with //! get_context(). //! //! Note: Don't store pointers to this object since that will likely //! introduce circular references. It can be retrieved easily through //! get_context() or parser->context. { Frame frame; //! The currently evaluating frame. int frame_depth; //! Number of frames currently on the frame stack. int max_frame_depth = 100; //! Maximum number of frames allowed on the frame stack. RequestID id; //! int type_check; //! Whether to do type checking. int error_count; //! Number of RXML errors that has occurred. TagSet tag_set; //! The current tag set that will be inherited by subparsers. #ifdef OLD_RXML_COMPAT int compatible_scope = 0; //! If set, the user_*_var functions access the variables in the //! scope "form" by default, and there's no subindex splitting or //! ".." decoding is done (see parse_user_var). #endif array(string|int) parse_user_var (string var, void|string|int scope_name) //! Parses the var string for scope and/or subindexes according to //! the RXML rules, e.g. "scope.var.1.foo". Returns an array where //! the first entry is the scope, and the remaining entries are the //! list of indexes. If scope_name is a string, it's used as the //! scope and the var string is only used for subindexes. A default //! scope is chosen as appropriate if var cannot be split, unless //! scope_name is a nonzero integer in which case it's returned in //! the scope position in the array (useful to detect whether var //! actually was splitted or not). //! //! A ".." in the var string quotes a literal ".", e.g. //! "yow...cons..yet" is separated into "yow." and "cons.yet". Any //! subindex that can be parsed as a signed integer is converted to //! it. Note that it doesn't happen for the first index, since a //! variable in a scope always is a string. { #ifdef OLD_RXML_COMPAT if (compatible_scope && !intp(scope_name)) return ({scope_name || "form", var}); #endif array(string|int) splitted; if(has_value(var, "..")) { // The \0 stuff is really here for a reason: The _only_ special // character is '.'. string coded = replace (var, "\0", "\0\0"); if (coded != var) splitted = map (replace (coded, "..", "\0p") / ".", replace, ({"\0p", "\0\0"}), ({".", "\0"})); else splitted = map (replace (var, "..", "\0") / ".", replace, "\0", "."); } else splitted = var / "."; if (stringp (scope_name)) splitted = ({scope_name}) + splitted; else if (sizeof (splitted) == 1) splitted = ({scope_name || "_"}) + splitted; for (int i = 2; i < sizeof (splitted); i++) if (sscanf (splitted[i], "%d%*c", int d) == 1) splitted[i] = d; return splitted; } local mixed get_var (string|array(string|int) var, void|string scope_name, void|Type want_type) //! Returns the value a variable in the specified scope, or the //! current scope if none is given. Returns zero with zero_type 1 if //! there's no such variable (or it's nil). //! //! If var is an array, it's used to successively index the value to //! get subvalues (see rxml_index for details). //! //! If the want_type argument is set, the result value is converted //! to that type with Type.encode(). If the value can't be //! converted, an RXML error is thrown. { #ifdef MODULE_DEBUG if (arrayp (var) ? !sizeof (var) : !stringp (var)) error ("Invalid variable specifier.\n"); #endif if (!scope_name) scope_name = "_"; if (SCOPE_TYPE vars = scopes[scope_name]) return rxml_index (vars, var, scope_name, this_object(), want_type); else if (scope_name == "_") parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name); } mixed user_get_var (string var, void|string scope_name, void|Type want_type) //! As get_var, but parses the var string for scope and/or //! subindexes, e.g. "scope.var.1.foo" (see parse_user_var for //! details). { if(!var || !sizeof(var)) return ([])[0]; array(string|int) splitted = parse_user_var (var, scope_name); return get_var (splitted[1..], splitted[0], want_type); } local mixed set_var (string|array(string|int) var, mixed val, void|string scope_name) //! Sets the value of a variable in the specified scope, or the //! current scope if none is given. Returns val. //! //! If var is an array, it's used to successively index the value to //! get subvalues (see rxml_index for details). { #ifdef MODULE_DEBUG if (arrayp (var) ? !sizeof (var) : !stringp (var)) error ("Invalid variable specifier.\n"); #endif if (!scope_name) scope_name = "_"; if (SCOPE_TYPE vars = scopes[scope_name]) { string|int index; if (arrayp (var)) if (sizeof (var) > 1) { index = var[-1]; var = var[..sizeof (var) - 1]; vars = rxml_index (vars, var, scope_name, this_object()); scope_name += "." + (array(string)) var * "."; } else index = var[0]; else index = var; if (objectp (vars) && vars->`[]=) return ([object(Scope)] vars)->`[]= (index, val, this_object(), scope_name); else if (mappingp (vars) || multisetp (vars)) return vars[index] = val; else if (arrayp (vars)) if (intp (index) && index) if ((index < 0 ? -index : index) > sizeof (vars)) parse_error( "Index %d out of range for array of size %d in %s.\n", index, sizeof (val), scope_name ); else if (index < 0) return vars[index] = val; else return vars[index - 1] = val; else parse_error( "Cannot index the array in %s with %O.\n", scope_name, index ); else parse_error ("%s is %O which cannot be indexed with %O.\n", scope_name, vars, index); } else if (scope_name == "_") parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name); } mixed user_set_var (string var, mixed val, void|string scope_name) //! As set_var, but parses the var string for scope and/or //! subindexes, e.g. "scope.var.1.foo" (see parse_user_var for //! details). { if(!var || !sizeof(var)) parse_error ("No variable specified.\n"); array(string|int) splitted = parse_user_var (var, scope_name); return set_var(splitted[1..], val, splitted[0]); } local void delete_var (string|array(string|int) var, void|string scope_name) //! Removes a variable in the specified scope, or the current scope //! if none is given. //! //! If var is an array, it's used to successively index the value to //! get subvalues (see rxml_index for details). { #ifdef MODULE_DEBUG if (arrayp (var) ? !sizeof (var) : !stringp (var)) error ("Invalid variable specifier.\n"); #endif if (!scope_name) scope_name = "_"; if (SCOPE_TYPE vars = scopes[scope_name]) { if (arrayp (var)) if (sizeof (var) > 1) { string|int last = var[-1]; var = var[..sizeof (var) - 1]; vars = rxml_index (vars, var, scope_name, this_object()); scope_name += "." + (array(string)) var * "."; var = last; } else var = var[0]; if (objectp (vars) && vars->_m_delete) ([object(Scope)] vars)->_m_delete (var, this_object(), scope_name); else if (mappingp (vars)) m_delete ([mapping(string:mixed)] vars, var); else if (multisetp (vars)) vars[var] = 0; else parse_error ("Cannot remove the index %O from the %t in %s.\n", var, vars, scope_name); } else if (scope_name == "_") parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name); } void user_delete_var (string var, void|string scope_name) //! As delete_var, but parses the var string for scope and/or //! subindexes, e.g. "scope.var.1.foo" (see parse_user_var for //! details). { if(!var || !sizeof(var)) return; array(string|int) splitted = parse_user_var (var, scope_name); delete_var(splitted[1..], splitted[0]); } array(string) list_var (void|string scope_name) //! Returns the names of all variables in the specified scope, or //! the current scope if none is given. { if (SCOPE_TYPE vars = scopes[scope_name || "_"]) if (objectp (vars)) return ([object(Scope)] vars)->_indices (this_object(), scope_name || "_"); else return indices ([mapping(string:mixed)] vars); else if ((<0, "_">)[scope_name]) parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name); } array(string) list_scopes() //! Returns the names of all defined scopes. { return indices (scopes) - ({"_"}); } int exist_scope (void|string scope_name) //! { return !!scopes[scope_name || "_"]; } void add_scope (string scope_name, SCOPE_TYPE vars) //! Adds or replaces the specified scope at the global level. A //! scope can be a mapping or a Scope object. A global "_" scope may //! also be defined this way. { if (scopes[scope_name]) if (scope_name == "_") { array(SCOPE_TYPE) hid; for (Frame f = frame; f; f = f->up) if (array(SCOPE_TYPE) h = hidden[f]) hid = h; if (hid) hid[0] = vars; else scopes["_"] = vars; } else { Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f; if (outermost) hidden[outermost][1] = vars; else scopes[scope_name] = vars; } else scopes[scope_name] = vars; } int extend_scope (string scope_name, SCOPE_TYPE vars) //! Adds or extends the specified scope at the global level. //! Returns 1 on success and 0 on failure. { if (scopes[scope_name]) { SCOPE_TYPE oldvars; if (scope_name == "_") { array(SCOPE_TYPE) hid; for (Frame f = frame; f; f = f->up) if (array(SCOPE_TYPE) h = hidden[f]) hid = h; if (hid) oldvars = hid[0]; else oldvars = scopes["_"]; } else { Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f; if (outermost) oldvars = hidden[outermost][1]; else oldvars = scopes[scope_name]; } #ifdef DEBUG if (!oldvars) fatal_error ("Internal error: I before e except after c.\n"); #endif if (!mappingp(vars)) { return 0; } foreach (indices(vars), string var) set_var(var, vars[var], scope_name); } else scopes[scope_name] = vars; return 1; } void remove_scope (string scope_name) //! Removes the named scope from the global level, if it exists. { #ifdef MODULE_DEBUG if (scope_name == "_") fatal_error ("Cannot remove current scope.\n"); #endif Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f; if (outermost) m_delete (hidden, outermost); else m_delete (scopes, scope_name); } string current_scope() //! Returns the name of the current scope, if it has any. { if (SCOPE_TYPE vars = scopes["_"]) { string scope_name; while (scope_name = search (scopes, vars, scope_name)) if (scope_name != "_") return scope_name; } return 0; } void add_runtime_tag (Tag tag) //! Adds a tag that will exist from this point forward in the //! current context only. { #ifdef MODULE_DEBUG if (tag->plugin_name) fatal_error ("Can't currently handle adding of plugin tags at runtime.\n"); #endif if (!new_runtime_tags) new_runtime_tags = NewRuntimeTags(); new_runtime_tags->add_tag (tag); } void remove_runtime_tag (string|Tag tag, void|int proc_instr) //! If tag is a Tag object, it's removed from the set of runtime //! tags. If tag is a string, the tag with that name is removed. In //! the latter case, if proc_instr is nonzero the set of runtime PI //! tags is searched, else the set of normal element runtime tags. { if (!new_runtime_tags) new_runtime_tags = NewRuntimeTags(); if (objectp (tag)) tag = tag->name; new_runtime_tags->remove_tag (tag); } multiset(Tag) get_runtime_tags() //! Returns all currently active runtime tags. { mapping(string:Tag) tags = runtime_tags; if (new_runtime_tags) tags = new_runtime_tags->filter_tags (tags); return mkmultiset (values (tags)); } void handle_exception (mixed err, PCode|Parser evaluator) //! This function gets any exception that is catched during //! evaluation. evaluator is the object that catched the error. { error_count++; if (objectp (err) && err->is_RXML_Backtrace) { evaluator->error_count++; if (evaluator->report_error && evaluator->recover_errors && evaluator->type->free_text) { string msg; if (id && id->conf) msg = err->type == "help" ? err->msg : (err->type == "run" ? ([function(Backtrace,Type:string)] ([object] id->conf)->handle_run_error) : ([function(Backtrace,Type:string)] ([object] id->conf)->handle_parse_error) ) ([object(Backtrace)] err, evaluator->type); else msg = err->msg; if (evaluator->report_error (msg)) return; } throw (err); } else throw_fatal (err); } // Internals. string current_var; // Used to get the parsed variable into the RXML error backtrace. Parser new_parser (Type top_level_type) // Returns a new parser object to start parsing with this context. // Normally TagSet.`() should be used instead of this. { #ifdef MODULE_DEBUG if (in_use || frame) fatal_error ("Context already in use.\n"); #endif return top_level_type->get_parser (this_object()); } mapping(string:SCOPE_TYPE) scopes = ([]); // The variable mappings for every currently visible scope. A // special entry "_" points to the current local scope. mapping(Frame:array(SCOPE_TYPE)) hidden = ([]); // The currently hidden scopes. The indices are frame objects which // introduce scopes. The values are tuples of the current scope and // the named scope they hide. void enter_scope (Frame frame) { #ifdef DEBUG if (!frame->vars) fatal_error ("Internal error: Frame has no variables.\n"); #endif if (string scope_name = [string] frame->scope_name) { if (!hidden[frame]) hidden[frame] = ({scopes["_"], scopes[scope_name]}); scopes["_"] = scopes[scope_name] = [SCOPE_TYPE] frame->vars; } else { if (!hidden[frame]) hidden[frame] = ({scopes["_"], 0}); scopes["_"] = [SCOPE_TYPE] frame->vars; } } void leave_scope (Frame frame) { if (array(SCOPE_TYPE) back = hidden[frame]) { if (SCOPE_TYPE cur = back[0]) scopes["_"] = cur; else m_delete (scopes, "_"); if (SCOPE_TYPE named = back[1]) { #ifdef MODULE_DEBUG if (!stringp (frame->scope_name)) fatal_error ("Scope named changed to %O during parsing.\n", frame->scope_name); #endif scopes[[string] frame->scope_name] = named; } else m_delete (scopes, [string] frame->scope_name); m_delete (hidden, frame); } } #define ENTER_SCOPE(ctx, frame) (frame->vars && ctx->enter_scope (frame)) #define LEAVE_SCOPE(ctx, frame) (frame->vars && ctx->leave_scope (frame)) mapping(string:Tag) runtime_tags = ([]); // The active runtime tags. PI tags are stored in the same mapping // with their names prefixed by '?'. NewRuntimeTags new_runtime_tags; // Used to record the result of any add_runtime_tag() and // remove_runtime_tag() calls since the last time the parsers ran. void create (TagSet _tag_set, void|RequestID _id) // Normally TagSet.`() should be used instead of this. { tag_set = _tag_set; id = _id; #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif } mapping(string:mixed)|mapping(object:array) unwind_state; // If this is a mapping, we have an unwound stack state. It contains // strings with arbitrary exception info, and the objects being // unwound with arrays containing the extra state info they need. // The first entry in these arrays are always the subobject. The // special entries are: // // "top": ({Frame|Parser|PCode (top object)}) // "stream_piece": mixed (When continuing, do a streaming // do_process() with this stream piece.) // "exec_left": array (Exec array left to evaluate. Only used // between Frame._exec_array() and Frame._eval().) MARK_OBJECT_ONLY; string _sprintf() {return "RXML.Context" + OBJ_COUNT;} #ifdef MODULE_DEBUG #if constant (thread_create) Thread.Thread in_use; #else int in_use; #endif #endif } static class NewRuntimeTags // Tool class used to track runtime tags in Context. { static mapping(string:Tag) add_tags; static mapping(string:int|string) remove_tags; void add_tag (Tag tag) { if (!add_tags) add_tags = ([]); if (tag->flags & FLAG_PROC_INSTR) { add_tags["?" + tag->name] = tag; // By doing the following, we can let remove_proc_instrs take precedence. if (remove_tags) m_delete (remove_tags, "?" + tag->name); } else { add_tags[tag->name] = tag; if (remove_tags) m_delete (remove_tags, tag->name); } } void remove_tag (string name, int proc_instr) { if (!remove_tags) remove_tags = ([]); if (proc_instr) remove_tags["?" + name] = name; else remove_tags[name] = 1; } array(Tag) added_tags() { if (!add_tags) return ({}); if (remove_tags) return values (add_tags - remove_tags); return values (add_tags); } array(string) removed_tags() { return remove_tags ? indices (filter (remove_tags, intp)) : ({}); } array(string) removed_pi_tags() { return remove_tags ? values (remove_tags) - ({1}) : ({}); } mapping(string:Tag) filter_tags (mapping(string:Tag) tags) { if (add_tags) tags |= add_tags; if (remove_tags) tags -= remove_tags; return tags; } } class Backtrace //! The object used to throw RXML errors. { constant is_generic_error = 1; constant is_RXML_Backtrace = 1; string type; // Currently "run" or "parse". string msg; Context context; Frame frame; string current_var; array backtrace; void create (void|string _type, void|string _msg, void|Context _context, void|array _backtrace) { type = _type; msg = _msg; if (context = _context || get_context()) { frame = context->frame; current_var = context->current_var; } if (_backtrace) backtrace = _backtrace; else { backtrace = predef::backtrace(); backtrace = backtrace[..sizeof (backtrace) - 2]; } } string describe_rxml_backtrace (void|int no_msg) //! Returns a formatted RXML frame backtrace. { string txt = no_msg ? "" : "RXML" + (type ? " " + type : "") + " error"; if (context) { if (!no_msg) txt += ": " + (msg || "(no error message)\n"); txt += current_var ? " | &" + current_var + ";\n" : ""; for (Frame f = frame; f; f = f->up) { string name; if (f->tag) name = f->tag->name; else if (!f->up) break; else name = "(unknown)"; if (f->flags & FLAG_PROC_INSTR) txt += " | <?" + name + "?>\n"; else { txt += " | <" + name; if (f->args) foreach (sort (indices (f->args)), string arg) { mixed val = f->args[arg]; txt += " " + arg + "="; if (arrayp (val)) txt += map (val, error_print_val) * ","; else txt += error_print_val (val); } else txt += " (no argmap)"; txt += ">\n"; } } } else if (!no_msg) txt += " (no context): " + (msg || "(no error message)\n"); return txt; } private string error_print_val (mixed val) { if (arrayp (val)) return "array"; else if (mappingp (val)) return "mapping"; else if (multisetp (val)) return "multiset"; else return sprintf ("%O", val); } string|array `[] (int i) { switch (i) { case 0: return describe_rxml_backtrace(); case 1: return backtrace; } } string _sprintf() {return "RXML.Backtrace(" + (type || "") + ")";} } //! Current context. //! It's set before any function in RXML.Tag or RXML.Frame is called. #if constant (thread_create) private Thread.Local _context = Thread.Local(); local void set_context (Context ctx) {_context->set (ctx);} local Context get_context() {return [object(Context)] _context->get();} #else private Context _context; local void set_context (Context ctx) {_context = ctx;} local Context get_context() {return _context;} #endif #if defined (MODULE_DEBUG) && constant (thread_create) // Got races in this debug check, but looks like we have to live with that. :\ #define ENTER_CONTEXT(ctx) \ Context __old_ctx = get_context(); \ set_context (ctx); \ if (ctx) { \ if (ctx->in_use && ctx->in_use != this_thread()) \ fatal_error ("Attempt to use context asynchronously.\n"); \ ctx->in_use = this_thread(); \ } #define LEAVE_CONTEXT() \ if (Context ctx = get_context()) \ if (__old_ctx != ctx) ctx->in_use = 0; \ set_context (__old_ctx); #else #define ENTER_CONTEXT(ctx) \ Context __old_ctx = get_context(); \ set_context (ctx); #define LEAVE_CONTEXT() \ set_context (__old_ctx); #endif //! Constants for the bit field RXML.Frame.flags. constant FLAG_NONE = 0x00000000; //! The no-flags flag. In case you think 0 is too ugly. ;) constant FLAG_DEBUG = 0x40000000; //! Write a lot of debug during the execution of the tag, showing what //! type conversions are done, what callbacks are being called etc. //! Note that DEBUG must be defined for the debug printouts to be //! compiled in (normally enabled with the --debug flag to Roxen). //! Static flags (i.e. tested in the Tag object). constant FLAG_PROC_INSTR = 0x00000010; //! Flags this as a processing instruction tag (i.e. one parsed with //! the <?name ... ?> syntax in XML). The string after the tag name to //! the ending separator constitutes the content of the tag. Arguments //! are not used. constant FLAG_EMPTY_ELEMENT = 0x00000001; //! If set, the tag does not use any content. E.g. with an HTML parser //! this defines whether the tag is a container or not, and in XML //! parsing the parser will signal an error if the tag have anything //! but "" as content. constant FLAG_COMPAT_PARSE = 0x00000002; //! Makes the PXml parser parse the tag in an HTML compatible way: If //! FLAG_EMPTY_ELEMENT is set and the tag doesn't end with '/>', it //! will be parsed as an empty element. The effect of this flag in //! other parsers is currently undefined. constant FLAG_NO_PREFIX = 0x00000004; //! Never apply any prefix to this tag. constant FLAG_SOCKET_TAG = 0x00000008; //! Declare the tag to be a socket tag, which accepts plugin tags (see //! Tag.plugin_name for details). constant FLAG_DONT_PREPARSE = 0x00000040; //! Don't preparse the content with the PXml parser. This is always //! the case for PI tags, so this flag doesn't have any effect for //! those. This is only used in the simple tag wrapper. Defined here //! as placeholder. constant FLAG_POSTPARSE = 0x00000080; //! Postparse the result with the PXml parser. This is only used in //! the simple tag wrapper. Defined here as placeholder. //! The rest of the flags are dynamic (i.e. tested in the Frame object). constant FLAG_PARENT_SCOPE = 0x00000100; //! If set, exec arrays will be interpreted in the scope of the parent //! tag, rather than in the current one. constant FLAG_NO_IMPLICIT_ARGS = 0x00000200; //! If set, the parser won't apply any implicit arguments. FIXME: Not //! yet implemented. constant FLAG_STREAM_RESULT = 0x00000400; //! If set, the do_process() function will be called repeatedly until //! it returns 0 or no more content is wanted. constant FLAG_STREAM_CONTENT = 0x00000800; //! If set, the tag supports getting its content in streaming mode: //! do_process() will be called repeatedly with successive parts of the //! content then. Can't be changed from do_process(). //! Note: It might be obvious, but using streaming is significantly //! less effective than nonstreaming, so it should only be done when //! big delays are expected. constant FLAG_STREAM = FLAG_STREAM_RESULT | FLAG_STREAM_CONTENT; constant FLAG_UNPARSED = 0x00001000; //! If set, args and content in the frame contain unparsed strings. //! The frame will be parsed before it's evaluated. This flag should //! never be set in Tag.flags, but it's useful when creating frames //! directly. constant FLAG_DONT_RECOVER = 0x00002000; //! If set, RXML errors are never recovered when parsing the content //! in the tag. If any occurs, it will instead abort the execution of //! this tag too to propagate the error to the parent tag. //! //! When an error occurs, the parser aborts tags upward in the frame //! stack until it comes to one which looks like it can accept an //! error report in its content. The parser then reports the error //! there and continues. //! //! The criteria for the frame which will handle the error recovery is //! that its content type has the free_text property, and that the //! parser that parses it has an report_error function (which e.g. //! RXML.PXml has). With this flag, a frame can declare that it isn't //! suitable to receive error reports even if it satisfies this. constant FLAG_DONT_REPORT_ERRORS = FLAG_DONT_RECOVER; // For compatibility. constant FLAG_RAW_ARGS = 0x00004000; //! Special flag to @[RXML.t_xml.format_tag]; only defined here as a //! placeholder. When this is given to @[RXML.t_xml.format_tag], it //! only encodes the argument quote character with the "Roxen //! encoding" when writing argument values, instead of encoding with //! entity references. It's intended for reformatting a tag which has //! been parsed by Parser.HTML() (or parse_html()) but hasn't been //! processed further. //! The following flags specifies whether certain conditions must be //! met for a cached frame to be considered (if RXML.Frame.is_valid() //! is defined). They may be read directly after do_return() returns. //! The tag name is always the same. FIXME: These are ideas only; //! nothing is currently implemented and they might change //! arbitrarily. constant FLAG_CACHE_DIFF_ARGS = 0x00010000; //! If set, the arguments to the tag need not be the same (using //! equal()) as the cached args. constant FLAG_CACHE_DIFF_CONTENT = 0x00020000; //! If set, the content need not be the same. constant FLAG_CACHE_DIFF_RESULT_TYPE = 0x00040000; //! If set, the result type need not be the same. (Typically //! not useful unless cached_return() is used.) constant FLAG_CACHE_DIFF_VARS = 0x00080000; //! If set, the variables with external scope in vars (i.e. normally //! those that has been accessed with get_var()) need not have the //! same values (using equal()) as the actual variables. constant FLAG_CACHE_DIFF_TAG_INSTANCE = 0x00100000; //! If set, the tag in the source document needs to be the same, so //! the same frame may be used when the tag occurs in another context. constant FLAG_CACHE_EXECUTE_RESULT = 0x00200000; //! If set, an exec array will be stored in the frame instead of the //! final result. On a cache hit it'll be executed to produce the //! result. class Frame //! A tag instance. A new frame is normally created for every parsed //! tag in the source document. It might be reused both when the //! document is requested again and when the tag is reevaluated in a //! loop, but it's not certain in either case. Therefore, be careful //! about using variable initializers. { constant is_RXML_Frame = 1; constant thrown_at_unwind = 1; //! Interface. Frame up; //! The parent frame. This frame is either created from the content //! inside the up frame, or it's in an exec array produced by the up //! frame. Tag tag; //! The RXML.Tag object this frame was created from. int flags; //! Various bit flags that affect parsing. See the FLAG_* constants. //! It's copied from Tag.flag when the frame is created. mapping(string:mixed) args; //! The (parsed and evaluated) arguments passed to the tag. Set //! every time the frame is executed, before any frame callbacks are //! called. Not set for processing instruction (FLAG_PROC_INSTR) //! tags. Type content_type; //! The type of the content. mixed content = nil; //! The content, if any. Set before do_process() and do_return() are //! called. Initialized to RXML.nil every time the frame executed. Type result_type; //! The required result type. If it has a parser, it will affect how //! execution arrays are handled; see the return value for //! do_return() for details. //! //! This is set by the type inference from Tag.result_types before //! any frame callbacks are called. The frame may change this type, //! but it must produce a result value which matches it. The value //! is converted before being inserted into the parent content if //! necessary. An exception (which this frame can't catch) is thrown //! if conversion is impossible. mixed result = nil; //! The result, which is assumed to be either RXML.nil or a valid //! value according to result_type. The exec arrays returned by e.g. //! do_return() changes this. It may also be set directly. //! Initialized to RXML.nil every time the frame executed. //! //! If result_type has a parser set, it will be used by do_return() //! etc before assigning to this variable. Thus it contains the //! value after any parsing and will not be parsed again. //!mapping(string:mixed) vars; //! Set this to introduce a new variable scope that will be active //! during parsing of the content and return values (but see also //! FLAG_PARENT_SCOPE). //!string scope_name; //! The scope name for the variables. Must be set before the scope //! is used for the first time, and can't be changed after that. //!TagSet additional_tags; //! If set, the tags in this tag set will be used in addition to the //! tags inherited from the surrounding parser. The additional tags //! will in turn be inherited by subparsers. //!TagSet local_tags; //! If set, the tags in this tag set will be used in the parser for //! the content, instead of the one inherited from the surrounding //! parser. The tags are not inherited by subparsers. //!Frame parent_frame; //! If this variable exists, it gets set to the frame object of the //! closest surrounding tag that defined this tag in its //! additional_tags or local_tags. Useful to access the "mother tag" //! from the subtags it defines. //!string raw_tag_text; //! If this variable exists, it gets the raw text representation of //! the tag, if there is any. Note that it's after parsing of any //! splice argument. //!array do_enter (RequestID id); //!array do_process (RequestID id, void|mixed piece); //!array do_return (RequestID id); //! do_enter() is called first thing when processing the tag. //! do_process() is called after (some of) the content has been //! processed. do_return() is called lastly before leaving the tag. //! //! For tags that loops more than one time (see do_iterate): //! do_enter() is only called initially before the first call to //! do_iterate(). do_process() is called after each iteration. //! do_return() is called after the last call to do_process(). //! //! The result_type variable is set to the type of result the parser //! wants. The tag may change it; the value will then be converted //! to the type that the parser wants. If the result type is //! sequential, it's spliced into the surrounding content, otherwise //! it replaces the previous value of the content, if any. If the //! result is RXML.nil, it does not affect the surrounding content //! at all. //! //! Return values: //! //! array - A so-called execution array to be handled by the //! parser. The elements are processed in order, and have //! the following usage: //! //! string - Added or put into the result. If the result type has //! a parser, the string will be parsed with it before //! it's assigned to the result variable and passed on. //! RXML.Frame - Already initialized frame to process. Neither //! arguments nor content will be parsed. It's result is //! added or put into the result of this tag. //! mapping(string:mixed) - Fields to merge into the headers. //! FIXME: Not yet implemented. //! object - Treated as a file object to read in blocking or //! nonblocking mode. FIXME: Not yet implemented, details //! not decided. //! multiset(mixed) - Should only contain one element that'll be //! added or put into the result. Normally not necessary; //! assign it directly to the result variable instead. //! propagate_tag() - Use a call to this function to propagate the //! tag to be handled by an overridden tag definition, if //! any exists. If this is used, it's probably necessary //! to define the raw_tag_text variable. For further //! details see the doc for propagate_tag() in this class. //! //! 0 - Do nothing special. Exits the tag when used from //! do_process() and FLAG_STREAM_RESULT is set. //! //! Note that the intended use is not to postparse by setting a //! parser on the result type, but instead to return an array with //! literal strings and RXML.Frame objects where parsing (or, more //! accurately, evaluation) needs to be done. //! //! If an array instead of a function is given, the array is handled //! as above. If the result variable is RXML.nil (which it defaults //! to), content is used as result if it's of a compatible type. //! //! If there is no do_return() and the result from parsing the //! content is not RXML.nil, it's assigned to or added to the result //! variable. Assignment is used if the content type is //! nonsequential, addition otherwise. Thus earlier values are //! simply overridden for nonsequential types. //! //! Regarding do_process only: //! //! Normally the content variable is set to the parsed content of //! the tag before do_process() is called. This may be RXML.nil if //! the content parsing didn't produce any result. //! //! piece is used when the tag is operating in streaming mode (i.e. //! FLAG_STREAM_CONTENT is set). It's then set to each successive //! part of the content in the stream, and the content variable is //! never touched. do_process() is also called "normally" with no //! piece argument afterwards. Note that tags that support streaming //! mode might still be used nonstreaming (it might also vary //! between iterations). //! //! As long as FLAG_STREAM_RESULT is set, do_process() will be //! called repeatedly until it returns 0. It's only the result piece //! from the execution array that is propagated after each turn; the //! result variable only accumulates all these pieces. //!int do_iterate (RequestID id); //! Controls the number of passes in the tag done by the parser. In //! every pass, the content of the tag (if any) is processed, then //! do_process() is called. //! //! Before doing any pass, do_iterate() is called. If the return //! value is nonzero, that many passes is done, then do_iterate() is //! called again and the process repeats. If the return value is //! zero, the tag exits and the value in result is used in the //! surrounding content as described above. //! //! The most common way to iterate is to do the setup before every //! pass (e.g. setup the variable scope) and return 1 to do one pass //! through the content. This will repeat until 0 is returned. //! //! If do_iterate is a positive integer, that many passes is done //! and then the tag exits. If do_iterate is zero or missing, one //! pass is done. If do_iterate is negative, no pass is done. //!int|function(RequestID:int) is_valid; //! When defined, the frame may be cached. First the name of the tag //! must be the same. Then the conditions specified by the cache //! bits in flag are checked. Then, if this is a function, it's //! called. If it returns 1, the frame is reused. FIXME: Not yet //! implemented. optional array cached_return (Context ctx, void|mixed piece); //! If defined, this will be called to get the value from a cached //! frame (that's still valid) instead of using the cached result. //! It's otherwise handled like do_return(). Note that the cached //! frame may be used from several threads. FIXME: Not yet //! implemented. //! Services. final mixed get_var (string var, void|string scope_name, void|Type want_type) //! A wrapper for easy access to RXML.Context.get_var(). { return get_context()->get_var (var, scope_name, want_type); } final mixed set_var (string var, mixed val, void|string scope_name) //! A wrapper for easy access to RXML.Context.set_var(). { return get_context()->set_var (var, val, scope_name); } final void delete_var (string var, void|string scope_name) //! A wrapper for easy access to RXML.Context.delete_var(). { get_context()->delete_var (var, scope_name); } void run_error (string msg, mixed... args) //! A wrapper for easy access to RXML.run_error(). { _run_error (msg, @args); } void parse_error (string msg, mixed... args) //! A wrapper for easy access to RXML.parse_error(). { _parse_error (msg, @args); } void tag_debug (string msg, mixed... args) //! Writes the message to the debug log if this tag has FLAG_DEBUG //! set. { if (flags & FLAG_DEBUG) report_debug (msg, @args); } void terminate() //! Makes the parser abort. The data parsed so far will be returned. //! Does not return; throws a special exception instead. { fatal_error ("FIXME\n"); } void suspend() //! Used together with resume() for nonblocking mode. May be called //! from any frame callback to suspend the parser: The parser will //! just stop, leaving the context intact. If it returns, the parser //! is used in a place that doesn't support nonblocking, so just go //! ahead and block. { fatal_error ("FIXME\n"); } void resume() //! Makes the parser continue where it left off. The function that //! called suspend() will be called again. { fatal_error ("FIXME\n"); } mapping(string:Tag) get_plugins() //! Returns the plugins registered for this tag, which is assumed to //! be a socket tag, i.e. to have FLAG_SOCKET_TAG set (see //! Tag.plugin_name for details). Indices are the plugin_name values //! for the plugin Tag objects, values are the plugin objects //! themselves. Don't be destructive on the returned mapping. { #ifdef MODULE_DEBUG if (!(tag->flags & FLAG_SOCKET_TAG)) fatal_error ("This tag is not a socket tag.\n"); #endif return get_context()->tag_set->get_plugins (tag->name, tag->flags & FLAG_PROC_INSTR); } final Tag get_overridden_tag() //! Returns the Tag object the tag for this frame overrides, if any. { return get_context()->tag_set->get_overridden_tag (tag); } Frame|string propagate_tag (void|mapping(string:string) args, void|string content) //! This function is intended to be used in the execution array from //! do_return() etc to propagate the tag to the next overridden tag //! definition, if any exists. It either returns a frame from the //! overridden tag or, if no overridden tag exists, a string //! containing a formatted tag (which requires that the result type //! supports formatted tags, i.e. has a working format_tag() //! function). If args and content are given, they will be used in //! the tag after parsing, otherwise the raw_tag_text variable is //! used, which must have a string value. { if (object(Tag) overridden = get_overridden_tag()) { Frame frame; if (!args) { #ifdef MODULE_DEBUG if (zero_type (this_object()->raw_tag_text)) fatal_error ("The variable raw_tag_text must be defined.\n"); if (!stringp (this_object()->raw_tag_text)) fatal_error ("raw_tag_text must have a string value.\n"); #endif sscanf (this_object()->raw_tag_text, "%*[^ \t\n\r]%s", string str); #ifdef DEBUG if (!str || !sizeof (str) || str[-1] != '>') fatal_error ("Failed to parse tag args from %O.\n", this_object()->raw_tag_text); #endif args = Parser_HTML()->parse_tag_args (str); #ifdef DEBUG if (!mappingp (args)) fatal_error ("Failed to parse tag args from %O.\n", this_object()->raw_tag_text); #endif } frame = overridden (args, content || ""); frame->flags |= FLAG_UNPARSED; return frame; } else if (args) return result_type->format_tag (tag, args, content); else { #ifdef MODULE_DEBUG if (zero_type (this_object()->raw_tag_text)) fatal_error ("The variable raw_tag_text must be defined.\n"); if (!stringp (this_object()->raw_tag_text)) fatal_error ("raw_tag_text must have a string value.\n"); #endif if (flags & FLAG_PROC_INSTR) return this_object()->raw_tag_text; else { #ifdef MODULE_DEBUG if (mixed err = catch { #endif return t_xml (PEnt)->eval (this_object()->raw_tag_text, get_context(), empty_tag_set); #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err); } #endif } } } // Internals. #ifdef DEBUG # define THIS_TAG_TOP_DEBUG(msg) tag_debug ("%O: %s", this_object(), (msg)) # define THIS_TAG_DEBUG(msg) tag_debug ("%O: %s", this_object(), (msg)) # define THIS_TAG_DEBUG_ENTER_SCOPE(ctx, this, msg) \ if (this->vars && ctx->scopes["_"] != this->vars) THIS_TAG_DEBUG (msg) # define THIS_TAG_DEBUG_LEAVE_SCOPE(ctx, this, msg) \ if (this->vars && ctx->scopes["_"] == this->vars) THIS_TAG_DEBUG (msg) #else # define THIS_TAG_TOP_DEBUG(msg) 0 # define THIS_TAG_DEBUG(msg) 0 # define THIS_TAG_DEBUG_ENTER_SCOPE(ctx, this, msg) 0 # define THIS_TAG_DEBUG_LEAVE_SCOPE(ctx, this, msg) 0 #endif mixed _exec_array (TagSetParser parser, array exec, int parent_scope) { Frame this = this_object(); Context ctx = parser->context; int i = 0; mixed res = nil; Parser subparser = 0; mixed err = catch { if (parent_scope) { THIS_TAG_DEBUG_LEAVE_SCOPE (ctx, this, "Exec: Temporary leaving scope\n"); LEAVE_SCOPE (ctx, this); } for (; i < sizeof (exec); i++) { mixed elem = exec[i], piece = nil; switch (sprintf ("%t", elem)) { case "string": if (result_type->_parser_prog == PNone) { THIS_TAG_DEBUG (sprintf ("Exec[%d]: String\n", i)); piece = elem; } else { subparser = result_type->get_parser (ctx, 0, parser); if (parser->recover_errors && !(flags & FLAG_DONT_RECOVER)) subparser->recover_errors = 1; THIS_TAG_DEBUG (sprintf ("Exec[%d]: Parsing string with %O\n", i, subparser)); subparser->finish ([string] elem); // Might unwind. piece = subparser->eval(); // Might unwind. subparser = 0; } break; case "mapping": THIS_TAG_DEBUG (sprintf ("Exec[%d]: Header mapping\n", i)); fatal_error ("Header mappings not yet implemented.\n"); break; case "multiset": if (sizeof ([multiset] elem) == 1) { piece = ((array) elem)[0]; THIS_TAG_DEBUG (sprintf ("Exec[%d]: Verbatim %t value\n", i, piece)); } else if (sizeof ([multiset] elem) > 1) fatal_error (sizeof ([multiset] elem) + " values in multiset in exec array.\n"); else fatal_error ("No value in multiset in exec array.\n"); break; default: if (objectp (elem)) // Can't count on that sprintf ("%t", ...) on an object // returns "object". if (([object] elem)->is_RXML_Frame) { THIS_TAG_DEBUG (sprintf ("Exec[%d]: Evaluating frame %O\n", i, ([object] elem))); ([object(Frame)] elem)->_eval (parser); // Might unwind. piece = ([object(Frame)] elem)->result; } else if (([object] elem)->is_RXML_Parser) { // The subparser above unwound. THIS_TAG_DEBUG (sprintf ("Exec[%d]: Continuing eval of frame %O\n", i, ([object] elem))); ([object(Parser)] elem)->finish(); // Might unwind. piece = ([object(Parser)] elem)->eval(); // Might unwind. } else fatal_error ("File objects not yet implemented.\n"); else fatal_error ("Invalid type %t in exec array.\n", elem); } if (result_type->sequential) { THIS_TAG_DEBUG (sprintf ("Exec[%d]: Adding %t to result\n", i, piece)); res += piece; } else if (piece != nil) { THIS_TAG_DEBUG (sprintf ("Exec[%d]: Setting result to %t\n", i, piece)); result = res = piece; } } if (result_type->sequential) result += res; if (parent_scope) { THIS_TAG_DEBUG_ENTER_SCOPE (ctx, this, "Exec: Reentering scope\n"); ENTER_SCOPE (ctx, this); } return res; }; if (parent_scope) { THIS_TAG_DEBUG_ENTER_SCOPE (ctx, this, "Exec: Reentering scope\n"); ENTER_SCOPE (ctx, this); } if (result_type->sequential) result += res; if (objectp (err) && ([object] err)->thrown_at_unwind) { THIS_TAG_DEBUG (sprintf ("Exec: Interrupted at position %d\n", i)); mapping(string:mixed)|mapping(object:array) ustate; if ((ustate = ctx->unwind_state) && !zero_type (ustate->stream_piece)) { // Subframe wants to stream. Update stream_piece and send it on. if (result_type->name != parser->type->name) res = parser->type->encode (res, result_type); if (result_type->sequential) ustate->stream_piece = res + ustate->stream_piece; else if (ustate->stream_piece == nil) ustate->stream_piece = res; } ustate->exec_left = exec[i..]; // Left to execute. if (subparser) // Replace the string with the subparser object so that we'll // continue in it later. It's done here to keep the original // exec array untouched. ([array] ustate->exec_left)[0] = subparser; throw (err); } throw_fatal (err); } private void _handle_runtime_tags (Context ctx, TagSetParser parser) { // FIXME: PCode handling. array(Tag) arr_add_tags = ctx->new_runtime_tags->added_tags(); array(string) arr_rem_tags = ctx->new_runtime_tags->removed_tags(); array(string) arr_rem_pi_tags = ctx->new_runtime_tags->removed_pi_tags(); for (Parser p = parser; p; p = p->_parent) if (p->tag_set_eval && !p->_local_tag_set && p->add_runtime_tag) { foreach (arr_add_tags, Tag tag) { THIS_TAG_DEBUG (sprintf ("Adding runtime tag %O\n", tag)); ([object(TagSetParser)] p)->add_runtime_tag (tag); } foreach (arr_rem_tags, string tag) { THIS_TAG_DEBUG (sprintf ("Removing runtime tag %s\n", tag)); ([object(TagSetParser)] p)->remove_runtime_tag (tag); } foreach (arr_rem_pi_tags, string tag) { THIS_TAG_DEBUG (sprintf ("Removing runtime tag %s\n", tag)); ([object(TagSetParser)] p)->remove_runtime_tag (tag, 1); } } ctx->runtime_tags = ctx->new_runtime_tags->filter_tags (ctx->runtime_tags); ctx->new_runtime_tags = 0; } void _eval (TagSetParser parser, void|mapping(string:string) raw_args, void|string raw_content) // Note: It might be somewhat tricky to override this function. // Note: Might be destructive on raw_args. { Frame this = this_object(); Context ctx = parser->context; RequestID id = ctx->id; // Unwind state data: //raw_content #define EVSTAT_BEGIN 0 #define EVSTAT_ENTERED 1 #define EVSTAT_LAST_ITER 2 #define EVSTAT_ITER_DONE 3 int eval_state = EVSTAT_BEGIN; int iter; #ifdef DEBUG int debug_iter = 1; #endif Parser subparser; mixed piece; array exec; TagSet orig_tag_set; // Flags that we added additional_tags to ctx->tag_set. //ctx->new_runtime_tags #define PRE_INIT_ERROR(X) (ctx->frame = this, fatal_error (X)) #ifdef DEBUG // Internal sanity checks. if (ctx != get_context()) PRE_INIT_ERROR ("Internal error: Context not current.\n"); if (!parser->tag_set_eval) PRE_INIT_ERROR ("Internal error: Calling _eval() with non-tag set parser.\n"); #endif #ifdef MODULE_DEBUG if (ctx->new_runtime_tags) PRE_INIT_ERROR ("Looks like Context.add_runtime_tag() or " "Context.remove_runtime_tag() was used outside any parser.\n"); #endif if (array state = ctx->unwind_state && ctx->unwind_state[this]) { #ifdef DEBUG if (!up) PRE_INIT_ERROR ("Internal error: Resuming frame without up pointer.\n"); if (raw_args || raw_content) PRE_INIT_ERROR ("Internal error: Can't feed new arguments or content " "when resuming parse.\n"); #endif object ignored; [ignored, eval_state, iter, raw_content, subparser, piece, exec, orig_tag_set, ctx->new_runtime_tags #ifdef DEBUG , debug_iter #endif ] = state; m_delete (ctx->unwind_state, this); if (!sizeof (ctx->unwind_state)) ctx->unwind_state = 0; THIS_TAG_TOP_DEBUG ("Continuing evaluation" + (piece ? " with stream piece\n" : "\n")); } else { if (flags & FLAG_UNPARSED) { #ifdef DEBUG if (raw_args || raw_content) PRE_INIT_ERROR ("Internal error: raw_args or raw_content given for " "unparsed frame.\n"); #endif raw_args = args, args = 0; raw_content = content, content = nil; #ifdef MODULE_DEBUG if (!stringp (raw_content)) PRE_INIT_ERROR ("Content is not a string in unparsed tag frame.\n"); #endif THIS_TAG_TOP_DEBUG ("Evaluating unparsed\n"); } else THIS_TAG_TOP_DEBUG ("Evaluating\n"); #ifdef MODULE_DEBUG if (up && up != ctx->frame) PRE_INIT_ERROR ("Reuse of frame in different context.\n"); #endif up = ctx->frame; piece = nil; if (++ctx->frame_depth >= ctx->max_frame_depth) { ctx->frame = this; ctx->frame_depth--; _run_error ("Too deep recursion -- exceeding %d nested tags.\n", ctx->max_frame_depth); } } #undef PRE_INIT_ERROR ctx->frame = this; do { // Target for breaks (goto wouldn't be all bad, really). if (tag) { if ((raw_args || args || ([]))->help) { TRACE_ENTER ("tag <" + tag->name + " help>", tag); string help = id->conf->find_tag_doc (tag->name, id); TRACE_LEAVE (""); THIS_TAG_TOP_DEBUG ("Reporting help - frame done\n"); ctx->handle_exception ( // Will throw if necessary. Backtrace ("help", help, ctx), parser); break; } TRACE_ENTER("tag <" + tag->name + ">", tag); #ifdef MODULE_LEVEL_SECURITY if (id->conf->check_security (tag, id, id->misc->seclevel)) { THIS_TAG_TOP_DEBUG ("Access denied - exiting\n"); TRACE_LEAVE("access denied"); break; } #endif } if (raw_args) { #ifdef MODULE_DEBUG if (flags & FLAG_PROC_INSTR) fatal_error ("Can't pass arguments to a processing instruction tag.\n"); #endif if (sizeof (raw_args)) { // Note: Code duplication in Tag.eval_args(). mapping(string:Type) atypes = raw_args & tag->req_arg_types; if (sizeof (atypes) < sizeof (tag->req_arg_types)) { array(string) missing = sort (indices (tag->req_arg_types - atypes)); parse_error ("Required " + (sizeof (missing) > 1 ? "arguments " + String.implode_nicely (missing) + " are" : "argument " + missing[0] + " is") + " missing.\n"); } atypes += raw_args & tag->opt_arg_types; #ifdef MODULE_DEBUG if (mixed err = catch { #endif foreach (indices (raw_args), string arg) { #ifdef DEBUG Type t = atypes[arg] || tag->def_arg_type; if (t->_parser_prog != PNone) { Parser p = t->get_parser (ctx, 0, parser); THIS_TAG_DEBUG (sprintf ("Evaluating argument %O with %O\n", arg, p)); p->finish (raw_args[arg]); // Should not unwind. raw_args[arg] = p->eval(); // Should not unwind. } #else raw_args[arg] = (atypes[arg] || tag->def_arg_type)-> eval (raw_args[arg], ctx, 0, parser, 1); // Should not unwind. #endif } #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err); } #endif } args = raw_args; } #ifdef MODULE_DEBUG else if (!args && !(flags & FLAG_PROC_INSTR)) fatal_error ("args not set.\n"); #endif if (!zero_type (this->parent_frame)) if (up->local_tags && up->local_tags->has_tag (tag)) { THIS_TAG_DEBUG (sprintf ("Setting parent_frame to %O from local_tags\n", up)); this->parent_frame = up; } else for (Frame f = up; f; f = f->up) if (f->additional_tags && f->additional_tags->has_tag (tag)) { THIS_TAG_DEBUG (sprintf ("Setting parent_frame to %O " "from additional_tags\n", f)); this->parent_frame = f; break; } if (TagSet add_tags = raw_content && [object(TagSet)] this->additional_tags) { TagSet tset = ctx->tag_set; if (!tset->has_effective_tags (add_tags)) { THIS_TAG_DEBUG (sprintf ("Installing additional_tags %O\n", add_tags)); int hash = HASH_INT2 (tset->id_number, add_tags->id_number); orig_tag_set = tset; TagSet local_ts; if (!(local_ts = local_tag_set_cache[hash])) { local_ts = TagSet (add_tags->name + "+" + orig_tag_set->name); local_ts->imported = ({add_tags, orig_tag_set}); local_tag_set_cache[hash] = local_ts; // Race, but it doesn't matter. } ctx->tag_set = local_ts; } else THIS_TAG_DEBUG (sprintf ("Not installing additional_tags %O " "since they're already in the tag set\n", add_tags)); } if (!result_type) { #ifdef MODULE_DEBUG if (!tag) fatal_error ("result_type not set in Frame object %O, " "and it has no Tag object to use for inferring it.\n", this_object()); #endif Type ptype = parser->type; find_result_type: { // First check if any of the types is a subtype of the // wanted type. If so, we can use it directly. foreach (tag->result_types, Type rtype) if (rtype->subtype_of (ptype)) { result_type = rtype; break find_result_type; } // Then check if any of the types is a supertype of the // wanted type. If so, set the result type to the wanted // type, since the tag has the responsibility to produce a // value of that type. foreach (tag->result_types, Type rtype) if (ptype->subtype_of (rtype)) { result_type = ptype (rtype->_parser_prog); break find_result_type; } parse_error ( "Tag returns " + String.implode_nicely ([array(string)] tag->result_types->name, "or") + " but " + [string] parser->type->name + " is expected.\n"); } THIS_TAG_DEBUG (sprintf ("Resolved result_type to %O from surrounding %O\n", result_type, ptype)); } else THIS_TAG_DEBUG (sprintf ("Keeping result_type %O\n", result_type)); if (!content_type) { #ifdef MODULE_DEBUG if (!tag) fatal_error ("content_type not set in Frame object %O, " "and it has no Tag object to use for inferring it.\n", this_object()); #endif content_type = tag->content_type; if (content_type == t_same) { content_type = result_type (content_type->_parser_prog); THIS_TAG_DEBUG (sprintf ("Resolved t_same to content_type %O\n", content_type)); } else THIS_TAG_DEBUG (sprintf ("Setting content_type to %O from tag\n", content_type)); } else THIS_TAG_DEBUG (sprintf ("Keeping content_type %O\n", content_type)); if (raw_content) { THIS_TAG_DEBUG ("Initializing the content variable to nil\n"); content = content_type->empty_value; } mixed err = catch { switch (eval_state) { case EVSTAT_BEGIN: if (array|function(RequestID:array) do_enter = [array|function(RequestID:array)] this->do_enter) { if (!exec) { if (arrayp (do_enter)) { THIS_TAG_DEBUG ("Getting exec array from do_enter\n"); exec = [array] do_enter; } else { THIS_TAG_DEBUG ("Calling do_enter\n"); exec = ([function(RequestID:array)] do_enter) (id); // Might unwind. THIS_TAG_DEBUG ((exec ? "Exec array" : "Zero") + " returned from do_enter\n"); } if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { if (!(flags & FLAG_PARENT_SCOPE)) { THIS_TAG_DEBUG_ENTER_SCOPE (ctx, this, "Entering scope\n"); ENTER_SCOPE (ctx, this); } mixed res = _exec_array (parser, exec, 0); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (ctx->unwind_state) fatal_error ("Internal error: Clobbering unwind_state " "to do streaming.\n"); if (piece != nil) fatal_error ("Internal error: Thanks, we think about how nice " "it must be to play the harmonica...\n"); #endif if (result_type->name != parser->type->name) { THIS_TAG_DEBUG (sprintf ("Converting result from %s to %s of " "surrounding content\n", result_type->name, parser->type->name)); res = parser->type->encode (res, result_type); } ctx->unwind_state = (["stream_piece": res]); THIS_TAG_DEBUG (sprintf ("Streaming %t from do_enter\n", res)); throw (this); } exec = 0; } } eval_state = EVSTAT_ENTERED; /* Fall through. */ case EVSTAT_ENTERED: case EVSTAT_LAST_ITER: do { if (eval_state != EVSTAT_LAST_ITER) { int|function(RequestID:int) do_iterate = [int|function(RequestID:int)] this->do_iterate; if (intp (do_iterate)) { iter = [int] do_iterate || 1; eval_state = EVSTAT_LAST_ITER; #ifdef DEBUG if (iter > 1) THIS_TAG_DEBUG (sprintf ("Getting %d iterations from do_iterate\n", iter)); else if (iter < 0) THIS_TAG_DEBUG ("Skipping to finish since do_iterate is negative\n"); #endif } else { THIS_TAG_DEBUG ("Calling do_iterate\n"); iter = (/*[function(RequestID:int)]HMM*/ do_iterate) ( id); // Might unwind. THIS_TAG_DEBUG (sprintf ("%O returned from do_iterate\n", iter)); if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); if (!iter) eval_state = EVSTAT_LAST_ITER; } } THIS_TAG_DEBUG_ENTER_SCOPE (ctx, this, "Entering scope\n"); ENTER_SCOPE (ctx, this); for (; iter > 0; iter-- #ifdef DEBUG , debug_iter++ #endif ) { if (raw_content && raw_content != "") if (flags & FLAG_EMPTY_ELEMENT) parse_error ("This tag doesn't handle content.\n"); else { // Got nested parsing to do. int finished = 0; if (!subparser) { // The nested content is not yet parsed. if (this->local_tags) { subparser = content_type->get_parser ( ctx, [object(TagSet)] this->local_tags, parser); subparser->_local_tag_set = 1; THIS_TAG_DEBUG ( sprintf ("Iter[%d]: Evaluating content with %O " "from local_tags\n", debug_iter, subparser)); } else { subparser = content_type->get_parser (ctx, 0, parser); #ifdef DEBUG if (content_type->_parser_prog != PNone) THIS_TAG_DEBUG (sprintf ("Iter[%d]: Evaluating content " "with %O\n", debug_iter, subparser)); #endif } if (parser->recover_errors && !(flags & FLAG_DONT_RECOVER)) subparser->recover_errors = 1; subparser->finish (raw_content); // Might unwind. finished = 1; } do { if (flags & FLAG_STREAM_CONTENT && subparser->read) { // Handle a stream piece. // Squeeze out any free text from the subparser first. mixed res = subparser->read(); if (content_type->sequential) piece = res + piece; else if (piece == nil) piece = res; THIS_TAG_DEBUG ( sprintf ("Iter[%d]: Got %s %t stream piece\n", debug_iter, finished ? "ending" : "a", piece)); if (piece != nil) { array|function(RequestID,void|mixed:array) do_process; if ((do_process = [array|function(RequestID,void|mixed:array)] this->do_process) && !arrayp (do_process)) { if (!exec) { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Calling do_process in " "streaming mode\n", debug_iter)); exec = do_process (id, piece); // Might unwind. THIS_TAG_DEBUG (sprintf ("Iter[%d]: %s returned from " "do_process\n", debug_iter, exec ? "Exec array" : "Zero")); if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { THIS_TAG_DEBUG_ENTER_SCOPE ( ctx, this, sprintf ("Iter[%d]: Entering scope\n", debug_iter)); ENTER_SCOPE (ctx, this); mixed res = _exec_array ( parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (!zero_type (ctx->unwind_state->stream_piece)) fatal_error ("Internal error: Clobbering " "unwind_state->stream_piece.\n"); #endif if (result_type->name != parser->type->name) { THIS_TAG_DEBUG ( sprintf ("Iter[%d]: Converting result from %s to %s" " of surrounding content\n", debug_iter, result_type->name, parser->type->name)); res = parser->type->encode (res, result_type); } ctx->unwind_state->stream_piece = res; THIS_TAG_DEBUG ( sprintf ("Iter[%d]: Streaming %t from " "do_process\n", debug_iter, res)); throw (this); } exec = 0; } else if (flags & FLAG_STREAM_RESULT) { THIS_TAG_DEBUG ( sprintf ("Iter[%d]: do_process finished the stream; " "ignoring remaining content\n", debug_iter)); ctx->unwind_state = 0; piece = nil; break; } } piece = nil; } if (finished) break; } else { // The frame doesn't handle streamed content. piece = nil; if (finished) { mixed res = subparser->eval(); // Might unwind. if (content_type->sequential) { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Adding %t to content\n", debug_iter, res)); content += res; } else if (res != nil) { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Setting content to %t\n", debug_iter, res)); content = res; } break; } } subparser->finish(); // Might unwind. finished = 1; } while (1); // Only loops when an unwound subparser has been recovered. subparser = 0; } if (array|function(RequestID,void|mixed:array) do_process = [array|function(RequestID,void|mixed:array)] this->do_process) { if (!exec) { if (arrayp (do_process)) { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Getting exec array from " "do_process\n", debug_iter)); exec = [array] do_process; } else { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Calling do_process\n", debug_iter)); exec = ([function(RequestID,void|mixed:array)] do_process) ( id); // Might unwind. THIS_TAG_DEBUG (sprintf ("Iter[%d]: %s returned from do_process\n", debug_iter, exec ? "Exec array" : "Zero")); } if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { THIS_TAG_DEBUG_ENTER_SCOPE ( ctx, this, sprintf ("Iter[%d]: Entering scope\n", debug_iter)); ENTER_SCOPE (ctx, this); mixed res = _exec_array ( parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (ctx->unwind_state) fatal_error ("Internal error: Clobbering unwind_state " "to do streaming.\n"); if (piece != nil) fatal_error ("Internal error: Thanks, we think about how nice " "it must be to play the harmonica...\n"); #endif if (result_type->name != parser->type->name) { THIS_TAG_DEBUG (sprintf ("Iter[%d]: Converting result from " "type %s to type %s of surrounding " "content\n", debug_iter, result_type->name, parser->type->name)); res = parser->type->encode (res, result_type); } ctx->unwind_state = (["stream_piece": res]); THIS_TAG_DEBUG (sprintf ("Iter[%d]: Streaming %t from " "do_process\n", debug_iter, res)); throw (this); } exec = 0; } } } } while (eval_state != EVSTAT_LAST_ITER); /* Fall through. */ case EVSTAT_ITER_DONE: if (array|function(RequestID:array) do_return = [array|function(RequestID:array)] this->do_return) { eval_state = EVSTAT_ITER_DONE; // Only need to record this state here. if (!exec) { if (arrayp (do_return)) { THIS_TAG_DEBUG ("Getting exec array from do_return\n"); exec = [array] do_return; } else { THIS_TAG_DEBUG ("Calling do_return\n"); exec = ([function(RequestID:array)] do_return) (id); // Might unwind. THIS_TAG_DEBUG ((exec ? "Exec array" : "Zero") + " returned from do_return\n"); } if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { THIS_TAG_DEBUG_ENTER_SCOPE (ctx, this, "Entering scope\n"); ENTER_SCOPE (ctx, this); _exec_array (parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. exec = 0; } } else if (result == nil && !(flags & FLAG_EMPTY_ELEMENT)) { if (result_type->_parser_prog == PNone) { if (content_type->name != result_type->name) { THIS_TAG_DEBUG (sprintf ("Assigning content to result after " "converting from %s to %s\n", content_type->name, result_type->name)); result = result_type->encode (content, content_type); } else { THIS_TAG_DEBUG ("Assigning content to result\n"); result = content; } } else if (stringp (content)) { eval_state = EVSTAT_ITER_DONE; // Only need to record this state here. if (!exec) { THIS_TAG_DEBUG ("Parsing content with exec array " "for assignment to result\n"); exec = ({content}); } _exec_array (parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. exec = 0; } } else { #ifdef DEBUG if (!(flags & FLAG_EMPTY_ELEMENT)) THIS_TAG_DEBUG ("Skipping nil result\n"); #endif } THIS_TAG_DEBUG_LEAVE_SCOPE (ctx, this, "Leaving scope\n"); LEAVE_SCOPE (ctx, this); } if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); }; ctx->frame_depth--; if (err) { THIS_TAG_DEBUG_LEAVE_SCOPE (ctx, this, "Leaving scope\n"); LEAVE_SCOPE (ctx, this); string action; if (objectp (err) && ([object] err)->thrown_at_unwind) { mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state; if (!ustate) ustate = ctx->unwind_state = ([]); #ifdef DEBUG if (ustate[this]) fatal_error ("Internal error: Frame already has an unwind state.\n"); #endif if (ustate->exec_left) { exec = [array] ustate->exec_left; m_delete (ustate, "exec_left"); } if (err == this || exec && sizeof (exec) && err == exec[0]) // This frame or a frame in the exec array wants to stream. if (parser->unwind_safe) { // Rethrow to continue in parent since we've already done // the appropriate do_process stuff in this frame in // either case. if (err == this) err = 0; if (orig_tag_set) ctx->tag_set = orig_tag_set, orig_tag_set = 0; action = "break"; THIS_TAG_TOP_DEBUG ("Interrupted for streaming - " "breaking to parent frame\n"); } else { // Can't stream since the parser isn't unwind safe. Just // continue. m_delete (ustate, "stream_piece"); action = "continue"; THIS_TAG_TOP_DEBUG ("Interrupted for streaming - " "continuing since parser isn't unwind safe\n"); } else if (!zero_type (ustate->stream_piece)) { // Got a stream piece from a subframe. We handle it above; // store the state and tail recurse. piece = ustate->stream_piece; m_delete (ustate, "stream_piece"); action = "continue"; } else { action = "break"; // Some other reason - back up to the top. THIS_TAG_TOP_DEBUG ("Interrupted\n"); } ustate[this] = ({err, eval_state, iter, raw_content, subparser, piece, exec, orig_tag_set, ctx->new_runtime_tags, #ifdef DEBUG debug_iter, #endif }); TRACE_LEAVE (action); } else { THIS_TAG_TOP_DEBUG ("Exception\n"); TRACE_LEAVE ("exception"); ctx->handle_exception (err, parser); // Will rethrow unknown errors. result = nil; action = "return"; } switch (action) { case "break": // Throw and handle in parent frame. #ifdef MODULE_DEBUG if (!parser->unwind_state) fatal_error ("Trying to unwind inside a parser that isn't unwind safe.\n"); #endif throw (this); case "continue": // Continue in this frame through tail recursion. _eval (parser); return; case "return": // A normal return. break; default: fatal_error ("Internal error: Don't you come here and %O on me!\n", action); } } else { THIS_TAG_TOP_DEBUG ("Done\n"); TRACE_LEAVE (""); } } while (0); // Breaks go here. if (orig_tag_set) ctx->tag_set = orig_tag_set; ctx->frame = up; } MARK_OBJECT; string _sprintf() { return "RXML.Frame(" + (tag && [string] tag->name) + ")" + OBJ_COUNT; } } // Global services. //! Shortcuts to some common functions in the current context (see the //! corresponding functions in the Context class for details). final mixed get_var (string var, void|string scope_name, void|Type want_type) {return get_context()->get_var (var, scope_name, want_type);} final mixed user_get_var (string var, void|string scope_name, void|Type want_type) {return get_context()->user_get_var (var, scope_name, want_type);} final mixed set_var (string var, mixed val, void|string scope_name) {return get_context()->set_var (var, val, scope_name);} final mixed user_set_var (string var, mixed val, void|string scope_name) {return get_context()->user_set_var (var, val, scope_name);} final void delete_var (string var, void|string scope_name) {get_context()->delete_var (var, scope_name);} final void user_delete_var (string var, void|string scope_name) {get_context()->user_delete_var (var, scope_name);} final void run_error (string msg, mixed... args) //! Throws an RXML run error with a dump of the parser stack in the //! current context. This is intended to be used by tags for errors //! that can occur during normal operation, such as when the //! connection to an SQL server fails. { if (sizeof (args)) msg = sprintf (msg, @args); array bt = backtrace(); throw (Backtrace ("run", msg, get_context(), bt[..sizeof (bt) - 2])); } final void parse_error (string msg, mixed... args) //! Throws an RXML parse error with a dump of the parser stack in the //! current context. This is intended to be used for programming //! errors in the RXML code, such as lookups in nonexisting scopes and //! invalid arguments to a tag. { if (sizeof (args)) msg = sprintf (msg, @args); array bt = backtrace(); throw (Backtrace ("parse", msg, get_context(), bt[..sizeof (bt) - 2])); } final void fatal_error (string msg, mixed... args) //! Throws a Pike error that isn't catched and handled anywhere. It's //! just like the common error() function, but includes the RXML frame //! backtrace. { if (sizeof (args)) msg = sprintf (msg, @args); array bt = backtrace(); throw_fatal (({msg, bt[..sizeof (bt) - 2]})); } final void throw_fatal (mixed err) //! Mainly used internally to throw an error that includes the RXML //! frame backtrace. { if (arrayp (err) && sizeof (err) == 2 || objectp (err) && !err->is_RXML_Backtrace && err->is_generic_error) { string msg; if (catch (msg = err[0])) throw (err); if (stringp (msg) && !has_value (msg, "\nRXML frame backtrace:\n")) { string descr = Backtrace (0, 0)->describe_rxml_backtrace (1); if (sizeof (descr)) { if (sizeof (msg) && msg[-1] != '\n') msg += "\n"; msg += "RXML frame backtrace:\n" + descr; catch (err[0] = msg); } } } throw (err); } final mixed rxml_index (mixed val, string|int|array(string|int) index, string scope_name, Context ctx, void|Type want_type) //! Index the value according to RXML type rules and returns the //! result. Throws RXML exceptions on any errors. If index is an //! array, its elements are used to successively subindex the value, //! e.g. ({"a", 2, "b"}) corresponds to val["a"][2]["c"]. scope_name //! is used to identify the context for the indexing. //! //! The special RXML index rules are: //! //! o Arrays are indexed with 1 for the first element, or //! alternatively -1 for the last. Indexing an array of size n with //! 0, n+1 or greater, -n-1 or less, or with a non-integer is an //! error. //! o Strings, along with integers and floats, are treated as simple //! scalar types which aren't really indexable. If a scalar type is //! indexed with 1 or -1, it produces itself instead of generating //! an error. (This is a convenience to avoid many special cases //! when treating both arrays and scalar types.) //! o If a value is an object which has an rxml_var_eval identifier, //! it's treated as a Value object and the rxml_var_eval function //! is called to produce its value. //! o If a value which is about to be indexed is an object which has //! a `[] function, it's called as a Scope object. //! o Both the special value nil and the undefined value (a zero with //! zero_type 1) may be used to signify no value at all, and both //! will be returned as the undefined value. //! //! If the want_type argument is set, the result value is converted to //! that type with Type.encode(). If the value can't be converted, an //! RXML error is thrown. //! //! This function is mainly for internal use; you commonly want to use //! get_var, set_var, user_get_var or user_set_var instead. { #ifdef MODULE_DEBUG if (arrayp (index) ? !sizeof (index) : !(stringp (index) || intp (index))) error ("Invalid index specifier.\n"); #endif int scope_got_type = 0; array(string|int) idxpath; if (arrayp (index)) idxpath = index, index = index[0]; else idxpath = ({0}); for (int i = 1;; i++) { // stringp was not really a good idea. if( arrayp( val ) /*|| stringp( val )*/ ) if (intp (index) && index) if( (index > sizeof( val )) || ((index < 0) && (-index > sizeof( val ) )) ) parse_error( "Index %d out of range for array of size %d in %s.\n", index, sizeof (val), scope_name ); else if( index < 0 ) val = val[index]; else val = val[index-1]; else parse_error( "Cannot index the array in %s with %O.\n", scope_name, index ); else if (val == nil) parse_error ("%s produced no value to index with %O.\n", scope_name, index); else if( objectp( val ) && val->`[] ) { #ifdef MODULE_DEBUG Scope scope = [object(Scope)] val; #endif if (zero_type ( val = ([object(Scope)] val)->`[]( index, ctx, scope_name, i == sizeof (idxpath) && (scope_got_type = 1, want_type)))) val = nil; #ifdef MODULE_DEBUG else if (mixed err = scope_got_type && want_type && !(objectp (val) && ([object] val)->rxml_var_eval) && catch (want_type->type_check (val))) if (([object] err)->is_RXML_Backtrace) error ("%O->`[] didn't return a value of the correct type:\n%s", scope, err->msg); else throw (err); #endif } else if( mappingp( val ) || objectp (val) ) { if (zero_type (val = val[ index ])) val = nil; } else if (multisetp (val)) { if (!val[index]) val = nil; } else if (!(<1, -1>)[index]) parse_error ("%s is %O which cannot be indexed with %O.\n", scope_name, val, index); if (i == sizeof (idxpath)) break; scope_name += "." + index; index = idxpath[i]; #ifdef MODULE_DEBUG mapping(object:int) called = ([]); #endif while (objectp (val) && ([object] val)->rxml_var_eval) { #ifdef MODULE_DEBUG // Detect infinite loops. This check is slightly too strong; // it's theoretically possible that a couple of Value objects // return each other a few rounds and then something different, // but we'll live with that. Besides, that situation ought to be // solved internally in them anyway. if (called[val]) error ("Cyclic rxml_var_eval chain detected in %O.\n" "All called objects:%{ %O%}\n", val, indices (called)); called[val] = 1; #endif if (zero_type (val = ([object(Value)] val)->rxml_var_eval ( ctx, index, scope_name, 0))) { val = nil; break; } } } if (val == nil) return ([])[0]; else if (!objectp (val) || !([object] val)->rxml_var_eval) if (want_type && !scope_got_type) return // FIXME: Some system to find out the source type? zero_type (val = want_type->encode (val)) || val == nil ? ([])[0] : val; else return val; #ifdef MODULE_DEBUG mapping(object:int) called = ([]); #endif do { #ifdef MODULE_DEBUG if (called[val]) error ("Cyclic rxml_var_eval chain detected in %O.\n" "All called objects:%{ %O%}\n", val, indices (called)); called[val] = 1; Value val_obj = [object(Value)] val; #endif if (zero_type (val = ([object(Value)] val)->rxml_var_eval ( ctx, index, scope_name, want_type)) || val == nil) return ([])[0]; #ifdef MODULE_DEBUG else if (mixed err = want_type && catch (want_type->type_check (val))) if (([object] err)->is_RXML_Backtrace) error ("%O->rxml_var_eval didn't return a value of the correct type:\n%s", val_obj, err->msg); else throw (err); #endif } while (objectp (val) && ([object] val)->rxml_var_eval); return val; } final void tag_debug (string msg, mixed... args) //! Writes the message to the debug log if the innermost tag being //! executed has FLAG_DEBUG set. { if (Frame f = get_context()->frame) // It's intentional that this assumes a context. if (f->flags & FLAG_DEBUG) report_debug (msg, @args); } final Frame make_tag (string name, mapping(string:mixed) args, void|mixed content, void|Tag overridden_by) //! Returns a frame for the specified tag, or 0 if no such tag exists. //! The tag definition is looked up in the current context and tag //! set. args and content are not parsed or evaluated. If //! overridden_by is given, the returned frame will come from the tag //! that overridden_by overrides, if there is any (name is not used in //! that case). { TagSet tag_set = get_context()->tag_set; Tag tag = overridden_by ? tag_set->get_overridden_tag (overridden_by) : tag_set->get_tag (name); return tag && tag (args, content); } final Frame make_unparsed_tag (string name, mapping(string:string) args, void|string content, void|Tag overridden_by) //! Returns a frame for the specified tag, or 0 if no such tag exists. //! The tag definition is looked up in the current context and tag //! set. args and content are given unparsed in this variant; they're //! parsed when the frame is about to be evaluated. If overridden_by //! is given, the returned frame will come from the tag that //! overridden_by overrides, if there is any (name is not used in that //! case). { TagSet tag_set = get_context()->tag_set; Tag tag = overridden_by ? tag_set->get_overridden_tag (overridden_by) : tag_set->get_tag (name); if (!tag) return 0; Frame frame = tag (args, content); frame->flags |= FLAG_UNPARSED; return frame; } class parse_frame /* (Type type, string to_parse) */ //! Returns a frame that, when evaluated, parses the given string //! according to the type (which typically has a parser set). { inherit Frame; constant flags = FLAG_UNPARSED; mapping(string:mixed) args = ([]); void create (Type type, string to_parse) { content_type = type, result_type = type (PNone); content = to_parse; } string _sprintf() {return sprintf ("RXML.parse_frame(%O)", content_type);} } //! Parsers. class Parser //! Interface class for a syntax parser that scans, parses and //! evaluates an input stream. Access to a parser object is assumed to //! be done in a thread safe way except where noted. { constant is_RXML_Parser = 1; constant thrown_at_unwind = 1; //! Services. int error_count; //! Number of RXML errors that occurred during evaluation. If this //! is nonzero, the value from eval() shouldn't be trusted. function(Parser:void) data_callback; //! A function to be called when data is likely to be available from //! eval(). It's always called when the source stream closes. //! write() and write_end() are the functions to use from outside //! the parser system, not feed() or finish(). int write (string in) //! Writes some source data to the parser. Returns nonzero if there //! might be data available in eval(). { int res; ENTER_CONTEXT (context); if (mixed err = catch { if (context && context->unwind_state && context->unwind_state->top) { #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object()) fatal_error ("The context got an unwound state from another parser. " "Can't rewind.\n"); #endif m_delete (context->unwind_state, "top"); if (!sizeof (context->unwind_state)) context->unwind_state = 0; } if (feed (in)) res = 1; // Might unwind. if (res && data_callback) data_callback (this_object()); }) if (objectp (err) && ([object] err)->thrown_at_unwind) { #ifdef DEBUG if (err != this_object()) { LEAVE_CONTEXT(); fatal_error ("Internal error: Unexpected unwind object catched.\n"); } #endif if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; } else { LEAVE_CONTEXT(); throw_fatal (err); } LEAVE_CONTEXT(); return res; } void write_end (void|string in) //! Closes the source data stream, optionally with a last bit of //! data. { int res; ENTER_CONTEXT (context); if (mixed err = catch { if (context && context->unwind_state && context->unwind_state->top) { #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object()) fatal_error ("The context got an unwound state from another parser. " "Can't rewind.\n"); #endif m_delete (context->unwind_state, "top"); if (!sizeof (context->unwind_state)) context->unwind_state = 0; } finish (in); // Might unwind. if (data_callback) data_callback (this_object()); }) if (objectp (err) && ([object] err)->thrown_at_unwind) { #ifdef DEBUG if (err != this_object()) { LEAVE_CONTEXT(); fatal_error ("Internal error: Unexpected unwind object catched.\n"); } #endif if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; } else { LEAVE_CONTEXT(); throw_fatal (err); } LEAVE_CONTEXT(); } array handle_var (string varref, Type surrounding_type) // Parses and evaluates a possible variable reference, with the // appropriate error handling. { // We're always evaluating here, so context is always set. if(varref[0]==':') return ({type->format_entity (varref[1..])}); if (has_value (varref, ".")) if (mixed err = catch { // It's intentional that we split on the first ':' for now, to // allow for future enhancements of this syntax. Scope and // variable names containing ':' are thus not accessible this way. sscanf (varref, "%[^:]:%s", varref, string encoding); context->current_var = varref; array(string|int) splitted = context->parse_user_var (varref, 1); if (splitted[0] == 1) parse_error ( "No scope in variable reference.\n" "(Use ':' in front to quote a character reference containing dots.)\n"); mixed val; if (zero_type (val = context->get_var ( // May throw. splitted[1..], splitted[0], encoding ? t_string : surrounding_type))) { context->current_var = 0; return ({}); } context->current_var = 0; return encoding ? ({Roxen->roxen_encode (val, encoding)}) : ({val}); }) { context->current_var = 0; context->handle_exception (err, this_object()); // May throw. return ({}); } if (!surrounding_type->free_text) parse_error ("Unknown variable reference &%s; not allowed in this " "context.\n", varref); return 0; } //! Interface. Context context; //! The context to do evaluation in. It's assumed to never be //! modified asynchronously during the time the parser is working on //! an input stream. Type type; //! The expected result type of the current stream. (The parser //! should not do any type checking on this.) int compile; //! Must be set to nonzero before a stream is fed which should be //! compiled to p-code. //!int unwind_safe; //! If nonzero, the parser supports unwinding with throw()/catch(). //! Whenever an exception is thrown from some evaluation function, //! it should be able to call that function again with identical //! arguments the next time it continues. int recover_errors; //! Set to nonzero to allow error recovery in this parser. //! report_error() will never be called if this is zero. mixed feed (string in); //! Feeds some source data to the parse stream. The parser may do //! scanning and parsing before returning. If context is set, it may //! also do evaluation in that context. Returns nonzero if there //! could be new data to get from eval(). void finish (void|string in); //! Like feed(), but also finishes the parse stream. A last bit of //! data may be given. It should work to call this on an already //! finished stream if no argument is given to it. optional int report_error (string msg); //! Used to report errors to the end user through the output. This //! is only called when type->free_text is nonzero and //! recover_errors is nonzero. msg should be stored in the output //! queue to be returned by eval(). If the context is bad for an //! error message, do nothing and return zero. The parser will then //! be aborted and the error will be propagated instead. Return //! nonzero if a message was written. optional mixed read(); //! Define to allow streaming operation. Returns the evaluated //! result so far, but does not do any evaluation. Returns RXML.nil //! if there's no data (for sequential types the empty value is also //! ok). mixed eval(); //! Evaluates the data fed so far and returns the result. The result //! returned by previous eval() calls should not be returned again //! as (part of) this return value. Returns RXML.nil if there's no //! data (for sequential types the empty value is also ok). optional PCode p_compile(); //! Define this to return a p-code representation of the current //! stream, which always is finished. optional void reset (Context ctx, Type type, mixed... args); //! Define to support reuse of a parser object. It'll be called //! instead of making a new object for a new stream. It keeps the //! static configuration, i.e. the type (and tag set when used in //! TagSetParser). Note that this function needs to deal with //! leftovers from add_runtime_tag() for TagSetParser objects. optional Parser clone (Context ctx, Type type, mixed... args); //! Define to create new parser objects by cloning instead of //! creating from scratch. It returns a new instance of this parser //! with the same static configuration, i.e. the type (and tag set //! when used in TagSetParser). static void create (Context ctx, Type _type, mixed... args) { context = ctx; type = _type; #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif } string current_input() {return 0;} //! Should return the representation in the input stream for the //! current tag or entity being parsed, or 0 if it isn't known. // Internals. Parser _next_free; // Used to link together unused parser objects for reuse. Parser _parent; // The parent parser if this one is nested. Stdio.File _source_file; mapping _defines; // These two are compatibility kludges for use with parse_rxml(). MARK_OBJECT_ONLY; string _sprintf() { return sprintf ("RXML.Parser(%O)%s", type, OBJ_COUNT); } } class TagSetParser //! Interface class for parsers that evaluates using the tag set. It //! provides the evaluation and compilation functionality. The parser //! should call Tag._handle_tag() from feed() and finish() for every //! encountered element tag and Tag._handle_pi_tag() for every PI tag. //! Parser.handle_var() should be called for encountered variable //! references. It must be able to continue cleanly after throw() from //! Tag._handle_tag() and Tag._handle_pi_tag(). { inherit Parser; constant is_RXML_TagSetParser = 1; constant tag_set_eval = 1; // Services. mixed eval() {return read();} // Interface. TagSet tag_set; //! The tag set used for parsing. optional void reset (Context ctx, Type _type, TagSet tag_set, mixed... args); optional Parser clone (Context ctx, Type _type, TagSet tag_set, mixed... args); static void create (Context ctx, Type _type, TagSet _tag_set, mixed... args) { //::create (ctx, _type); context = ctx; type = _type; tag_set = _tag_set; #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif } //! In addition to the type, the tag set is part of the static //! configuration. mixed read(); //! No longer optional in this class. Since the evaluation is done //! in Tag._handle_tag() or similar, this always does the same as //! eval(). optional void add_runtime_tag (Tag tag); //! Adds a tag that will exist from this point forward in the //! current parser instance only. This may only be left undefined if //! the parser doesn't parse tags at all. optional void remove_runtime_tag (string|Tag tag, void|int proc_instr); //! If tag is a Tag object, it's removed from the set of runtime //! tags that's been added by add_runtime_tag(). If tag is a string, //! the tag with that name is removed. In this case, if proc_instr //! is nonzero the set of runtime PI tags is searched, else the set //! of normal element runtime tags. This may only be left undefined //! if the parser doesn't parse tags at all. // Internals. int _local_tag_set; string _sprintf() { return sprintf ("RXML.TagSetParser(%O,%O)%s", type, tag_set, OBJ_COUNT); } } class PNone //! The identity parser. It only returns its input. { inherit Parser; string data = ""; int evalpos = 0; int feed (string in) { data += in; return 1; } void finish (void|string in) { if (in) data += in; } string eval() { string res = data[evalpos..]; evalpos = sizeof (data); return res; } string byte_compile() { return data; } string byte_interpret (string byte_code, Context ctx) { return byte_code; } void reset (Context ctx) { context = ctx; data = ""; evalpos = 0; } string _sprintf() {return "RXML.PNone" + OBJ_COUNT;} } mixed simple_parse (string in, void|program parser) //! A convenience function to parse a string with no type info, no tag //! set, and no variable references. The parser defaults to PExpr. { // FIXME: Recycle contexts? return t_any (parser || PExpr)->eval (in, Context (empty_tag_set)); } //! Types. class Type //! A static type definition. It does type checking and specifies some //! properties of the type. It may also contain a Parser program that //! will be used to read text and evaluate values of this type. Note //! that the parser is not relevant for type checking. //! //! @note The doc for this class is rather lengthy, but most of it //! applies only to type implementors. It's very much simpler to use a //! type than to implement one; typical users only need to choose one //! and use @[encode], @[subtype_of], @[`()] or @[eval] in it. { constant is_RXML_Type = 1; // Services int `== (mixed other) //! Returns nonzero iff this type is the same as @[other], i.e. has //! the same name. If @[other] is known to be a type, it's somewhat //! faster to compare the names directly. { return /*::`== (this_object(), other) ||*/ objectp (other) && ([object] other)->is_RXML_Type && ([object(Type)] other)->name == this_object()->name; } int subtype_of (Type other) //! Returns nonzero iff this type is the same as or a subtype of //! @[other], meaning that any value of this type can be expressed //! by @[other] without (or with at most negligible) loss of //! information. { return glob ([string] other->name, [string] this_object()->name); } int `< (mixed other) //! Comparison regards a type as less than its supertypes. If //! @[other] isn't a type, it's compared with @[name]. { if (objectp (other) && ([object] other)->is_RXML_Type) { if (([object(Type)] other)->name == this_object()->name) return 0; return subtype_of (other); } return this_object()->name < other; } int convertible (Type from) //! Returns nonzero iff it's possible to convert values of the type //! @[from] to this type using some chain of conversions. { if (conversion_type->name == from->name || conversion_type->name == from->conversion_type->name || this_object()->name == from->conversion_type->name || this_object()->name == from->name) return 1; // The following is not terribly efficient, but most situations // should be handled by the special cases above. for (Type tconv = conversion_type; tconv; tconv = tconv->conversion_type) for (Type fconv = from->conversion_type; fconv; fconv = fconv->conversion_type) if (fconv->name == tconv->name) return 1; return 0; } Type `() (program/*(Parser)HMM*/ newparser, mixed... parser_args) //! Returns a type identical to this one, but which has the given //! parser. parser_args is passed as extra arguments to the //! create()/reset()/clone() functions. { Type newtype; if (sizeof (parser_args)) { // Can't cache this. newtype = clone(); newtype->_parser_prog = newparser; newtype->_parser_args = parser_args; if (newparser->tag_set_eval) newtype->_p_cache = set_weak_flag (([]), 1); } else { if (!_t_obj_cache) _t_obj_cache = ([]); if (!(newtype = _t_obj_cache[newparser])) if (newparser == _parser_prog) _t_obj_cache[newparser] = newtype = this_object(); else { _t_obj_cache[newparser] = newtype = clone(); newtype->_parser_prog = newparser; if (newparser->tag_set_eval) newtype->_p_cache = set_weak_flag (([]), 1); } } return newtype; } inline Parser get_parser (Context ctx, void|TagSet tag_set, void|Parser|PCode parent) //! Returns a parser instance initialized with the given context. { Parser p; if (_p_cache) { // It's a tag set parser. TagSet tset = tag_set || ctx->tag_set; if (parent && parent->is_RXML_TagSetParser && tset == parent->tag_set && sizeof (ctx->runtime_tags) && parent->clone && parent->type == this_object()) { // There are runtime tags. Try to clone the parent parser if // all conditions are met. p = parent->clone (ctx, this_object(), tset, @_parser_args); p->_parent = parent; return p; } // vvv Using interpreter lock from here. PCacheObj pco = _p_cache[tset]; if (pco && pco->tag_set_gen == tset->generation) { if ((p = pco->free_parser)) { pco->free_parser = p->_next_free; // ^^^ Using interpreter lock to here. p->data_callback = p->compile = 0; p->reset (ctx, this_object(), tset, @_parser_args); #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif } else // ^^^ Using interpreter lock to here. if (pco->clone_parser) p = pco->clone_parser->clone (ctx, this_object(), tset, @_parser_args); else if ((p = _parser_prog (ctx, this_object(), tset, @_parser_args))->clone) { // pco->clone_parser might already be initialized here due // to race, but that doesn't matter. p->context = 0; // Don't leave the context in the clone master. #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif p = (pco->clone_parser = p)->clone (ctx, this_object(), tset, @_parser_args); } } else { // ^^^ Using interpreter lock to here. pco = PCacheObj(); pco->tag_set_gen = tset->generation; _p_cache[tset] = pco; // Might replace an object due to race, but that's ok. if ((p = _parser_prog (ctx, this_object(), tset, @_parser_args))->clone) { // pco->clone_parser might already be initialized here due // to race, but that doesn't matter. p->context = 0; // Don't leave the context in the clone master. #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif p = (pco->clone_parser = p)->clone (ctx, this_object(), tset, @_parser_args); } } if (ctx->tag_set == tset && p->add_runtime_tag && sizeof (ctx->runtime_tags)) foreach (values (ctx->runtime_tags), Tag tag) p->add_runtime_tag (tag); } else { if ((p = free_parser)) { // Relying on interpreter lock here. free_parser = p->_next_free; p->data_callback = p->compile = 0; p->reset (ctx, this_object(), @_parser_args); #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif } else if (clone_parser) // Relying on interpreter lock here. p = clone_parser->clone (ctx, this_object(), @_parser_args); else if ((p = _parser_prog (ctx, this_object(), @_parser_args))->clone) { // clone_parser might already be initialized here due to race, // but that doesn't matter. p->context = 0; // Don't leave the context in the clone master. #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif p = (clone_parser = p)->clone (ctx, this_object(), @_parser_args); } } p->_parent = parent; return p; } mixed eval (string in, void|Context ctx, void|TagSet tag_set, void|Parser|PCode parent, void|int dont_switch_ctx) //! Parses and evaluates the value in the given string. If a context //! isn't given, the current one is used. The current context and //! ctx are assumed to be the same if dont_switch_ctx is nonzero. { mixed res; if (!ctx) ctx = get_context(); if (_parser_prog == PNone) res = in; else { Parser p = get_parser (ctx, tag_set, parent); p->_parent = parent; if (dont_switch_ctx) p->finish (in); // Optimize the job in p->write_end(). else p->write_end (in); res = p->eval(); if (p->reset) { p->context = p->recover_errors = p->_parent = 0; #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif if (_p_cache) { if (PCacheObj pco = _p_cache[tag_set || ctx->tag_set]) { // Relying on interpreter lock here. p->_next_free = pco->free_parser; pco->free_parser = p; } } else { // Relying on interpreter lock in this block. p->_next_free = free_parser; free_parser = p; } } } if (ctx->type_check) type_check (res); return res; } // Interface //! @decl constant string name; //! //! Unique type identifier. Required and considered constant. //! //! If it contains a "/", it's treated as a MIME type and should //! then follow the rules for a MIME type with subtype (RFC 2045, //! section 5.1). Among other things, that means that the valid //! characters are, besides the "/", US-ASCII values 33-126 except //! "(", ")", "<", ">", "@@", ",", ";", ":", "\", """, "/", "[", //! "]", "?" and "=". //! //! If it doesn't contain a "/", it's treated as a type outside the //! MIME system, e.g. "int" for an integer. Any type that can be //! mapped to a MIME type should be so. //! //! Type hierarchies are currently implemented with glob patterns, //! e.g. "image/png" is a subtype of "image/*". However, this syntax //! will be developed further. //! //! A type in the type hierarchy should be able to express any value //! that any of its subtypes can express without (or with at most //! negligible) loss of information, but not necessarily on the same //! form. This is different from the type trees described by //! @[conversion_type], although it's always preferable if a //! supertype also can be used as @[conversion_type] in its //! subtypes. //! //! There are however exceptions to the rule above about information //! preservation, since it's impossible to satisfy it for //! sufficiently generic types. E.g. the type @[RXML.t_any] cannot //! express hardly any value (except @[RXML.nil]) without loss of //! information. constant sequential = 0; //! Nonzero if data of this type is sequential, defined as: //! o One or more data items can be concatenated with `+. //! o (Sane) parsers are homomorphic on the type, i.e. //! eval ("da") + eval ("ta") == eval ("da" + "ta") //! and //! eval ("data") + eval ("") == eval ("data") //! provided the data is only split between (sensibly defined) //! atomic elements. //!mixed empty_value; //! The empty value, i.e. what eval ("") would produce. Type conversion_type; //! The type to use as middlestep in indirect conversions. Required //! and considered constant. It should be zero (not @[RXML.t_any]) //! if there is no sensible conversion type. The @[conversion_type] //! references must never produce a cycle between types. //! //! It's values of the conversion type that @[decode] tries to //! return, and also that @[encode] must handle without resorting to //! indirect conversions. It's used as a fallback between types //! which doesn't have explicit conversion functions for each other; //! see @[indirect_convert]. //! //! @note The trees described by the conversion types aren't proper //! type hierarchies in the sense of value set sizes, as opposed to //! the relations expressed by the glob patterns in @[name]. The //! conversion type is chosen purely on pragmatic grounds for doing //! indirect conversions. It's better if the conversion type is a //! supertype (i.e. has a larger value set), but in lack of proper //! supertypes it may also be a subtype, to make it possible to use //! indirect conversion for at least a subset of the values. See the //! example in @[decode]. //!int free_text; //! Nonzero if the type keeps the free text between parsed tokens, //! e.g. the plain text between tags in XML. The type must be //! sequential and use strings. //! @decl optional constant int entity_syntax; //! //! Nonzero constant for all types with string values that use //! entity syntax, like XML or HTML. void type_check (mixed val, void|string msg, mixed... args); //! Checks whether the given value is a valid one of this type. //! Errors are thrown as RXML parse errors, and in that case @[msg], //! if given, is prepended to the error message with ": " between //! them. If there are any more arguments on the line, the prepended //! message is formatted with @tt{sprintf (@[msg], @@@[args])@}. //! There's a @[type_check_error] helper that can be used to handle //! the message formatting and error throwing. mixed encode (mixed val, void|Type from); //! Converts the given value to this type. //! //! If the @[from] type isn't given, the function should try to //! convert it to the required internal form for this type, using a //! cast as a last resort if the type of @[val] isn't recognized. It //! should then encode it, if necessary, as though it were a literal //! (typically only applicable for types using strings with //! encodings, like the @[RXML.t_xml] type). Any conversion error, //! including in the cast, should be thrown as an RXML parse error. //! //! If the @[from] type is given, it's the type of the value. If //! it's @[RXML.t_any], the function should (superficially) check //! the value and return it without conversion. Otherwise, if the //! encode function doesn't have routines to explicitly handle a //! conversion from that type, then indirect conversion using //! @[conversion_type] should be done. The @[indirect_convert] //! function implements that. The encode function should at least be //! able to convert values of @[conversion_type] to this type, or //! else throw an RXML parse error if it isn't possible. //! //! @note Remember to override @[convertible] if this function can //! convert directly from any type besides the conversion type. //! Don't count on that the conversion type tree is constant so that //! the default implementation would return true anyway. optional mixed decode (mixed val); //! Converts the value, which is of this type, to a value of type //! @[conversion_type]. If this function isn't defined, then any //! value of this type works directly in the conversion type. //! //! If the type can't be converted, an RXML parse error should be //! thrown. That might happen if the value contains markup or //! similar that can't be represented in the conversion type. //! //! E.g. in a type for XML markup which have @[RXML.t_text] as the //! conversion type, this function should return a literal string //! only if the text doesn't contain tags, otherwise it should throw //! an error. It should never both decode "<" to "<" and just //! leave literal "<" in the string. It should also not parse the //! value with some evaluating parser (see @[get_parser]) since the //! value should only change representation. (This example shows //! that a more fitting conversion type for XML markup would be a //! DOM type that can represent XML node trees, since values //! containing tags could be decoded then.) Type clone() //! Returns a copy of the type. Exists only for overriding purposes; //! it's normally not useful to call this since type objects are //! shared. { Type newtype = object_program ((object(this_program)) this_object())(); newtype->_parser_prog = _parser_prog; newtype->_parser_args = _parser_args; newtype->_t_obj_cache = _t_obj_cache; return newtype; } string format_tag (string|Tag tag, void|mapping(string:string) args, void|string content, void|int flags) //! Returns a formatted tag according to the type. tag is either a //! tag object or the name of the tag. Throws an error if this type //! cannot format tags. { parse_error ("Cannot format tags with type %s.\n", this_object()->name); } string format_entity (string entity) //! Returns a formatted entity according to the type. Throws an //! error if this type cannot format entities. { parse_error ("Cannot format entities with type %s.\n", this_object()->name); } static final void type_check_error (string msg1, array args1, string msg2, mixed... args2) //! Helper intended to format and throw an RXML parse error in //! @[type_check]. Assuming the same argument names as in the //! @[type_check] declaration, use like this: //! //! @example //! if (value is bogus) //! type_check_error (msg, args, "My error message with %O %O.\n", foo, bar); //! @end example { if (sizeof (args2)) msg2 = sprintf (msg2, @args2); if (msg1) { if (sizeof (args1)) msg1 = sprintf (msg1, @args1); parse_error (msg1 + ": " + msg2); } else parse_error (msg2); } /*static*/ final mixed indirect_convert (mixed val, Type from) //! Converts @[val], which is a value of the type @[from], to this //! type. Uses indirect conversion via @[conversion_type] as //! necessary. Only intended as a helper function for @[encode], so //! it won't do a direct conversion from @[conversion_type] to this //! type. Throws RXML parse error on any conversion error. { if (conversion_type) { if (from->conversion_type) { string fromconvname = from->conversion_type->name; if (conversion_type->name == fromconvname) return encode (from->decode ? from->decode (val) : val, conversion_type); if (this_object()->name == fromconvname) return from->decode ? from->decode (val) : val; } string name = this_object()->name; if (name == from->name) return val; // The following is not terribly efficient, but most situations // should be handled by the special cases above. int levels = 1; for (Type conv = from->conversion_type; conv; conv = conv->conversion_type, levels++) if (conv->name == name) { while (levels--) { val = from->decode ? from->decode (val) : val; from = from->conversion_type; } return val; } if (conversion_type->conversion_type && conversion_type->conversion_type->name == from->name) // indirect_convert should never do the job of encode. return encode (conversion_type->encode (val, from), conversion_type); else { #ifdef MODULE_DEBUG if (conversion_type->name == from->name) error ("This function shouldn't be used to convert " "from the conversion type %s to %s; use encode() for that.\n", conversion_type->name, this_object()->name); #endif return encode (conversion_type->indirect_convert (val, from), conversion_type); } } parse_error ("Cannot convert type %s to %s.\n", from->name, this_object()->name); } // Internals program/*(Parser)HMM*/ _parser_prog = PNone; // The parser to use. Should never be changed in a type object. /*private*/ array(mixed) _parser_args = ({}); /*private*/ mapping(program:Type) _t_obj_cache; // To avoid creating new type objects all the time in `(). // Cache used for parsers that doesn't depend on the tag set. private Parser clone_parser; // Used with Parser.clone(). private Parser free_parser; // The list of objects to reuse with Parser.reset(). // Cache used for parsers that depend on the tag set. /*private*/ mapping(TagSet:PCacheObj) _p_cache; MARK_OBJECT_ONLY; string _sprintf() {return "RXML.Type(" + this_object()->name + ")" + OBJ_COUNT;} } static class PCacheObj { int tag_set_gen; Parser clone_parser; Parser free_parser; } // Special types. TAny t_any = TAny(); //! A completely unspecified nonsequential type. Every type is a //! subtype of this one. //! //! This type is also special in that any value can be converted to //! and from this type without the value getting changed in any way, //! which means that the meaning of a value might change when this //! type is used as a middle step. //! //! E.g if @tt{"<foo>"@} of type @[RXML.t_text] is converted directly //! to @[RXML.t_xml], it's quoted to @tt{"<foo>"@}, since //! @[RXML.t_text] always is literal text. However if it's first //! converted to @[RXML.t_any] and then to @[RXML.t_xml], it still //! remains @tt{"<foo>"@}, which then carries a totally different //! meaning. static class TAny { inherit Type; constant name = "*"; constant conversion_type = 0; constant free_text = 1; // FIXME: Temporary measure. mixed encode (mixed val, void|Type from) { return val; } string _sprintf() {return "RXML.t_any" + OBJ_COUNT;} } TNil t_nil = TNil(); //! A sequential type accepting only the value nil. This type is by //! definition a subtype of every other type. static class TNil { inherit Type; constant name = "nil"; constant sequential = 1; Nil empty_value = nil; Type conversion_type = 0; void type_check (mixed val, void|string msg, mixed... args) { if (val != nil) type_check_error (msg, args, "Expected nil, got %t.\n", val); } Nil encode (mixed val, void|Type from) { if (from && from != local::name) val = indirect_convert (val, from); #ifdef MODULE_DEBUG type_check (val); #endif return nil; } int subtype_of (Type other) {return 1;} string _sprintf() {return "RXML.t_nil" + OBJ_COUNT;} } TSame t_same = TSame(); //! A magic type used in Tag.content_type. static class TSame { inherit Type; constant name = "same"; string _sprintf() {return "RXML.t_same" + OBJ_COUNT;} } // Basic types. Even though most of these have a `+ that fulfills // requirements to make them sequential, we don't want all those to be // treated that way. It would imply that a sequence of e.g. integers // are implicitly added together, which would be nonintuitive. TScalar t_scalar = TScalar(); //! Any type of scalar, i.e. text or number. It's not sequential, as //! opposed to the subtype @[RXML.t_string]. //! //! FIXME: This is currently not labeled as a supertype for t_string //! and t_num, so it's only marginally useful. It's name will probably //! change. static class TScalar { inherit Type; constant name = "scalar"; constant sequential = 0; Nil empty_value = nil; Type conversion_type = 0; void type_check (mixed val, void|string msg, mixed... args) { if (!stringp (val) && !intp (val) && !floatp (val)) type_check_error (msg, args, "Expected scalar value, got %t.\n", val); } string|int|float encode (mixed val, void|Type from) { if (from) switch (from->name) { case TAny.name: type_check (val); // Fall through. case local::name: return [string|int|float] val; default: return [string|int|float] indirect_convert (val, from); } if (!stringp (val) && !intp (val) && !floatp (val)) // Cannot unambigiously use a cast for this type. parse_error ("Cannot convert value of type %t to scalar.\n", val); return [string|int|float] val; } string _sprintf() {return "RXML.t_scalar" + OBJ_COUNT;} } TNum t_num = TNum(); //! Type for any number, currently integer or float. //! //! FIXME: This is currently not labeled as a supertype for t_int and //! t_float, so it's only marginally useful. It's name will probably //! change. static class TNum { inherit Type; constant name = "number"; constant sequential = 0; constant empty_value = 0; Type conversion_type = t_scalar; void type_check (mixed val, void|string msg, mixed... args) { if (!intp (val) && !floatp (val)) type_check_error (msg, args, "Expected numeric value, got %t.\n", val); } int|float encode (mixed val, void|Type from) { if (from) switch (from->name) { case TAny.name: type_check (val); // Fall through. case local::name: return [int|float] val; default: return [int|float] indirect_convert (val, from); case TScalar.name: } if (stringp (val)) if (sscanf (val, "%d%*c", int i) == 1) return i; else if (sscanf (val, "%f%*c", float f) == 1) return f; else parse_error ("String contains neither integer nor float.\n"); if (!intp (val) && !floatp (val)) // Cannot unambigiously use a cast for this type. parse_error ("Cannot convert value of type %t to number.\n", val); return [int|float] val; } string _sprintf() {return "RXML.t_num" + OBJ_COUNT;} } TInt t_int = TInt(); //! Type for integers. static class TInt { inherit Type; constant name = "int"; constant sequential = 0; constant empty_value = 0; Type conversion_type = t_scalar; void type_check (mixed val, void|string msg, mixed... args) { if (!intp (val)) type_check_error (msg, args, "Expected integer value, got %t.\n", val); } int encode (mixed val, void|Type from) { if (from) switch (from->name) { case TAny.name: type_check (val); // Fall through. case local::name: return [int] val; default: return [int] indirect_convert (val, from); case TScalar.name: } if (stringp (val)) if (sscanf (val, "%d%*c", int i) == 1) return i; else parse_error ("String does not contain an integer.\n"); mixed err = catch {return (int) val;}; parse_error ("Cannot convert value to integer: " + describe_error (err)); } string _sprintf() {return "RXML.t_int" + OBJ_COUNT;} } TFloat t_float = TFloat(); //! Type for floats. static class TFloat { inherit Type; constant name = "float"; constant sequential = 0; constant empty_value = 0; Type conversion_type = t_scalar; void type_check (mixed val, void|string msg, mixed... args) { if (!floatp (val)) type_check_error (msg, args, "Expected float value, got %t.\n", val); } float encode (mixed val, void|Type from) { if (from) switch (from->name) { case TAny.name: type_check (val); // Fall through. case local::name: return [float] val; default: return [float] indirect_convert (val, from); case TScalar.name: } if (stringp (val)) if (sscanf (val, "%f%*c", float f) == 1) return f; else parse_error ("String does not contain a float.\n"); mixed err = catch {return (float) val;}; parse_error ("Cannot convert value to float: " + describe_error (err)); } string _sprintf() {return "RXML.t_float" + OBJ_COUNT;} } // Text types. TString t_string = TString(); //! Any type of string; acts as a supertype for all text types. //! //! Conversion to and from this type and other text types is similar //! to @[RXML.t_any] in that the value doesn't change, which means //! that its meaning might change (for an example see the doc for //! @[RXML.t_any]). This implies that strings produced by tags etc //! (which are typically literal) should be given the type //! @[RXML.t_text] and not this type, so that they get correctly //! encoded when inserted into e.g. XML markup. static class TString { inherit Type; constant name = "text/*"; constant sequential = 1; constant empty_value = ""; Type conversion_type = t_scalar; constant free_text = 1; void type_check (mixed val, void|string msg, mixed... args) { if (!stringp (val)) type_check_error (msg, args, "Expected string for %s, got %t.\n", name, val); } string encode (mixed val, void|Type from) { if (from) switch (from->name) { case TAny.name: type_check (val); // Fall through. case local::name: return [string] val; default: if (from->subtype_of (this_object())) { #ifdef MODULE_DEBUG type_check (val); #endif return [string] val; } return [string] indirect_convert (val, from);

Roxen.git/ server/ etc/ modules/ RXML.pmod/ module.pmod > ed775f34fa997dd8c5c7ce0fa6711dd75fddc70d [Annotate]