/usr/share/tcltk/tcllib1.17/snit/main2.tcl is in tcllib 1.17-dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 | #-----------------------------------------------------------------------
# TITLE:
# main2.tcl
#
# AUTHOR:
# Will Duquette
#
# DESCRIPTION:
# Snit's Not Incr Tcl, a simple object system in Pure Tcl.
#
# Snit 2.x Compiler and Run-Time Library
#
# Copyright (C) 2003-2006 by William H. Duquette
# This code is licensed as described in license.txt.
#
#-----------------------------------------------------------------------
#-----------------------------------------------------------------------
# Namespace
namespace eval ::snit:: {
namespace export \
compile type widget widgetadaptor typemethod method macro
}
#-----------------------------------------------------------------------
# Some Snit variables
namespace eval ::snit:: {
variable reservedArgs {type selfns win self}
# Widget classes which can be hulls (must have -class)
variable hulltypes {
toplevel tk::toplevel
frame tk::frame ttk::frame
labelframe tk::labelframe ttk::labelframe
}
}
#-----------------------------------------------------------------------
# Snit Type Implementation template
namespace eval ::snit:: {
# Template type definition: All internal and user-visible Snit
# implementation code.
#
# The following placeholders will automatically be replaced with
# the client's code, in two passes:
#
# First pass:
# %COMPILEDDEFS% The compiled type definition.
#
# Second pass:
# %TYPE% The fully qualified type name.
# %IVARDECS% Instance variable declarations
# %TVARDECS% Type variable declarations
# %TCONSTBODY% Type constructor body
# %INSTANCEVARS% The compiled instance variable initialization code.
# %TYPEVARS% The compiled type variable initialization code.
# This is the overall type template.
variable typeTemplate
# This is the normal type proc
variable nominalTypeProc
# This is the "-hastypemethods no" type proc
variable simpleTypeProc
}
set ::snit::typeTemplate {
#-------------------------------------------------------------------
# The type's namespace definition and the user's type variables
namespace eval %TYPE% {%TYPEVARS%
}
#----------------------------------------------------------------
# Commands for use in methods, typemethods, etc.
#
# These are implemented as aliases into the Snit runtime library.
interp alias {} %TYPE%::installhull {} ::snit::RT.installhull %TYPE%
interp alias {} %TYPE%::install {} ::snit::RT.install %TYPE%
interp alias {} %TYPE%::typevariable {} ::variable
interp alias {} %TYPE%::variable {} ::snit::RT.variable
interp alias {} %TYPE%::mytypevar {} ::snit::RT.mytypevar %TYPE%
interp alias {} %TYPE%::typevarname {} ::snit::RT.mytypevar %TYPE%
interp alias {} %TYPE%::myvar {} ::snit::RT.myvar
interp alias {} %TYPE%::varname {} ::snit::RT.myvar
interp alias {} %TYPE%::codename {} ::snit::RT.codename %TYPE%
interp alias {} %TYPE%::myproc {} ::snit::RT.myproc %TYPE%
interp alias {} %TYPE%::mymethod {} ::snit::RT.mymethod
interp alias {} %TYPE%::mytypemethod {} ::snit::RT.mytypemethod %TYPE%
interp alias {} %TYPE%::from {} ::snit::RT.from %TYPE%
#-------------------------------------------------------------------
# Snit's internal variables
namespace eval %TYPE% {
# Array: General Snit Info
#
# ns: The type's namespace
# hasinstances: T or F, from pragma -hasinstances.
# simpledispatch: T or F, from pragma -hasinstances.
# canreplace: T or F, from pragma -canreplace.
# counter: Count of instances created so far.
# widgetclass: Set by widgetclass statement.
# hulltype: Hull type (frame or toplevel) for widgets only.
# exceptmethods: Methods explicitly not delegated to *
# excepttypemethods: Methods explicitly not delegated to *
# tvardecs: Type variable declarations--for dynamic methods
# ivardecs: Instance variable declarations--for dyn. methods
typevariable Snit_info
set Snit_info(ns) %TYPE%::
set Snit_info(hasinstances) 1
set Snit_info(simpledispatch) 0
set Snit_info(canreplace) 0
set Snit_info(counter) 0
set Snit_info(widgetclass) {}
set Snit_info(hulltype) frame
set Snit_info(exceptmethods) {}
set Snit_info(excepttypemethods) {}
set Snit_info(tvardecs) {%TVARDECS%}
set Snit_info(ivardecs) {%IVARDECS%}
# Array: Public methods of this type.
# The index is the method name, or "*".
# The value is [list $pattern $componentName], where
# $componentName is "" for normal methods.
typevariable Snit_typemethodInfo
array unset Snit_typemethodInfo
# Array: Public methods of instances of this type.
# The index is the method name, or "*".
# The value is [list $pattern $componentName], where
# $componentName is "" for normal methods.
typevariable Snit_methodInfo
array unset Snit_methodInfo
# Array: option information. See dictionary.txt.
typevariable Snit_optionInfo
array unset Snit_optionInfo
set Snit_optionInfo(local) {}
set Snit_optionInfo(delegated) {}
set Snit_optionInfo(starcomp) {}
set Snit_optionInfo(except) {}
}
#----------------------------------------------------------------
# Compiled Procs
#
# These commands are created or replaced during compilation:
# Snit_instanceVars selfns
#
# Initializes the instance variables, if any. Called during
# instance creation.
proc %TYPE%::Snit_instanceVars {selfns} {
%INSTANCEVARS%
}
# Type Constructor
proc %TYPE%::Snit_typeconstructor {type} {
%TVARDECS%
namespace path [namespace parent $type]
%TCONSTBODY%
}
#----------------------------------------------------------------
# Default Procs
#
# These commands might be replaced during compilation:
# Snit_destructor type selfns win self
#
# Default destructor for the type. By default, it does
# nothing. It's replaced by any user destructor.
# For types, it's called by method destroy; for widgettypes,
# it's called by a destroy event handler.
proc %TYPE%::Snit_destructor {type selfns win self} { }
#----------------------------------------------------------
# Compiled Definitions
%COMPILEDDEFS%
#----------------------------------------------------------
# Finally, call the Type Constructor
%TYPE%::Snit_typeconstructor %TYPE%
}
#-----------------------------------------------------------------------
# Type procs
#
# These procs expect the fully-qualified type name to be
# substituted in for %TYPE%.
# This is the nominal type proc. It supports typemethods and
# delegated typemethods.
set ::snit::nominalTypeProc {
# WHD: Code for creating the type ensemble
namespace eval %TYPE% {
namespace ensemble create \
-unknown [list ::snit::RT.UnknownTypemethod %TYPE% ""] \
-prefixes 0
}
}
# This is the simplified type proc for when there are no typemethods
# except create. In this case, it doesn't take a method argument;
# the method is always "create".
set ::snit::simpleTypeProc {
# Type dispatcher function. Note: This function lives
# in the parent of the %TYPE% namespace! All accesses to
# %TYPE% variables and methods must be qualified!
proc %TYPE% {args} {
::variable %TYPE%::Snit_info
# FIRST, if the are no args, the single arg is %AUTO%
if {[llength $args] == 0} {
if {$Snit_info(isWidget)} {
error "wrong \# args: should be \"%TYPE% name args\""
}
lappend args %AUTO%
}
# NEXT, we're going to call the create method.
# Pass along the return code unchanged.
if {$Snit_info(isWidget)} {
set command [list ::snit::RT.widget.typemethod.create %TYPE%]
} else {
set command [list ::snit::RT.type.typemethod.create %TYPE%]
}
set retval [catch {uplevel 1 $command $args} result]
if {$retval} {
if {$retval == 1} {
global errorInfo
global errorCode
return -code error -errorinfo $errorInfo \
-errorcode $errorCode $result
} else {
return -code $retval $result
}
}
return $result
}
}
#=======================================================================
# Snit Type Definition
#
# These are the procs used to define Snit types, widgets, and
# widgetadaptors.
#-----------------------------------------------------------------------
# Snit Compilation Variables
#
# The following variables are used while Snit is compiling a type,
# and are disposed afterwards.
namespace eval ::snit:: {
# The compiler variable contains the name of the slave interpreter
# used to compile type definitions.
variable compiler ""
# The compile array accumulates information about the type or
# widgettype being compiled. It is cleared before and after each
# compilation. It has these indices:
#
# type: The name of the type being compiled, for use
# in compilation procs.
# defs: Compiled definitions, both standard and client.
# which: type, widget, widgetadaptor
# instancevars: Instance variable definitions and initializations.
# ivprocdec: Instance variable proc declarations.
# tvprocdec: Type variable proc declarations.
# typeconstructor: Type constructor body.
# widgetclass: The widgetclass, for snit::widgets, only
# hasoptions: False, initially; set to true when first
# option is defined.
# localoptions: Names of local options.
# delegatedoptions: Names of delegated options.
# localmethods: Names of locally defined methods.
# delegatesmethods: no if no delegated methods, yes otherwise.
# hashierarchic : no if no hierarchic methods, yes otherwise.
# components: Names of defined components.
# typecomponents: Names of defined typecomponents.
# typevars: Typevariable definitions and initializations.
# varnames: Names of instance variables
# typevarnames Names of type variables
# hasconstructor False, initially; true when constructor is
# defined.
# resource-$opt The option's resource name
# class-$opt The option's class
# -default-$opt The option's default value
# -validatemethod-$opt The option's validate method
# -configuremethod-$opt The option's configure method
# -cgetmethod-$opt The option's cget method.
# -hastypeinfo The -hastypeinfo pragma
# -hastypedestroy The -hastypedestroy pragma
# -hastypemethods The -hastypemethods pragma
# -hasinfo The -hasinfo pragma
# -hasinstances The -hasinstances pragma
# -simpledispatch The -simpledispatch pragma WHD: OBSOLETE
# -canreplace The -canreplace pragma
variable compile
# This variable accumulates method dispatch information; it has
# the same structure as the %TYPE%::Snit_methodInfo array, and is
# used to initialize it.
variable methodInfo
# This variable accumulates typemethod dispatch information; it has
# the same structure as the %TYPE%::Snit_typemethodInfo array, and is
# used to initialize it.
variable typemethodInfo
# The following variable lists the reserved type definition statement
# names, e.g., the names you can't use as macros. It's built at
# compiler definition time using "info commands".
variable reservedwords {}
}
#-----------------------------------------------------------------------
# type compilation commands
#
# The type and widgettype commands use a slave interpreter to compile
# the type definition. These are the procs
# that are aliased into it.
# Initialize the compiler
proc ::snit::Comp.Init {} {
variable compiler
variable reservedwords
if {$compiler eq ""} {
# Create the compiler's interpreter
set compiler [interp create]
# Initialize the interpreter
$compiler eval {
catch {close stdout}
catch {close stderr}
catch {close stdin}
# Load package information
# TBD: see if this can be moved outside.
# @mdgen NODEP: ::snit::__does_not_exist__
catch {package require ::snit::__does_not_exist__}
# Protect some Tcl commands our type definitions
# will shadow.
rename proc _proc
rename variable _variable
}
# Define compilation aliases.
$compiler alias pragma ::snit::Comp.statement.pragma
$compiler alias widgetclass ::snit::Comp.statement.widgetclass
$compiler alias hulltype ::snit::Comp.statement.hulltype
$compiler alias constructor ::snit::Comp.statement.constructor
$compiler alias destructor ::snit::Comp.statement.destructor
$compiler alias option ::snit::Comp.statement.option
$compiler alias oncget ::snit::Comp.statement.oncget
$compiler alias onconfigure ::snit::Comp.statement.onconfigure
$compiler alias method ::snit::Comp.statement.method
$compiler alias typemethod ::snit::Comp.statement.typemethod
$compiler alias typeconstructor ::snit::Comp.statement.typeconstructor
$compiler alias proc ::snit::Comp.statement.proc
$compiler alias typevariable ::snit::Comp.statement.typevariable
$compiler alias variable ::snit::Comp.statement.variable
$compiler alias typecomponent ::snit::Comp.statement.typecomponent
$compiler alias component ::snit::Comp.statement.component
$compiler alias delegate ::snit::Comp.statement.delegate
$compiler alias expose ::snit::Comp.statement.expose
# Get the list of reserved words
set reservedwords [$compiler eval {info commands}]
}
}
# Compile a type definition, and return the results as a list of two
# items: the fully-qualified type name, and a script that will define
# the type when executed.
#
# which type, widget, or widgetadaptor
# type the type name
# body the type definition
proc ::snit::Comp.Compile {which type body} {
variable typeTemplate
variable nominalTypeProc
variable simpleTypeProc
variable compile
variable compiler
variable methodInfo
variable typemethodInfo
# FIRST, qualify the name.
if {![string match "::*" $type]} {
# Get caller's namespace;
# append :: if not global namespace.
set ns [uplevel 2 [list namespace current]]
if {"::" != $ns} {
append ns "::"
}
set type "$ns$type"
}
# NEXT, create and initialize the compiler, if needed.
Comp.Init
# NEXT, initialize the class data
array unset methodInfo
array unset typemethodInfo
array unset compile
set compile(type) $type
set compile(defs) {}
set compile(which) $which
set compile(hasoptions) no
set compile(localoptions) {}
set compile(instancevars) {}
set compile(typevars) {}
set compile(delegatedoptions) {}
set compile(ivprocdec) {}
set compile(tvprocdec) {}
set compile(typeconstructor) {}
set compile(widgetclass) {}
set compile(hulltype) {}
set compile(localmethods) {}
set compile(delegatesmethods) no
set compile(hashierarchic) no
set compile(components) {}
set compile(typecomponents) {}
set compile(varnames) {}
set compile(typevarnames) {}
set compile(hasconstructor) no
set compile(-hastypedestroy) yes
set compile(-hastypeinfo) yes
set compile(-hastypemethods) yes
set compile(-hasinfo) yes
set compile(-hasinstances) yes
set compile(-canreplace) no
set isWidget [string match widget* $which]
set isWidgetAdaptor [string match widgetadaptor $which]
# NEXT, Evaluate the type's definition in the class interpreter.
$compiler eval $body
# NEXT, Add the standard definitions
append compile(defs) \
"\nset %TYPE%::Snit_info(isWidget) $isWidget\n"
append compile(defs) \
"\nset %TYPE%::Snit_info(isWidgetAdaptor) $isWidgetAdaptor\n"
# Indicate whether the type can create instances that replace
# existing commands.
append compile(defs) "\nset %TYPE%::Snit_info(canreplace) $compile(-canreplace)\n"
# Check pragmas for conflict.
if {!$compile(-hastypemethods) && !$compile(-hasinstances)} {
error "$which $type has neither typemethods nor instances"
}
# If there are typemethods, define the standard typemethods and
# the nominal type proc. Otherwise define the simple type proc.
if {$compile(-hastypemethods)} {
# Add the info typemethod unless the pragma forbids it.
if {$compile(-hastypeinfo)} {
Comp.statement.delegate typemethod info \
using {::snit::RT.typemethod.info %t}
}
# Add the destroy typemethod unless the pragma forbids it.
if {$compile(-hastypedestroy)} {
Comp.statement.delegate typemethod destroy \
using {::snit::RT.typemethod.destroy %t}
}
# Add the nominal type proc.
append compile(defs) $nominalTypeProc
} else {
# Add the simple type proc.
append compile(defs) $simpleTypeProc
}
# Add standard methods/typemethods that only make sense if the
# type has instances.
if {$compile(-hasinstances)} {
# Add the info method unless the pragma forbids it.
if {$compile(-hasinfo)} {
Comp.statement.delegate method info \
using {::snit::RT.method.info %t %n %w %s}
}
# Add the option handling stuff if there are any options.
if {$compile(hasoptions)} {
Comp.statement.variable options
Comp.statement.delegate method cget \
using {::snit::RT.method.cget %t %n %w %s}
Comp.statement.delegate method configurelist \
using {::snit::RT.method.configurelist %t %n %w %s}
Comp.statement.delegate method configure \
using {::snit::RT.method.configure %t %n %w %s}
}
# Add a default constructor, if they haven't already defined one.
# If there are options, it will configure args; otherwise it
# will do nothing.
if {!$compile(hasconstructor)} {
if {$compile(hasoptions)} {
Comp.statement.constructor {args} {
$self configurelist $args
}
} else {
Comp.statement.constructor {} {}
}
}
if {!$isWidget} {
Comp.statement.delegate method destroy \
using {::snit::RT.method.destroy %t %n %w %s}
Comp.statement.delegate typemethod create \
using {::snit::RT.type.typemethod.create %t}
} else {
Comp.statement.delegate typemethod create \
using {::snit::RT.widget.typemethod.create %t}
}
# Save the method info.
append compile(defs) \
"\narray set %TYPE%::Snit_methodInfo [list [array get methodInfo]]\n"
} else {
append compile(defs) "\nset %TYPE%::Snit_info(hasinstances) 0\n"
}
# NEXT, compiling the type definition built up a set of information
# about the type's locally defined options; add this information to
# the compiled definition.
Comp.SaveOptionInfo
# NEXT, compiling the type definition built up a set of information
# about the typemethods; save the typemethod info.
append compile(defs) \
"\narray set %TYPE%::Snit_typemethodInfo [list [array get typemethodInfo]]\n"
# NEXT, if this is a widget define the hull component if it isn't
# already defined.
if {$isWidget} {
Comp.DefineComponent hull
}
# NEXT, substitute the compiled definition into the type template
# to get the type definition script.
set defscript [Expand $typeTemplate \
%COMPILEDDEFS% $compile(defs)]
# NEXT, substitute the defined macros into the type definition script.
# This is done as a separate step so that the compile(defs) can
# contain the macros defined below.
set defscript [Expand $defscript \
%TYPE% $type \
%IVARDECS% $compile(ivprocdec) \
%TVARDECS% $compile(tvprocdec) \
%TCONSTBODY% $compile(typeconstructor) \
%INSTANCEVARS% $compile(instancevars) \
%TYPEVARS% $compile(typevars) \
]
array unset compile
return [list $type $defscript]
}
# Information about locally-defined options is accumulated during
# compilation, but not added to the compiled definition--the option
# statement can appear multiple times, so it's easier this way.
# This proc fills in Snit_optionInfo with the accumulated information.
#
# It also computes the option's resource and class names if needed.
#
# Note that the information for delegated options was put in
# Snit_optionInfo during compilation.
proc ::snit::Comp.SaveOptionInfo {} {
variable compile
foreach option $compile(localoptions) {
if {$compile(resource-$option) eq ""} {
set compile(resource-$option) [string range $option 1 end]
}
if {$compile(class-$option) eq ""} {
set compile(class-$option) [Capitalize $compile(resource-$option)]
}
# NOTE: Don't verify that the validate, configure, and cget
# values name real methods; the methods might be defined outside
# the typedefinition using snit::method.
Mappend compile(defs) {
# Option %OPTION%
lappend %TYPE%::Snit_optionInfo(local) %OPTION%
set %TYPE%::Snit_optionInfo(islocal-%OPTION%) 1
set %TYPE%::Snit_optionInfo(resource-%OPTION%) %RESOURCE%
set %TYPE%::Snit_optionInfo(class-%OPTION%) %CLASS%
set %TYPE%::Snit_optionInfo(default-%OPTION%) %DEFAULT%
set %TYPE%::Snit_optionInfo(validate-%OPTION%) %VALIDATE%
set %TYPE%::Snit_optionInfo(configure-%OPTION%) %CONFIGURE%
set %TYPE%::Snit_optionInfo(cget-%OPTION%) %CGET%
set %TYPE%::Snit_optionInfo(readonly-%OPTION%) %READONLY%
set %TYPE%::Snit_optionInfo(typespec-%OPTION%) %TYPESPEC%
} %OPTION% $option \
%RESOURCE% $compile(resource-$option) \
%CLASS% $compile(class-$option) \
%DEFAULT% [list $compile(-default-$option)] \
%VALIDATE% [list $compile(-validatemethod-$option)] \
%CONFIGURE% [list $compile(-configuremethod-$option)] \
%CGET% [list $compile(-cgetmethod-$option)] \
%READONLY% $compile(-readonly-$option) \
%TYPESPEC% [list $compile(-type-$option)]
}
}
# Evaluates a compiled type definition, thus making the type available.
proc ::snit::Comp.Define {compResult} {
# The compilation result is a list containing the fully qualified
# type name and a script to evaluate to define the type.
set type [lindex $compResult 0]
set defscript [lindex $compResult 1]
# Execute the type definition script.
# Consider using namespace eval %TYPE%. See if it's faster.
if {[catch {eval $defscript} result]} {
namespace delete $type
catch {rename $type ""}
error $result
}
return $type
}
# Sets pragma options which control how the type is defined.
proc ::snit::Comp.statement.pragma {args} {
variable compile
set errRoot "Error in \"pragma...\""
foreach {opt val} $args {
switch -exact -- $opt {
-hastypeinfo -
-hastypedestroy -
-hastypemethods -
-hasinstances -
-simpledispatch -
-hasinfo -
-canreplace {
if {![string is boolean -strict $val]} {
error "$errRoot, \"$opt\" requires a boolean value"
}
set compile($opt) $val
}
default {
error "$errRoot, unknown pragma"
}
}
}
}
# Defines a widget's option class name.
# This statement is only available for snit::widgets,
# not for snit::types or snit::widgetadaptors.
proc ::snit::Comp.statement.widgetclass {name} {
variable compile
# First, widgetclass can only be set for true widgets
if {"widget" != $compile(which)} {
error "widgetclass cannot be set for snit::$compile(which)s"
}
# Next, validate the option name. We'll require that it begin
# with an uppercase letter.
set initial [string index $name 0]
if {![string is upper $initial]} {
error "widgetclass \"$name\" does not begin with an uppercase letter"
}
if {"" != $compile(widgetclass)} {
error "too many widgetclass statements"
}
# Next, save it.
Mappend compile(defs) {
set %TYPE%::Snit_info(widgetclass) %WIDGETCLASS%
} %WIDGETCLASS% [list $name]
set compile(widgetclass) $name
}
# Defines a widget's hull type.
# This statement is only available for snit::widgets,
# not for snit::types or snit::widgetadaptors.
proc ::snit::Comp.statement.hulltype {name} {
variable compile
variable hulltypes
# First, hulltype can only be set for true widgets
if {"widget" != $compile(which)} {
error "hulltype cannot be set for snit::$compile(which)s"
}
# Next, it must be one of the valid hulltypes (frame, toplevel, ...)
if {[lsearch -exact $hulltypes [string trimleft $name :]] == -1} {
error "invalid hulltype \"$name\", should be one of\
[join $hulltypes {, }]"
}
if {"" != $compile(hulltype)} {
error "too many hulltype statements"
}
# Next, save it.
Mappend compile(defs) {
set %TYPE%::Snit_info(hulltype) %HULLTYPE%
} %HULLTYPE% $name
set compile(hulltype) $name
}
# Defines a constructor.
proc ::snit::Comp.statement.constructor {arglist body} {
variable compile
CheckArgs "constructor" $arglist
# Next, add a magic reference to self.
set arglist [concat type selfns win self $arglist]
# Next, add variable declarations to body:
set body "%TVARDECS%\n%IVARDECS%\n$body"
set compile(hasconstructor) yes
append compile(defs) "proc %TYPE%::Snit_constructor [list $arglist] [list $body]\n"
}
# Defines a destructor.
proc ::snit::Comp.statement.destructor {body} {
variable compile
# Next, add variable declarations to body:
set body "%TVARDECS%\n%IVARDECS%\n$body"
append compile(defs) "proc %TYPE%::Snit_destructor {type selfns win self} [list $body]\n\n"
}
# Defines a type option. The option value can be a triple, specifying
# the option's -name, resource name, and class name.
proc ::snit::Comp.statement.option {optionDef args} {
variable compile
# First, get the three option names.
set option [lindex $optionDef 0]
set resourceName [lindex $optionDef 1]
set className [lindex $optionDef 2]
set errRoot "Error in \"option [list $optionDef]...\""
# Next, validate the option name.
if {![Comp.OptionNameIsValid $option]} {
error "$errRoot, badly named option \"$option\""
}
if {$option in $compile(delegatedoptions)} {
error "$errRoot, cannot define \"$option\" locally, it has been delegated"
}
if {!($option in $compile(localoptions))} {
# Remember that we've seen this one.
set compile(hasoptions) yes
lappend compile(localoptions) $option
# Initialize compilation info for this option.
set compile(resource-$option) ""
set compile(class-$option) ""
set compile(-default-$option) ""
set compile(-validatemethod-$option) ""
set compile(-configuremethod-$option) ""
set compile(-cgetmethod-$option) ""
set compile(-readonly-$option) 0
set compile(-type-$option) ""
}
# NEXT, see if we have a resource name. If so, make sure it
# isn't being redefined differently.
if {$resourceName ne ""} {
if {$compile(resource-$option) eq ""} {
# If it's undefined, just save the value.
set compile(resource-$option) $resourceName
} elseif {$resourceName ne $compile(resource-$option)} {
# It's been redefined differently.
error "$errRoot, resource name redefined from \"$compile(resource-$option)\" to \"$resourceName\""
}
}
# NEXT, see if we have a class name. If so, make sure it
# isn't being redefined differently.
if {$className ne ""} {
if {$compile(class-$option) eq ""} {
# If it's undefined, just save the value.
set compile(class-$option) $className
} elseif {$className ne $compile(class-$option)} {
# It's been redefined differently.
error "$errRoot, class name redefined from \"$compile(class-$option)\" to \"$className\""
}
}
# NEXT, handle the args; it's not an error to redefine these.
if {[llength $args] == 1} {
set compile(-default-$option) [lindex $args 0]
} else {
foreach {optopt val} $args {
switch -exact -- $optopt {
-default -
-validatemethod -
-configuremethod -
-cgetmethod {
set compile($optopt-$option) $val
}
-type {
set compile($optopt-$option) $val
if {[llength $val] == 1} {
# The type spec *is* the validation object
append compile(defs) \
"\nset %TYPE%::Snit_optionInfo(typeobj-$option) [list $val]\n"
} else {
# Compilation the creation of the validation object
set cmd [linsert $val 1 %TYPE%::Snit_TypeObj_%AUTO%]
append compile(defs) \
"\nset %TYPE%::Snit_optionInfo(typeobj-$option) \[$cmd\]\n"
}
}
-readonly {
if {![string is boolean -strict $val]} {
error "$errRoot, -readonly requires a boolean, got \"$val\""
}
set compile($optopt-$option) $val
}
default {
error "$errRoot, unknown option definition option \"$optopt\""
}
}
}
}
}
# 1 if the option name is valid, 0 otherwise.
proc ::snit::Comp.OptionNameIsValid {option} {
if {![string match {-*} $option] || [string match {*[A-Z ]*} $option]} {
return 0
}
return 1
}
# Defines an option's cget handler
proc ::snit::Comp.statement.oncget {option body} {
variable compile
set errRoot "Error in \"oncget $option...\""
if {[lsearch -exact $compile(delegatedoptions) $option] != -1} {
return -code error "$errRoot, option \"$option\" is delegated"
}
if {[lsearch -exact $compile(localoptions) $option] == -1} {
return -code error "$errRoot, option \"$option\" unknown"
}
Comp.statement.method _cget$option {_option} $body
Comp.statement.option $option -cgetmethod _cget$option
}
# Defines an option's configure handler.
proc ::snit::Comp.statement.onconfigure {option arglist body} {
variable compile
if {[lsearch -exact $compile(delegatedoptions) $option] != -1} {
return -code error "onconfigure $option: option \"$option\" is delegated"
}
if {[lsearch -exact $compile(localoptions) $option] == -1} {
return -code error "onconfigure $option: option \"$option\" unknown"
}
if {[llength $arglist] != 1} {
error \
"onconfigure $option handler should have one argument, got \"$arglist\""
}
CheckArgs "onconfigure $option" $arglist
# Next, add a magic reference to the option name
set arglist [concat _option $arglist]
Comp.statement.method _configure$option $arglist $body
Comp.statement.option $option -configuremethod _configure$option
}
# Defines an instance method.
proc ::snit::Comp.statement.method {method arglist body} {
variable compile
variable methodInfo
# FIRST, check the method name against previously defined
# methods.
Comp.CheckMethodName $method 0 ::snit::methodInfo \
"Error in \"method [list $method]...\""
if {[llength $method] > 1} {
set compile(hashierarchic) yes
}
# Remeber this method
lappend compile(localmethods) $method
CheckArgs "method [list $method]" $arglist
# Next, add magic references to type and self.
set arglist [concat type selfns win self $arglist]
# Next, add variable declarations to body:
set body "%TVARDECS%\n%IVARDECS%\n# END snit method prolog\n$body"
# Next, save the definition script.
if {[llength $method] == 1} {
set methodInfo($method) {0 "%t::Snit_method%m %t %n %w %s" ""}
Mappend compile(defs) {
proc %TYPE%::Snit_method%METHOD% %ARGLIST% %BODY%
} %METHOD% $method %ARGLIST% [list $arglist] %BODY% [list $body]
} else {
set methodInfo($method) {0 "%t::Snit_hmethod%j %t %n %w %s" ""}
Mappend compile(defs) {
proc %TYPE%::Snit_hmethod%JMETHOD% %ARGLIST% %BODY%
} %JMETHOD% [join $method _] %ARGLIST% [list $arglist] \
%BODY% [list $body]
}
}
# Check for name collisions; save prefix information.
#
# method The name of the method or typemethod.
# delFlag 1 if delegated, 0 otherwise.
# infoVar The fully qualified name of the array containing
# information about the defined methods.
# errRoot The root string for any error messages.
proc ::snit::Comp.CheckMethodName {method delFlag infoVar errRoot} {
upvar $infoVar methodInfo
# FIRST, make sure the method name is a valid Tcl list.
if {[catch {lindex $method 0}]} {
error "$errRoot, the name \"$method\" must have list syntax."
}
# NEXT, check whether we can define it.
if {![catch {set methodInfo($method)} data]} {
# We can't redefine methods with submethods.
if {[lindex $data 0] == 1} {
error "$errRoot, \"$method\" has submethods."
}
# You can't delegate a method that's defined locally,
# and you can't define a method locally if it's been delegated.
if {$delFlag && [lindex $data 2] eq ""} {
error "$errRoot, \"$method\" has been defined locally."
} elseif {!$delFlag && [lindex $data 2] ne ""} {
error "$errRoot, \"$method\" has been delegated"
}
}
# Handle hierarchical case.
if {[llength $method] > 1} {
set prefix {}
set tokens $method
while {[llength $tokens] > 1} {
lappend prefix [lindex $tokens 0]
set tokens [lrange $tokens 1 end]
if {![catch {set methodInfo($prefix)} result]} {
# Prefix is known. If it's not a prefix, throw an
# error.
if {[lindex $result 0] == 0} {
error "$errRoot, \"$prefix\" has no submethods."
}
}
set methodInfo($prefix) [list 1]
}
}
}
# Defines a typemethod method.
proc ::snit::Comp.statement.typemethod {method arglist body} {
variable compile
variable typemethodInfo
# FIRST, check the typemethod name against previously defined
# typemethods.
Comp.CheckMethodName $method 0 ::snit::typemethodInfo \
"Error in \"typemethod [list $method]...\""
CheckArgs "typemethod $method" $arglist
# First, add magic reference to type.
set arglist [concat type $arglist]
# Next, add typevariable declarations to body:
set body "%TVARDECS%\n# END snit method prolog\n$body"
# Next, save the definition script
if {[llength $method] == 1} {
set typemethodInfo($method) {0 "%t::Snit_typemethod%m %t" ""}
Mappend compile(defs) {
proc %TYPE%::Snit_typemethod%METHOD% %ARGLIST% %BODY%
} %METHOD% $method %ARGLIST% [list $arglist] %BODY% [list $body]
} else {
set typemethodInfo($method) {0 "%t::Snit_htypemethod%j %t" ""}
Mappend compile(defs) {
proc %TYPE%::Snit_htypemethod%JMETHOD% %ARGLIST% %BODY%
} %JMETHOD% [join $method _] \
%ARGLIST% [list $arglist] %BODY% [list $body]
}
}
# Defines a type constructor.
proc ::snit::Comp.statement.typeconstructor {body} {
variable compile
if {"" != $compile(typeconstructor)} {
error "too many typeconstructors"
}
set compile(typeconstructor) $body
}
# Defines a static proc in the type's namespace.
proc ::snit::Comp.statement.proc {proc arglist body} {
variable compile
# If "ns" is defined, the proc can see instance variables.
if {[lsearch -exact $arglist selfns] != -1} {
# Next, add instance variable declarations to body:
set body "%IVARDECS%\n$body"
}
# The proc can always see typevariables.
set body "%TVARDECS%\n$body"
append compile(defs) "
# Proc $proc
proc [list %TYPE%::$proc $arglist $body]
"
}
# Defines a static variable in the type's namespace.
proc ::snit::Comp.statement.typevariable {name args} {
variable compile
set errRoot "Error in \"typevariable $name...\""
set len [llength $args]
if {$len > 2 ||
($len == 2 && [lindex $args 0] ne "-array")} {
error "$errRoot, too many initializers"
}
if {[lsearch -exact $compile(varnames) $name] != -1} {
error "$errRoot, \"$name\" is already an instance variable"
}
lappend compile(typevarnames) $name
if {$len == 1} {
append compile(typevars) \
"\n\t [list ::variable $name [lindex $args 0]]"
} elseif {$len == 2} {
append compile(typevars) \
"\n\t [list ::variable $name]"
append compile(typevars) \
"\n\t [list array set $name [lindex $args 1]]"
} else {
append compile(typevars) \
"\n\t [list ::variable $name]"
}
if {$compile(tvprocdec) eq ""} {
set compile(tvprocdec) "\n\t"
append compile(tvprocdec) "namespace upvar [list $compile(type)]"
}
append compile(tvprocdec) " [list $name $name]"
}
# Defines an instance variable; the definition will go in the
# type's create typemethod.
proc ::snit::Comp.statement.variable {name args} {
variable compile
set errRoot "Error in \"variable $name...\""
set len [llength $args]
if {$len > 2 ||
($len == 2 && [lindex $args 0] ne "-array")} {
error "$errRoot, too many initializers"
}
if {[lsearch -exact $compile(typevarnames) $name] != -1} {
error "$errRoot, \"$name\" is already a typevariable"
}
lappend compile(varnames) $name
# Add a ::variable to instancevars, so that ::variable is used
# at least once; ::variable makes the variable visible to
# [info vars] even if no value is assigned.
append compile(instancevars) "\n"
Mappend compile(instancevars) {::variable ${selfns}::%N} %N $name
if {$len == 1} {
append compile(instancevars) \
"\nset $name [list [lindex $args 0]]\n"
} elseif {$len == 2} {
append compile(instancevars) \
"\narray set $name [list [lindex $args 1]]\n"
}
if {$compile(ivprocdec) eq ""} {
set compile(ivprocdec) "\n\t"
append compile(ivprocdec) {namespace upvar $selfns}
}
append compile(ivprocdec) " [list $name $name]"
}
# Defines a typecomponent, and handles component options.
#
# component The logical name of the delegate
# args options.
proc ::snit::Comp.statement.typecomponent {component args} {
variable compile
set errRoot "Error in \"typecomponent $component...\""
# FIRST, define the component
Comp.DefineTypecomponent $component $errRoot
# NEXT, handle the options.
set publicMethod ""
set inheritFlag 0
foreach {opt val} $args {
switch -exact -- $opt {
-public {
set publicMethod $val
}
-inherit {
set inheritFlag $val
if {![string is boolean $inheritFlag]} {
error "typecomponent $component -inherit: expected boolean value, got \"$val\""
}
}
default {
error "typecomponent $component: Invalid option \"$opt\""
}
}
}
# NEXT, if -public specified, define the method.
if {$publicMethod ne ""} {
Comp.statement.delegate typemethod [list $publicMethod *] to $component
}
# NEXT, if "-inherit 1" is specified, delegate typemethod * to
# this component.
if {$inheritFlag} {
Comp.statement.delegate typemethod "*" to $component
}
}
# Defines a name to be a typecomponent
#
# The name becomes a typevariable; in addition, it gets a
# write trace so that when it is set, all of the component mechanisms
# get updated.
#
# component The component name
proc ::snit::Comp.DefineTypecomponent {component {errRoot "Error"}} {
variable compile
if {[lsearch -exact $compile(varnames) $component] != -1} {
error "$errRoot, \"$component\" is already an instance variable"
}
if {[lsearch -exact $compile(typecomponents) $component] == -1} {
# Remember we've done this.
lappend compile(typecomponents) $component
# Make it a type variable with no initial value
Comp.statement.typevariable $component ""
# Add a write trace to do the component thing.
Mappend compile(typevars) {
trace add variable %COMP% write \
[list ::snit::RT.TypecomponentTrace [list %TYPE%] %COMP%]
} %TYPE% $compile(type) %COMP% $component
}
}
# Defines a component, and handles component options.
#
# component The logical name of the delegate
# args options.
#
# TBD: Ideally, it should be possible to call this statement multiple
# times, possibly changing the option values. To do that, I'd need
# to cache the option values and not act on them until *after* I'd
# read the entire type definition.
proc ::snit::Comp.statement.component {component args} {
variable compile
set errRoot "Error in \"component $component...\""
# FIRST, define the component
Comp.DefineComponent $component $errRoot
# NEXT, handle the options.
set publicMethod ""
set inheritFlag 0
foreach {opt val} $args {
switch -exact -- $opt {
-public {
set publicMethod $val
}
-inherit {
set inheritFlag $val
if {![string is boolean $inheritFlag]} {
error "component $component -inherit: expected boolean value, got \"$val\""
}
}
default {
error "component $component: Invalid option \"$opt\""
}
}
}
# NEXT, if -public specified, define the method.
if {$publicMethod ne ""} {
Comp.statement.delegate method [list $publicMethod *] to $component
}
# NEXT, if -inherit is specified, delegate method/option * to
# this component.
if {$inheritFlag} {
Comp.statement.delegate method "*" to $component
Comp.statement.delegate option "*" to $component
}
}
# Defines a name to be a component
#
# The name becomes an instance variable; in addition, it gets a
# write trace so that when it is set, all of the component mechanisms
# get updated.
#
# component The component name
proc ::snit::Comp.DefineComponent {component {errRoot "Error"}} {
variable compile
if {[lsearch -exact $compile(typevarnames) $component] != -1} {
error "$errRoot, \"$component\" is already a typevariable"
}
if {[lsearch -exact $compile(components) $component] == -1} {
# Remember we've done this.
lappend compile(components) $component
# Make it an instance variable with no initial value
Comp.statement.variable $component ""
# Add a write trace to do the component thing.
Mappend compile(instancevars) {
trace add variable ${selfns}::%COMP% write \
[list ::snit::RT.ComponentTrace [list %TYPE%] $selfns %COMP%]
} %TYPE% $compile(type) %COMP% $component
}
}
# Creates a delegated method, typemethod, or option.
proc ::snit::Comp.statement.delegate {what name args} {
# FIRST, dispatch to correct handler.
switch $what {
typemethod { Comp.DelegatedTypemethod $name $args }
method { Comp.DelegatedMethod $name $args }
option { Comp.DelegatedOption $name $args }
default {
error "Error in \"delegate $what $name...\", \"$what\"?"
}
}
if {([llength $args] % 2) != 0} {
error "Error in \"delegate $what $name...\", invalid syntax"
}
}
# Creates a delegated typemethod delegating it to a particular
# typecomponent or an arbitrary command.
#
# method The name of the method
# arglist Delegation options
proc ::snit::Comp.DelegatedTypemethod {method arglist} {
variable compile
variable typemethodInfo
set errRoot "Error in \"delegate typemethod [list $method]...\""
# Next, parse the delegation options.
set component ""
set target ""
set exceptions {}
set pattern ""
set methodTail [lindex $method end]
foreach {opt value} $arglist {
switch -exact $opt {
to { set component $value }
as { set target $value }
except { set exceptions $value }
using { set pattern $value }
default {
error "$errRoot, unknown delegation option \"$opt\""
}
}
}
if {$component eq "" && $pattern eq ""} {
error "$errRoot, missing \"to\""
}
if {$methodTail eq "*" && $target ne ""} {
error "$errRoot, cannot specify \"as\" with \"*\""
}
if {$methodTail ne "*" && $exceptions ne ""} {
error "$errRoot, can only specify \"except\" with \"*\""
}
if {$pattern ne "" && $target ne ""} {
error "$errRoot, cannot specify both \"as\" and \"using\""
}
foreach token [lrange $method 1 end-1] {
if {$token eq "*"} {
error "$errRoot, \"*\" must be the last token."
}
}
# NEXT, define the component
if {$component ne ""} {
Comp.DefineTypecomponent $component $errRoot
}
# NEXT, define the pattern.
if {$pattern eq ""} {
if {$methodTail eq "*"} {
set pattern "%c %m"
} elseif {$target ne ""} {
set pattern "%c $target"
} else {
set pattern "%c %m"
}
}
# Make sure the pattern is a valid list.
if {[catch {lindex $pattern 0} result]} {
error "$errRoot, the using pattern, \"$pattern\", is not a valid list"
}
# NEXT, check the method name against previously defined
# methods.
Comp.CheckMethodName $method 1 ::snit::typemethodInfo $errRoot
set typemethodInfo($method) [list 0 $pattern $component]
if {[string equal $methodTail "*"]} {
Mappend compile(defs) {
set %TYPE%::Snit_info(excepttypemethods) %EXCEPT%
} %EXCEPT% [list $exceptions]
}
}
# Creates a delegated method delegating it to a particular
# component or command.
#
# method The name of the method
# arglist Delegation options.
proc ::snit::Comp.DelegatedMethod {method arglist} {
variable compile
variable methodInfo
set errRoot "Error in \"delegate method [list $method]...\""
# Next, parse the delegation options.
set component ""
set target ""
set exceptions {}
set pattern ""
set methodTail [lindex $method end]
foreach {opt value} $arglist {
switch -exact $opt {
to { set component $value }
as { set target $value }
except { set exceptions $value }
using { set pattern $value }
default {
error "$errRoot, unknown delegation option \"$opt\""
}
}
}
if {$component eq "" && $pattern eq ""} {
error "$errRoot, missing \"to\""
}
if {$methodTail eq "*" && $target ne ""} {
error "$errRoot, cannot specify \"as\" with \"*\""
}
if {$methodTail ne "*" && $exceptions ne ""} {
error "$errRoot, can only specify \"except\" with \"*\""
}
if {$pattern ne "" && $target ne ""} {
error "$errRoot, cannot specify both \"as\" and \"using\""
}
foreach token [lrange $method 1 end-1] {
if {$token eq "*"} {
error "$errRoot, \"*\" must be the last token."
}
}
# NEXT, we delegate some methods
set compile(delegatesmethods) yes
# NEXT, define the component. Allow typecomponents.
if {$component ne ""} {
if {[lsearch -exact $compile(typecomponents) $component] == -1} {
Comp.DefineComponent $component $errRoot
}
}
# NEXT, define the pattern.
if {$pattern eq ""} {
if {$methodTail eq "*"} {
set pattern "%c %m"
} elseif {$target ne ""} {
set pattern "%c $target"
} else {
set pattern "%c %m"
}
}
# Make sure the pattern is a valid list.
if {[catch {lindex $pattern 0} result]} {
error "$errRoot, the using pattern, \"$pattern\", is not a valid list"
}
# NEXT, check the method name against previously defined
# methods.
Comp.CheckMethodName $method 1 ::snit::methodInfo $errRoot
# NEXT, save the method info.
set methodInfo($method) [list 0 $pattern $component]
if {[string equal $methodTail "*"]} {
Mappend compile(defs) {
set %TYPE%::Snit_info(exceptmethods) %EXCEPT%
} %EXCEPT% [list $exceptions]
}
}
# Creates a delegated option, delegating it to a particular
# component and, optionally, to a particular option of that
# component.
#
# optionDef The option definition
# args definition arguments.
proc ::snit::Comp.DelegatedOption {optionDef arglist} {
variable compile
# First, get the three option names.
set option [lindex $optionDef 0]
set resourceName [lindex $optionDef 1]
set className [lindex $optionDef 2]
set errRoot "Error in \"delegate option [list $optionDef]...\""
# Next, parse the delegation options.
set component ""
set target ""
set exceptions {}
foreach {opt value} $arglist {
switch -exact $opt {
to { set component $value }
as { set target $value }
except { set exceptions $value }
default {
error "$errRoot, unknown delegation option \"$opt\""
}
}
}
if {$component eq ""} {
error "$errRoot, missing \"to\""
}
if {$option eq "*" && $target ne ""} {
error "$errRoot, cannot specify \"as\" with \"delegate option *\""
}
if {$option ne "*" && $exceptions ne ""} {
error "$errRoot, can only specify \"except\" with \"delegate option *\""
}
# Next, validate the option name
if {"*" != $option} {
if {![Comp.OptionNameIsValid $option]} {
error "$errRoot, badly named option \"$option\""
}
}
if {$option in $compile(localoptions)} {
error "$errRoot, \"$option\" has been defined locally"
}
if {$option in $compile(delegatedoptions)} {
error "$errRoot, \"$option\" is multiply delegated"
}
# NEXT, define the component
Comp.DefineComponent $component $errRoot
# Next, define the target option, if not specified.
if {![string equal $option "*"] &&
[string equal $target ""]} {
set target $option
}
# NEXT, save the delegation data.
set compile(hasoptions) yes
if {![string equal $option "*"]} {
lappend compile(delegatedoptions) $option
# Next, compute the resource and class names, if they aren't
# already defined.
if {"" == $resourceName} {
set resourceName [string range $option 1 end]
}
if {"" == $className} {
set className [Capitalize $resourceName]
}
Mappend compile(defs) {
set %TYPE%::Snit_optionInfo(islocal-%OPTION%) 0
set %TYPE%::Snit_optionInfo(resource-%OPTION%) %RES%
set %TYPE%::Snit_optionInfo(class-%OPTION%) %CLASS%
lappend %TYPE%::Snit_optionInfo(delegated) %OPTION%
set %TYPE%::Snit_optionInfo(target-%OPTION%) [list %COMP% %TARGET%]
lappend %TYPE%::Snit_optionInfo(delegated-%COMP%) %OPTION%
} %OPTION% $option \
%COMP% $component \
%TARGET% $target \
%RES% $resourceName \
%CLASS% $className
} else {
Mappend compile(defs) {
set %TYPE%::Snit_optionInfo(starcomp) %COMP%
set %TYPE%::Snit_optionInfo(except) %EXCEPT%
} %COMP% $component %EXCEPT% [list $exceptions]
}
}
# Exposes a component, effectively making the component's command an
# instance method.
#
# component The logical name of the delegate
# "as" sugar; if not "", must be "as"
# methodname The desired method name for the component's command, or ""
proc ::snit::Comp.statement.expose {component {"as" ""} {methodname ""}} {
variable compile
# FIRST, define the component
Comp.DefineComponent $component
# NEXT, define the method just as though it were in the type
# definition.
if {[string equal $methodname ""]} {
set methodname $component
}
Comp.statement.method $methodname args [Expand {
if {[llength $args] == 0} {
return $%COMPONENT%
}
if {[string equal $%COMPONENT% ""]} {
error "undefined component \"%COMPONENT%\""
}
set cmd [linsert $args 0 $%COMPONENT%]
return [uplevel 1 $cmd]
} %COMPONENT% $component]
}
#-----------------------------------------------------------------------
# Public commands
# Compile a type definition, and return the results as a list of two
# items: the fully-qualified type name, and a script that will define
# the type when executed.
#
# which type, widget, or widgetadaptor
# type the type name
# body the type definition
proc ::snit::compile {which type body} {
return [Comp.Compile $which $type $body]
}
proc ::snit::type {type body} {
return [Comp.Define [Comp.Compile type $type $body]]
}
proc ::snit::widget {type body} {
return [Comp.Define [Comp.Compile widget $type $body]]
}
proc ::snit::widgetadaptor {type body} {
return [Comp.Define [Comp.Compile widgetadaptor $type $body]]
}
proc ::snit::typemethod {type method arglist body} {
# Make sure the type exists.
if {![info exists ${type}::Snit_info]} {
error "no such type: \"$type\""
}
upvar ${type}::Snit_info Snit_info
upvar ${type}::Snit_typemethodInfo Snit_typemethodInfo
# FIRST, check the typemethod name against previously defined
# typemethods.
Comp.CheckMethodName $method 0 ${type}::Snit_typemethodInfo \
"Cannot define \"$method\""
# NEXT, check the arguments
CheckArgs "snit::typemethod $type $method" $arglist
# Next, add magic reference to type.
set arglist [concat type $arglist]
# Next, add typevariable declarations to body:
set body "$Snit_info(tvardecs)\n$body"
# Next, define it.
if {[llength $method] == 1} {
set Snit_typemethodInfo($method) {0 "%t::Snit_typemethod%m %t" ""}
uplevel 1 [list proc ${type}::Snit_typemethod$method $arglist $body]
} else {
set Snit_typemethodInfo($method) {0 "%t::Snit_htypemethod%j %t" ""}
set suffix [join $method _]
uplevel 1 [list proc ${type}::Snit_htypemethod$suffix $arglist $body]
}
}
proc ::snit::method {type method arglist body} {
# Make sure the type exists.
if {![info exists ${type}::Snit_info]} {
error "no such type: \"$type\""
}
upvar ${type}::Snit_methodInfo Snit_methodInfo
upvar ${type}::Snit_info Snit_info
# FIRST, check the method name against previously defined
# methods.
Comp.CheckMethodName $method 0 ${type}::Snit_methodInfo \
"Cannot define \"$method\""
# NEXT, check the arguments
CheckArgs "snit::method $type $method" $arglist
# Next, add magic references to type and self.
set arglist [concat type selfns win self $arglist]
# Next, add variable declarations to body:
set body "$Snit_info(tvardecs)\n$Snit_info(ivardecs)\n$body"
# Next, define it.
if {[llength $method] == 1} {
set Snit_methodInfo($method) {0 "%t::Snit_method%m %t %n %w %s" ""}
uplevel 1 [list proc ${type}::Snit_method$method $arglist $body]
} else {
set Snit_methodInfo($method) {0 "%t::Snit_hmethod%j %t %n %w %s" ""}
set suffix [join $method _]
uplevel 1 [list proc ${type}::Snit_hmethod$suffix $arglist $body]
}
}
# Defines a proc within the compiler; this proc can call other
# type definition statements, and thus can be used for meta-programming.
proc ::snit::macro {name arglist body} {
variable compiler
variable reservedwords
# FIRST, make sure the compiler is defined.
Comp.Init
# NEXT, check the macro name against the reserved words
if {[lsearch -exact $reservedwords $name] != -1} {
error "invalid macro name \"$name\""
}
# NEXT, see if the name has a namespace; if it does, define the
# namespace.
set ns [namespace qualifiers $name]
if {$ns ne ""} {
$compiler eval "namespace eval $ns {}"
}
# NEXT, define the macro
$compiler eval [list _proc $name $arglist $body]
}
#-----------------------------------------------------------------------
# Utility Functions
#
# These are utility functions used while compiling Snit types.
# Builds a template from a tagged list of text blocks, then substitutes
# all symbols in the mapTable, returning the expanded template.
proc ::snit::Expand {template args} {
return [string map $args $template]
}
# Expands a template and appends it to a variable.
proc ::snit::Mappend {varname template args} {
upvar $varname myvar
append myvar [string map $args $template]
}
# Checks argument list against reserved args
proc ::snit::CheckArgs {which arglist} {
variable reservedArgs
foreach name $reservedArgs {
if {$name in $arglist} {
error "$which's arglist may not contain \"$name\" explicitly"
}
}
}
# Capitalizes the first letter of a string.
proc ::snit::Capitalize {text} {
return [string toupper $text 0]
}
#=======================================================================
# Snit Runtime Library
#
# These are procs used by Snit types and widgets at runtime.
#-----------------------------------------------------------------------
# Object Creation
# Creates a new instance of the snit::type given its name and the args.
#
# type The snit::type
# name The instance name
# args Args to pass to the constructor
proc ::snit::RT.type.typemethod.create {type name args} {
variable ${type}::Snit_info
variable ${type}::Snit_optionInfo
# FIRST, qualify the name.
if {![string match "::*" $name]} {
# Get caller's namespace;
# append :: if not global namespace.
set ns [uplevel 1 [list namespace current]]
if {"::" != $ns} {
append ns "::"
}
set name "$ns$name"
}
# NEXT, if %AUTO% appears in the name, generate a unique
# command name. Otherwise, ensure that the name isn't in use.
if {[string match "*%AUTO%*" $name]} {
set name [::snit::RT.UniqueName Snit_info(counter) $type $name]
} elseif {!$Snit_info(canreplace) && [llength [info commands $name]]} {
error "command \"$name\" already exists"
}
# NEXT, create the instance's namespace.
set selfns \
[::snit::RT.UniqueInstanceNamespace Snit_info(counter) $type]
namespace eval $selfns {}
# NEXT, install the dispatcher
RT.MakeInstanceCommand $type $selfns $name
# Initialize the options to their defaults.
namespace upvar ${selfns} options options
foreach opt $Snit_optionInfo(local) {
set options($opt) $Snit_optionInfo(default-$opt)
}
# Initialize the instance vars to their defaults.
# selfns must be defined, as it is used implicitly.
${type}::Snit_instanceVars $selfns
# Execute the type's constructor.
set errcode [catch {
RT.ConstructInstance $type $selfns $name $args
} result]
if {$errcode} {
global errorInfo
global errorCode
set theInfo $errorInfo
set theCode $errorCode
::snit::RT.DestroyObject $type $selfns $name
error "Error in constructor: $result" $theInfo $theCode
}
# NEXT, return the object's name.
return $name
}
# Creates a new instance of the snit::widget or snit::widgetadaptor
# given its name and the args.
#
# type The snit::widget or snit::widgetadaptor
# name The instance name
# args Args to pass to the constructor
proc ::snit::RT.widget.typemethod.create {type name args} {
variable ${type}::Snit_info
variable ${type}::Snit_optionInfo
# FIRST, if %AUTO% appears in the name, generate a unique
# command name.
if {[string match "*%AUTO%*" $name]} {
set name [::snit::RT.UniqueName Snit_info(counter) $type $name]
}
# NEXT, create the instance's namespace.
set selfns \
[::snit::RT.UniqueInstanceNamespace Snit_info(counter) $type]
namespace eval $selfns { }
# NEXT, Initialize the widget's own options to their defaults.
namespace upvar $selfns options options
foreach opt $Snit_optionInfo(local) {
set options($opt) $Snit_optionInfo(default-$opt)
}
# Initialize the instance vars to their defaults.
${type}::Snit_instanceVars $selfns
# NEXT, if this is a normal widget (not a widget adaptor) then create a
# frame as its hull. We set the frame's -class to the user's widgetclass,
# or, if none, search for -class in the args list, otherwise default to
# the basename of the $type with an initial upper case letter.
if {!$Snit_info(isWidgetAdaptor)} {
# FIRST, determine the class name
set wclass $Snit_info(widgetclass)
if {$Snit_info(widgetclass) eq ""} {
set idx [lsearch -exact $args -class]
if {$idx >= 0 && ($idx%2 == 0)} {
# -class exists and is in the -option position
set wclass [lindex $args [expr {$idx+1}]]
set args [lreplace $args $idx [expr {$idx+1}]]
} else {
set wclass [::snit::Capitalize [namespace tail $type]]
}
}
# NEXT, create the widget
set self $name
package require Tk
${type}::installhull using $Snit_info(hulltype) -class $wclass
# NEXT, let's query the option database for our
# widget, now that we know that it exists.
foreach opt $Snit_optionInfo(local) {
set dbval [RT.OptionDbGet $type $name $opt]
if {"" != $dbval} {
set options($opt) $dbval
}
}
}
# Execute the type's constructor, and verify that it
# has a hull.
set errcode [catch {
RT.ConstructInstance $type $selfns $name $args
::snit::RT.Component $type $selfns hull
# Prepare to call the object's destructor when the
# <Destroy> event is received. Use a Snit-specific bindtag
# so that the widget name's tag is unencumbered.
bind Snit$type$name <Destroy> [::snit::Expand {
::snit::RT.DestroyObject %TYPE% %NS% %W
} %TYPE% $type %NS% $selfns]
# Insert the bindtag into the list of bindtags right
# after the widget name.
set taglist [bindtags $name]
set ndx [lsearch -exact $taglist $name]
incr ndx
bindtags $name [linsert $taglist $ndx Snit$type$name]
} result]
if {$errcode} {
global errorInfo
global errorCode
set theInfo $errorInfo
set theCode $errorCode
::snit::RT.DestroyObject $type $selfns $name
error "Error in constructor: $result" $theInfo $theCode
}
# NEXT, return the object's name.
return $name
}
# RT.MakeInstanceCommand type selfns instance
#
# type The object type
# selfns The instance namespace
# instance The instance name
#
# Creates the instance proc.
proc ::snit::RT.MakeInstanceCommand {type selfns instance} {
variable ${type}::Snit_info
# FIRST, remember the instance name. The Snit_instance variable
# allows the instance to figure out its current name given the
# instance namespace.
namespace upvar $selfns Snit_instance Snit_instance
set Snit_instance $instance
# NEXT, qualify the proc name if it's a widget.
if {$Snit_info(isWidget)} {
set procname ::$instance
} else {
set procname $instance
}
# NEXT, install the new proc
# WHD: Snit 2.0 code
set unknownCmd [list ::snit::RT.UnknownMethod $type $selfns $instance ""]
set createCmd [list namespace ensemble create \
-command $procname \
-unknown $unknownCmd \
-prefixes 0]
namespace eval $selfns $createCmd
# NEXT, add the trace.
trace add command $procname {rename delete} \
[list ::snit::RT.InstanceTrace $type $selfns $instance]
}
# This proc is called when the instance command is renamed.
# If op is delete, then new will always be "", so op is redundant.
#
# type The fully-qualified type name
# selfns The instance namespace
# win The original instance/tk window name.
# old old instance command name
# new new instance command name
# op rename or delete
#
# If the op is delete, we need to clean up the object; otherwise,
# we need to track the change.
#
# NOTE: In Tcl 8.4.2 there's a bug: errors in rename and delete
# traces aren't propagated correctly. Instead, they silently
# vanish. Add a catch to output any error message.
proc ::snit::RT.InstanceTrace {type selfns win old new op} {
variable ${type}::Snit_info
# Note to developers ...
# For Tcl 8.4.0, errors thrown in trace handlers vanish silently.
# Therefore we catch them here and create some output to help in
# debugging such problems.
if {[catch {
# FIRST, clean up if necessary
if {"" == $new} {
if {$Snit_info(isWidget)} {
destroy $win
} else {
::snit::RT.DestroyObject $type $selfns $win
}
} else {
# Otherwise, track the change.
variable ${selfns}::Snit_instance
set Snit_instance [uplevel 1 [list namespace which -command $new]]
# Also, clear the instance caches, as many cached commands
# might be invalid.
RT.ClearInstanceCaches $selfns
}
} result]} {
global errorInfo
# Pop up the console on Windows wish, to enable stdout.
# This clobbers errorInfo on unix, so save it so we can print it.
set ei $errorInfo
catch {console show}
puts "Error in ::snit::RT.InstanceTrace $type $selfns $win $old $new $op:"
puts $ei
}
}
# Calls the instance constructor and handles related housekeeping.
proc ::snit::RT.ConstructInstance {type selfns instance arglist} {
variable ${type}::Snit_optionInfo
variable ${selfns}::Snit_iinfo
# Track whether we are constructed or not.
set Snit_iinfo(constructed) 0
# Call the user's constructor
eval [linsert $arglist 0 \
${type}::Snit_constructor $type $selfns $instance $instance]
set Snit_iinfo(constructed) 1
# Validate the initial set of options (including defaults)
foreach option $Snit_optionInfo(local) {
set value [set ${selfns}::options($option)]
if {$Snit_optionInfo(typespec-$option) ne ""} {
if {[catch {
$Snit_optionInfo(typeobj-$option) validate $value
} result]} {
return -code error "invalid $option default: $result"
}
}
}
# Unset the configure cache for all -readonly options.
# This ensures that the next time anyone tries to
# configure it, an error is thrown.
foreach opt $Snit_optionInfo(local) {
if {$Snit_optionInfo(readonly-$opt)} {
unset -nocomplain ${selfns}::Snit_configureCache($opt)
}
}
return
}
# Returns a unique command name.
#
# REQUIRE: type is a fully qualified name.
# REQUIRE: name contains "%AUTO%"
# PROMISE: the returned command name is unused.
proc ::snit::RT.UniqueName {countervar type name} {
upvar $countervar counter
while 1 {
# FIRST, bump the counter and define the %AUTO% instance name;
# then substitute it into the specified name. Wrap around at
# 2^31 - 2 to prevent overflow problems.
incr counter
if {$counter > 2147483646} {
set counter 0
}
set auto "[namespace tail $type]$counter"
set candidate [Expand $name %AUTO% $auto]
if {![llength [info commands $candidate]]} {
return $candidate
}
}
}
# Returns a unique instance namespace, fully qualified.
#
# countervar The name of a counter variable
# type The instance's type
#
# REQUIRE: type is fully qualified
# PROMISE: The returned namespace name is unused.
proc ::snit::RT.UniqueInstanceNamespace {countervar type} {
upvar $countervar counter
while 1 {
# FIRST, bump the counter and define the namespace name.
# Then see if it already exists. Wrap around at
# 2^31 - 2 to prevent overflow problems.
incr counter
if {$counter > 2147483646} {
set counter 0
}
set ins "${type}::Snit_inst${counter}"
if {![namespace exists $ins]} {
return $ins
}
}
}
# Retrieves an option's value from the option database.
# Returns "" if no value is found.
proc ::snit::RT.OptionDbGet {type self opt} {
variable ${type}::Snit_optionInfo
return [option get $self \
$Snit_optionInfo(resource-$opt) \
$Snit_optionInfo(class-$opt)]
}
#-----------------------------------------------------------------------
# Object Destruction
# Implements the standard "destroy" method
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
proc ::snit::RT.method.destroy {type selfns win self} {
variable ${selfns}::Snit_iinfo
# Can't destroy the object if it isn't complete constructed.
if {!$Snit_iinfo(constructed)} {
return -code error "Called 'destroy' method in constructor"
}
# Calls Snit_cleanup, which (among other things) calls the
# user's destructor.
::snit::RT.DestroyObject $type $selfns $win
}
# This is the function that really cleans up; it's automatically
# called when any instance is destroyed, e.g., by "$object destroy"
# for types, and by the <Destroy> event for widgets.
#
# type The fully-qualified type name.
# selfns The instance namespace
# win The original instance command name.
proc ::snit::RT.DestroyObject {type selfns win} {
variable ${type}::Snit_info
# If the variable Snit_instance doesn't exist then there's no
# instance command for this object -- it's most likely a
# widgetadaptor. Consequently, there are some things that
# we don't need to do.
if {[info exists ${selfns}::Snit_instance]} {
namespace upvar $selfns Snit_instance instance
# First, remove the trace on the instance name, so that we
# don't call RT.DestroyObject recursively.
RT.RemoveInstanceTrace $type $selfns $win $instance
# Next, call the user's destructor
${type}::Snit_destructor $type $selfns $win $instance
# Next, if this isn't a widget, delete the instance command.
# If it is a widget, get the hull component's name, and rename
# it back to the widget name
# Next, delete the hull component's instance command,
# if there is one.
if {$Snit_info(isWidget)} {
set hullcmd [::snit::RT.Component $type $selfns hull]
catch {rename $instance ""}
# Clear the bind event
bind Snit$type$win <Destroy> ""
if {[llength [info commands $hullcmd]]} {
# FIRST, rename the hull back to its original name.
# If the hull is itself a megawidget, it will have its
# own cleanup to do, and it might not do it properly
# if it doesn't have the right name.
rename $hullcmd ::$instance
# NEXT, destroy it.
destroy $instance
}
} else {
catch {rename $instance ""}
}
}
# Next, delete the instance's namespace. This kills any
# instance variables.
namespace delete $selfns
return
}
# Remove instance trace
#
# type The fully qualified type name
# selfns The instance namespace
# win The original instance name/Tk window name
# instance The current instance name
proc ::snit::RT.RemoveInstanceTrace {type selfns win instance} {
variable ${type}::Snit_info
if {$Snit_info(isWidget)} {
set procname ::$instance
} else {
set procname $instance
}
# NEXT, remove any trace on this name
catch {
trace remove command $procname {rename delete} \
[list ::snit::RT.InstanceTrace $type $selfns $win]
}
}
#-----------------------------------------------------------------------
# Typecomponent Management and Method Caching
# Typecomponent trace; used for write trace on typecomponent
# variables. Saves the new component object name, provided
# that certain conditions are met. Also clears the typemethod
# cache.
proc ::snit::RT.TypecomponentTrace {type component n1 n2 op} {
namespace upvar $type \
Snit_info Snit_info \
$component cvar \
Snit_typecomponents Snit_typecomponents
# Save the new component value.
set Snit_typecomponents($component) $cvar
# Clear the typemethod cache.
# TBD: can we unset just the elements related to
# this component?
# WHD: Namespace 2.0 code
namespace ensemble configure $type -map {}
}
# WHD: Snit 2.0 code
#
# RT.UnknownTypemethod type eId eCmd method args
#
# type The type
# eId The ensemble command ID; "" for the instance itself.
# eCmd The ensemble command name.
# method The unknown method name.
# args The additional arguments, if any.
#
# This proc looks up the method relative to the specified ensemble.
# If no method is found, it assumes that the "create" method is
# desired, and that the "method" is the instance name. In this case,
# it returns the "create" typemethod command with the instance name
# appended; this will cause the instance to be created without updating
# the -map. If the method is found, the method's command is created and
# added to the -map; the function returns the empty list.
proc snit::RT.UnknownTypemethod {type eId eCmd method args} {
namespace upvar $type \
Snit_typemethodInfo Snit_typemethodInfo \
Snit_typecomponents Snit_typecomponents \
Snit_info Snit_info
# FIRST, get the pattern data and the typecomponent name.
set implicitCreate 0
set instanceName ""
set fullMethod $eId
lappend fullMethod $method
set starredMethod [concat $eId *]
set methodTail $method
if {[info exists Snit_typemethodInfo($fullMethod)]} {
set key $fullMethod
} elseif {[info exists Snit_typemethodInfo($starredMethod)]} {
if {[lsearch -exact $Snit_info(excepttypemethods) $methodTail] == -1} {
set key $starredMethod
} else {
# WHD: The method is explicitly not delegated, so this is an error.
# Or should we treat it as an instance name?
return [list ]
}
} elseif {[llength $fullMethod] > 1} {
return [list ]
} elseif {$Snit_info(hasinstances)} {
# Assume the unknown name is an instance name to create, unless
# this is a widget and the style of the name is wrong, or the
# name mimics a standard typemethod.
if {[set ${type}::Snit_info(isWidget)] &&
![string match ".*" $method]} {
return [list ]
}
# Without this check, the call "$type info" will redefine the
# standard "::info" command, with disastrous results. Since it's
# a likely thing to do if !-typeinfo, put in an explicit check.
if {$method eq "info" || $method eq "destroy"} {
return [list ]
}
set implicitCreate 1
set instanceName $method
set key create
set method create
} else {
return [list ]
}
foreach {flag pattern compName} $Snit_typemethodInfo($key) {}
if {$flag == 1} {
# FIRST, define the ensemble command.
lappend eId $method
set newCmd ${type}::Snit_ten[llength $eId]_[join $eId _]
set unknownCmd [list ::snit::RT.UnknownTypemethod \
$type $eId]
set createCmd [list namespace ensemble create \
-command $newCmd \
-unknown $unknownCmd \
-prefixes 0]
namespace eval $type $createCmd
# NEXT, add the method to the current ensemble
set map [namespace ensemble configure $eCmd -map]
dict append map $method $newCmd
namespace ensemble configure $eCmd -map $map
return [list ]
}
# NEXT, build the substitution list
set subList [list \
%% % \
%t $type \
%M $fullMethod \
%m [lindex $fullMethod end] \
%j [join $fullMethod _]]
if {$compName ne ""} {
if {![info exists Snit_typecomponents($compName)]} {
error "$type delegates typemethod \"$method\" to undefined typecomponent \"$compName\""
}
lappend subList %c [list $Snit_typecomponents($compName)]
}
set command {}
foreach subpattern $pattern {
lappend command [string map $subList $subpattern]
}
if {$implicitCreate} {
# In this case, $method is the name of the instance to
# create. Don't cache, as we usually won't do this one
# again.
lappend command $instanceName
return $command
}
# NEXT, if the actual command name isn't fully qualified,
# assume it's global.
set cmd [lindex $command 0]
if {[string index $cmd 0] ne ":"} {
set command [lreplace $command 0 0 "::$cmd"]
}
# NEXT, update the ensemble map.
set map [namespace ensemble configure $eCmd -map]
dict append map $method $command
namespace ensemble configure $eCmd -map $map
return [list ]
}
#-----------------------------------------------------------------------
# Component Management and Method Caching
# Retrieves the object name given the component name.
proc ::snit::RT.Component {type selfns name} {
variable ${selfns}::Snit_components
if {[catch {set Snit_components($name)} result]} {
variable ${selfns}::Snit_instance
error "component \"$name\" is undefined in $type $Snit_instance"
}
return $result
}
# Component trace; used for write trace on component instance
# variables. Saves the new component object name, provided
# that certain conditions are met. Also clears the method
# cache.
proc ::snit::RT.ComponentTrace {type selfns component n1 n2 op} {
namespace upvar $type Snit_info Snit_info
namespace upvar $selfns \
$component cvar \
Snit_components Snit_components
# If they try to redefine the hull component after
# it's been defined, that's an error--but only if
# this is a widget or widget adaptor.
if {"hull" == $component &&
$Snit_info(isWidget) &&
[info exists Snit_components($component)]} {
set cvar $Snit_components($component)
error "The hull component cannot be redefined"
}
# Save the new component value.
set Snit_components($component) $cvar
# Clear the instance caches.
# TBD: can we unset just the elements related to
# this component?
RT.ClearInstanceCaches $selfns
}
# WHD: Snit 2.0 code
#
# RT.UnknownMethod type selfns win eId eCmd method args
#
# type The type or widget command.
# selfns The instance namespace.
# win The original instance name.
# eId The ensemble command ID; "" for the instance itself.
# eCmd The real ensemble command name
# method The unknown method name
# args The additional arguments, if any.
#
# This proc looks up the method relative to the specific ensemble.
# If no method is found, it returns an empty list; this will result in
# the parent ensemble throwing an error.
# If the method is found, the ensemble's -map is extended with the
# correct command, and the empty list is returned; this caches the
# method's command. If the method is found, and it is also an
# ensemble, the ensemble command is created with an empty map.
proc ::snit::RT.UnknownMethod {type selfns win eId eCmd method args} {
variable ${type}::Snit_info
variable ${type}::Snit_methodInfo
variable ${type}::Snit_typecomponents
variable ${selfns}::Snit_components
# FIRST, get the "self" value
set self [set ${selfns}::Snit_instance]
# FIRST, get the pattern data and the component name.
set fullMethod $eId
lappend fullMethod $method
set starredMethod [concat $eId *]
set methodTail $method
if {[info exists Snit_methodInfo($fullMethod)]} {
set key $fullMethod
} elseif {[info exists Snit_methodInfo($starredMethod)] &&
[lsearch -exact $Snit_info(exceptmethods) $methodTail] == -1} {
set key $starredMethod
} else {
return [list ]
}
foreach {flag pattern compName} $Snit_methodInfo($key) {}
if {$flag == 1} {
# FIRST, define the ensemble command.
lappend eId $method
# Fix provided by Anton Kovalenko; previously this call erroneously
# used ${type} rather than ${selfns}.
set newCmd ${selfns}::Snit_en[llength $eId]_[join $eId _]
set unknownCmd [list ::snit::RT.UnknownMethod \
$type $selfns $win $eId]
set createCmd [list namespace ensemble create \
-command $newCmd \
-unknown $unknownCmd \
-prefixes 0]
namespace eval $selfns $createCmd
# NEXT, add the method to the current ensemble
set map [namespace ensemble configure $eCmd -map]
dict append map $method $newCmd
namespace ensemble configure $eCmd -map $map
return [list ]
}
# NEXT, build the substitution list
set subList [list \
%% % \
%t $type \
%M $fullMethod \
%m [lindex $fullMethod end] \
%j [join $fullMethod _] \
%n [list $selfns] \
%w [list $win] \
%s [list $self]]
if {$compName ne ""} {
if {[info exists Snit_components($compName)]} {
set compCmd $Snit_components($compName)
} elseif {[info exists Snit_typecomponents($compName)]} {
set compCmd $Snit_typecomponents($compName)
} else {
error "$type $self delegates method \"$fullMethod\" to undefined component \"$compName\""
}
lappend subList %c [list $compCmd]
}
# Note: The cached command will execute faster if it's
# already a list.
set command {}
foreach subpattern $pattern {
lappend command [string map $subList $subpattern]
}
# NEXT, if the actual command name isn't fully qualified,
# assume it's global.
set cmd [lindex $command 0]
if {[string index $cmd 0] ne ":"} {
set command [lreplace $command 0 0 "::$cmd"]
}
# NEXT, update the ensemble map.
set map [namespace ensemble configure $eCmd -map]
dict append map $method $command
namespace ensemble configure $eCmd -map $map
return [list ]
}
# Clears all instance command caches
proc ::snit::RT.ClearInstanceCaches {selfns} {
# WHD: clear ensemble -map
if {![info exists ${selfns}::Snit_instance]} {
# Component variable set prior to constructor
# via the "variable" type definition statement.
return
}
set self [set ${selfns}::Snit_instance]
namespace ensemble configure $self -map {}
unset -nocomplain -- ${selfns}::Snit_cgetCache
unset -nocomplain -- ${selfns}::Snit_configureCache
unset -nocomplain -- ${selfns}::Snit_validateCache
}
#-----------------------------------------------------------------------
# Component Installation
# Implements %TYPE%::installhull. The variables self and selfns
# must be defined in the caller's context.
#
# Installs the named widget as the hull of a
# widgetadaptor. Once the widget is hijacked, its new name
# is assigned to the hull component.
proc ::snit::RT.installhull {type {using "using"} {widgetType ""} args} {
variable ${type}::Snit_info
variable ${type}::Snit_optionInfo
upvar 1 self self
upvar 1 selfns selfns
namespace upvar $selfns \
hull hull \
options options
# FIRST, make sure we can do it.
if {!$Snit_info(isWidget)} {
error "installhull is valid only for snit::widgetadaptors"
}
if {[info exists ${selfns}::Snit_instance]} {
error "hull already installed for $type $self"
}
# NEXT, has it been created yet? If not, create it using
# the specified arguments.
if {"using" == $using} {
# FIRST, create the widget
set cmd [linsert $args 0 $widgetType $self]
set obj [uplevel 1 $cmd]
# NEXT, for each option explicitly delegated to the hull
# that doesn't appear in the usedOpts list, get the
# option database value and apply it--provided that the
# real option name and the target option name are different.
# (If they are the same, then the option database was
# already queried as part of the normal widget creation.)
#
# Also, we don't need to worry about implicitly delegated
# options, as the option and target option names must be
# the same.
if {[info exists Snit_optionInfo(delegated-hull)]} {
# FIRST, extract all option names from args
set usedOpts {}
set ndx [lsearch -glob $args "-*"]
foreach {opt val} [lrange $args $ndx end] {
lappend usedOpts $opt
}
foreach opt $Snit_optionInfo(delegated-hull) {
set target [lindex $Snit_optionInfo(target-$opt) 1]
if {"$target" == $opt} {
continue
}
set result [lsearch -exact $usedOpts $target]
if {$result != -1} {
continue
}
set dbval [RT.OptionDbGet $type $self $opt]
$obj configure $target $dbval
}
}
} else {
set obj $using
if {$obj ne $self} {
error \
"hull name mismatch: \"$obj\" != \"$self\""
}
}
# NEXT, get the local option defaults.
foreach opt $Snit_optionInfo(local) {
set dbval [RT.OptionDbGet $type $self $opt]
if {"" != $dbval} {
set options($opt) $dbval
}
}
# NEXT, do the magic
set i 0
while 1 {
incr i
set newName "::hull${i}$self"
if {![llength [info commands $newName]]} {
break
}
}
rename ::$self $newName
RT.MakeInstanceCommand $type $selfns $self
# Note: this relies on RT.ComponentTrace to do the dirty work.
set hull $newName
return
}
# Implements %TYPE%::install.
#
# Creates a widget and installs it as the named component.
# It expects self and selfns to be defined in the caller's context.
proc ::snit::RT.install {type compName "using" widgetType winPath args} {
variable ${type}::Snit_optionInfo
variable ${type}::Snit_info
upvar 1 self self
upvar 1 selfns selfns
namespace upvar ${selfns} \
$compName comp \
hull hull
# We do the magic option database stuff only if $self is
# a widget.
if {$Snit_info(isWidget)} {
if {"" == $hull} {
error "tried to install \"$compName\" before the hull exists"
}
# FIRST, query the option database and save the results
# into args. Insert them before the first option in the
# list, in case there are any non-standard parameters.
#
# Note: there might not be any delegated options; if so,
# don't bother.
if {[info exists Snit_optionInfo(delegated-$compName)]} {
set ndx [lsearch -glob $args "-*"]
foreach opt $Snit_optionInfo(delegated-$compName) {
set dbval [RT.OptionDbGet $type $self $opt]
if {"" != $dbval} {
set target [lindex $Snit_optionInfo(target-$opt) 1]
set args [linsert $args $ndx $target $dbval]
}
}
}
}
# NEXT, create the component and save it.
set cmd [concat [list $widgetType $winPath] $args]
set comp [uplevel 1 $cmd]
# NEXT, handle the option database for "delegate option *",
# in widgets only.
if {$Snit_info(isWidget) && $Snit_optionInfo(starcomp) eq $compName} {
# FIRST, get the list of option specs from the widget.
# If configure doesn't work, skip it.
if {[catch {$comp configure} specs]} {
return
}
# NEXT, get the set of explicitly used options from args
set usedOpts {}
set ndx [lsearch -glob $args "-*"]
foreach {opt val} [lrange $args $ndx end] {
lappend usedOpts $opt
}
# NEXT, "delegate option *" matches all options defined
# by this widget that aren't defined by the widget as a whole,
# and that aren't excepted. Plus, we skip usedOpts. So build
# a list of the options it can't match.
set skiplist [concat \
$usedOpts \
$Snit_optionInfo(except) \
$Snit_optionInfo(local) \
$Snit_optionInfo(delegated)]
# NEXT, loop over all of the component's options, and set
# any not in the skip list for which there is an option
# database value.
foreach spec $specs {
# Skip aliases
if {[llength $spec] != 5} {
continue
}
set opt [lindex $spec 0]
if {[lsearch -exact $skiplist $opt] != -1} {
continue
}
set res [lindex $spec 1]
set cls [lindex $spec 2]
set dbvalue [option get $self $res $cls]
if {"" != $dbvalue} {
$comp configure $opt $dbvalue
}
}
}
return
}
#-----------------------------------------------------------------------
# Method/Variable Name Qualification
# Implements %TYPE%::variable. Requires selfns.
proc ::snit::RT.variable {varname} {
upvar 1 selfns selfns
if {![string match "::*" $varname]} {
uplevel 1 [list upvar 1 ${selfns}::$varname $varname]
} else {
# varname is fully qualified; let the standard
# "variable" command handle it.
uplevel 1 [list ::variable $varname]
}
}
# Fully qualifies a typevariable name.
#
# This is used to implement the mytypevar command.
proc ::snit::RT.mytypevar {type name} {
return ${type}::$name
}
# Fully qualifies an instance variable name.
#
# This is used to implement the myvar command.
proc ::snit::RT.myvar {name} {
upvar 1 selfns selfns
return ${selfns}::$name
}
# Use this like "list" to convert a proc call into a command
# string to pass to another object (e.g., as a -command).
# Qualifies the proc name properly.
#
# This is used to implement the "myproc" command.
proc ::snit::RT.myproc {type procname args} {
set procname "${type}::$procname"
return [linsert $args 0 $procname]
}
# DEPRECATED
proc ::snit::RT.codename {type name} {
return "${type}::$name"
}
# Use this like "list" to convert a typemethod call into a command
# string to pass to another object (e.g., as a -command).
# Inserts the type command at the beginning.
#
# This is used to implement the "mytypemethod" command.
proc ::snit::RT.mytypemethod {type args} {
return [linsert $args 0 $type]
}
# Use this like "list" to convert a method call into a command
# string to pass to another object (e.g., as a -command).
# Inserts the code at the beginning to call the right object, even if
# the object's name has changed. Requires that selfns be defined
# in the calling context, eg. can only be called in instance
# code.
#
# This is used to implement the "mymethod" command.
proc ::snit::RT.mymethod {args} {
upvar 1 selfns selfns
return [linsert $args 0 ::snit::RT.CallInstance ${selfns}]
}
# Calls an instance method for an object given its
# instance namespace and remaining arguments (the first of which
# will be the method name.
#
# selfns The instance namespace
# args The arguments
#
# Uses the selfns to determine $self, and calls the method
# in the normal way.
#
# This is used to implement the "mymethod" command.
proc ::snit::RT.CallInstance {selfns args} {
namespace upvar $selfns Snit_instance self
set retval [catch {uplevel 1 [linsert $args 0 $self]} result]
if {$retval} {
if {$retval == 1} {
global errorInfo
global errorCode
return -code error -errorinfo $errorInfo \
-errorcode $errorCode $result
} else {
return -code $retval $result
}
}
return $result
}
# Looks for the named option in the named variable. If found,
# it and its value are removed from the list, and the value
# is returned. Otherwise, the default value is returned.
# If the option is undelegated, it's own default value will be
# used if none is specified.
#
# Implements the "from" command.
proc ::snit::RT.from {type argvName option {defvalue ""}} {
namespace upvar $type Snit_optionInfo Snit_optionInfo
upvar $argvName argv
set ioption [lsearch -exact $argv $option]
if {$ioption == -1} {
if {"" == $defvalue &&
[info exists Snit_optionInfo(default-$option)]} {
return $Snit_optionInfo(default-$option)
} else {
return $defvalue
}
}
set ivalue [expr {$ioption + 1}]
set value [lindex $argv $ivalue]
set argv [lreplace $argv $ioption $ivalue]
return $value
}
#-----------------------------------------------------------------------
# Type Destruction
# Implements the standard "destroy" typemethod:
# Destroys a type completely.
#
# type The snit type
proc ::snit::RT.typemethod.destroy {type} {
variable ${type}::Snit_info
# FIRST, destroy all instances
foreach selfns [namespace children $type "${type}::Snit_inst*"] {
if {![namespace exists $selfns]} {
continue
}
namespace upvar $selfns Snit_instance obj
if {$Snit_info(isWidget)} {
destroy $obj
} else {
if {[llength [info commands $obj]]} {
$obj destroy
}
}
}
# NEXT, get rid of the type command.
rename $type ""
# NEXT, destroy the type's data.
namespace delete $type
}
#-----------------------------------------------------------------------
# Option Handling
# Implements the standard "cget" method
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# option The name of the option
proc ::snit::RT.method.cget {type selfns win self option} {
if {[catch {set ${selfns}::Snit_cgetCache($option)} command]} {
set command [snit::RT.CacheCgetCommand $type $selfns $win $self $option]
if {[llength $command] == 0} {
return -code error "unknown option \"$option\""
}
}
uplevel 1 $command
}
# Retrieves and caches the command that implements "cget" for the
# specified option.
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# option The name of the option
proc ::snit::RT.CacheCgetCommand {type selfns win self option} {
variable ${type}::Snit_optionInfo
variable ${selfns}::Snit_cgetCache
if {[info exists Snit_optionInfo(islocal-$option)]} {
# We know the item; it's either local, or explicitly delegated.
if {$Snit_optionInfo(islocal-$option)} {
# It's a local option. If it has a cget method defined,
# use it; otherwise just return the value.
if {$Snit_optionInfo(cget-$option) eq ""} {
set command [list set ${selfns}::options($option)]
} else {
# WHD: Snit 2.0 code -- simpler, no slower.
set command [list \
$self \
{*}$Snit_optionInfo(cget-$option) \
$option]
}
set Snit_cgetCache($option) $command
return $command
}
# Explicitly delegated option; get target
set comp [lindex $Snit_optionInfo(target-$option) 0]
set target [lindex $Snit_optionInfo(target-$option) 1]
} elseif {$Snit_optionInfo(starcomp) ne "" &&
[lsearch -exact $Snit_optionInfo(except) $option] == -1} {
# Unknown option, but unknowns are delegated; get target.
set comp $Snit_optionInfo(starcomp)
set target $option
} else {
return ""
}
# Get the component's object.
set obj [RT.Component $type $selfns $comp]
set command [list $obj cget $target]
set Snit_cgetCache($option) $command
return $command
}
# Implements the standard "configurelist" method
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# optionlist A list of options and their values.
proc ::snit::RT.method.configurelist {type selfns win self optionlist} {
variable ${type}::Snit_optionInfo
foreach {option value} $optionlist {
# FIRST, get the configure command, caching it if need be.
if {[catch {set ${selfns}::Snit_configureCache($option)} command]} {
set command [snit::RT.CacheConfigureCommand \
$type $selfns $win $self $option]
if {[llength $command] == 0} {
return -code error "unknown option \"$option\""
}
}
# NEXT, if we have a type-validation object, use it.
# TBD: Should test (islocal-$option) here, but islocal
# isn't defined for implicitly delegated options.
if {[info exists Snit_optionInfo(typeobj-$option)]
&& $Snit_optionInfo(typeobj-$option) ne ""} {
if {[catch {
$Snit_optionInfo(typeobj-$option) validate $value
} result]} {
return -code error "invalid $option value: $result"
}
}
# NEXT, the caching the configure command also cached the
# validate command, if any. If we have one, run it.
set valcommand [set ${selfns}::Snit_validateCache($option)]
if {[llength $valcommand]} {
lappend valcommand $value
uplevel 1 $valcommand
}
# NEXT, configure the option with the value.
lappend command $value
uplevel 1 $command
}
return
}
# Retrieves and caches the command that stores the named option.
# Also stores the command that validates the name option if any;
# If none, the validate command is "", so that the cache is always
# populated.
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# option An option name
proc ::snit::RT.CacheConfigureCommand {type selfns win self option} {
variable ${type}::Snit_optionInfo
variable ${selfns}::Snit_configureCache
variable ${selfns}::Snit_validateCache
if {[info exist Snit_optionInfo(islocal-$option)]} {
# We know the item; it's either local, or explicitly delegated.
if {$Snit_optionInfo(islocal-$option)} {
# It's a local option.
# If it's readonly, it throws an error if we're already
# constructed.
if {$Snit_optionInfo(readonly-$option)} {
if {[set ${selfns}::Snit_iinfo(constructed)]} {
error "option $option can only be set at instance creation"
}
}
# If it has a validate method, cache that for later.
if {$Snit_optionInfo(validate-$option) ne ""} {
# WHD: Snit 2.0 code -- simpler, no slower.
set command [list \
$self \
{*}$Snit_optionInfo(validate-$option) \
$option]
set Snit_validateCache($option) $command
} else {
set Snit_validateCache($option) ""
}
# If it has a configure method defined,
# cache it; otherwise, just set the value.
if {$Snit_optionInfo(configure-$option) eq ""} {
set command [list set ${selfns}::options($option)]
} else {
# WHD: Snit 2.0 code -- simpler, no slower.
set command [list \
$self \
{*}$Snit_optionInfo(configure-$option) \
$option]
}
set Snit_configureCache($option) $command
return $command
}
# Delegated option: get target.
set comp [lindex $Snit_optionInfo(target-$option) 0]
set target [lindex $Snit_optionInfo(target-$option) 1]
} elseif {$Snit_optionInfo(starcomp) != "" &&
[lsearch -exact $Snit_optionInfo(except) $option] == -1} {
# Unknown option, but unknowns are delegated.
set comp $Snit_optionInfo(starcomp)
set target $option
} else {
return ""
}
# There is no validate command in this case; save an empty string.
set Snit_validateCache($option) ""
# Get the component's object
set obj [RT.Component $type $selfns $comp]
set command [list $obj configure $target]
set Snit_configureCache($option) $command
return $command
}
# Implements the standard "configure" method
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# args A list of options and their values, possibly empty.
proc ::snit::RT.method.configure {type selfns win self args} {
# If two or more arguments, set values as usual.
if {[llength $args] >= 2} {
::snit::RT.method.configurelist $type $selfns $win $self $args
return
}
# If zero arguments, acquire data for each known option
# and return the list
if {[llength $args] == 0} {
set result {}
foreach opt [RT.method.info.options $type $selfns $win $self] {
# Refactor this, so that we don't need to call via $self.
lappend result [RT.GetOptionDbSpec \
$type $selfns $win $self $opt]
}
return $result
}
# They want it for just one.
set opt [lindex $args 0]
return [RT.GetOptionDbSpec $type $selfns $win $self $opt]
}
# Retrieves the option database spec for a single option.
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# option The name of an option
#
# TBD: This is a bad name. What it's returning is the
# result of the configure query.
proc ::snit::RT.GetOptionDbSpec {type selfns win self opt} {
variable ${type}::Snit_optionInfo
namespace upvar $selfns \
Snit_components Snit_components \
options options
if {[info exists options($opt)]} {
# This is a locally-defined option. Just build the
# list and return it.
set res $Snit_optionInfo(resource-$opt)
set cls $Snit_optionInfo(class-$opt)
set def $Snit_optionInfo(default-$opt)
return [list $opt $res $cls $def \
[RT.method.cget $type $selfns $win $self $opt]]
} elseif {[info exists Snit_optionInfo(target-$opt)]} {
# This is an explicitly delegated option. The only
# thing we don't have is the default.
set res $Snit_optionInfo(resource-$opt)
set cls $Snit_optionInfo(class-$opt)
# Get the default
set logicalName [lindex $Snit_optionInfo(target-$opt) 0]
set comp $Snit_components($logicalName)
set target [lindex $Snit_optionInfo(target-$opt) 1]
if {[catch {$comp configure $target} result]} {
set defValue {}
} else {
set defValue [lindex $result 3]
}
return [list $opt $res $cls $defValue [$self cget $opt]]
} elseif {$Snit_optionInfo(starcomp) ne "" &&
[lsearch -exact $Snit_optionInfo(except) $opt] == -1} {
set logicalName $Snit_optionInfo(starcomp)
set target $opt
set comp $Snit_components($logicalName)
if {[catch {set value [$comp cget $target]} result]} {
error "unknown option \"$opt\""
}
if {![catch {$comp configure $target} result]} {
# Replace the delegated option name with the local name.
return [::snit::Expand $result $target $opt]
}
# configure didn't work; return simple form.
return [list $opt "" "" "" $value]
} else {
error "unknown option \"$opt\""
}
}
#-----------------------------------------------------------------------
# Type Introspection
# Implements the standard "info" typemethod.
#
# type The snit type
# command The info subcommand
# args All other arguments.
proc ::snit::RT.typemethod.info {type command args} {
global errorInfo
global errorCode
switch -exact $command {
args -
body -
default -
typevars -
typemethods -
instances {
# TBD: it should be possible to delete this error
# handling.
set errflag [catch {
uplevel 1 [linsert $args 0 \
::snit::RT.typemethod.info.$command $type]
} result]
if {$errflag} {
return -code error -errorinfo $errorInfo \
-errorcode $errorCode $result
} else {
return $result
}
}
default {
error "\"$type info $command\" is not defined"
}
}
}
# Returns a list of the type's typevariables whose names match a
# pattern, excluding Snit internal variables.
#
# type A Snit type
# pattern Optional. The glob pattern to match. Defaults
# to *.
proc ::snit::RT.typemethod.info.typevars {type {pattern *}} {
set result {}
foreach name [info vars "${type}::$pattern"] {
set tail [namespace tail $name]
if {![string match "Snit_*" $tail]} {
lappend result $name
}
}
return $result
}
# Returns a list of the type's methods whose names match a
# pattern. If "delegate typemethod *" is used, the list may
# not be complete.
#
# type A Snit type
# pattern Optional. The glob pattern to match. Defaults
# to *.
proc ::snit::RT.typemethod.info.typemethods {type {pattern *}} {
variable ${type}::Snit_typemethodInfo
# FIRST, get the explicit names, skipping prefixes.
set result {}
foreach name [array names Snit_typemethodInfo -glob $pattern] {
if {[lindex $Snit_typemethodInfo($name) 0] != 1} {
lappend result $name
}
}
# NEXT, add any from the cache that aren't explicit.
# WHD: fixed up to use newstyle method cache/list of subcommands.
if {[info exists Snit_typemethodInfo(*)]} {
# First, remove "*" from the list.
set ndx [lsearch -exact $result "*"]
if {$ndx != -1} {
set result [lreplace $result $ndx $ndx]
}
# Next, get the type's -map
array set typemethodCache [namespace ensemble configure $type -map]
# Next, get matching names from the cache that we don't already
# know about.
foreach name [array names typemethodCache -glob $pattern] {
if {[lsearch -exact $result $name] == -1} {
lappend result $name
}
}
}
return $result
}
# $type info args
#
# Returns a method's list of arguments. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.typemethod.info.args {type method} {
upvar ${type}::Snit_typemethodInfo Snit_typemethodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
#parray Snit_typemethodInfo
if {![info exists Snit_typemethodInfo($method)]} {
return -code error "Unknown typemethod \"$method\""
}
foreach {flag cmd component} $Snit_typemethodInfo($method) break
if {$flag} {
return -code error "Unknown typemethod \"$method\""
}
if {$component != ""} {
return -code error "Delegated typemethod \"$method\""
}
set map [list %m $method %j [join $method _] %t $type]
set theproc [lindex [string map $map $cmd] 0]
return [lrange [::info args $theproc] 1 end]
}
# $type info body
#
# Returns a method's body. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.typemethod.info.body {type method} {
upvar ${type}::Snit_typemethodInfo Snit_typemethodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
#parray Snit_typemethodInfo
if {![info exists Snit_typemethodInfo($method)]} {
return -code error "Unknown typemethod \"$method\""
}
foreach {flag cmd component} $Snit_typemethodInfo($method) break
if {$flag} {
return -code error "Unknown typemethod \"$method\""
}
if {$component != ""} {
return -code error "Delegated typemethod \"$method\""
}
set map [list %m $method %j [join $method _] %t $type]
set theproc [lindex [string map $map $cmd] 0]
return [RT.body [::info body $theproc]]
}
# $type info default
#
# Returns a method's list of arguments. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.typemethod.info.default {type method aname dvar} {
upvar 1 $dvar def
upvar ${type}::Snit_typemethodInfo Snit_typemethodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
#parray Snit_methodInfo
if {![info exists Snit_typemethodInfo($method)]} {
return -code error "Unknown typemethod \"$method\""
}
foreach {flag cmd component} $Snit_typemethodInfo($method) break
if {$flag} {
return -code error "Unknown typemethod \"$method\""
}
if {$component != ""} {
return -code error "Delegated typemethod \"$method\""
}
set map [list %m $method %j [join $method _] %t $type]
set theproc [lindex [string map $map $cmd] 0]
return [::info default $theproc $aname def]
}
# Returns a list of the type's instances whose names match
# a pattern.
#
# type A Snit type
# pattern Optional. The glob pattern to match
# Defaults to *
#
# REQUIRE: type is fully qualified.
proc ::snit::RT.typemethod.info.instances {type {pattern *}} {
set result {}
foreach selfns [namespace children $type "${type}::Snit_inst*"] {
namespace upvar $selfns Snit_instance instance
if {[string match $pattern $instance]} {
lappend result $instance
}
}
return $result
}
#-----------------------------------------------------------------------
# Instance Introspection
# Implements the standard "info" method.
#
# type The snit type
# selfns The instance's instance namespace
# win The instance's original name
# self The instance's current name
# command The info subcommand
# args All other arguments.
proc ::snit::RT.method.info {type selfns win self command args} {
switch -exact $command {
args -
body -
default -
type -
vars -
options -
methods -
typevars -
typemethods {
set errflag [catch {
uplevel 1 [linsert $args 0 ::snit::RT.method.info.$command \
$type $selfns $win $self]
} result]
if {$errflag} {
global errorInfo
return -code error -errorinfo $errorInfo $result
} else {
return $result
}
}
default {
# error "\"$self info $command\" is not defined"
return -code error "\"$self info $command\" is not defined"
}
}
}
# $self info type
#
# Returns the instance's type
proc ::snit::RT.method.info.type {type selfns win self} {
return $type
}
# $self info typevars
#
# Returns the instance's type's typevariables
proc ::snit::RT.method.info.typevars {type selfns win self {pattern *}} {
return [RT.typemethod.info.typevars $type $pattern]
}
# $self info typemethods
#
# Returns the instance's type's typemethods
proc ::snit::RT.method.info.typemethods {type selfns win self {pattern *}} {
return [RT.typemethod.info.typemethods $type $pattern]
}
# Returns a list of the instance's methods whose names match a
# pattern. If "delegate method *" is used, the list may
# not be complete.
#
# type A Snit type
# selfns The instance namespace
# win The original instance name
# self The current instance name
# pattern Optional. The glob pattern to match. Defaults
# to *.
proc ::snit::RT.method.info.methods {type selfns win self {pattern *}} {
variable ${type}::Snit_methodInfo
# FIRST, get the explicit names, skipping prefixes.
set result {}
foreach name [array names Snit_methodInfo -glob $pattern] {
if {[lindex $Snit_methodInfo($name) 0] != 1} {
lappend result $name
}
}
# NEXT, add any from the cache that aren't explicit.
# WHD: Fixed up to use newstyle method cache/list of subcommands.
if {[info exists Snit_methodInfo(*)]} {
# First, remove "*" from the list.
set ndx [lsearch -exact $result "*"]
if {$ndx != -1} {
set result [lreplace $result $ndx $ndx]
}
# Next, get the instance's -map
set self [set ${selfns}::Snit_instance]
array set methodCache [namespace ensemble configure $self -map]
# Next, get matching names from the cache that we don't already
# know about.
foreach name [array names methodCache -glob $pattern] {
if {[lsearch -exact $result $name] == -1} {
lappend result $name
}
}
}
return $result
}
# $self info args
#
# Returns a method's list of arguments. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.method.info.args {type selfns win self method} {
upvar ${type}::Snit_methodInfo Snit_methodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
#parray Snit_methodInfo
if {![info exists Snit_methodInfo($method)]} {
return -code error "Unknown method \"$method\""
}
foreach {flag cmd component} $Snit_methodInfo($method) break
if {$flag} {
return -code error "Unknown method \"$method\""
}
if {$component != ""} {
return -code error "Delegated method \"$method\""
}
set map [list %m $method %j [join $method _] %t $type %n $selfns %w $win %s $self]
set theproc [lindex [string map $map $cmd] 0]
return [lrange [::info args $theproc] 4 end]
}
# $self info body
#
# Returns a method's body. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.method.info.body {type selfns win self method} {
upvar ${type}::Snit_methodInfo Snit_methodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
#parray Snit_methodInfo
if {![info exists Snit_methodInfo($method)]} {
return -code error "Unknown method \"$method\""
}
foreach {flag cmd component} $Snit_methodInfo($method) break
if {$flag} {
return -code error "Unknown method \"$method\""
}
if {$component != ""} {
return -code error "Delegated method \"$method\""
}
set map [list %m $method %j [join $method _] %t $type %n $selfns %w $win %s $self]
set theproc [lindex [string map $map $cmd] 0]
return [RT.body [::info body $theproc]]
}
# $self info default
#
# Returns a method's list of arguments. does not work for delegated
# methods, nor for the internal dispatch methods of multi-word
# methods.
proc ::snit::RT.method.info.default {type selfns win self method aname dvar} {
upvar 1 $dvar def
upvar ${type}::Snit_methodInfo Snit_methodInfo
# Snit_methodInfo: method -> list (flag cmd component)
# flag : 1 -> internal dispatcher for multi-word method.
# 0 -> regular method
#
# cmd : template mapping from method to command prefix, may
# contain placeholders for various pieces of information.
#
# component : is empty for normal methods.
if {![info exists Snit_methodInfo($method)]} {
return -code error "Unknown method \"$method\""
}
foreach {flag cmd component} $Snit_methodInfo($method) break
if {$flag} {
return -code error "Unknown method \"$method\""
}
if {$component != ""} {
return -code error "Delegated method \"$method\""
}
set map [list %m $method %j [join $method _] %t $type %n $selfns %w $win %s $self]
set theproc [lindex [string map $map $cmd] 0]
return [::info default $theproc $aname def]
}
# $self info vars
#
# Returns the instance's instance variables
proc ::snit::RT.method.info.vars {type selfns win self {pattern *}} {
set result {}
foreach name [info vars "${selfns}::$pattern"] {
set tail [namespace tail $name]
if {![string match "Snit_*" $tail]} {
lappend result $name
}
}
return $result
}
# $self info options
#
# Returns a list of the names of the instance's options
proc ::snit::RT.method.info.options {type selfns win self {pattern *}} {
variable ${type}::Snit_optionInfo
# First, get the local and explicitly delegated options
set result [concat $Snit_optionInfo(local) $Snit_optionInfo(delegated)]
# If "configure" works as for Tk widgets, add the resulting
# options to the list. Skip excepted options
if {$Snit_optionInfo(starcomp) ne ""} {
namespace upvar $selfns Snit_components Snit_components
set logicalName $Snit_optionInfo(starcomp)
set comp $Snit_components($logicalName)
if {![catch {$comp configure} records]} {
foreach record $records {
set opt [lindex $record 0]
if {[lsearch -exact $result $opt] == -1 &&
[lsearch -exact $Snit_optionInfo(except) $opt] == -1} {
lappend result $opt
}
}
}
}
# Next, apply the pattern
set names {}
foreach name $result {
if {[string match $pattern $name]} {
lappend names $name
}
}
return $names
}
proc ::snit::RT.body {body} {
regsub -all ".*# END snit method prolog\n" $body {} body
return $body
}
|