Roxen.git/server/etc/modules/RXML.pmod/module.pmod:84e69554bbc31aaa0804f2d9aa09ec3482d1afca

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 //! RXML parser and compiler framework. //! //! Created 1999-07-30 by Martin Stjernholm. //! //! $Id: module.pmod,v 1.47 2000/02/08 21:24:56 nilsson Exp $ //! Kludge: Must use "RXML.refs" somewhere for the whole module to be //! loaded correctly. //! WARNING: This API is not yet set in stone; expect incompatible //! changes. //#pragma strict_types // Disabled for now since it doesn't work well enough. #ifdef OBJ_COUNT_DEBUG // This debug mode gives every object a unique number in the // _sprintf() string. # define DECLARE_CNT(count) static int count = ++all_constants()->_obj_count # define PAREN_CNT(count) ("(" + (count) + ")") # define COMMA_CNT(count) ("," + (count)) #else # define DECLARE_CNT(count) # define PAREN_CNT(count) "" # define COMMA_CNT(count) "" #endif 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 HTML-style entities. Type content_type = t_same (PHtml); //! The handled type of the content, if the tag gets any. //! //! This default is the special type t_same, which means the type is //! taken from the effective type of the result. The PHtml argument //! causes the HTML parser to be used to read it, which means that //! the content is preparsed with HTML syntax. Use no parser to get //! the raw text. 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 //! gotten from Frame.do_return (see that function for details). //!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 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_return(). The //! argument values and the content are normally not parsed. //! //! Note: Never reuse the same frame object. { Tag this = this_object(); object/*(Frame)HMM*/ frame = ([function(:object/*(Frame)HMM*/)] this->Frame)(); frame->tag = this; frame->flags = flags; frame->args = args; if (!zero_type (content)) frame->content = content; 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)); rxml_fatal ("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) error ("Can't save parser state when evaluating arguments.\n"); throw (err); } #endif return 1; } // Internals. array _handle_tag (TagSetParser parser, mapping(string:string) args, void|string content) // Callback for tag set parsers. Returns a sequence of result values // to be added to the result queue. Note that this function handles // an unwind frame for the parser. { Context ctx = parser->context; // FIXME: P-code generation. object/*(Frame)HMM*/ frame; 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; } else frame = `() (args, Void); else frame = `() (args, Void); mixed err = catch { frame->_eval (parser, args, content); mixed res; if ((res = frame->result) == Void) return ({}); if (frame->result_type->quoting_scheme != parser->type->quoting_scheme) res = parser->type->quote (res); 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) error ("Internal error: Unexpected unwind object catched.\n"); if (ustate[parser]) error ("Internal error: Clobbering unwind state for parser.\n"); #endif ustate[parser] = ({err}); err = parser; } throw (err); } DECLARE_CNT (__count); string _sprintf() { return "RXML.Tag(" + [string] this_object()->name + COMMA_CNT (__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. { 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. #define LOW_TAG_TYPE \ string|array| \ function(:int(1..1)|string|array)| \ function(object,mapping(string:string):int(1..1)|string|array) #define LOW_CONTAINER_TYPE \ string|array| \ function(:int(1..1)|string|array)| \ function(object,mapping(string:string),string:int(1..1)|string|array) #define LOW_ENTITY_TYPE \ string|array| \ function(:int(1..1)|string|array)| \ function(object:int(1..1)|string|array) mapping(string:LOW_TAG_TYPE) low_tags; mapping(string:LOW_CONTAINER_TYPE) low_containers; mapping(string:LOW_ENTITY_TYPE) low_entities; //! Passed directly to Parser.HTML when that parser is used. This is //! intended for compatibility only and might eventually be removed. //! Note: Changes in these aren't tracked; changed() must be called. static void create (string _name, void|array(Tag) _tags) //! { name = _name; if (_tags) foreach (_tags, Tag tag) if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag; } void add_tag (Tag tag) //! { 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) if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag; changed(); } void remove_tag (string|Tag tag) //! { if (stringp (tag)) m_delete (tags, tag); else for (string n; !zero_type (n = search (tags, [object(Tag)] tag));) m_delete (tags, n); changed(); } local Tag|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) get_local_tag (string name) //! Returns the tag definition for the given name in this tag set. //! The return value is either a Tag object or an array ({low_tag, //! low_container}), where one element always is zero. { if (Tag tag = tags[name]) return tag; else if (LOW_CONTAINER_TYPE cdef = low_containers && low_containers[name]) return ({0, cdef}); else if (LOW_TAG_TYPE tdef = low_tags && low_tags[name]) return ({tdef, 0}); else return 0; } array(Tag) get_local_tags() //! Doesn't return the low tag/container definitions. { return values (tags); } Tag|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) get_tag (string name) //! Returns the active tag definition for the given name. The return //! value is the same as for get_local_tag(). { if (object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) def = get_local_tag (name)) return def; foreach (imported, TagSet tag_set) if (object(Tag) tag = [object(Tag)] tag_set->get_tag (name)) return tag; return 0; } Tag|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) get_overridden_tag ( Tag|LOW_TAG_TYPE|LOW_CONTAINER_TYPE tagdef, void|string name) //! Returns the tag definition that the given one overrides, or zero //! if none. tag is a Tag object or a low tag/container definition. //! In the latter case, the tag name must be given as the second //! argument. The return value is the same as for get_local_tag(). { if (objectp (tagdef) && ([object] tagdef)->is_RXML_Tag) name = [string] ([object] tagdef)->name; #ifdef MODULE_DEBUG if (!name) error ("Need tag name.\n"); #endif if (tags[name] == tagdef || (low_containers && low_containers[name] == tagdef) || (low_tags && low_tags[name] == tagdef)) { foreach (imported, TagSet tag_set) if (object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) tagdef = tag_set->get_tag (name)) return tagdef; } else { int found = 0; foreach (imported, TagSet tag_set) if (object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) subtag = tag_set->get_tag (name)) if (found) return subtag; else if (arrayp (subtag) ? subtag[0] == tagdef || subtag[1] == tagdef : subtag == tagdef) if ((subtag = tag_set->get_overridden_tag (tagdef, name))) return subtag; else found = 1; } return 0; } array(Tag|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE)) get_overridden_tags (string name) //! Returns all tag definitions for the given name, i.e. including //! the overridden ones. A tag to the left overrides one to the //! right. The elements in the returned array are the same as for //! get_local_tag(). { if (object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) def = get_local_tag (name)) return ({def}) + imported->get_overridden_tags (name) * ({}); else return imported->get_overridden_tags (name) * ({}); } multiset(string) get_tag_names() //! { multiset(string) res = (multiset) indices (tags); if (low_tags) res |= (multiset) indices (low_tags); if (low_containers) res |= (multiset) indices (low_containers); return `| (res, @imported->get_tag_names()); } mapping(string:Tag) get_plugins (string name) //! Returns the registered plugins for the given tag name. Don't be //! destructive on the returned mapping. { mapping(string:Tag) res; if ((res = plugins[name])) return res; low_get_plugins (name + "#", res = ([])); return plugins[name] = res; } mixed `->= (string var, mixed val) { switch (var) { case "imported": (imported - ({0}))->dont_notify (changed); imported = [array(TagSet)] val; imported->do_notify (changed); break; default: ::`->= (var, val); } changed(); return val; } 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}); prepare_funs (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; plugins = ([]); (notify_funcs -= ({0}))(); set_weak_flag (notify_funcs, 1); } // 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 = ([]); // Private since we want to track changes in this. 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(string:mapping(string:Tag)) 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. } DECLARE_CNT (__count); string _sprintf() { return name ? "RXML.TagSet(" + name + COMMA_CNT (__count) + ")" : "RXML.TagSet" + PAREN_CNT (__count); } } 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. //! //! 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 type->convert(value), //! since that function does just that. { 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 could be used instead of rxml_var_eval. { return 0; } string _sprintf() {return "RXML.Value";} } class Scope //! Interface for objects that emulates a scope mapping. { mixed `[] (string var, void|Context ctx, void|string scope_name) {rxml_fatal ("Cannot query variable" + _in_the_scope (scope_name) + ".\n");} mixed `[]= (string var, mixed val, void|Context ctx, void|string scope_name) {rxml_fatal ("Cannot set variable" + _in_the_scope (scope_name) + ".\n");} array(string) _indices (void|Context ctx, void|string scope_name) {rxml_fatal ("Cannot list variables" + _in_the_scope (scope_name) + ".\n");} void m_delete (string var, void|Context ctx, void|string scope_name) {rxml_fatal ("Cannot delete variable" + _in_the_scope (scope_name) + ".\n");} 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. 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. int tag_set_is_local; //! Nonzero if tag_set is a copy local to this context. A local tag //! set that imports the old tag set is created whenever need be. array parse_user_var (string var, void|string scope_name) //! Tries to decide what variable and scope to use. Handles cases //! where the variable also contains the scope, e.g. "scope.var". { if(!var || !sizeof(var)) return ([])[0]; array(string) splitted=var/"."; if(sizeof(splitted)>2) return ([])[0]; if(sizeof(splitted)==2) scope_name=splitted[0]; else scope_name = scope_name || "_"; return ({ scope_name, splitted[-1] }); } local mixed get_var (string 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. //! //! If the type argument is set, the value is converted to that type //! with Type.convert(). If the value can't be converted, an RXML //! error is thrown. { if (SCOPE_TYPE vars = scopes[scope_name || "_"]) { mixed val; if (objectp (vars)) { if (zero_type (val = ([object(Scope)] vars)->`[] ( var, this_object(), scope_name || "_")) || val == Void) return ([])[0]; } else if (zero_type (val = vars[var])) return ([])[0]; if (objectp (val) && ([object] val)->rxml_var_eval) { return zero_type (val = ([object(Value)] val)->rxml_var_eval ( this_object(), var, scope_name || "_", want_type)) || val == Void ? ([])[0] : val; } else if (want_type) return // FIXME: Some system to find out the source type? zero_type (val = want_type->convert (val)) || val == Void ? ([])[0] : val; else return val; } else if (scope_name) rxml_fatal ("Unknown scope %O.\n", scope_name); else rxml_fatal ("No current scope.\n"); } mixed user_get_var (string var, void|string scope_name, void|Type want_type) //! As get_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var". { if(!var || !sizeof(var)) return ([])[0]; array(string) splitted=var/"."; if(sizeof(splitted)>2) return ([])[0]; if(sizeof(splitted)==2) scope_name=splitted[0]; else scope_name = scope_name || "_"; return get_var(splitted[-1], scope_name, want_type); } local mixed set_var (string 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 (SCOPE_TYPE vars = scopes[scope_name || "_"]) if (objectp (vars)) return ([object(Scope)] vars)->`[]= (var, val, this_object(), scope_name || "_"); else return vars[var] = val; else if (scope_name) rxml_fatal ("Unknown scope %O.\n", scope_name); else rxml_fatal ("No current scope.\n"); } mixed user_set_var (string var, mixed val, void|string scope_name) //! As set_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var". { if(!var || !sizeof(var)) return val; array(string) splitted=var/"."; if(sizeof(splitted)>2) return val; if(sizeof(splitted)==2) scope_name=splitted[0]; else scope_name = scope_name || "_"; return set_var(splitted[-1], val, scope_name); } local void delete_var (string var, void|string scope_name) //! Removes a variable in the specified scope, or the current scope //! if none is given. { if (SCOPE_TYPE vars = scopes[scope_name || "_"]) if (objectp (vars)) ([object(Scope)] vars)->m_delete (var, this_object(), scope_name || "_"); else m_delete ([mapping(string:mixed)] vars, var); else if (scope_name) rxml_fatal ("Unknown scope %O.\n", scope_name); else rxml_fatal ("No current scope.\n"); } void user_delete_var (string var, void|string scope_name) //! As delete_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var". { if(!var || !sizeof(var)) return; array(string) splitted=var/"."; if(sizeof(splitted)>2) return; if(sizeof(splitted)==2) scope_name=splitted[0]; else scope_name = scope_name || "_"; delete_var(splitted[-1], scope_name); } 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 (scope_name) rxml_fatal ("Unknown scope %O.\n", scope_name); else rxml_fatal ("No current scope.\n"); } 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) 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 == "_") 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. It will have effect in the current parser //! and parent parsers up to the point where tag_set changes. { if (!new_runtime_tags) new_runtime_tags = RuntimeTags(); new_runtime_tags->add_tags[tag] = 1; // By doing the following, we can let remove_tags take precedence. new_runtime_tags->remove_tags[tag] = 0; new_runtime_tags->remove_tags[tag->name] = 0; } void remove_runtime_tag (string|Tag tag) //! Removes a tag added by add_runtime_tag(). It will have effect in //! the current parser and parent parsers up to the point where //! tag_set changes. { if (!new_runtime_tags) new_runtime_tags = RuntimeTags(); new_runtime_tags->remove_tags[tag] = 1; } string describe_rxml_backtrace (Frame f, void|string current_var) //! Returns a formatted backtrace from the given frame. If //! current_var is specified, it's taken to be the a variable entity //! being parsed on top of the frame. { string msg = current_var ? " | &" + current_var + ";\n" : ""; for (; f; f = f->up) { if (f->tag) msg += " | <" + f->tag->name; else if (!f->up) break; else msg += " | <(unknown tag)"; if (f->args) foreach (sort (indices (f->args)), string arg) { mixed val = f->args[arg]; msg += " " + arg + "="; if (arrayp (val)) msg += map (val, error_print_val) * ","; else msg += error_print_val (val); } else msg += " (no argmap)"; msg += ">\n"; } return msg; } void rxml_error (string msg, mixed... args) //! Throws an RXML error with a dump of the parser stack. 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); msg = rxml_error_prefix + ": " + msg + describe_rxml_backtrace (frame, current_var); array b = backtrace(); throw (({msg, b[..sizeof (b) - 2]})); } void rxml_fatal (string msg, mixed... args) //! Throws an RXML fatal error with a dump of the parser stack. 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); msg = rxml_fatal_prefix + ": " + msg + describe_rxml_backtrace (frame, current_var); array b = backtrace(); throw (({msg, b[..sizeof (b) - 2]})); } 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++; string msg = describe_error (err); int error = msg[..sizeof (rxml_error_prefix) - 1] == rxml_error_prefix; if (error || msg[..sizeof (rxml_fatal_prefix) - 1] == rxml_fatal_prefix) { // An RXML error. while (evaluator->_parent) { evaluator->error_count++; evaluator = evaluator->_parent; } if (id && id->conf) msg = (error ? ([function(mixed,Type:string)] ([object] id->conf)->handle_rxml_error) : ([function(mixed,Type:string)] ([object] id->conf)->handle_rxml_fatal) ) (err, evaluator->type); else { #ifdef MODULE_DEBUG report_notice (describe_backtrace (err)); #else report_notice (msg); #endif } if (msg && evaluator->type->free_text && evaluator->report_error) evaluator->report_error (msg); } else throw (err); } // Internals. constant rxml_error_prefix = "RXML error"; constant rxml_fatal_prefix = "RXML fatal"; 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 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) 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) error ("Internal error: Frame has no variables.\n"); #endif if (!hidden[frame]) if (string scope_name = [string] frame->scope_name) { hidden[frame] = ({scopes["_"], scopes[scope_name]}); scopes["_"] = scopes[scope_name] = [SCOPE_TYPE] frame->vars; } else { 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)) 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)) void make_tag_set_local() { if (!tag_set_is_local) { TagSet new_tag_set = TagSet (tag_set->name + " (local)"); // FIXME: Cache this? new_tag_set->imported = ({tag_set}); tag_set = new_tag_set; tag_set_is_local = 1; } } class RuntimeTags { multiset(Tag) add_tags = (<>); multiset(Tag|string) remove_tags = (<>); } RuntimeTags 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; } 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_return() with this stream piece.) // "exec_left": array (Exec array left to evaluate. Only used // between Frame._exec_array() and Frame._eval().) DECLARE_CNT (__count); string _sprintf() {return "RXML.Context" + PAREN_CNT (__count);} #ifdef MODULE_DEBUG int in_use; #endif } //! 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(); inline void set_context (Context ctx) {_context->set (ctx);} inline Context get_context() {return [object(Context)] _context->get();} #else private Context _context; inline void set_context (Context ctx) {_context = ctx;} inline Context get_context() {return _context;} #endif #ifdef MODULE_DEBUG // 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 && __old_ctx != ctx) \ error ("Attempt to use context asynchronously.\n"); \ ctx->in_use = 1; \ } #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 // Global services. void rxml_error (string msg, mixed... args) //! Tries to throw an error with rxml_error() in the current context. { Context ctx = get_context(); if (ctx && ctx->rxml_error) ctx->rxml_error (msg, @args); else { if (sizeof (args)) msg = sprintf (msg, @args); msg = Context.rxml_error_prefix + " (no context): " + msg; array b = backtrace(); throw (({msg, b[..sizeof (b) - 2]})); } } void rxml_fatal (string msg, mixed... args) //! Tries to throw a fatal error with rxml_fatal() in the current //! context. { Context ctx = get_context(); if (ctx && ctx->rxml_fatal) ctx->rxml_fatal (msg, @args); else { if (sizeof (args)) msg = sprintf (msg, @args); msg = Context.rxml_fatal_prefix + " (no context): " + msg; array b = backtrace(); throw (({msg, b[..sizeof (b) - 2]})); } } Frame make_tag (string name, mapping(string:mixed) args, void|mixed content) //! Returns a frame for the specified tag. The tag definition is //! looked up in the current context and tag set. args and content are //! not parsed or evaluated. { TagSet tag_set = get_context()->tag_set; object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) tag = tag_set->get_tag (name); if (arrayp (tag)) error ("Getting frames for low level tags are currently not implemented.\n"); return tag (args, content); } Frame make_unparsed_tag (string name, mapping(string:string) args, void|string content) //! Returns a frame for the specified tag. 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. { TagSet tag_set = get_context()->tag_set; object(Tag)|array(LOW_TAG_TYPE|LOW_CONTAINER_TYPE) tag = tag_set->get_tag (name); if (arrayp (tag)) error ("Getting frames for low level tags are currently not implemented.\n"); Frame frame = tag (args, content); frame->flags |= FLAG_UNPARSED; return frame; } //! Constants for the bit field RXML.Frame.flags. constant FLAG_NONE = 0x00000000; //! The no-flags flag. In case you think 0 is too ugly. ;) //! Static flags (i.e. tested in the Tag object). constant FLAG_CONTAINER = 0x00000001; //! If set, the tag accepts non-empty content. E.g. with the standard //! HTML parser this defines whether the tag is a container or not. constant FLAG_NO_PREFIX = 0x00000002; //! Never apply any prefix to this tag. constant FLAG_SOCKET_TAG = 0x0000004; //! 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 PHtml parser. This is only //! used in the simple tag wrapper. Defined here as placeholder. constant FLAG_POSTPARSE = 0x00000080; //! Postparse the result with the PHtml 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, the array from do_return() and cached_return() 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_return() 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_return() will be called repeatedly with successive parts of the //! content then. Can't be changed from do_return(). //! 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; //! 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; not //! yet implemented. 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_SAME_STACK = 0x00100000; //! If set, the stack of call frames needs to be the same. constant FLAG_CACHE_EXECUTE_RESULT = 0x00200000; //! If set, an array to execute will be stored in the frame instead of //! the final result. On a cache hit it'll be executed like the return //! value from do_return() to produce the result. constant FLAG_UNPARSED = 0x80000000; //! Only used internally. Signifies that args and content in the frame //! contain unparsed strings. class Frame //! A tag instance. { 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 the array returned from //! do_return() in 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. mapping(string:mixed) args; //! The arguments passed to the tag. Set before //! do_enter()/do_return() are called. Type content_type; //! The type of the content. mixed content = Void; //! The content. Set before do_return() is called, but only when the //! tag is actually used with container syntax. Type result_type; //! The required result type. Set before do_enter()/do_return() are //! called. do_return() should produce a result of this type. mixed result = Void; //! The result. //!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). It must be set in do_iterate() or earlier. //!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. //!array do_enter (RequestID id); //!array do_return (RequestID id, void|mixed piece); //! do_enter() is called first thing when processing the tag. //! do_return() is called after the content (if any) is processed. //! //! 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_return() is called after each iteration. //! //! The result_type variable is set to the type of result the parser //! wants. It's any type that is valid by tag->result_type. 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 Void, 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. FIXME: Somehow represent //! removal of headers? //! 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. //! //! 0 - Do nothing special. Exits the tag when used from //! do_return() 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 do_return is zero, the value in the result variable //! is simply used. If the result variable is Void, content is used //! as result if it's of a compatible type. //! //! Regarding do_return only: //! //! Normally the content variable is set to the parsed content of //! the tag before do_return() is called. This may be Void if the //! content parsing didn't produce any result. //! //! If the result from parsing the content is not Void, it's //! assigned to or added to the content variable. Assignment is used //! if the content type is nonsequential, addition otherwise. Thus //! earlier values are simply overridden for nonsequential types. //! //! 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_return() 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_return() 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_return() 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 no pass is done. //! If do_iterate is missing, one 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. void rxml_error (string msg, mixed... args) //! Throws an RXML error from 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. { get_context()/*HMM*/->rxml_error (msg, @args); } void rxml_fatal (string msg, mixed... args) //! Throws an RXML fatal error from 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. { get_context()/*HMM*/->rxml_fatal (msg, @args); } void terminate() //! Makes the parser abort. The data parsed so far will be returned. //! Does not return; throws a special exception instead. { error ("FIXME\n"); } void suspend() //! Used together with resume() for nonblocking mode. May be called //! from do_enter() or do_return() 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. { error ("FIXME\n"); } void resume() //! Makes the parser continue where it left off. The function that //! called suspend() will be called again. { 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 (!(flags & FLAG_SOCKET_TAG)) error ("This tag is not a socket tag.\n"); #endif return get_context()->tag_set->get_plugins (tag->name); } // Internals. mixed _exec_array (TagSetParser parser, array exec) { Frame this = this_object(); Context ctx = parser->context; int i = 0; mixed res = Void; Parser subparser = 0; mixed err = catch { if (flags & FLAG_PARENT_SCOPE) LEAVE_SCOPE (ctx, this); for (; i < sizeof (exec); i++) { mixed elem = exec[i], piece = Void; switch (sprintf ("%t", elem)) { case "string": if (result_type->_parser_prog == PNone) piece = elem; else { subparser = result_type->get_parser (ctx); subparser->_parent = parser; subparser->finish ([string] elem); // Might unwind. piece = subparser->eval(); // Might unwind. subparser = 0; } break; case "object": if (([object] elem)->is_RXML_Frame) { ([object(Frame)] elem)->_eval (0); // Might unwind. piece = ([object(Frame)] elem)->result; } else if (([object] elem)->is_RXML_Parser) { // The subparser above unwound. ([object(Parser)] elem)->finish(); // Might unwind. piece = ([object(Parser)] elem)->eval(); // Might unwind. } else error ("File objects not yet implemented.\n"); break; case "mapping": error ("Header mappings not yet implemented.\n"); break; case "multiset": if (sizeof ([multiset] elem) == 1) piece = ((array) elem)[0]; else if (sizeof ([multiset] elem) > 1) error (sizeof ([multiset] elem) + " values in multiset in exec array.\n"); else error ("No value in multiset in exec array.\n"); break; default: error ("Invalid type %t in exec array.\n", elem); } if (result_type->sequential) res += piece; else if (piece != Void) result = res = piece; } if (result_type->sequential) result += res; if (flags & FLAG_PARENT_SCOPE) ENTER_SCOPE (ctx, this); return res; }; if (result_type->sequential) result += res; if (objectp (err) && ([object] err)->thrown_at_unwind) { 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->quoting_scheme != parser->type->quoting_scheme) res = parser->type->quote (res); if (result_type->sequential) ustate->stream_piece = res + ustate->stream_piece; else if (ustate->stream_piece == Void) 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); } private void _handle_runtime_tags (TagSetParser parser, Context.RuntimeTags runtime_tags) { // FIXME: PCode handling. multiset(string|Tag) rem_tags = runtime_tags->remove_tags; multiset(Tag) add_tags = runtime_tags->add_tags - rem_tags; if (sizeof (rem_tags)) foreach (indices (add_tags), Tag tag) if (rem_tags[tag->name]) add_tags[tag] = 0; array(string|Tag) arr_rem_tags = (array) rem_tags; array(Tag) arr_add_tags = (array) add_tags; for (Parser p = parser; p; p = p->_parent) if (p->tag_set_eval) { foreach (arr_add_tags, Tag tag) ([object(TagSetParser)] p)->add_runtime_tag (tag); foreach (arr_rem_tags, string|object(Tag) tag) ([object(TagSetParser)] p)->remove_runtime_tag (tag); } } void _eval (TagSetParser parser, void|mapping(string:string) raw_args, void|string raw_content) // Note: It might be somewhat tricky to override this function. { Frame this = this_object(); Context ctx = parser->context; // Unwind state data: //raw_content #define ESTATE_BEGIN 0 #define ESTATE_ENTERED 1 #define ESTATE_LAST_ITER 2 int eval_state = ESTATE_BEGIN; int iter; Parser subparser; mixed piece; array exec; int tags_added; // Flag that we added additional_tags to ctx->tag_set. //ctx->new_runtime_tags #define PRE_INIT_ERROR(X) (ctx->frame = this, 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 (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 = Void; #ifdef MODULE_DEBUG if (!stringp (raw_content)) PRE_INIT_ERROR ("Content is not a string in unparsed tag frame.\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, tags_added, ctx->new_runtime_tags] = state; m_delete (ctx->unwind_state, this); if (!sizeof (ctx->unwind_state)) ctx->unwind_state = 0; } else { #ifdef MODULE_DEBUG if (up && up != ctx->frame) PRE_INIT_ERROR ("Reuse of frame in different context.\n"); #endif up = ctx->frame; piece = Void; } #undef PRE_INIT_ERROR ctx->frame = this; if (raw_args) { args = 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)); rxml_fatal ("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 (args), string arg) args[arg] = (atypes[arg] || tag->def_arg_type)-> eval (raw_args[arg], ctx, 0, parser, 1); // Should not unwind. #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) error ("Can't save parser state when evaluating arguments.\n"); throw (err); } #endif } #ifdef DEBUG if (!args) error ("Internal error: args not set.\n"); #endif if (TagSet add_tags = raw_content && [object(TagSet)] this->additional_tags) { if (!ctx->tag_set_is_local) ctx->make_tag_set_local(); if (search (ctx->tag_set->imported, add_tags) < 0) { ctx->tag_set->imported = ({add_tags}) + ctx->tag_set->imported; tags_added = 1; } } if (!result_type) { Type ptype = parser->type; foreach (tag->result_types, Type rtype) if (ptype->subtype_of (rtype)) {result_type = rtype; break;} if (!result_type) // Sigh.. rxml_fatal ( "Tag returns " + String.implode_nicely ([array(string)] tag->result_types->name, "or") + " but " + [string] parser->type->name + " is expected.\n"); } if (!content_type) { content_type = tag->content_type; if (content_type == t_same) content_type = result_type (content_type->_parser_prog); } mixed err = catch { if (eval_state == ESTATE_BEGIN) if (array|function(RequestID,void|mixed:array) do_enter = [array|function(RequestID,void|mixed:array)] this->do_enter) { if (!exec) exec = do_enter (ctx->id); // Might unwind. if (exec) { mixed res = _exec_array (parser, exec); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (ctx->unwind_state) error ("Internal error: Clobbering unwind_state to do streaming.\n"); if (piece != Void) error ("Internal error: Thanks, we think about how nice it must " "be to play the harmonica...\n"); #endif if (result_type->quoting_scheme != parser->type->quoting_scheme) res = parser->type->quote (res); ctx->unwind_state = (["stream_piece": res]); throw (this); } } } eval_state = ESTATE_ENTERED; do { if (eval_state != ESTATE_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 = ESTATE_LAST_ITER; } else if (!(iter = (/*[function(RequestID:int)]HMM*/ do_iterate ) (ctx->id))) // Might unwind. eval_state = ESTATE_LAST_ITER; } ENTER_SCOPE (ctx, this); for (; iter > 0; iter--) { if (raw_content) { // Got nested parsing to do. if (ctx->new_runtime_tags) { // Empty this first in case do_enter() set it. _handle_runtime_tags (parser, ctx->new_runtime_tags); ctx->new_runtime_tags = 0; } int finished = 0; if (!subparser) { // The nested content is not yet parsed. subparser = content_type->get_parser ( ctx, [object(TagSet)] this->local_tags); subparser->_parent = parser; 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 == Void) piece = res; if (piece != Void) { array|function(RequestID,void|mixed:array) do_return; if ((do_return = [array|function(RequestID,void|mixed:array)] this->do_return) && functionp (do_return)) { if (!exec) exec = do_return (ctx->id, piece); // Might unwind. if (exec) { mixed res = _exec_array (parser, exec); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (!zero_type (ctx->unwind_state->stream_piece)) error ("Internal error: " "Clobbering unwind_state->stream_piece.\n"); #endif if (result_type->quoting_scheme != parser->type->quoting_scheme) res = parser->type->quote (res); ctx->unwind_state->stream_piece = res; throw (this); } exec = 0; } else if (flags & FLAG_STREAM_RESULT) { // do_return() finished the stream. Ignore remaining content. ctx->unwind_state = 0; piece = Void; break; } } piece = Void; } if (finished) break; } else { // The frame doesn't handle streamed content. piece = Void; if (finished) { mixed res = subparser->eval(); // Might unwind. if (content_type->sequential) content += res; else if (res != Void) 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_return = [array|function(RequestID,void|mixed:array)] this->do_return) { if (!exec) exec = functionp (do_return) ? ([function(RequestID,void|mixed:array)] do_return) ( ctx->id) : // Might unwind. [array] do_return; if (exec) { mixed res = _exec_array (parser, exec); // Might unwind. if (flags & FLAG_STREAM_RESULT) { #ifdef DEBUG if (ctx->unwind_state) error ("Internal error: Clobbering unwind_state to do streaming.\n"); if (piece != Void) error ("Internal error: Thanks, we think about how nice it must " "be to play the harmonica...\n"); #endif if (result_type->quoting_scheme != parser->type->quoting_scheme) res = parser->type->quote (res); ctx->unwind_state = (["stream_piece": res]); throw (this); } } } } LEAVE_SCOPE (ctx, this); } while (eval_state != ESTATE_LAST_ITER); if (!this->do_return && result == Void && content_type->subtype_of (result_type)) result = content; if (ctx->new_runtime_tags) { _handle_runtime_tags (parser, ctx->new_runtime_tags); ctx->new_runtime_tags = 0; } }; if (err) { 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]) 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_return stuff in this frame in either // case. if (err == this) err = 0; if (tags_added) { ctx->tag_set->imported -= ({/*[object(TagSet)]HMM*/ this->additional_tags}); tags_added = 0; } action = "break"; } else { // Can't stream since the parser isn't unwind safe. Just // continue. m_delete (ustate, "stream_piece"); action = "continue"; } 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. ustate[this] = ({err, eval_state, iter, raw_content, subparser, piece, exec, tags_added, ctx->new_runtime_tags}); } else { ctx->handle_exception (err, parser); // May throw. action = "return"; } switch (action) { case "break": // Throw and handle in parent frame. #ifdef MODULE_DEBUG if (!parser->unwind_state) 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: error ("Internal error: Don't you come here and %O on me!\n", action); } } if (tags_added) ctx->tag_set->imported -= ({/*[object(TagSet)]HMM*/ this->additional_tags}); ctx->frame = up; } DECLARE_CNT (__count); string _sprintf() { return "RXML.Frame(" + (tag && [string] tag->name) + COMMA_CNT (__count) + ")"; } } //! 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); mixed err = catch { if (context && context->unwind_state && context->unwind_state->top) { #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object()) 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()); }; LEAVE_CONTEXT(); if (err) if (objectp (err) && ([object] err)->thrown_at_unwind) { #ifdef DEBUG if (err != this_object()) error ("Internal error: Unexpected unwind object catched.\n"); #endif if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; } else if (context) context->handle_exception (err, this_object()); // May throw. else throw (err); 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); mixed err = catch { if (context && context->unwind_state && context->unwind_state->top) { #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object()) 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()); }; LEAVE_CONTEXT(); if (err) if (objectp (err) && ([object] err)->thrown_at_unwind) { #ifdef DEBUG if (err != this_object()) error ("Internal error: Unexpected unwind object catched.\n"); #endif if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; } else if (context) context->handle_exception (err, this_object()); // May throw. else throw (err); } array handle_var (string varref) // Parses and evaluates a possible variable reference, with the // appropriate error handling. { // We're always evaluating here, so context is always set. array(string) split = varref / "."; if (sizeof (split) == 2) if (mixed err = catch { sscanf (split[1], "%[^:]:%s", split[1], string encoding); context->current_var = varref; mixed val; if (zero_type (val = context->get_var ( // May throw. split[1], split[0], encoding ? t_text : 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 ({}); } return type->free_text ? 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. //!mixed 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. 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 void report_error (string msg); //! Used to report errors to the end user through the output. This //! is only called when the type allows free text. msg should be //! stored in the output queue to be returned by eval(). optional mixed read(); //! Define to allow streaming operation. Returns the evaluated //! result so far, but does not do any evaluation. Returns Void 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 Void 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. 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. The instance //! this function is called in is never actually used for parsing. static void create (Context ctx, Type _type, mixed... args) { context = ctx; type = _type; } // 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(). DECLARE_CNT (__count); string _sprintf() {return "RXML.Parser" + PAREN_CNT (__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 tag, and Parser.handle_var() for encountered variable //! references. It must be able to continue cleanly after throw() from //! Tag._handle_tag(). { inherit Parser; 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); tag_set = _tag_set; } //! 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(). void add_runtime_tag (Tag tag); //! Adds a tag that will exist from this point forward in the //! current parser instance only. void remove_runtime_tag (string|Tag tag); //! Removes a tag added by add_runtime_tag(). string _sprintf() {return "RXML.TagSetParser" + PAREN_CNT (__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" + PAREN_CNT (__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. { constant is_RXML_Type = 1; //! Interface. //!string name; //! Unique type identifier. Required and considered constant. Type //! hierarchies are currently implemented with glob patterns, e.g. //! "image/png" is a subtype of "image/*", and "array(string)" is a //! subtype of "array(*)". //!mixed sequential; //! 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 for sequential data types, i.e. what eval ("") //! would produce. //!mixed free_text; //! Nonzero if the type keeps the free text between parsed tokens, //! e.g. the plain text between tags in HTML. The type must be //! sequential and use strings. void type_check (mixed val); //! Checks whether the given value is a valid one of this type. Type //! errors are thrown with RXML.rxml_fatal(). //!string quoting_scheme; //! An identifier for the quoting scheme this type uses, if any. The //! quoting scheme specifies how literals needs to be quoted for the //! type. Values converted between types with the same quoting //! scheme are not quoted. mixed quote (mixed val) //! Quotes the given value according to the quoting scheme for this //! type. { return val; } mixed convert (mixed val, void|Type from); //! Converts the given value to this type. If the from type is //! given, it's the type of the value. Since it's not always known, //! this function should try to do something sensible based on the //! primitive pike type. If the type can't be reasonably converted, //! an RXML fatal should be thrown. //! //! Quoting should be done if the from type is missing or has a //! different quoting scheme. Type clone() //! Returns a copy of the type. { Type newtype = object_program (this_object())(); newtype->_parser_prog = _parser_prog; newtype->_parser_args = _parser_args; newtype->_t_obj_cache = _t_obj_cache; return newtype; } //! Services. int `== (mixed other) //! { return objectp (other) && ([object] other)->is_RXML_Type && ([object(Type)] other)->name == this_object()->name; } int subtype_of (Type other) //! { return glob ([string] other->name, [string] this_object()->name); } 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 = ([]); } 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 = ([]); } } return newtype; } inline Parser get_parser (Context ctx, void|TagSet tag_set) //! Returns a parser instance initialized with the given context. { Parser p; if (_p_cache) { // It's a tag set parser. TagSet tset; // vvv Using interpreter lock from here. PCacheObj pco = _p_cache[tset = tag_set || ctx->tag_set]; 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); } 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 (0, this_object(), tset, @_parser_args))->clone) // pco->clone_parser might already be initialized here due // to race, but that doesn't matter. 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 (0, this_object(), tset, @_parser_args))->clone) // pco->clone_parser might already be initialized here due // to race, but that doesn't matter. p = (pco->clone_parser = p)->clone (ctx, this_object(), tset, @_parser_args); } } 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); } else if (clone_parser) // Relying on interpreter lock here. p = clone_parser->clone (ctx, this_object(), @_parser_args); else if ((p = _parser_prog (0, this_object(), @_parser_args))->clone) // clone_parser might already be initialized here due to race, // but that doesn't matter. p = (clone_parser = p)->clone (ctx, this_object(), @_parser_args); } return p; } mixed eval (string in, void|Context ctx, void|TagSet tag_set, void|Parser|PCode parent, void|int dont_switch_ctx) //! Convenience function to parse and evaluate 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); 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) if (_p_cache) { // Relying on interpreter lock in this block. PCacheObj pco = _p_cache[tag_set || ctx->tag_set]; 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; } // 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 class PCacheObj { int tag_set_gen; Parser clone_parser; Parser free_parser; } /*private*/ mapping(TagSet:PCacheObj) _p_cache; DECLARE_CNT (__count); string _sprintf() {return "RXML.Type" + PAREN_CNT (__count);} } static class TAny //! A completely unspecified nonsequential type. { inherit Type; constant name = "*"; constant quoting_scheme = "none"; mixed convert (mixed val) {return val;} string _sprintf() {return "RXML.t_any" + PAREN_CNT (__count);} } TAny t_any = TAny(); static class TSame //! A magic type used in Tag.content_type. { inherit Type; constant name = "same"; string _sprintf() {return "RXML.t_same" + PAREN_CNT (__count);} } TSame t_same = TSame(); static class TText //! The standard type for generic document text. { inherit Type; constant name = "text/*"; constant sequential = 1; constant empty_value = ""; constant free_text = 1; constant quoting_scheme = "none"; string convert (mixed val) { if (mixed err = catch {return (string) val;}) rxml_fatal ("Couldn't convert value to text: " + describe_error (err)); } string _sprintf() {return "RXML.t_text" + PAREN_CNT (__count);} } TText t_text = TText(); static class TXml //! The type for XML and similar markup. { inherit TText; constant name = "text/xml"; constant quoting_scheme = "xml"; string quote (string val) { return replace ( val, // FIXME: This ignores the invalid Unicode character blocks. ({"&", "<", ">", "\"", "\'", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\010", "\013", "\014", "\016", "\017", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\030", "\031", "\032", "\033", "\034", "\035", "\036", "\037", }), ({"&", "<", ">", """, /*"'"*/ "'", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", })); } string convert (mixed val, void|Type from) { if (mixed err = catch {val = (string) val;}) rxml_fatal ("Couldn't convert value to text: " + describe_error (err)); if (!from || from->quoting_scheme != quoting_scheme) val = quote ([string] val); return val; } string _sprintf() {return "RXML.t_xml" + PAREN_CNT (__count);} } THtml t_xml = TXml(); static class THtml //! Identical to t_xml, but tags it as "text/html". { inherit TXml; constant name = "text/html"; string _sprintf() {return "RXML.t_html" + PAREN_CNT (__count);} } THtml t_html = THtml(); // P-code compilation and evaluation. class VarRef //! A helper for representing variable reference tokens. { constant is_RXML_VarRef = 1; string scope, var; static void create (string _scope, string _var) {scope = _scope, var = _var;} int valid (Context ctx) {return ctx->exist_scope (scope);} mixed get (Context ctx) {return ctx->get_var (var, scope);} mixed set (Context ctx, mixed val) {return ctx->set_var (var, val, scope);} void delete (Context ctx) {ctx->delete_var (var, scope);} string name() {return scope + "." + var;} DECLARE_CNT (__count); string _sprintf() {return "RXML.VarRef(" + scope + "." + var + COMMA_CNT (__count) + ")";} } class PCode //! Holds p-code and evaluates it. P-code is the intermediate form //! after parsing and before evaluation. { constant is_RXML_PCode = 1; constant thrown_at_unwind = 1; array p_code = ({}); int error_count; //! Number of RXML errors that occurred during evaluation. If this //! is nonzero, the value from eval() shouldn't be trusted. mixed eval (Context ctx) //! Evaluates the p-code in the given context. { // FIXME } function(Context:mixed) compile(); //! Returns a compiled function for doing the evaluation. The //! function will receive a context to do the evaluation in. // Internals. void report_error (string msg) { // FIXME } PCode|Parser _parent; // The parent evaluator if this one is nested. DECLARE_CNT (__count); string _sprintf() {return "RXML.PCode" + PAREN_CNT (__count);} } //! Some parser tools. static class VoidType { mixed `+ (mixed... vals) {return sizeof (vals) ? predef::`+ (@vals) : this_object();} mixed ``+ (mixed val) {return val;} int `!() {return 1;} string _sprintf() {return "RXML.Void";} }; VoidType Void = VoidType(); //! An object representing the void value. Works as initializer for //! sequences, since Void + anything == anything + Void == anything. class ScanStream //! A helper class for the input and scanner stage in a parser. It's a //! stream that takes unparsed strings and splits them into tokens //! which are queued. Intended to be inherited in a Parser class. { private class Link { array data; Link next; } private Link head = Link(); // Last link is an empty eof marker. private Link tail = head; private int next_token = 0; private string end = ""; private int fin = 0; array scan (string in, int finished); //! The scanner function. It gets an unparsed string and should //! return an array of tokens. If the second argument is nonzero, //! there won't be any more data later. If the second argument is //! zero, the last item in the returned array is handled as unparsed //! data that will be passed back to the scanner later. Tokens may //! be of any type. Use VarRef objects for variables. void feed (string in) //! { #ifdef MODULE_DEBUG if (fin) error ("Cannot feed data to a finished stream.\n"); #endif array tokens = scan (end + in, 0); end = [string] tokens[-1]; if (sizeof (tokens) > 1) { tail->data = tokens[..sizeof (tokens) - 2]; tail = tail->next = Link(); } } void finish (void|string in) //! { if (in || !fin && sizeof (end)) { #ifdef MODULE_DEBUG if (in && fin) error ("Cannot feed data to a finished stream.\n"); #endif fin = 1; if (in) end += in; tail->data = scan (end, 1); tail = tail->next = Link(); } } void reset() //! { head = Link(); tail = head; next_token = 0; end = ""; fin = 0; } mixed read() //! Returns the next token, or Void if there's no more data. { while (head->next) if (next_token >= sizeof (head->data)) { next_token = 0; head = head->next; } else return head->data[next_token++]; return Void; } void unread (mixed... put_back) //! Puts back tokens and variable references at the beginning of the //! stream so that the leftmost argument will be read first. { int i = sizeof (put_back); while (i) head->data[--next_token] = put_back[--i]; if (i) { Link l = Link(); l->next = head, head = l; l->data = allocate (next_token = max (i - 32, 0)) + put_back[..--i]; } } array read_all() //! { array data; if (next_token) { data = head->data[next_token..]; head = head->next; next_token = 0; } else data = ({}); while (head->next) { data += head->data; head = head->next; } return data; } int finished() //! Returns nonzero if the write end is finished. { return fin; } DECLARE_CNT (__count); string _sprintf() {return "RXML.ScanStream" + PAREN_CNT (__count);} } // Various internal stuff. // Argh! static program PHtml; static program PEnt; static program PExpr; void _fix_module_ref (string name, mixed val) { mixed err = catch { switch (name) { case "PHtml": PHtml = [program] val; break; case "PEnt": PEnt = [program] val; break; case "PExpr": PExpr = [program] val; break; case "empty_tag_set": empty_tag_set = [object(TagSet)] val; break; default: error ("Herk\n"); } }; if (err) werror (describe_backtrace (err)); }

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