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
|
/*
* ------------------------------------------------------------------------
* PACKAGE: [incr Tcl]
* DESCRIPTION: Object-Oriented Extensions to Tcl
*
* [incr Tcl] provides object-oriented extensions to Tcl, much as
* C++ provides object-oriented extensions to C. It provides a means
* of encapsulating related procedures together with their shared data
* in a local namespace that is hidden from the outside world. It
* promotes code re-use through inheritance. More than anything else,
* it encourages better organization of Tcl applications through the
* object-oriented paradigm, leading to code that is easier to
* understand and maintain.
*
* This part handles ensembles, which support compound commands in Tcl.
* The usual "info" command is an ensemble with parts like "info body"
* and "info globals". Extension developers can extend commands like
* "info" by adding their own parts to the ensemble.
*
* ========================================================================
* AUTHOR: Michael J. McLennan
* Bell Labs Innovations for Lucent Technologies
* mmclennan@lucent.com
* http://www.tcltk.com/itcl
* ========================================================================
* Copyright (c) 1993-1998 Lucent Technologies, Inc.
* ------------------------------------------------------------------------
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*/
#include "itclInt.h"
/*
* Data used to represent an ensemble:
*/
struct Ensemble;
typedef struct EnsemblePart {
char *name; /* name of this part */
int minChars; /* chars needed to uniquely identify part */
Command *cmdPtr; /* command handling this part */
char *usage; /* usage string describing syntax */
struct Ensemble* ensemble; /* ensemble containing this part */
} EnsemblePart;
/*
* Data used to represent an ensemble:
*/
typedef struct Ensemble {
Tcl_Interp *interp; /* interpreter containing this ensemble */
EnsemblePart **parts; /* list of parts in this ensemble */
int numParts; /* number of parts in part list */
int maxParts; /* current size of parts list */
Tcl_Command cmd; /* command representing this ensemble */
EnsemblePart* parent; /* parent part for sub-ensembles
* NULL => toplevel ensemble */
} Ensemble;
/*
* Data shared by ensemble access commands and ensemble parser:
*/
typedef struct EnsembleParser {
Tcl_Interp* master; /* master interp containing ensembles */
Tcl_Interp* parser; /* slave interp for parsing */
Ensemble* ensData; /* add parts to this ensemble */
} EnsembleParser;
/*
* Declarations for local procedures to this file:
*/
static void FreeEnsInvocInternalRep _ANSI_ARGS_((Tcl_Obj *objPtr));
static void DupEnsInvocInternalRep _ANSI_ARGS_((Tcl_Obj *objPtr,
Tcl_Obj *copyPtr));
static void UpdateStringOfEnsInvoc _ANSI_ARGS_((Tcl_Obj *objPtr));
static int SetEnsInvocFromAny _ANSI_ARGS_((Tcl_Interp *interp,
Tcl_Obj *objPtr));
/*
* This structure defines a Tcl object type that takes the
* place of a part name during ensemble invocations. When an
* error occurs and the caller tries to print objv[0], it will
* get a string that contains a complete path to the ensemble
* part.
*/
Tcl_ObjType itclEnsInvocType = {
"ensembleInvoc", /* name */
FreeEnsInvocInternalRep, /* freeIntRepProc */
DupEnsInvocInternalRep, /* dupIntRepProc */
UpdateStringOfEnsInvoc, /* updateStringProc */
SetEnsInvocFromAny /* setFromAnyProc */
};
/*
* Forward declarations for the procedures used in this file.
*/
static void GetEnsembleUsage _ANSI_ARGS_((Ensemble *ensData,
Tcl_Obj *objPtr));
static void GetEnsemblePartUsage _ANSI_ARGS_((EnsemblePart *ensPart,
Tcl_Obj *objPtr));
static int CreateEnsemble _ANSI_ARGS_((Tcl_Interp *interp,
Ensemble *parentEnsData, CONST char *ensName));
static int AddEnsemblePart _ANSI_ARGS_((Tcl_Interp *interp,
Ensemble* ensData, CONST char* partName, CONST char* usageInfo,
Tcl_ObjCmdProc *objProc, ClientData clientData,
Tcl_CmdDeleteProc *deleteProc, EnsemblePart **rVal));
static void DeleteEnsemble _ANSI_ARGS_((ClientData clientData));
static int FindEnsemble _ANSI_ARGS_((Tcl_Interp *interp, CONST char **nameArgv,
int nameArgc, Ensemble** ensDataPtr));
static int CreateEnsemblePart _ANSI_ARGS_((Tcl_Interp *interp,
Ensemble *ensData, CONST char* partName, EnsemblePart **ensPartPtr));
static void DeleteEnsemblePart _ANSI_ARGS_((EnsemblePart *ensPart));
static int FindEnsemblePart _ANSI_ARGS_((Tcl_Interp *interp,
Ensemble *ensData, CONST char* partName, EnsemblePart **rensPart));
static int FindEnsemblePartIndex _ANSI_ARGS_((Ensemble *ensData,
CONST char *partName, int *posPtr));
static void ComputeMinChars _ANSI_ARGS_((Ensemble *ensData, int pos));
static int HandleEnsemble _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, int objc, Tcl_Obj *CONST objv[]));
static EnsembleParser* GetEnsembleParser _ANSI_ARGS_((Tcl_Interp *interp));
static void DeleteEnsParser _ANSI_ARGS_((ClientData clientData,
Tcl_Interp* interp));
/*
*----------------------------------------------------------------------
*
* Itcl_EnsembleInit --
*
* Called when any interpreter is created to make sure that
* things are properly set up for ensembles.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything goes
* wrong.
*
* Side effects:
* On the first call, the "ensemble" object type is registered
* with the Tcl compiler. If an error is encountered, an error
* is left as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
/* ARGSUSED */
int
Itcl_EnsembleInit(interp)
Tcl_Interp *interp; /* interpreter being initialized */
{
if (Tcl_GetObjType(itclEnsInvocType.name) == NULL) {
Tcl_RegisterObjType(&itclEnsInvocType);
}
Tcl_CreateObjCommand(interp, "::itcl::ensemble",
Itcl_EnsembleCmd, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL);
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* Itcl_CreateEnsemble --
*
* Creates an ensemble command, or adds a sub-ensemble to an
* existing ensemble command. The ensemble name is a space-
* separated list. The first word in the list is the command
* name for the top-level ensemble. Other names do not have
* commands associated with them; they are merely sub-ensembles
* within the ensemble. So a name like "a::b::foo bar baz"
* represents an ensemble command called "foo" in the namespace
* "a::b" that has a sub-ensemble "bar", that has a sub-ensemble
* "baz".
*
* If the name is a single word, then this procedure creates
* a top-level ensemble and installs an access command for it.
* If a command already exists with that name, it is deleted.
*
* If the name has more than one word, then the leading words
* are treated as a path name for an existing ensemble. The
* last word is treated as the name for a new sub-ensemble.
* If an part already exists with that name, it is an error.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything goes
* wrong.
*
* Side effects:
* If an error is encountered, an error is left as the result
* in the interpreter.
*
*----------------------------------------------------------------------
*/
int
Itcl_CreateEnsemble(interp, ensName)
Tcl_Interp *interp; /* interpreter to be updated */
CONST char* ensName; /* name of the new ensemble */
{
CONST char **nameArgv = NULL;
int nameArgc;
Ensemble *parentEnsData;
Tcl_DString buffer;
/*
* Split the ensemble name into its path components.
*/
if (Tcl_SplitList(interp, ensName, &nameArgc,
&nameArgv) != TCL_OK) {
goto ensCreateFail;
}
if (nameArgc < 1) {
Tcl_AppendResult(interp,
"invalid ensemble name \"", ensName, "\"",
(char*)NULL);
goto ensCreateFail;
}
/*
* If there is more than one path component, then follow
* the path down to the last component, to find the containing
* ensemble.
*/
parentEnsData = NULL;
if (nameArgc > 1) {
if (FindEnsemble(interp, nameArgv, nameArgc-1, &parentEnsData)
!= TCL_OK) {
goto ensCreateFail;
}
if (parentEnsData == NULL) {
char *pname = Tcl_Merge(nameArgc-1, nameArgv);
Tcl_AppendResult(interp,
"invalid ensemble name \"", pname, "\"",
(char*)NULL);
ckfree(pname);
goto ensCreateFail;
}
}
/*
* Create the ensemble.
*/
if (CreateEnsemble(interp, parentEnsData, nameArgv[nameArgc-1])
!= TCL_OK) {
goto ensCreateFail;
}
ckfree((char*)nameArgv);
return TCL_OK;
ensCreateFail:
if (nameArgv) {
ckfree((char*)nameArgv);
}
Tcl_DStringInit(&buffer);
Tcl_DStringAppend(&buffer, "\n (while creating ensemble \"", -1);
Tcl_DStringAppend(&buffer, ensName, -1);
Tcl_DStringAppend(&buffer, "\")", -1);
Tcl_AddObjErrorInfo(interp, Tcl_DStringValue(&buffer), -1);
Tcl_DStringFree(&buffer);
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* Itcl_AddEnsemblePart --
*
* Adds a part to an ensemble which has been created by
* Itcl_CreateEnsemble. Ensembles are addressed by name, as
* described in Itcl_CreateEnsemble.
*
* If the ensemble already has a part with the specified name,
* this procedure returns an error. Otherwise, it adds a new
* part to the ensemble.
*
* Any client data specified is automatically passed to the
* handling procedure whenever the part is invoked. It is
* automatically destroyed by the deleteProc when the part is
* deleted.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything goes
* wrong.
*
* Side effects:
* If an error is encountered, an error is left as the result
* in the interpreter.
*
*----------------------------------------------------------------------
*/
int
Itcl_AddEnsemblePart(interp, ensName, partName, usageInfo,
objProc, clientData, deleteProc)
Tcl_Interp *interp; /* interpreter to be updated */
CONST char* ensName; /* ensemble containing this part */
CONST char* partName; /* name of the new part */
CONST char* usageInfo; /* usage info for argument list */
Tcl_ObjCmdProc *objProc; /* handling procedure for part */
ClientData clientData; /* client data associated with part */
Tcl_CmdDeleteProc *deleteProc; /* procedure used to destroy client data */
{
CONST char **nameArgv = NULL;
int nameArgc;
Ensemble *ensData;
EnsemblePart *ensPart;
Tcl_DString buffer;
/*
* Parse the ensemble name and look for a containing ensemble.
*/
if (Tcl_SplitList(interp, ensName, &nameArgc,
&nameArgv) != TCL_OK) {
goto ensPartFail;
}
if (FindEnsemble(interp, nameArgv, nameArgc, &ensData) != TCL_OK) {
goto ensPartFail;
}
if (ensData == NULL) {
char *pname = Tcl_Merge(nameArgc, nameArgv);
Tcl_AppendResult(interp,
"invalid ensemble name \"", pname, "\"",
(char*)NULL);
ckfree(pname);
goto ensPartFail;
}
/*
* Install the new part into the part list.
*/
if (AddEnsemblePart(interp, ensData, partName, usageInfo,
objProc, clientData, deleteProc, &ensPart) != TCL_OK) {
goto ensPartFail;
}
ckfree((char*)nameArgv);
return TCL_OK;
ensPartFail:
if (nameArgv) {
ckfree((char*)nameArgv);
}
Tcl_DStringInit(&buffer);
Tcl_DStringAppend(&buffer, "\n (while adding to ensemble \"", -1);
Tcl_DStringAppend(&buffer, ensName, -1);
Tcl_DStringAppend(&buffer, "\")", -1);
Tcl_AddObjErrorInfo(interp, Tcl_DStringValue(&buffer), -1);
Tcl_DStringFree(&buffer);
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* Itcl_GetEnsemblePart --
*
* Looks for a part within an ensemble, and returns information
* about it.
*
* Results:
* If the ensemble and its part are found, this procedure
* loads information about the part into the "infoPtr" structure
* and returns 1. Otherwise, it returns 0.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
int
Itcl_GetEnsemblePart(interp, ensName, partName, infoPtr)
Tcl_Interp *interp; /* interpreter to be updated */
CONST char *ensName; /* ensemble containing the part */
CONST char *partName; /* name of the desired part */
Tcl_CmdInfo *infoPtr; /* returns: info associated with part */
{
CONST char **nameArgv = NULL;
int nameArgc;
Ensemble *ensData;
EnsemblePart *ensPart;
Command *cmdPtr;
Itcl_InterpState state;
/*
* Parse the ensemble name and look for a containing ensemble.
* Save the interpreter state before we do this. If we get any
* errors, we don't want them to affect the interpreter.
*/
state = Itcl_SaveInterpState(interp, TCL_OK);
if (Tcl_SplitList(interp, ensName, &nameArgc,
&nameArgv) != TCL_OK) {
goto ensGetFail;
}
if (FindEnsemble(interp, nameArgv, nameArgc, &ensData) != TCL_OK) {
goto ensGetFail;
}
if (ensData == NULL) {
goto ensGetFail;
}
/*
* Look for a part with the desired name. If found, load
* its data into the "infoPtr" structure.
*/
if (FindEnsemblePart(interp, ensData, partName, &ensPart)
!= TCL_OK || ensPart == NULL) {
goto ensGetFail;
}
cmdPtr = ensPart->cmdPtr;
infoPtr->isNativeObjectProc = (cmdPtr->objProc != TclInvokeStringCommand);
infoPtr->objProc = cmdPtr->objProc;
infoPtr->objClientData = cmdPtr->objClientData;
infoPtr->proc = cmdPtr->proc;
infoPtr->clientData = cmdPtr->clientData;
infoPtr->deleteProc = cmdPtr->deleteProc;
infoPtr->deleteData = cmdPtr->deleteData;
infoPtr->namespacePtr = (Tcl_Namespace*)cmdPtr->nsPtr;
Itcl_DiscardInterpState(state);
return 1;
ensGetFail:
Itcl_RestoreInterpState(interp, state);
return 0;
}
/*
*----------------------------------------------------------------------
*
* Itcl_IsEnsemble --
*
* Determines whether or not an existing command is an ensemble.
*
* Results:
* Returns non-zero if the command is an ensemble, and zero
* otherwise.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
int
Itcl_IsEnsemble(infoPtr)
Tcl_CmdInfo* infoPtr; /* command info from Tcl_GetCommandInfo() */
{
if (infoPtr) {
return (infoPtr->deleteProc == DeleteEnsemble);
}
return 0;
}
/*
*----------------------------------------------------------------------
*
* Itcl_GetEnsembleUsage --
*
* Returns a summary of all of the parts of an ensemble and
* the meaning of their arguments. Each part is listed on
* a separate line. Having this summary is sometimes useful
* when building error messages for the "@error" handler in
* an ensemble.
*
* Ensembles are accessed by name, as described in
* Itcl_CreateEnsemble.
*
* Results:
* If the ensemble is found, its usage information is appended
* onto the object "objPtr", and this procedure returns
* non-zero. It is the responsibility of the caller to
* initialize and free the object. If anything goes wrong,
* this procedure returns 0.
*
* Side effects:
* Object passed in is modified.
*
*----------------------------------------------------------------------
*/
int
Itcl_GetEnsembleUsage(interp, ensName, objPtr)
Tcl_Interp *interp; /* interpreter containing the ensemble */
CONST char *ensName; /* name of the ensemble */
Tcl_Obj *objPtr; /* returns: summary of usage info */
{
CONST char **nameArgv = NULL;
int nameArgc;
Ensemble *ensData;
Itcl_InterpState state;
/*
* Parse the ensemble name and look for the ensemble.
* Save the interpreter state before we do this. If we get
* any errors, we don't want them to affect the interpreter.
*/
state = Itcl_SaveInterpState(interp, TCL_OK);
if (Tcl_SplitList(interp, ensName, &nameArgc,
&nameArgv) != TCL_OK) {
goto ensUsageFail;
}
if (FindEnsemble(interp, nameArgv, nameArgc, &ensData) != TCL_OK) {
goto ensUsageFail;
}
if (ensData == NULL) {
goto ensUsageFail;
}
/*
* Add a summary of usage information to the return buffer.
*/
GetEnsembleUsage(ensData, objPtr);
Itcl_DiscardInterpState(state);
return 1;
ensUsageFail:
Itcl_RestoreInterpState(interp, state);
return 0;
}
/*
*----------------------------------------------------------------------
*
* Itcl_GetEnsembleUsageForObj --
*
* Returns a summary of all of the parts of an ensemble and
* the meaning of their arguments. This procedure is just
* like Itcl_GetEnsembleUsage, but it determines the desired
* ensemble from a command line argument. The argument should
* be the first argument on the command line--the ensemble
* command or one of its parts.
*
* Results:
* If the ensemble is found, its usage information is appended
* onto the object "objPtr", and this procedure returns
* non-zero. It is the responsibility of the caller to
* initialize and free the object. If anything goes wrong,
* this procedure returns 0.
*
* Side effects:
* Object passed in is modified.
*
*----------------------------------------------------------------------
*/
int
Itcl_GetEnsembleUsageForObj(interp, ensObjPtr, objPtr)
Tcl_Interp *interp; /* interpreter containing the ensemble */
Tcl_Obj *ensObjPtr; /* argument representing ensemble */
Tcl_Obj *objPtr; /* returns: summary of usage info */
{
Ensemble *ensData;
Tcl_Obj *chainObj;
Tcl_Command cmd;
Command *cmdPtr;
/*
* If the argument is an ensemble part, then follow the chain
* back to the command word for the entire ensemble.
*/
chainObj = ensObjPtr;
while (chainObj && chainObj->typePtr == &itclEnsInvocType) {
chainObj = (Tcl_Obj*)chainObj->internalRep.twoPtrValue.ptr2;
}
if (chainObj) {
cmd = Tcl_GetCommandFromObj(interp, chainObj);
cmdPtr = (Command*)cmd;
if (cmdPtr->deleteProc == DeleteEnsemble) {
ensData = (Ensemble*)cmdPtr->objClientData;
GetEnsembleUsage(ensData, objPtr);
return 1;
}
}
return 0;
}
/*
*----------------------------------------------------------------------
*
* GetEnsembleUsage --
*
*
* Returns a summary of all of the parts of an ensemble and
* the meaning of their arguments. Each part is listed on
* a separate line. This procedure is used internally to
* generate usage information for error messages.
*
* Results:
* Appends usage information onto the object in "objPtr".
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static void
GetEnsembleUsage(ensData, objPtr)
Ensemble *ensData; /* ensemble data */
Tcl_Obj *objPtr; /* returns: summary of usage info */
{
char *spaces = " ";
int isOpenEnded = 0;
int i;
EnsemblePart *ensPart;
for (i=0; i < ensData->numParts; i++) {
ensPart = ensData->parts[i];
if (*ensPart->name == '@' && strcmp(ensPart->name,"@error") == 0) {
isOpenEnded = 1;
}
else {
Tcl_AppendToObj(objPtr, spaces, -1);
GetEnsemblePartUsage(ensPart, objPtr);
spaces = "\n ";
}
}
if (isOpenEnded) {
Tcl_AppendToObj(objPtr,
"\n...and others described on the man page", -1);
}
}
/*
*----------------------------------------------------------------------
*
* GetEnsemblePartUsage --
*
* Determines the usage for a single part within an ensemble,
* and appends a summary onto a dynamic string. The usage
* is a combination of the part name and the argument summary.
* It is the caller's responsibility to initialize and free
* the dynamic string.
*
* Results:
* Returns usage information in the object "objPtr".
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static void
GetEnsemblePartUsage(ensPart, objPtr)
EnsemblePart *ensPart; /* ensemble part for usage info */
Tcl_Obj *objPtr; /* returns: usage information */
{
EnsemblePart *part;
Command *cmdPtr;
char *name;
Itcl_List trail;
Itcl_ListElem *elem;
Tcl_DString buffer;
/*
* Build the trail of ensemble names leading to this part.
*/
Tcl_DStringInit(&buffer);
Itcl_InitList(&trail);
for (part=ensPart; part; part=part->ensemble->parent) {
Itcl_InsertList(&trail, (ClientData)part);
}
cmdPtr = (Command*)ensPart->ensemble->cmd;
name = Tcl_GetHashKey(cmdPtr->hPtr->tablePtr, cmdPtr->hPtr);
Tcl_DStringAppendElement(&buffer, name);
for (elem=Itcl_FirstListElem(&trail); elem; elem=Itcl_NextListElem(elem)) {
part = (EnsemblePart*)Itcl_GetListValue(elem);
Tcl_DStringAppendElement(&buffer, part->name);
}
Itcl_DeleteList(&trail);
/*
* If the part has usage info, use it directly.
*/
if (ensPart->usage && *ensPart->usage != '\0') {
Tcl_DStringAppend(&buffer, " ", 1);
Tcl_DStringAppend(&buffer, ensPart->usage, -1);
}
/*
* If the part is itself an ensemble, summarize its usage.
*/
else if (ensPart->cmdPtr &&
ensPart->cmdPtr->deleteProc == DeleteEnsemble) {
Tcl_DStringAppend(&buffer, " option ?arg arg ...?", 21);
}
Tcl_AppendToObj(objPtr, Tcl_DStringValue(&buffer),
Tcl_DStringLength(&buffer));
Tcl_DStringFree(&buffer);
}
/*
*----------------------------------------------------------------------
*
* CreateEnsemble --
*
* Creates an ensemble command, or adds a sub-ensemble to an
* existing ensemble command. Works like Itcl_CreateEnsemble,
* except that the ensemble name is a single name, not a path.
* If a parent ensemble is specified, then a new ensemble is
* added to that parent. If a part already exists with the
* same name, it is an error. If a parent ensemble is not
* specified, then a top-level ensemble is created. If a
* command already exists with the same name, it is deleted.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything goes
* wrong.
*
* Side effects:
* If an error is encountered, an error is left as the result
* in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
CreateEnsemble(interp, parentEnsData, ensName)
Tcl_Interp *interp; /* interpreter to be updated */
Ensemble *parentEnsData; /* parent ensemble or NULL */
CONST char *ensName; /* name of the new ensemble */
{
Ensemble *ensData;
EnsemblePart *ensPart;
Command *cmdPtr;
Tcl_CmdInfo cmdInfo;
/*
* Create the data associated with the ensemble.
*/
ensData = (Ensemble*)ckalloc(sizeof(Ensemble));
ensData->interp = interp;
ensData->numParts = 0;
ensData->maxParts = 10;
ensData->parts = (EnsemblePart**)ckalloc(
(unsigned)(ensData->maxParts*sizeof(EnsemblePart*))
);
ensData->cmd = NULL;
ensData->parent = NULL;
/*
* If there is no parent data, then this is a top-level
* ensemble. Create the ensemble by installing its access
* command.
*
* BE CAREFUL: Set the string-based proc to the wrapper
* procedure TclInvokeObjectCommand. Otherwise, the
* ensemble command may fail. For example, it will fail
* when invoked as a hidden command.
*/
if (parentEnsData == NULL) {
ensData->cmd = Tcl_CreateObjCommand(interp, ensName,
HandleEnsemble, (ClientData)ensData, DeleteEnsemble);
if (Tcl_GetCommandInfo(interp, ensName, &cmdInfo)) {
cmdInfo.proc = TclInvokeObjectCommand;
Tcl_SetCommandInfo(interp, ensName, &cmdInfo);
}
return TCL_OK;
}
/*
* Otherwise, this ensemble is contained within another parent.
* Install the new ensemble as a part within its parent.
*/
if (CreateEnsemblePart(interp, parentEnsData, ensName, &ensPart)
!= TCL_OK) {
DeleteEnsemble((ClientData)ensData);
return TCL_ERROR;
}
ensData->cmd = parentEnsData->cmd;
ensData->parent = ensPart;
/*
* Initialize non-NULL data only. This allows us to handle the
* structure differences between versions better.
*/
cmdPtr = (Command *) ckalloc(sizeof(Command));
memset((VOID *) cmdPtr, 0, sizeof(Command));
cmdPtr->nsPtr = ((Command *) ensData->cmd)->nsPtr;
cmdPtr->objProc = HandleEnsemble;
cmdPtr->objClientData = (ClientData)ensData;
cmdPtr->deleteProc = DeleteEnsemble;
cmdPtr->deleteData = cmdPtr->objClientData;
ensPart->cmdPtr = cmdPtr;
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* AddEnsemblePart --
*
* Adds a part to an existing ensemble. Works like
* Itcl_AddEnsemblePart, but the part name is a single word,
* not a path.
*
* If the ensemble already has a part with the specified name,
* this procedure returns an error. Otherwise, it adds a new
* part to the ensemble.
*
* Any client data specified is automatically passed to the
* handling procedure whenever the part is invoked. It is
* automatically destroyed by the deleteProc when the part is
* deleted.
*
* Results:
* Returns TCL_OK if successful, along with a pointer to the
* new part. Returns TCL_ERROR if anything goes wrong.
*
* Side effects:
* If an error is encountered, an error is left as the result
* in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
AddEnsemblePart(interp, ensData, partName, usageInfo,
objProc, clientData, deleteProc, rVal)
Tcl_Interp *interp; /* interpreter to be updated */
Ensemble* ensData; /* ensemble that will contain this part */
CONST char* partName; /* name of the new part */
CONST char* usageInfo; /* usage info for argument list */
Tcl_ObjCmdProc *objProc; /* handling procedure for part */
ClientData clientData; /* client data associated with part */
Tcl_CmdDeleteProc *deleteProc; /* procedure used to destroy client data */
EnsemblePart **rVal; /* returns: new ensemble part */
{
EnsemblePart *ensPart;
Command *cmdPtr;
/*
* Install the new part into the part list.
*/
if (CreateEnsemblePart(interp, ensData, partName, &ensPart) != TCL_OK) {
return TCL_ERROR;
}
if (usageInfo) {
ensPart->usage = ckalloc((unsigned)(strlen(usageInfo)+1));
strcpy(ensPart->usage, usageInfo);
}
/*
* Initialize non-NULL data only. This allows us to handle the
* structure differences between versions better.
*/
cmdPtr = (Command *) ckalloc(sizeof(Command));
memset((VOID *) cmdPtr, 0, sizeof(Command));
cmdPtr->nsPtr = ((Command *) ensData->cmd)->nsPtr;
cmdPtr->objProc = objProc;
cmdPtr->objClientData = (ClientData)clientData;
cmdPtr->deleteProc = deleteProc;
cmdPtr->deleteData = (ClientData)clientData;
ensPart->cmdPtr = cmdPtr;
*rVal = ensPart;
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* DeleteEnsemble --
*
* Invoked when the command associated with an ensemble is
* destroyed, to delete the ensemble. Destroys all parts
* included in the ensemble, and frees all memory associated
* with it.
*
* Results:
* None.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static void
DeleteEnsemble(clientData)
ClientData clientData; /* ensemble data */
{
Ensemble* ensData = (Ensemble*)clientData;
/*
* BE CAREFUL: Each ensemble part removes itself from the list.
* So keep deleting the first part until all parts are gone.
*/
while (ensData->numParts > 0) {
DeleteEnsemblePart(ensData->parts[0]);
}
ckfree((char*)ensData->parts);
ckfree((char*)ensData);
}
/*
*----------------------------------------------------------------------
*
* FindEnsemble --
*
* Searches for an ensemble command and follows a path to
* sub-ensembles.
*
* Results:
* Returns TCL_OK if the ensemble was found, along with a
* pointer to the ensemble data in "ensDataPtr". Returns
* TCL_ERROR if anything goes wrong.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
FindEnsemble(interp, nameArgv, nameArgc, ensDataPtr)
Tcl_Interp *interp; /* interpreter containing the ensemble */
CONST char **nameArgv; /* path of names leading to ensemble */
int nameArgc; /* number of strings in nameArgv */
Ensemble** ensDataPtr; /* returns: ensemble data */
{
int i;
Command* cmdPtr;
Ensemble *ensData;
EnsemblePart *ensPart;
*ensDataPtr = NULL; /* assume that no data will be found */
/*
* If there are no names in the path, then return an error.
*/
if (nameArgc < 1) {
Tcl_AppendToObj(Tcl_GetObjResult(interp),
"invalid ensemble name \"\"", -1);
return TCL_ERROR;
}
/*
* Use the first name to find the command for the top-level
* ensemble.
*/
cmdPtr = (Command*) Tcl_FindCommand(interp, nameArgv[0],
(Tcl_Namespace*)NULL, TCL_LEAVE_ERR_MSG);
if (cmdPtr == NULL || cmdPtr->deleteProc != DeleteEnsemble) {
Tcl_AppendResult(interp,
"command \"", nameArgv[0], "\" is not an ensemble",
(char*)NULL);
return TCL_ERROR;
}
ensData = (Ensemble*)cmdPtr->objClientData;
/*
* Follow the trail of sub-ensemble names.
*/
for (i=1; i < nameArgc; i++) {
if (FindEnsemblePart(interp, ensData, nameArgv[i], &ensPart)
!= TCL_OK) {
return TCL_ERROR;
}
if (ensPart == NULL) {
char *pname = Tcl_Merge(i, nameArgv);
Tcl_AppendResult(interp,
"invalid ensemble name \"", pname, "\"",
(char*)NULL);
ckfree(pname);
return TCL_ERROR;
}
cmdPtr = ensPart->cmdPtr;
if (cmdPtr == NULL || cmdPtr->deleteProc != DeleteEnsemble) {
Tcl_AppendResult(interp,
"part \"", nameArgv[i], "\" is not an ensemble",
(char*)NULL);
return TCL_ERROR;
}
ensData = (Ensemble*)cmdPtr->objClientData;
}
*ensDataPtr = ensData;
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* CreateEnsemblePart --
*
* Creates a new part within an ensemble.
*
* Results:
* If successful, this procedure returns TCL_OK, along with a
* pointer to the new part in "ensPartPtr". If a part with the
* same name already exists, this procedure returns TCL_ERROR.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
CreateEnsemblePart(interp, ensData, partName, ensPartPtr)
Tcl_Interp *interp; /* interpreter containing the ensemble */
Ensemble *ensData; /* ensemble being modified */
CONST char* partName; /* name of the new part */
EnsemblePart **ensPartPtr; /* returns: new ensemble part */
{
int i, pos, size;
EnsemblePart** partList;
EnsemblePart* part;
/*
* If a matching entry was found, then return an error.
*/
if (FindEnsemblePartIndex(ensData, partName, &pos)) {
Tcl_AppendResult(interp,
"part \"", partName, "\" already exists in ensemble",
(char*)NULL);
return TCL_ERROR;
}
/*
* Otherwise, make room for a new entry. Keep the parts in
* lexicographical order, so we can search them quickly
* later.
*/
if (ensData->numParts >= ensData->maxParts) {
size = ensData->maxParts*sizeof(EnsemblePart*);
partList = (EnsemblePart**)ckalloc((unsigned)2*size);
memcpy((VOID*)partList, (VOID*)ensData->parts, (size_t)size);
ckfree((char*)ensData->parts);
ensData->parts = partList;
ensData->maxParts *= 2;
}
for (i=ensData->numParts; i > pos; i--) {
ensData->parts[i] = ensData->parts[i-1];
}
ensData->numParts++;
part = (EnsemblePart*)ckalloc(sizeof(EnsemblePart));
part->name = (char*)ckalloc((unsigned)(strlen(partName)+1));
strcpy(part->name, partName);
part->cmdPtr = NULL;
part->usage = NULL;
part->ensemble = ensData;
ensData->parts[pos] = part;
/*
* Compare the new part against the one on either side of
* it. Determine how many letters are needed in each part
* to guarantee that an abbreviated form is unique. Update
* the parts on either side as well, since they are influenced
* by the new part.
*/
ComputeMinChars(ensData, pos);
ComputeMinChars(ensData, pos-1);
ComputeMinChars(ensData, pos+1);
*ensPartPtr = part;
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* DeleteEnsemblePart --
*
* Deletes a single part from an ensemble. The part must have
* been created previously by CreateEnsemblePart.
*
* If the part has a delete proc, then it is called to free the
* associated client data.
*
* Results:
* None.
*
* Side effects:
* Delete proc is called.
*
*----------------------------------------------------------------------
*/
static void
DeleteEnsemblePart(ensPart)
EnsemblePart *ensPart; /* part being destroyed */
{
int i, pos;
Command *cmdPtr;
Ensemble *ensData;
cmdPtr = ensPart->cmdPtr;
/*
* If this part has a delete proc, then call it to free
* up the client data.
*/
if (cmdPtr->deleteData && cmdPtr->deleteProc) {
(*cmdPtr->deleteProc)(cmdPtr->deleteData);
}
ckfree((char*)cmdPtr);
/*
* Find this part within its ensemble, and remove it from
* the list of parts.
*/
if (FindEnsemblePartIndex(ensPart->ensemble, ensPart->name, &pos)) {
ensData = ensPart->ensemble;
for (i=pos; i < ensData->numParts-1; i++) {
ensData->parts[i] = ensData->parts[i+1];
}
ensData->numParts--;
}
/*
* Free the memory associated with the part.
*/
if (ensPart->usage) {
ckfree(ensPart->usage);
}
ckfree(ensPart->name);
ckfree((char*)ensPart);
}
/*
*----------------------------------------------------------------------
*
* FindEnsemblePart --
*
* Searches for a part name within an ensemble. Recognizes
* unique abbreviations for part names.
*
* Results:
* If the part name is not a unique abbreviation, this procedure
* returns TCL_ERROR. Otherwise, it returns TCL_OK. If the
* part can be found, "rensPart" returns a pointer to the part.
* Otherwise, it returns NULL.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
FindEnsemblePart(interp, ensData, partName, rensPart)
Tcl_Interp *interp; /* interpreter containing the ensemble */
Ensemble *ensData; /* ensemble being searched */
CONST char* partName; /* name of the desired part */
EnsemblePart **rensPart; /* returns: pointer to the desired part */
{
int pos = 0;
int first, last, nlen;
int i, cmp;
*rensPart = NULL;
/*
* Search for the desired part name.
* All parts are in lexicographical order, so use a
* binary search to find the part quickly. Match only
* as many characters as are included in the specified
* part name.
*/
first = 0;
last = ensData->numParts-1;
nlen = strlen(partName);
while (last >= first) {
pos = (first+last)/2;
if (*partName == *ensData->parts[pos]->name) {
cmp = strncmp(partName, ensData->parts[pos]->name, nlen);
if (cmp == 0) {
break; /* found it! */
}
}
else if (*partName < *ensData->parts[pos]->name) {
cmp = -1;
}
else {
cmp = 1;
}
if (cmp > 0) {
first = pos+1;
} else {
last = pos-1;
}
}
/*
* If a matching entry could not be found, then quit.
*/
if (last < first) {
return TCL_OK;
}
/*
* If a matching entry was found, there may be some ambiguity
* if the user did not specify enough characters. Find the
* top-most match in the list, and see if the part name has
* enough characters. If there are two parts like "foo"
* and "food", this allows us to match "foo" exactly.
*/
if (nlen < ensData->parts[pos]->minChars) {
while (pos > 0) {
pos--;
if (strncmp(partName, ensData->parts[pos]->name, nlen) != 0) {
pos++;
break;
}
}
}
if (nlen < ensData->parts[pos]->minChars) {
Tcl_Obj *resultPtr = Tcl_NewStringObj((char*)NULL, 0);
Tcl_AppendStringsToObj(resultPtr,
"ambiguous option \"", partName, "\": should be one of...",
(char*)NULL);
for (i=pos; i < ensData->numParts; i++) {
if (strncmp(partName, ensData->parts[i]->name, nlen) != 0) {
break;
}
Tcl_AppendToObj(resultPtr, "\n ", 3);
GetEnsemblePartUsage(ensData->parts[i], resultPtr);
}
Tcl_SetObjResult(interp, resultPtr);
return TCL_ERROR;
}
/*
* Found a match. Return the desired part.
*/
*rensPart = ensData->parts[pos];
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* FindEnsemblePartIndex --
*
* Searches for a part name within an ensemble. The part name
* must be an exact match for an existing part name in the
* ensemble. This procedure is useful for managing (i.e.,
* creating and deleting) parts in an ensemble.
*
* Results:
* If an exact match is found, this procedure returns
* non-zero, along with the index of the part in posPtr.
* Otherwise, it returns zero, along with an index in posPtr
* indicating where the part should be.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
static int
FindEnsemblePartIndex(ensData, partName, posPtr)
Ensemble *ensData; /* ensemble being searched */
CONST char *partName; /* name of desired part */
int *posPtr; /* returns: index for part */
{
int pos = 0;
int first, last;
int cmp;
/*
* Search for the desired part name.
* All parts are in lexicographical order, so use a
* binary search to find the part quickly.
*/
first = 0;
last = ensData->numParts-1;
while (last >= first) {
pos = (first+last)/2;
if (*partName == *ensData->parts[pos]->name) {
cmp = strcmp(partName, ensData->parts[pos]->name);
if (cmp == 0) {
break; /* found it! */
}
}
else if (*partName < *ensData->parts[pos]->name) {
cmp = -1;
}
else {
cmp = 1;
}
if (cmp > 0) {
first = pos+1;
} else {
last = pos-1;
}
}
if (last >= first) {
*posPtr = pos;
return 1;
}
*posPtr = first;
return 0;
}
/*
*----------------------------------------------------------------------
*
* ComputeMinChars --
*
* Compares part names on an ensemble's part list and
* determines the minimum number of characters needed for a
* unique abbreviation. The parts on either side of a
* particular part index are compared. As long as there is
* a part on one side or the other, this procedure updates
* the parts to have the proper minimum abbreviations.
*
* Results:
* None.
*
* Side effects:
* Updates three parts within the ensemble to remember
* the minimum abbreviations.
*
*----------------------------------------------------------------------
*/
static void
ComputeMinChars(ensData, pos)
Ensemble *ensData; /* ensemble being modified */
int pos; /* index of part being updated */
{
int min, max;
char *p, *q;
/*
* If the position is invalid, do nothing.
*/
if (pos < 0 || pos >= ensData->numParts) {
return;
}
/*
* Start by assuming that only the first letter is required
* to uniquely identify this part. Then compare the name
* against each neighboring part to determine the real minimum.
*/
ensData->parts[pos]->minChars = 1;
if (pos-1 >= 0) {
p = ensData->parts[pos]->name;
q = ensData->parts[pos-1]->name;
for (min=1; *p == *q && *p != '\0' && *q != '\0'; min++) {
p++;
q++;
}
if (min > ensData->parts[pos]->minChars) {
ensData->parts[pos]->minChars = min;
}
}
if (pos+1 < ensData->numParts) {
p = ensData->parts[pos]->name;
q = ensData->parts[pos+1]->name;
for (min=1; *p == *q && *p != '\0' && *q != '\0'; min++) {
p++;
q++;
}
if (min > ensData->parts[pos]->minChars) {
ensData->parts[pos]->minChars = min;
}
}
max = strlen(ensData->parts[pos]->name);
if (ensData->parts[pos]->minChars > max) {
ensData->parts[pos]->minChars = max;
}
}
/*
*----------------------------------------------------------------------
*
* HandleEnsemble --
*
* Invoked by Tcl whenever the user issues an ensemble-style
* command. Handles commands of the form:
*
* <ensembleName> <partName> ?<arg> <arg>...?
*
* Looks for the <partName> within the ensemble, and if it
* exists, the procedure transfers control to it.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything
* goes wrong.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
static int
HandleEnsemble(clientData, interp, objc, objv)
ClientData clientData; /* ensemble data */
Tcl_Interp *interp; /* current interpreter */
int objc; /* number of arguments */
Tcl_Obj *CONST objv[]; /* argument objects */
{
Ensemble *ensData = (Ensemble*)clientData;
int i, result;
Command *cmdPtr;
EnsemblePart *ensPart;
char *partName;
int partNameLen;
Tcl_Obj *cmdlinePtr, *chainObj;
int cmdlinec;
Tcl_Obj **cmdlinev;
/*
* If a part name is not specified, return an error that
* summarizes the usage for this ensemble.
*/
if (objc < 2) {
Tcl_Obj *resultPtr = Tcl_NewStringObj(
"wrong # args: should be one of...\n", -1);
GetEnsembleUsage(ensData, resultPtr);
Tcl_SetObjResult(interp, resultPtr);
return TCL_ERROR;
}
/*
* Lookup the desired part. If an ambiguous abbrevition is
* found, return an error immediately.
*/
partName = Tcl_GetStringFromObj(objv[1], &partNameLen);
if (FindEnsemblePart(interp, ensData, partName, &ensPart) != TCL_OK) {
return TCL_ERROR;
}
/*
* If the part was not found, then look for an "@error" part
* to handle the error.
*/
if (ensPart == NULL) {
if (FindEnsemblePart(interp, ensData, "@error", &ensPart) != TCL_OK) {
return TCL_ERROR;
}
if (ensPart != NULL) {
cmdPtr = (Command*)ensPart->cmdPtr;
result = (*cmdPtr->objProc)(cmdPtr->objClientData,
interp, objc, objv);
return result;
}
}
if (ensPart == NULL) {
return Itcl_EnsembleErrorCmd((ClientData)ensData,
interp, objc-1, objv+1);
}
/*
* Pass control to the part, and return the result.
*/
chainObj = Tcl_NewObj();
chainObj->bytes = NULL;
chainObj->typePtr = &itclEnsInvocType;
chainObj->internalRep.twoPtrValue.ptr1 = (VOID *) ensPart;
chainObj->internalRep.twoPtrValue.ptr2 = (VOID *) objv[0];
Tcl_IncrRefCount(objv[0]);
cmdlinePtr = Tcl_NewListObj(0, (Tcl_Obj**)NULL);
Tcl_ListObjAppendElement((Tcl_Interp*)NULL, cmdlinePtr, chainObj);
for (i=2; i < objc; i++) {
Tcl_ListObjAppendElement((Tcl_Interp*)NULL, cmdlinePtr, objv[i]);
}
Tcl_IncrRefCount(cmdlinePtr);
result = Tcl_ListObjGetElements((Tcl_Interp*)NULL, cmdlinePtr,
&cmdlinec, &cmdlinev);
if (result == TCL_OK) {
cmdPtr = (Command*)ensPart->cmdPtr;
result = (*cmdPtr->objProc)(cmdPtr->objClientData, interp,
cmdlinec, cmdlinev);
}
Tcl_DecrRefCount(cmdlinePtr);
return result;
}
/*
*----------------------------------------------------------------------
*
* Itcl_EnsembleCmd --
*
* Invoked by Tcl whenever the user issues the "ensemble"
* command to manipulate an ensemble. Handles the following
* syntax:
*
* ensemble <ensName> ?<command> <arg> <arg>...?
* ensemble <ensName> {
* part <partName> <args> <body>
* ensemble <ensName> {
* ...
* }
* }
*
* Finds or creates the ensemble <ensName>, and then executes
* the commands to add parts.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything
* goes wrong.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
int
Itcl_EnsembleCmd(clientData, interp, objc, objv)
ClientData clientData; /* ensemble data */
Tcl_Interp *interp; /* current interpreter */
int objc; /* number of arguments */
Tcl_Obj *CONST objv[]; /* argument objects */
{
int status;
char *ensName;
EnsembleParser *ensInfo;
Ensemble *ensData, *savedEnsData;
EnsemblePart *ensPart;
Tcl_Command cmd;
Command *cmdPtr;
Tcl_Obj *objPtr;
/*
* Make sure that an ensemble name was specified.
*/
if (objc < 2) {
Tcl_AppendResult(interp,
"wrong # args: should be \"",
Tcl_GetStringFromObj(objv[0], (int*)NULL),
" name ?command arg arg...?\"",
(char*)NULL);
return TCL_ERROR;
}
/*
* If this is the "ensemble" command in the main interpreter,
* then the client data will be null. Otherwise, it is
* the "ensemble" command in the ensemble body parser, and
* the client data indicates which ensemble we are modifying.
*/
if (clientData) {
ensInfo = (EnsembleParser*)clientData;
} else {
ensInfo = GetEnsembleParser(interp);
}
ensData = ensInfo->ensData;
/*
* Find or create the desired ensemble. If an ensemble is
* being built, then this "ensemble" command is enclosed in
* another "ensemble" command. Use the current ensemble as
* the parent, and find or create an ensemble part within it.
*/
ensName = Tcl_GetStringFromObj(objv[1], (int*)NULL);
if (ensData) {
if (FindEnsemblePart(interp, ensData, ensName, &ensPart) != TCL_OK) {
ensPart = NULL;
}
if (ensPart == NULL) {
if (CreateEnsemble(interp, ensData, ensName) != TCL_OK) {
return TCL_ERROR;
}
if (FindEnsemblePart(interp, ensData, ensName, &ensPart)
!= TCL_OK) {
Tcl_Panic("Itcl_EnsembleCmd: can't create ensemble");
}
}
cmdPtr = (Command*)ensPart->cmdPtr;
if (cmdPtr->deleteProc != DeleteEnsemble) {
Tcl_AppendResult(interp,
"part \"", Tcl_GetStringFromObj(objv[1], (int*)NULL),
"\" is not an ensemble",
(char*)NULL);
return TCL_ERROR;
}
ensData = (Ensemble*)cmdPtr->objClientData;
}
/*
* Otherwise, the desired ensemble is a top-level ensemble.
* Find or create the access command for the ensemble, and
* then get its data.
*/
else {
cmd = Tcl_FindCommand(interp, ensName, (Tcl_Namespace*)NULL, 0);
if (cmd == NULL) {
if (CreateEnsemble(interp, (Ensemble*)NULL, ensName)
!= TCL_OK) {
return TCL_ERROR;
}
cmd = Tcl_FindCommand(interp, ensName, (Tcl_Namespace*)NULL, 0);
}
cmdPtr = (Command*)cmd;
if (cmdPtr == NULL || cmdPtr->deleteProc != DeleteEnsemble) {
Tcl_AppendResult(interp,
"command \"", Tcl_GetStringFromObj(objv[1], (int*)NULL),
"\" is not an ensemble",
(char*)NULL);
return TCL_ERROR;
}
ensData = (Ensemble*)cmdPtr->objClientData;
}
/*
* At this point, we have the data for the ensemble that is
* being manipulated. Plug this into the parser, and then
* interpret the rest of the arguments in the ensemble parser.
*/
status = TCL_OK;
savedEnsData = ensInfo->ensData;
ensInfo->ensData = ensData;
if (objc == 3) {
status = Tcl_EvalObj(ensInfo->parser, objv[2]);
}
else if (objc > 3) {
objPtr = Tcl_NewListObj(objc-2, objv+2);
Tcl_IncrRefCount(objPtr); /* stop Eval trashing it */
status = Tcl_EvalObj(ensInfo->parser, objPtr);
Tcl_DecrRefCount(objPtr); /* we're done with the object */
}
/*
* Copy the result from the parser interpreter to the
* master interpreter. If an error was encountered,
* copy the error info first, and then set the result.
* Otherwise, the offending command is reported twice.
*/
if (status == TCL_ERROR) {
CONST char *errInfo = Tcl_GetVar2(ensInfo->parser, "::errorInfo",
(char*)NULL, TCL_GLOBAL_ONLY);
if (errInfo) {
Tcl_AddObjErrorInfo(interp, errInfo, -1);
}
if (objc == 3) {
char msg[128];
sprintf(msg, "\n (\"ensemble\" body line %d)",
Tcl_GetErrorLine(ensInfo->parser));
Tcl_AddObjErrorInfo(interp, msg, -1);
}
}
Tcl_SetObjResult(interp, Tcl_GetObjResult(ensInfo->parser));
ensInfo->ensData = savedEnsData;
return status;
}
/*
*----------------------------------------------------------------------
*
* GetEnsembleParser --
*
* Returns the slave interpreter that acts as a parser for
* the body of an "ensemble" definition. The first time that
* this is called for an interpreter, the parser is created
* and registered as associated data. After that, it is
* simply returned.
*
* Results:
* Returns a pointer to the ensemble parser data structure.
*
* Side effects:
* On the first call, the ensemble parser is created and
* registered as "itcl_ensembleParser" with the interpreter.
*
*----------------------------------------------------------------------
*/
static EnsembleParser*
GetEnsembleParser(interp)
Tcl_Interp *interp; /* interpreter handling the ensemble */
{
Namespace *nsPtr;
Tcl_Namespace *childNs;
EnsembleParser *ensInfo;
Tcl_HashEntry *hPtr;
Tcl_HashSearch search;
Tcl_Command cmd;
/*
* Look for an existing ensemble parser. If it is found,
* return it immediately.
*/
ensInfo = (EnsembleParser*) Tcl_GetAssocData(interp,
"itcl_ensembleParser", NULL);
if (ensInfo) {
return ensInfo;
}
/*
* Create a slave interpreter that can be used to parse
* the body of an ensemble definition.
*/
ensInfo = (EnsembleParser*)ckalloc(sizeof(EnsembleParser));
ensInfo->master = interp;
ensInfo->parser = Tcl_CreateInterp();
ensInfo->ensData = NULL;
/*
* Remove all namespaces and all normal commands from the
* parser interpreter.
*/
nsPtr = (Namespace*)Tcl_GetGlobalNamespace(ensInfo->parser);
for (hPtr = Tcl_FirstHashEntry(&nsPtr->childTable, &search);
hPtr != NULL;
hPtr = Tcl_FirstHashEntry(&nsPtr->childTable, &search)) {
childNs = (Tcl_Namespace*)Tcl_GetHashValue(hPtr);
Tcl_DeleteNamespace(childNs);
}
for (hPtr = Tcl_FirstHashEntry(&nsPtr->cmdTable, &search);
hPtr != NULL;
hPtr = Tcl_FirstHashEntry(&nsPtr->cmdTable, &search)) {
cmd = (Tcl_Command)Tcl_GetHashValue(hPtr);
Tcl_DeleteCommandFromToken(ensInfo->parser, cmd);
}
/*
* Add the allowed commands to the parser interpreter:
* part, delete, ensemble
*/
Tcl_CreateObjCommand(ensInfo->parser, "part", Itcl_EnsPartCmd,
(ClientData)ensInfo, (Tcl_CmdDeleteProc*)NULL);
Tcl_CreateObjCommand(ensInfo->parser, "option", Itcl_EnsPartCmd,
(ClientData)ensInfo, (Tcl_CmdDeleteProc*)NULL);
Tcl_CreateObjCommand(ensInfo->parser, "ensemble", Itcl_EnsembleCmd,
(ClientData)ensInfo, (Tcl_CmdDeleteProc*)NULL);
/*
* Install the parser data, so we'll have it the next time
* we call this procedure.
*/
(void) Tcl_SetAssocData(interp, "itcl_ensembleParser",
DeleteEnsParser, (ClientData)ensInfo);
return ensInfo;
}
/*
*----------------------------------------------------------------------
*
* DeleteEnsParser --
*
* Called when an interpreter is destroyed to clean up the
* ensemble parser within it. Destroys the slave interpreter
* and frees up the data associated with it.
*
* Results:
* None.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
/* ARGSUSED */
static void
DeleteEnsParser(clientData, interp)
ClientData clientData; /* client data for ensemble-related commands */
Tcl_Interp *interp; /* interpreter containing the data */
{
EnsembleParser* ensInfo = (EnsembleParser*)clientData;
Tcl_DeleteInterp(ensInfo->parser);
ckfree((char*)ensInfo);
}
/*
*----------------------------------------------------------------------
*
* Itcl_EnsPartCmd --
*
* Invoked by Tcl whenever the user issues the "part" command
* to manipulate an ensemble. This command can only be used
* inside the "ensemble" command, which handles ensembles.
* Handles the following syntax:
*
* ensemble <ensName> {
* part <partName> <args> <body>
* }
*
* Adds a new part called <partName> to the ensemble. If a
* part already exists with that name, it is an error. The
* new part is handled just like an ordinary Tcl proc, with
* a list of <args> and a <body> of code to execute.
*
* Results:
* Returns TCL_OK if successful, and TCL_ERROR if anything
* goes wrong.
*
* Side effects:
* If anything goes wrong, this procedure returns an error
* message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
int
Itcl_EnsPartCmd(clientData, interp, objc, objv)
ClientData clientData; /* ensemble data */
Tcl_Interp *interp; /* current interpreter */
int objc; /* number of arguments */
Tcl_Obj *CONST objv[]; /* argument objects */
{
EnsembleParser *ensInfo = (EnsembleParser*)clientData;
Ensemble *ensData = (Ensemble*)ensInfo->ensData;
int status, varArgs, space;
char *partName, *usage;
Proc *procPtr;
Command *cmdPtr;
CompiledLocal *localPtr;
EnsemblePart *ensPart;
Tcl_DString buffer;
if (objc != 4) {
Tcl_AppendResult(interp,
"wrong # args: should be \"",
Tcl_GetStringFromObj(objv[0], (int*)NULL),
" name args body\"",
(char*)NULL);
return TCL_ERROR;
}
/*
* Create a Tcl-style proc definition using the specified args
* and body. This is not a proc in the usual sense. It belongs
* to the namespace that contains the ensemble, but it is
* accessed through the ensemble, not through a Tcl command.
*/
partName = Tcl_GetStringFromObj(objv[1], (int*)NULL);
cmdPtr = (Command*)ensData->cmd;
if (TclCreateProc(interp, cmdPtr->nsPtr, partName, objv[2], objv[3],
&procPtr) != TCL_OK) {
return TCL_ERROR;
}
/*
* Deduce the usage information from the argument list.
* We'll register this when we create the part, in a moment.
*/
Tcl_DStringInit(&buffer);
varArgs = 0;
space = 0;
for (localPtr=procPtr->firstLocalPtr;
localPtr != NULL;
localPtr=localPtr->nextPtr) {
if (TclIsVarArgument(localPtr)) {
varArgs = 0;
if (strcmp(localPtr->name, "args") == 0) {
varArgs = 1;
}
else if (localPtr->defValuePtr) {
if (space) {
Tcl_DStringAppend(&buffer, " ", 1);
}
Tcl_DStringAppend(&buffer, "?", 1);
Tcl_DStringAppend(&buffer, localPtr->name, -1);
Tcl_DStringAppend(&buffer, "?", 1);
space = 1;
}
else {
if (space) {
Tcl_DStringAppend(&buffer, " ", 1);
}
Tcl_DStringAppend(&buffer, localPtr->name, -1);
space = 1;
}
}
}
if (varArgs) {
if (space) {
Tcl_DStringAppend(&buffer, " ", 1);
}
Tcl_DStringAppend(&buffer, "?arg arg ...?", 13);
}
usage = Tcl_DStringValue(&buffer);
/*
* Create a new part within the ensemble. If successful,
* plug the command token into the proc; we'll need it later
* if we try to compile the Tcl code for the part. If
* anything goes wrong, clean up before bailing out.
*/
status = AddEnsemblePart(interp, ensData, partName, usage,
TclObjInterpProc, (ClientData)procPtr, TclProcDeleteProc,
&ensPart);
if (status == TCL_OK) {
procPtr->cmdPtr = ensPart->cmdPtr;
} else {
TclProcDeleteProc((ClientData)procPtr);
}
Tcl_DStringFree(&buffer);
return status;
}
/*
*----------------------------------------------------------------------
*
* Itcl_EnsembleErrorCmd --
*
* Invoked when the user tries to access an unknown part for
* an ensemble. Acts as the default handler for the "@error"
* part. Generates an error message like:
*
* bad option "foo": should be one of...
* info args procname
* info body procname
* info cmdcount
* ...
*
* Results:
* Always returns TCL_OK.
*
* Side effects:
* Returns the error message as the result in the interpreter.
*
*----------------------------------------------------------------------
*/
/* ARGSUSED */
int
Itcl_EnsembleErrorCmd(clientData, interp, objc, objv)
ClientData clientData; /* ensemble info */
Tcl_Interp *interp; /* current interpreter */
int objc; /* number of arguments */
Tcl_Obj *CONST objv[]; /* argument objects */
{
Ensemble *ensData = (Ensemble*)clientData;
char *cmdName;
Tcl_Obj *objPtr;
cmdName = Tcl_GetStringFromObj(objv[0], (int*)NULL);
objPtr = Tcl_NewStringObj((char*)NULL, 0);
Tcl_AppendStringsToObj(objPtr,
"bad option \"", cmdName, "\": should be one of...\n",
(char*)NULL);
GetEnsembleUsage(ensData, objPtr);
Tcl_SetObjResult(interp, objPtr);
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* FreeEnsInvocInternalRep --
*
* Frees the resources associated with an ensembleInvoc object's
* internal representation.
*
* Results:
* None.
*
* Side effects:
* Decrements the ref count of the two objects referenced by
* this object. If there are no more uses, this will free
* the other objects.
*
*----------------------------------------------------------------------
*/
static void
FreeEnsInvocInternalRep(objPtr)
register Tcl_Obj *objPtr; /* namespName object with internal
* representation to free */
{
Tcl_Obj *prevArgObj = (Tcl_Obj*)objPtr->internalRep.twoPtrValue.ptr2;
if (prevArgObj) {
Tcl_DecrRefCount(prevArgObj);
}
}
/*
*----------------------------------------------------------------------
*
* DupEnsInvocInternalRep --
*
* Initializes the internal representation of an ensembleInvoc
* object to a copy of the internal representation of
* another ensembleInvoc object.
*
* This shouldn't be called. Normally, a temporary ensembleInvoc
* object is created while an ensemble call is in progress.
* This object may be converted to string form if an error occurs.
* It does not stay around long, and there is no reason for it
* to be duplicated.
*
* Results:
* None.
*
* Side effects:
* copyPtr's internal rep is set to duplicates of the objects
* pointed to by srcPtr's internal rep.
*
*----------------------------------------------------------------------
*/
static void
DupEnsInvocInternalRep(srcPtr, copyPtr)
Tcl_Obj *srcPtr; /* Object with internal rep to copy. */
register Tcl_Obj *copyPtr; /* Object with internal rep to set. */
{
EnsemblePart *ensPart = (EnsemblePart*)srcPtr->internalRep.twoPtrValue.ptr1;
Tcl_Obj *prevArgObj = (Tcl_Obj*)srcPtr->internalRep.twoPtrValue.ptr2;
Tcl_Obj *objPtr;
copyPtr->internalRep.twoPtrValue.ptr1 = (VOID *) ensPart;
if (prevArgObj) {
objPtr = Tcl_DuplicateObj(prevArgObj);
Tcl_IncrRefCount(objPtr);
copyPtr->internalRep.twoPtrValue.ptr2 = (VOID *) objPtr;
}
}
/*
*----------------------------------------------------------------------
*
* SetEnsInvocFromAny --
*
* Generates the internal representation for an ensembleInvoc
* object. This conversion really shouldn't take place.
* Normally, a temporary ensembleInvoc object is created while
* an ensemble call is in progress. This object may be converted
* to string form if an error occurs. But there is no reason
* for any other object to be converted to ensembleInvoc form.
*
* Results:
* Always returns TCL_OK.
*
* Side effects:
* The string representation is saved as if it were the
* command line argument for the ensemble invocation. The
* reference to the ensemble part is set to NULL.
*
*----------------------------------------------------------------------
*/
static int
SetEnsInvocFromAny(interp, objPtr)
Tcl_Interp *interp; /* Determines the context for
name resolution */
register Tcl_Obj *objPtr; /* The object to convert */
{
int length;
char *name;
Tcl_Obj *argObj;
/*
* Get objPtr's string representation.
* Make it up-to-date if necessary.
* THIS FAILS IF THE OBJECT'S STRING REP CONTAINS NULLS.
*/
name = Tcl_GetStringFromObj(objPtr, &length);
/*
* Make an argument object to contain the string, and
* set the ensemble part definition to NULL. At this point,
* we don't know anything about an ensemble, so we'll just
* keep the string around as if it were the command line
* invocation.
*/
argObj = Tcl_NewStringObj(name, length);
/*
* Free the old representation and install a new one.
*/
if (objPtr->typePtr && objPtr->typePtr->freeIntRepProc != NULL) {
(*objPtr->typePtr->freeIntRepProc)(objPtr);
}
objPtr->internalRep.twoPtrValue.ptr1 = (VOID *) NULL;
objPtr->internalRep.twoPtrValue.ptr2 = (VOID *) argObj;
objPtr->typePtr = &itclEnsInvocType;
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* UpdateStringOfEnsInvoc --
*
* Updates the string representation for an ensembleInvoc object.
* This is called when an error occurs in an ensemble part, when
* the code tries to print objv[0] as the command name. This
* code automatically chains together all of the names leading
* to the ensemble part, so the error message references the
* entire command, not just the part name.
*
* Note: This procedure does not free an existing old string rep
* so storage will be lost if this has not already been done.
*
* Results:
* None.
*
* Side effects:
* The object's string is set to the full command name for
* the ensemble part.
*
*----------------------------------------------------------------------
*/
static void
UpdateStringOfEnsInvoc(objPtr)
register Tcl_Obj *objPtr; /* NamespName obj to update string rep. */
{
EnsemblePart *ensPart = (EnsemblePart*)objPtr->internalRep.twoPtrValue.ptr1;
Tcl_Obj *prevArgObj = (Tcl_Obj*)objPtr->internalRep.twoPtrValue.ptr2;
Tcl_DString buffer;
int length;
char *name;
Tcl_DStringInit(&buffer);
/*
* Get the string representation for the previous argument.
* This will force each ensembleInvoc argument up the line
* to get its string representation. So we will get the
* original command name, followed by the sub-ensemble, and
* the next sub-ensemble, and so on. Then add the part
* name from the ensPart argument.
*/
if (prevArgObj) {
name = Tcl_GetStringFromObj(prevArgObj, &length);
Tcl_DStringAppend(&buffer, name, length);
}
if (ensPart) {
Tcl_DStringAppendElement(&buffer, ensPart->name);
}
/*
* The following allocates an empty string on the heap if name is ""
* (e.g., if the internal rep is NULL).
*/
name = Tcl_DStringValue(&buffer);
length = strlen(name);
objPtr->bytes = (char *) ckalloc((unsigned) (length + 1));
memcpy((VOID *) objPtr->bytes, (VOID *) name, (unsigned) length);
objPtr->bytes[length] = '\0';
objPtr->length = length;
}
|