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
|
/*
* tkMenu.c --
*
* This file contains most of the code for implementing menus in Tk. It takes
* care of all of the generic (platform-independent) parts of menus, and
* is supplemented by platform-specific files. The geometry calculation
* and drawing code for menus is in the file tkMenuDraw.c
*
* Copyright (c) 1990-1994 The Regents of the University of California.
* Copyright (c) 1994-1998 Sun Microsystems, Inc.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*
* SCCS: @(#) tkMenu.c 1.165 98/02/11 19:02:31
*/
/*
* Notes on implementation of menus:
*
* Menus can be used in three ways:
* - as a popup menu, either as part of a menubutton or standalone.
* - as a menubar. The menu's cascade items are arranged according to
* the specific platform to provide the user access to the menus at all
* times
* - as a tearoff palette. This is a window with the menu's items in it.
*
* The goal is to provide the Tk developer with a way to use a common
* set of menus for all of these tasks.
*
* In order to make the bindings for cascade menus work properly under Unix,
* the cascade menus' pathnames must be proper children of the menu that
* they are cascade from. So if there is a menu .m, and it has two
* cascades labelled "File" and "Edit", the cascade menus might have
* the pathnames .m.file and .m.edit. Another constraint is that the menus
* used for menubars must be children of the toplevel widget that they
* are attached to. And on the Macintosh, the platform specific menu handle
* for cascades attached to a menu bar must have a title that matches the
* label for the cascade menu.
*
* To handle all of the constraints, Tk menubars and tearoff menus are
* implemented using menu clones. Menu clones are full menus in their own
* right; they have a Tk window and pathname associated with them; they have
* a TkMenu structure and array of entries. However, they are linked with the
* original menu that they were cloned from. The reflect the attributes of
* the original, or "master", menu. So if an item is added to a menu, and
* that menu has clones, then the item must be added to all of its clones
* also. Menus are cloned when a menu is torn-off or when a menu is assigned
* as a menubar using the "-menu" option of the toplevel's pathname configure
* subcommand. When a clone is destroyed, only the clone is destroyed, but
* when the master menu is destroyed, all clones are also destroyed. This
* allows the developer to just deal with one set of menus when creating
* and destroying.
*
* Clones are rather tricky when a menu with cascade entries is cloned (such
* as a menubar). Not only does the menu have to be cloned, but each cascade
* entry's corresponding menu must also be cloned. This maintains the pathname
* parent-child hierarchy necessary for menubars and toplevels to work.
* This leads to several special cases:
*
* 1. When a new menu is created, and it is pointed to by cascade entries in
* cloned menus, the new menu has to be cloned to parallel the cascade
* structure.
* 2. When a cascade item is added to a menu that has been cloned, and the
* menu that the cascade item points to exists, that menu has to be cloned.
* 3. When the menu that a cascade entry points to is changed, the old
* cloned cascade menu has to be discarded, and the new one has to be cloned.
*
*/
#define __NO_OLD_CONFIG
#include "tkPort.h"
#include "tkMenu.h"
#define MENU_HASH_KEY "tkMenus"
static int menusInitialized; /* Whether or not the hash tables, etc., have
* been setup */
/*
* Configuration specs for individual menu entries. If this changes, be sure
* to update code in TkpMenuInit that changes the font string entry.
*/
char *tkMenuStateStrings[] = {"active", "normal", "disabled", (char *) NULL};
static char *menuEntryTypeStrings[] = {"cascade", "checkbutton", "command",
"radiobutton", "separator", (char *) NULL};
Tk_OptionSpec tkBasicMenuEntryConfigSpecs[] = {
{TK_OPTION_BORDER, "-activebackground", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_ACTIVE_BG, Tk_Offset(TkMenuEntry, activeBorderPtr), -1,
TK_OPTION_NULL_OK},
{TK_OPTION_COLOR, "-activeforeground", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_ACTIVE_FG,
Tk_Offset(TkMenuEntry, activeFgPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-accelerator", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_ACCELERATOR,
Tk_Offset(TkMenuEntry, accelPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_BORDER, "-background", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_BG,
Tk_Offset(TkMenuEntry, borderPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_BITMAP, "-bitmap", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_BITMAP,
Tk_Offset(TkMenuEntry, bitmapPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_BOOLEAN, "-columnbreak", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_COLUMN_BREAK,
Tk_Offset(TkMenuEntry, columnBreakPtr), -1},
{TK_OPTION_STRING, "-command", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_COMMAND,
Tk_Offset(TkMenuEntry, commandPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_FONT, "-font", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_FONT,
Tk_Offset(TkMenuEntry, fontPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_COLOR, "-foreground", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_FG,
Tk_Offset(TkMenuEntry, fgPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_BOOLEAN, "-hidemargin", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_HIDE_MARGIN,
Tk_Offset(TkMenuEntry, hideMarginPtr), -1},
{TK_OPTION_STRING, "-image", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_IMAGE,
Tk_Offset(TkMenuEntry, imagePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-label", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_LABEL,
Tk_Offset(TkMenuEntry, labelPtr), -1, 0},
{TK_OPTION_STRING_TABLE, "-state", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_STATE,
Tk_Offset(TkMenuEntry, statePtr), -1, 0,
(ClientData) tkMenuStateStrings},
{TK_OPTION_INT, "-underline", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_UNDERLINE, -1, Tk_Offset(TkMenuEntry, underline)},
{TK_OPTION_END}
};
Tk_OptionSpec tkSeparatorEntryConfigSpecs[] = {
{TK_OPTION_BORDER, "-background", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_BG,
Tk_Offset(TkMenuEntry, borderPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_END}
};
Tk_OptionSpec tkCheckButtonEntryConfigSpecs[] = {
{TK_OPTION_BOOLEAN, "-indicatoron", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_INDICATOR,
Tk_Offset(TkMenuEntry, indicatorOnPtr), -1},
{TK_OPTION_STRING, "-offvalue", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_OFF_VALUE,
Tk_Offset(TkMenuEntry, offValuePtr), -1},
{TK_OPTION_STRING, "-onvalue", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_ON_VALUE,
Tk_Offset(TkMenuEntry, onValuePtr), -1},
{TK_OPTION_COLOR, "-selectcolor", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_SELECT,
Tk_Offset(TkMenuEntry, indicatorFgPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-selectimage", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_SELECT_IMAGE,
Tk_Offset(TkMenuEntry, selectImagePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-variable", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_CHECK_VARIABLE,
Tk_Offset(TkMenuEntry, namePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_END, (char *) NULL, (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) tkBasicMenuEntryConfigSpecs}
};
Tk_OptionSpec tkRadioButtonEntryConfigSpecs[] = {
{TK_OPTION_BOOLEAN, "-indicatoron", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_INDICATOR,
Tk_Offset(TkMenuEntry, indicatorOnPtr), -1},
{TK_OPTION_COLOR, "-selectcolor", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_SELECT,
Tk_Offset(TkMenuEntry, indicatorFgPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-selectimage", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_SELECT_IMAGE,
Tk_Offset(TkMenuEntry, selectImagePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-value", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_VALUE,
Tk_Offset(TkMenuEntry, onValuePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-variable", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_RADIO_VARIABLE,
Tk_Offset(TkMenuEntry, namePtr), -1, 0},
{TK_OPTION_END, (char *) NULL, (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) tkBasicMenuEntryConfigSpecs}
};
Tk_OptionSpec tkCascadeEntryConfigSpecs[] = {
{TK_OPTION_STRING, "-menu", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_MENU,
Tk_Offset(TkMenuEntry, namePtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_END, (char *) NULL, (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) tkBasicMenuEntryConfigSpecs}
};
Tk_OptionSpec tkTearoffEntryConfigSpecs[] = {
{TK_OPTION_BORDER, "-background", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_BG,
Tk_Offset(TkMenuEntry, borderPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING_TABLE, "-state", (char *) NULL, (char *) NULL,
DEF_MENU_ENTRY_STATE, Tk_Offset(TkMenuEntry, statePtr), -1, 0,
(ClientData) tkMenuStateStrings},
{TK_OPTION_END}
};
static Tk_OptionSpec *specsArray[] = {
tkCascadeEntryConfigSpecs, tkCheckButtonEntryConfigSpecs,
tkBasicMenuEntryConfigSpecs, tkRadioButtonEntryConfigSpecs,
tkSeparatorEntryConfigSpecs, tkTearoffEntryConfigSpecs};
/*
* Menu type strings for use with Tcl_GetIndexFromObj.
*/
static char *menuTypeStrings[] = {"normal", "tearoff", "menubar",
(char *) NULL};
Tk_OptionSpec tkMenuConfigSpecs[] = {
{TK_OPTION_BORDER, "-activebackground", "activeBackground",
"Foreground", DEF_MENU_ACTIVE_BG_COLOR,
Tk_Offset(TkMenu, activeBorderPtr), -1, 0,
(ClientData) DEF_MENU_ACTIVE_BG_MONO},
{TK_OPTION_PIXELS, "-activeborderwidth", "activeBorderWidth",
"BorderWidth", DEF_MENU_ACTIVE_BORDER_WIDTH,
Tk_Offset(TkMenu, activeBorderWidthPtr), -1},
{TK_OPTION_COLOR, "-activeforeground", "activeForeground",
"Background", DEF_MENU_ACTIVE_FG_COLOR,
Tk_Offset(TkMenu, activeFgPtr), -1, 0,
(ClientData) DEF_MENU_ACTIVE_FG_MONO},
{TK_OPTION_BORDER, "-background", "background", "Background",
DEF_MENU_BG_COLOR, Tk_Offset(TkMenu, borderPtr), -1, 0,
(ClientData) DEF_MENU_BG_MONO},
{TK_OPTION_SYNONYM, "-bd", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-borderwidth"},
{TK_OPTION_SYNONYM, "-bg", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-background"},
{TK_OPTION_PIXELS, "-borderwidth", "borderWidth", "BorderWidth",
DEF_MENU_BORDER_WIDTH,
Tk_Offset(TkMenu, borderWidthPtr), -1, 0},
{TK_OPTION_CURSOR, "-cursor", "cursor", "Cursor",
DEF_MENU_CURSOR,
Tk_Offset(TkMenu, cursorPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_COLOR, "-disabledforeground", "disabledForeground",
"DisabledForeground", DEF_MENU_DISABLED_FG_COLOR,
Tk_Offset(TkMenu, disabledFgPtr), -1, TK_OPTION_NULL_OK,
(ClientData) DEF_MENU_DISABLED_FG_MONO},
{TK_OPTION_SYNONYM, "-fg", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-foreground"},
{TK_OPTION_FONT, "-font", "font", "Font",
DEF_MENU_FONT, Tk_Offset(TkMenu, fontPtr), -1},
{TK_OPTION_COLOR, "-foreground", "foreground", "Foreground",
DEF_MENU_FG, Tk_Offset(TkMenu, fgPtr), -1},
{TK_OPTION_STRING, "-postcommand", "postCommand", "Command",
DEF_MENU_POST_COMMAND,
Tk_Offset(TkMenu, postCommandPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_RELIEF, "-relief", "relief", "Relief",
DEF_MENU_RELIEF, Tk_Offset(TkMenu, reliefPtr), -1},
{TK_OPTION_COLOR, "-selectcolor", "selectColor", "Background",
DEF_MENU_SELECT_COLOR, Tk_Offset(TkMenu, indicatorFgPtr), -1, 0,
(ClientData) DEF_MENU_SELECT_MONO},
{TK_OPTION_STRING, "-takefocus", "takeFocus", "TakeFocus",
DEF_MENU_TAKE_FOCUS,
Tk_Offset(TkMenu, takeFocusPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_BOOLEAN, "-tearoff", "tearOff", "TearOff",
DEF_MENU_TEAROFF,
Tk_Offset(TkMenu, tearoffPtr), -1},
{TK_OPTION_STRING, "-tearoffcommand", "tearOffCommand",
"TearOffCommand", DEF_MENU_TEAROFF_CMD,
Tk_Offset(TkMenu, tearoffCommandPtr), -1, TK_OPTION_NULL_OK},
{TK_OPTION_STRING, "-title", "title", "Title",
DEF_MENU_TITLE, Tk_Offset(TkMenu, titlePtr), -1,
TK_OPTION_NULL_OK},
{TK_OPTION_STRING_TABLE, "-type", "type", "Type",
DEF_MENU_TYPE, Tk_Offset(TkMenu, menuTypePtr), -1, TK_OPTION_NULL_OK,
(ClientData) menuTypeStrings},
{TK_OPTION_END}
};
/*
* Command line options. Put here because MenuCmd has to look at them
* along with MenuWidgetObjCmd.
*/
static char *menuOptions[] = {
"activate", "add", "cget", "clone", "configure", "delete", "entrycget",
"entryconfigure", "index", "insert", "invoke", "post", "postcascade",
"type", "unpost", "yposition", (char *) NULL
};
enum options {
MENU_ACTIVATE, MENU_ADD, MENU_CGET, MENU_CLONE, MENU_CONFIGURE,
MENU_DELETE, MENU_ENTRYCGET, MENU_ENTRYCONFIGURE, MENU_INDEX,
MENU_INSERT, MENU_INVOKE, MENU_POST, MENU_POSTCASCADE, MENU_TYPE,
MENU_UNPOST, MENU_YPOSITION
};
/*
* Prototypes for static procedures in this file:
*/
static int CloneMenu _ANSI_ARGS_((TkMenu *menuPtr,
Tcl_Obj *newMenuName, Tcl_Obj *newMenuTypeString));
static int ConfigureMenu _ANSI_ARGS_((Tcl_Interp *interp,
TkMenu *menuPtr, int objc, Tcl_Obj *CONST objv[]));
static int ConfigureMenuCloneEntries _ANSI_ARGS_((
Tcl_Interp *interp, TkMenu *menuPtr, int index,
int objc, Tcl_Obj *CONST objv[]));
static int ConfigureMenuEntry _ANSI_ARGS_((TkMenuEntry *mePtr,
int objc, Tcl_Obj *CONST objv[]));
static void DeleteMenuCloneEntries _ANSI_ARGS_((TkMenu *menuPtr,
int first, int last));
static void DestroyMenuHashTable _ANSI_ARGS_((
ClientData clientData, Tcl_Interp *interp));
static void DestroyMenuInstance _ANSI_ARGS_((TkMenu *menuPtr));
static void DestroyMenuEntry _ANSI_ARGS_((char *memPtr));
static int GetIndexFromCoords
_ANSI_ARGS_((Tcl_Interp *interp, TkMenu *menuPtr,
char *string, int *indexPtr));
static int MenuDoYPosition _ANSI_ARGS_((Tcl_Interp *interp,
TkMenu *menuPtr, Tcl_Obj *objPtr));
static int MenuAddOrInsert _ANSI_ARGS_((Tcl_Interp *interp,
TkMenu *menuPtr, Tcl_Obj *indexPtr, int objc,
Tcl_Obj *CONST objv[]));
static int MenuCmd _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, int objc,
Tcl_Obj *CONST objv[]));
static void MenuCmdDeletedProc _ANSI_ARGS_((
ClientData clientData));
static TkMenuEntry * MenuNewEntry _ANSI_ARGS_((TkMenu *menuPtr, int index,
int type));
static char * MenuVarProc _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, char *name1, char *name2,
int flags));
static int MenuWidgetObjCmd _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, int objc,
Tcl_Obj *CONST objv[]));
static void MenuWorldChanged _ANSI_ARGS_((
ClientData instanceData));
static int PostProcessEntry _ANSI_ARGS_((TkMenuEntry *mePtr));
static void RecursivelyDeleteMenu _ANSI_ARGS_((TkMenu *menuPtr));
static void UnhookCascadeEntry _ANSI_ARGS_((TkMenuEntry *mePtr));
/*
* The structure below is a list of procs that respond to certain window
* manager events. One of these includes a font change, which forces
* the geometry proc to be called.
*/
static TkClassProcs menuClass = {
NULL, /* createProc. */
MenuWorldChanged /* geometryProc. */
};
/*
*--------------------------------------------------------------
*
* Tk_CreateMenuCmd --
*
* Called by Tk at initialization time to create the menu
* command.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* See the user documentation.
*
*--------------------------------------------------------------
*/
int
TkCreateMenuCmd(interp)
Tcl_Interp *interp; /* Interpreter we are creating the
* command in. */
{
TkMenuOptionTables *optionTablesPtr =
(TkMenuOptionTables *) ckalloc(sizeof(TkMenuOptionTables));
optionTablesPtr->menuOptionTable =
Tk_CreateOptionTable(interp, tkMenuConfigSpecs);
optionTablesPtr->entryOptionTables[TEAROFF_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[TEAROFF_ENTRY]);
optionTablesPtr->entryOptionTables[COMMAND_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[COMMAND_ENTRY]);
optionTablesPtr->entryOptionTables[CASCADE_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[CASCADE_ENTRY]);
optionTablesPtr->entryOptionTables[SEPARATOR_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[SEPARATOR_ENTRY]);
optionTablesPtr->entryOptionTables[RADIO_BUTTON_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[RADIO_BUTTON_ENTRY]);
optionTablesPtr->entryOptionTables[CHECK_BUTTON_ENTRY] =
Tk_CreateOptionTable(interp, specsArray[CHECK_BUTTON_ENTRY]);
Tcl_CreateObjCommand(interp, "menu", MenuCmd,
(ClientData) optionTablesPtr, NULL);
if (Tcl_IsSafe(interp)) {
Tcl_HideCommand(interp, "menu", "menu");
}
return TCL_OK;
}
/*
*--------------------------------------------------------------
*
* MenuCmd --
*
* This procedure is invoked to process the "menu" Tcl
* command. See the user documentation for details on
* what it does.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* See the user documentation.
*
*--------------------------------------------------------------
*/
static int
MenuCmd(clientData, interp, objc, objv)
ClientData clientData; /* Main window associated with
* interpreter. */
Tcl_Interp *interp; /* Current interpreter. */
int objc; /* Number of arguments. */
Tcl_Obj *CONST objv[]; /* Argument strings. */
{
Tk_Window tkwin = Tk_MainWindow(interp);
Tk_Window new;
register TkMenu *menuPtr;
TkMenuReferences *menuRefPtr;
int i, index;
int toplevel;
char *windowName;
static char *typeStringList[] = {"-type", (char *) NULL};
TkMenuOptionTables *optionTablesPtr = (TkMenuOptionTables *) clientData;
if (objc < 2) {
Tcl_WrongNumArgs(interp, 1, objv, "pathName ?options?");
return TCL_ERROR;
}
TkMenuInit();
toplevel = 1;
for (i = 2; i < (objc - 1); i++) {
if (Tcl_GetIndexFromObj(NULL, objv[i], typeStringList, NULL, 0, &index)
!= TCL_ERROR) {
if ((Tcl_GetIndexFromObj(NULL, objv[i + 1], menuTypeStrings, NULL,
0, &index) == TCL_OK) && (index == MENUBAR)) {
toplevel = 0;
}
break;
}
}
windowName = Tcl_GetStringFromObj(objv[1], NULL);
new = Tk_CreateWindowFromPath(interp, tkwin, windowName, toplevel ? ""
: NULL);
if (new == NULL) {
return TCL_ERROR;
}
/*
* Initialize the data structure for the menu.
*/
menuPtr = (TkMenu *) ckalloc(sizeof(TkMenu));
menuPtr->tkwin = new;
menuPtr->display = Tk_Display(new);
menuPtr->interp = interp;
menuPtr->widgetCmd = Tcl_CreateObjCommand(interp,
Tk_PathName(menuPtr->tkwin), MenuWidgetObjCmd,
(ClientData) menuPtr, MenuCmdDeletedProc);
menuPtr->entries = NULL;
menuPtr->numEntries = 0;
menuPtr->active = -1;
menuPtr->borderPtr = NULL;
menuPtr->borderWidthPtr = NULL;
menuPtr->reliefPtr = NULL;
menuPtr->activeBorderPtr = NULL;
menuPtr->activeBorderWidthPtr = NULL;
menuPtr->fontPtr = NULL;
menuPtr->fgPtr = NULL;
menuPtr->disabledFgPtr = NULL;
menuPtr->activeFgPtr = NULL;
menuPtr->indicatorFgPtr = NULL;
menuPtr->tearoffPtr = NULL;
menuPtr->tearoffCommandPtr = NULL;
menuPtr->cursorPtr = None;
menuPtr->takeFocusPtr = NULL;
menuPtr->postCommandPtr = NULL;
menuPtr->postCommandGeneration = 0;
menuPtr->postedCascade = NULL;
menuPtr->nextInstancePtr = NULL;
menuPtr->masterMenuPtr = menuPtr;
menuPtr->menuType = UNKNOWN_TYPE;
menuPtr->menuFlags = 0;
menuPtr->parentTopLevelPtr = NULL;
menuPtr->menuTypePtr = NULL;
menuPtr->titlePtr = NULL;
menuPtr->errorStructPtr = NULL;
menuPtr->optionTablesPtr = optionTablesPtr;
TkMenuInitializeDrawingFields(menuPtr);
Tk_SetClass(menuPtr->tkwin, "Menu");
TkSetClassProcs(menuPtr->tkwin, &menuClass, (ClientData) menuPtr);
if (Tk_InitOptions(interp, (char *) menuPtr,
menuPtr->optionTablesPtr->menuOptionTable, menuPtr->tkwin)
!= TCL_OK) {
Tk_DestroyWindow(menuPtr->tkwin);
ckfree((char *) menuPtr);
return TCL_ERROR;
}
menuRefPtr = TkCreateMenuReferences(menuPtr->interp,
Tk_PathName(menuPtr->tkwin));
menuRefPtr->menuPtr = menuPtr;
menuPtr->menuRefPtr = menuRefPtr;
if (TCL_OK != TkpNewMenu(menuPtr)) {
Tk_DestroyWindow(menuPtr->tkwin);
ckfree((char *) menuPtr);
return TCL_ERROR;
}
Tk_CreateEventHandler(new, ExposureMask|StructureNotifyMask|ActivateMask,
TkMenuEventProc, (ClientData) menuPtr);
if (ConfigureMenu(interp, menuPtr, objc - 2, objv + 2) != TCL_OK) {
Tk_DestroyWindow(menuPtr->tkwin);
return TCL_ERROR;
}
/*
* If a menu has a parent menu pointing to it as a cascade entry, the
* parent menu needs to be told that this menu now exists so that
* the platform-part of the menu is correctly updated.
*
* If a menu has an instance and has cascade entries, then each cascade
* menu must also have a parallel instance. This is especially true on
* the Mac, where each menu has to have a separate title everytime it is in
* a menubar. For instance, say you have a menu .m1 with a cascade entry
* for .m2, where .m2 does not exist yet. You then put .m1 into a menubar.
* This creates a menubar instance for .m1, but since .m2 is not there,
* nothing else happens. When we go to create .m2, we hook it up properly
* with .m1. However, we now need to clone .m2 and assign the clone of .m2
* to be the cascade entry for the clone of .m1. This is special case
* #1 listed in the introductory comment.
*/
if (menuRefPtr->parentEntryPtr != NULL) {
TkMenuEntry *cascadeListPtr = menuRefPtr->parentEntryPtr;
TkMenuEntry *nextCascadePtr;
Tcl_Obj *newMenuName;
Tcl_Obj *newObjv[2];
while (cascadeListPtr != NULL) {
nextCascadePtr = cascadeListPtr->nextCascadePtr;
/*
* If we have a new master menu, and an existing cloned menu
* points to this menu in a cascade entry, we have to clone
* the new menu and point the entry to the clone instead
* of the menu we are creating. Otherwise, ConfigureMenuEntry
* will hook up the platform-specific cascade linkages now
* that the menu we are creating exists.
*/
if ((menuPtr->masterMenuPtr != menuPtr)
|| ((menuPtr->masterMenuPtr == menuPtr)
&& ((cascadeListPtr->menuPtr->masterMenuPtr
== cascadeListPtr->menuPtr)))) {
newObjv[0] = Tcl_NewStringObj("-menu", -1);
newObjv[1] = Tcl_NewStringObj(Tk_PathName(menuPtr->tkwin), -1);
Tcl_IncrRefCount(newObjv[0]);
Tcl_IncrRefCount(newObjv[1]);
ConfigureMenuEntry(cascadeListPtr, 2, newObjv);
Tcl_DecrRefCount(newObjv[0]);
Tcl_DecrRefCount(newObjv[1]);
} else {
Tcl_Obj *normalPtr = Tcl_NewStringObj("normal", -1);
Tcl_Obj *windowNamePtr = Tcl_NewStringObj(
Tk_PathName(cascadeListPtr->menuPtr->tkwin), -1);
Tcl_IncrRefCount(normalPtr);
Tcl_IncrRefCount(windowNamePtr);
newMenuName = TkNewMenuName(menuPtr->interp,
windowNamePtr, menuPtr);
Tcl_IncrRefCount(newMenuName);
CloneMenu(menuPtr, newMenuName, normalPtr);
/*
* Now we can set the new menu instance to be the cascade entry
* of the parent's instance.
*/
newObjv[0] = Tcl_NewStringObj("-menu", -1);
newObjv[1] = newMenuName;
Tcl_IncrRefCount(newObjv[0]);
ConfigureMenuEntry(cascadeListPtr, 2, newObjv);
Tcl_DecrRefCount(normalPtr);
Tcl_DecrRefCount(newObjv[0]);
Tcl_DecrRefCount(newObjv[1]);
Tcl_DecrRefCount(windowNamePtr);
}
cascadeListPtr = nextCascadePtr;
}
}
/*
* If there already exist toplevel widgets that refer to this menu,
* find them and notify them so that they can reconfigure their
* geometry to reflect the menu.
*/
if (menuRefPtr->topLevelListPtr != NULL) {
TkMenuTopLevelList *topLevelListPtr = menuRefPtr->topLevelListPtr;
TkMenuTopLevelList *nextPtr;
Tk_Window listtkwin;
while (topLevelListPtr != NULL) {
/*
* Need to get the next pointer first. TkSetWindowMenuBar
* changes the list, so that the next pointer is different
* after calling it.
*/
nextPtr = topLevelListPtr->nextPtr;
listtkwin = topLevelListPtr->tkwin;
TkSetWindowMenuBar(menuPtr->interp, listtkwin,
Tk_PathName(menuPtr->tkwin), Tk_PathName(menuPtr->tkwin));
topLevelListPtr = nextPtr;
}
}
Tcl_SetResult(interp, Tk_PathName(menuPtr->tkwin), TCL_STATIC);
return TCL_OK;
}
/*
*--------------------------------------------------------------
*
* MenuWidgetObjCmd --
*
* This procedure is invoked to process the Tcl command
* that corresponds to a widget managed by this module.
* See the user documentation for details on what it does.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* See the user documentation.
*
*--------------------------------------------------------------
*/
static int
MenuWidgetObjCmd(clientData, interp, objc, objv)
ClientData clientData; /* Information about menu widget. */
Tcl_Interp *interp; /* Current interpreter. */
int objc; /* Number of arguments. */
Tcl_Obj *CONST objv[]; /* Argument strings. */
{
register TkMenu *menuPtr = (TkMenu *) clientData;
register TkMenuEntry *mePtr;
int result = TCL_OK;
int option;
if (objc < 2) {
Tcl_WrongNumArgs(interp, 1, objv, "option ?arg arg ...?");
return TCL_ERROR;
}
if (Tcl_GetIndexFromObj(interp, objv[1], menuOptions, "option", 0,
&option) != TCL_OK) {
return TCL_ERROR;
}
Tcl_Preserve((ClientData) menuPtr);
switch ((enum options) option) {
case MENU_ACTIVATE: {
int index;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "activate index");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (menuPtr->active == index) {
goto done;
}
if (index >= 0) {
if (menuPtr->entries[index]->type == SEPARATOR_ENTRY) {
int state;
Tcl_GetIndexFromObj(interp,
menuPtr->entries[index]->statePtr,
tkMenuStateStrings, NULL, 0, &state);
if (state == ENTRY_DISABLED) {
index = -1;
}
}
}
result = TkActivateMenuEntry(menuPtr, index);
break;
}
case MENU_ADD:
if (objc < 3) {
Tcl_WrongNumArgs(interp, 1, objv, "add type ?options?");
goto error;
}
if (MenuAddOrInsert(interp, menuPtr, (Tcl_Obj *) NULL,
objc - 2, objv + 2) != TCL_OK) {
goto error;
}
break;
case MENU_CGET: {
Tcl_Obj *resultPtr;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "cget option");
goto error;
}
resultPtr = Tk_GetOptionValue(interp, (char *) menuPtr,
menuPtr->optionTablesPtr->menuOptionTable, objv[2],
menuPtr->tkwin);
if (resultPtr == NULL) {
goto error;
}
Tcl_SetObjResult(interp, resultPtr);
break;
}
case MENU_CLONE:
if ((objc < 3) || (objc > 4)) {
Tcl_WrongNumArgs(interp, 1, objv,
"clone newMenuName ?menuType?");
goto error;
}
result = CloneMenu(menuPtr, objv[2], (objc == 3) ? NULL : objv[3]);
break;
case MENU_CONFIGURE: {
Tcl_Obj *resultPtr;
if (objc == 2) {
resultPtr = Tk_GetOptionInfo(interp, (char *) menuPtr,
menuPtr->optionTablesPtr->menuOptionTable,
(Tcl_Obj *) NULL, menuPtr->tkwin);
if (resultPtr == NULL) {
result = TCL_ERROR;
} else {
result = TCL_OK;
Tcl_SetObjResult(interp, resultPtr);
}
} else if (objc == 3) {
resultPtr = Tk_GetOptionInfo(interp, (char *) menuPtr,
menuPtr->optionTablesPtr->menuOptionTable,
objv[2], menuPtr->tkwin);
if (resultPtr == NULL) {
result = TCL_ERROR;
} else {
result = TCL_OK;
Tcl_SetObjResult(interp, resultPtr);
}
} else {
result = ConfigureMenu(interp, menuPtr, objc - 2, objv + 2);
}
if (result != TCL_OK) {
goto error;
}
break;
}
case MENU_DELETE: {
int first, last, tearoff;
if ((objc != 3) && (objc != 4)) {
Tcl_WrongNumArgs(interp, 1, objv, "delete first ?last?");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &first)
!= TCL_OK) {
goto error;
}
if (objc == 3) {
last = first;
} else {
if (TkGetMenuIndex(interp, menuPtr, objv[3], 0, &last)
!= TCL_OK) {
goto error;
}
}
Tcl_GetBooleanFromObj(interp, menuPtr->tearoffPtr, &tearoff);
if (tearoff && (first == 0)) {
/*
* Sorry, can't delete the tearoff entry; must reconfigure
* the menu.
*/
first = 1;
}
if ((first < 0) || (last < first)) {
goto done;
}
DeleteMenuCloneEntries(menuPtr, first, last);
break;
}
case MENU_ENTRYCGET: {
int index;
Tcl_Obj *resultPtr;
if (objc != 4) {
Tcl_WrongNumArgs(interp, 1, objv, "entrycget index option");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (index < 0) {
goto done;
}
mePtr = menuPtr->entries[index];
Tcl_Preserve((ClientData) mePtr);
resultPtr = Tk_GetOptionValue(interp, (char *) mePtr,
mePtr->optionTable, objv[3], menuPtr->tkwin);
Tcl_Release((ClientData) mePtr);
if (resultPtr == NULL) {
goto error;
}
Tcl_SetObjResult(interp, resultPtr);
break;
}
case MENU_ENTRYCONFIGURE: {
int index;
Tcl_Obj *resultPtr;
if (objc < 3) {
Tcl_WrongNumArgs(interp, 1, objv,
"entryconfigure index ?option value ...?");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (index < 0) {
goto done;
}
mePtr = menuPtr->entries[index];
Tcl_Preserve((ClientData) mePtr);
if (objc == 3) {
resultPtr = Tk_GetOptionInfo(interp, (char *) mePtr,
mePtr->optionTable, (Tcl_Obj *) NULL, menuPtr->tkwin);
if (resultPtr == NULL) {
result = TCL_ERROR;
} else {
result = TCL_OK;
Tcl_SetObjResult(interp, resultPtr);
}
} else if (objc == 4) {
resultPtr = Tk_GetOptionInfo(interp, (char *) mePtr,
mePtr->optionTable, objv[3], menuPtr->tkwin);
if (resultPtr == NULL) {
result = TCL_ERROR;
} else {
result = TCL_OK;
Tcl_SetObjResult(interp, resultPtr);
}
} else {
result = ConfigureMenuCloneEntries(interp, menuPtr, index,
objc - 3, objv + 3);
}
Tcl_Release((ClientData) mePtr);
break;
}
case MENU_INDEX: {
int index;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "index string");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (index < 0) {
Tcl_SetObjResult(interp, Tcl_NewStringObj("none", -1));
} else {
Tcl_SetObjResult(interp, Tcl_NewIntObj(index));
}
break;
}
case MENU_INSERT:
if (objc < 4) {
Tcl_WrongNumArgs(interp, 1, objv,
"insert index type ?options?");
goto error;
}
if (MenuAddOrInsert(interp, menuPtr, objv[2], objc - 3,
objv + 3) != TCL_OK) {
goto error;
}
break;
case MENU_INVOKE: {
int index;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "invoke index");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (index < 0) {
goto done;
}
result = TkInvokeMenu(interp, menuPtr, index);
break;
}
case MENU_POST: {
int x, y;
if (objc != 4) {
Tcl_WrongNumArgs(interp, 1, objv, "post x y");
goto error;
}
if ((Tcl_GetIntFromObj(interp, objv[2], &x) != TCL_OK)
|| (Tcl_GetIntFromObj(interp, objv[3], &y) != TCL_OK)) {
goto error;
}
/*
* Tearoff menus are posted differently on Mac and Windows than
* non-tearoffs. TkpPostMenu does not actually map the menu's
* window on those platforms, and popup menus have to be
* handled specially.
*/
if (menuPtr->menuType != TEAROFF_MENU) {
result = TkpPostMenu(interp, menuPtr, x, y);
} else {
result = TkPostTearoffMenu(interp, menuPtr, x, y);
}
break;
}
case MENU_POSTCASCADE: {
int index;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "postcascade index");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if ((index < 0) || (menuPtr->entries[index]->type
!= CASCADE_ENTRY)) {
result = TkPostSubmenu(interp, menuPtr, (TkMenuEntry *) NULL);
} else {
result = TkPostSubmenu(interp, menuPtr,
menuPtr->entries[index]);
}
break;
}
case MENU_TYPE: {
int index;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "type index");
goto error;
}
if (TkGetMenuIndex(interp, menuPtr, objv[2], 0, &index)
!= TCL_OK) {
goto error;
}
if (index < 0) {
goto done;
}
if (menuPtr->entries[index]->type == TEAROFF_ENTRY) {
Tcl_SetObjResult(interp, Tcl_NewStringObj("tearoff", -1));
} else {
Tcl_SetObjResult(interp, Tcl_NewStringObj(
menuEntryTypeStrings[menuPtr->entries[index]->type],
-1));
}
break;
}
case MENU_UNPOST:
if (objc != 2) {
Tcl_WrongNumArgs(interp, 1, objv, "unpost");
goto error;
}
Tk_UnmapWindow(menuPtr->tkwin);
result = TkPostSubmenu(interp, menuPtr, (TkMenuEntry *) NULL);
break;
case MENU_YPOSITION:
if (objc != 3) {
Tcl_WrongNumArgs(interp, 1, objv, "yposition index");
goto error;
}
result = MenuDoYPosition(interp, menuPtr, objv[2]);
break;
}
done:
Tcl_Release((ClientData) menuPtr);
return result;
error:
Tcl_Release((ClientData) menuPtr);
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* TkInvokeMenu --
*
* Given a menu and an index, takes the appropriate action for the
* entry associated with that index.
*
* Results:
* Standard Tcl result.
*
* Side effects:
* Commands may get excecuted; variables may get set; sub-menus may
* get posted.
*
*----------------------------------------------------------------------
*/
int
TkInvokeMenu(interp, menuPtr, index)
Tcl_Interp *interp; /* The interp that the menu lives in. */
TkMenu *menuPtr; /* The menu we are invoking. */
int index; /* The zero based index of the item we
* are invoking */
{
int result = TCL_OK;
TkMenuEntry *mePtr;
int state;
if (index < 0) {
goto done;
}
mePtr = menuPtr->entries[index];
Tcl_GetIndexFromObj(NULL, mePtr->statePtr, tkMenuStateStrings, NULL, 0,
&state);
if (state == ENTRY_DISABLED) {
goto done;
}
Tcl_Preserve((ClientData) mePtr);
if (mePtr->type == TEAROFF_ENTRY) {
Tcl_Obj *objv[2];
objv[0] = Tcl_NewStringObj("tkTearOffMenu", -1);
Tcl_IncrRefCount(objv[0]);
objv[1] = Tcl_NewStringObj(Tk_PathName(menuPtr->tkwin), -1);
Tcl_IncrRefCount(objv[1]);
result = Tcl_EvalObjv(interp, 2, objv, "", -1, 0);
Tcl_DecrRefCount(objv[0]);
Tcl_DecrRefCount(objv[1]);
} else if ((mePtr->type == CHECK_BUTTON_ENTRY)
&& (mePtr->namePtr != NULL)) {
Tcl_Obj *valuePtr;
char *name;
if (mePtr->entryFlags & ENTRY_SELECTED) {
valuePtr = mePtr->offValuePtr;
} else {
valuePtr = mePtr->onValuePtr;
}
if (valuePtr == NULL) {
valuePtr = Tcl_NewStringObj("", -1);
}
Tcl_IncrRefCount(valuePtr);
name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
if (Tcl_SetObjVar2(interp, name, NULL, valuePtr,
TCL_GLOBAL_ONLY|TCL_LEAVE_ERR_MSG) == NULL) {
result = TCL_ERROR;
}
Tcl_DecrRefCount(valuePtr);
} else if ((mePtr->type == RADIO_BUTTON_ENTRY)
&& (mePtr->namePtr != NULL)) {
Tcl_Obj *valuePtr = mePtr->onValuePtr;
char *name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
if (valuePtr == NULL) {
valuePtr = Tcl_NewStringObj("", -1);
}
Tcl_IncrRefCount(valuePtr);
if (Tcl_SetObjVar2(interp, name, NULL, valuePtr,
TCL_GLOBAL_ONLY|TCL_LEAVE_ERR_MSG) == NULL) {
result = TCL_ERROR;
}
Tcl_DecrRefCount(valuePtr);
}
if ((result == TCL_OK) && (mePtr->commandPtr != NULL)) {
Tcl_Obj *commandPtr = mePtr->commandPtr;
Tcl_IncrRefCount(commandPtr);
result = Tcl_EvalObj(interp, commandPtr, TCL_EVAL_GLOBAL);
Tcl_DecrRefCount(commandPtr);
}
Tcl_Release((ClientData) mePtr);
done:
return result;
}
/*
*----------------------------------------------------------------------
*
* DestroyMenuInstance --
*
* This procedure is invoked by TkDestroyMenu
* to clean up the internal structure of a menu at a safe time
* (when no-one is using it anymore). Only takes care of one instance
* of the menu.
*
* Results:
* None.
*
* Side effects:
* Everything associated with the menu is freed up.
*
*----------------------------------------------------------------------
*/
static void
DestroyMenuInstance(menuPtr)
TkMenu *menuPtr; /* Info about menu widget. */
{
int i;
TkMenu *menuInstancePtr;
TkMenuEntry *cascadePtr, *nextCascadePtr;
Tcl_Obj *newObjv[2];
TkMenu *parentMasterMenuPtr;
TkMenuEntry *parentMasterEntryPtr;
/*
* If the menu has any cascade menu entries pointing to it, the cascade
* entries need to be told that the menu is going away. We need to clear
* the menu ptr field in the menu reference at this point in the code
* so that everything else can forget about this menu properly. We also
* need to reset -menu field of all entries that are not master menus
* back to this entry name if this is a master menu pointed to by another
* master menu. If there is a clone menu that points to this menu,
* then this menu is itself a clone, so when this menu goes away,
* the -menu field of the pointing entry must be set back to this
* menu's master menu name so that later if another menu is created
* the cascade hierarchy can be maintained.
*/
TkpDestroyMenu(menuPtr);
cascadePtr = menuPtr->menuRefPtr->parentEntryPtr;
menuPtr->menuRefPtr->menuPtr = NULL;
TkFreeMenuReferences(menuPtr->menuRefPtr);
for (; cascadePtr != NULL; cascadePtr = nextCascadePtr) {
nextCascadePtr = cascadePtr->nextCascadePtr;
if (menuPtr->masterMenuPtr != menuPtr) {
Tcl_Obj *menuNamePtr = Tcl_NewStringObj("-menu", -1);
parentMasterMenuPtr = cascadePtr->menuPtr->masterMenuPtr;
parentMasterEntryPtr =
parentMasterMenuPtr->entries[cascadePtr->index];
newObjv[0] = menuNamePtr;
newObjv[1] = parentMasterEntryPtr->namePtr;
Tcl_IncrRefCount(newObjv[0]);
Tcl_IncrRefCount(newObjv[1]);
ConfigureMenuEntry(cascadePtr, 2, newObjv);
Tcl_DecrRefCount(newObjv[0]);
Tcl_DecrRefCount(newObjv[1]);
} else {
ConfigureMenuEntry(cascadePtr, 0, (Tcl_Obj **) NULL);
}
}
if (menuPtr->masterMenuPtr != menuPtr) {
for (menuInstancePtr = menuPtr->masterMenuPtr;
menuInstancePtr != NULL;
menuInstancePtr = menuInstancePtr->nextInstancePtr) {
if (menuInstancePtr->nextInstancePtr == menuPtr) {
menuInstancePtr->nextInstancePtr =
menuInstancePtr->nextInstancePtr->nextInstancePtr;
break;
}
}
} else if (menuPtr->nextInstancePtr != NULL) {
panic("Attempting to delete master menu when there are still clones.");
}
/*
* Free up all the stuff that requires special handling, then
* let Tk_FreeConfigurationOptions handle all the standard option-related
* stuff.
*/
for (i = menuPtr->numEntries; --i >= 0; ) {
/*
* As each menu entry is deleted from the end of the array of
* entries, decrement menuPtr->numEntries. Otherwise, the act of
* deleting menu entry i will dereference freed memory attempting
* to queue a redraw for menu entries (i+1)...numEntries.
*/
DestroyMenuEntry((char *) menuPtr->entries[i]);
menuPtr->numEntries = i;
}
if (menuPtr->entries != NULL) {
ckfree((char *) menuPtr->entries);
}
TkMenuFreeDrawOptions(menuPtr);
Tk_FreeConfigOptions((char *) menuPtr,
menuPtr->optionTablesPtr->menuOptionTable, menuPtr->tkwin);
}
/*
*----------------------------------------------------------------------
*
* TkDestroyMenu --
*
* This procedure is invoked by Tcl_EventuallyFree or Tcl_Release
* to clean up the internal structure of a menu at a safe time
* (when no-one is using it anymore). If called on a master instance,
* destroys all of the slave instances. If called on a non-master
* instance, just destroys that instance.
*
* Results:
* None.
*
* Side effects:
* Everything associated with the menu is freed up.
*
*----------------------------------------------------------------------
*/
void
TkDestroyMenu(menuPtr)
TkMenu *menuPtr; /* Info about menu widget. */
{
TkMenu *menuInstancePtr;
TkMenuTopLevelList *topLevelListPtr, *nextTopLevelPtr;
if (menuPtr->menuFlags & MENU_DELETION_PENDING) {
return;
}
/*
* Now destroy all non-tearoff instances of this menu if this is a
* parent menu. Is this loop safe enough? Are there going to be
* destroy bindings on child menus which kill the parent? If not,
* we have to do a slightly more complex scheme.
*/
if (menuPtr->masterMenuPtr == menuPtr) {
menuPtr->menuFlags |= MENU_DELETION_PENDING;
while (menuPtr->nextInstancePtr != NULL) {
menuInstancePtr = menuPtr->nextInstancePtr;
menuPtr->nextInstancePtr = menuInstancePtr->nextInstancePtr;
if (menuInstancePtr->tkwin != NULL) {
Tk_DestroyWindow(menuInstancePtr->tkwin);
}
}
menuPtr->menuFlags &= ~MENU_DELETION_PENDING;
}
/*
* If any toplevel widgets have this menu as their menubar,
* the geometry of the window may have to be recalculated.
*/
topLevelListPtr = menuPtr->menuRefPtr->topLevelListPtr;
while (topLevelListPtr != NULL) {
nextTopLevelPtr = topLevelListPtr->nextPtr;
TkpSetWindowMenuBar(topLevelListPtr->tkwin, NULL);
topLevelListPtr = nextTopLevelPtr;
}
DestroyMenuInstance(menuPtr);
}
/*
*----------------------------------------------------------------------
*
* UnhookCascadeEntry --
*
* This entry is removed from the list of entries that point to the
* cascade menu. This is done in preparation for changing the menu
* that this entry points to.
*
* Results:
* None
*
* Side effects:
* The appropriate lists are modified.
*
*----------------------------------------------------------------------
*/
static void
UnhookCascadeEntry(mePtr)
TkMenuEntry *mePtr; /* The cascade entry we are removing
* from the cascade list. */
{
TkMenuEntry *cascadeEntryPtr;
TkMenuEntry *prevCascadePtr;
TkMenuReferences *menuRefPtr;
menuRefPtr = mePtr->childMenuRefPtr;
if (menuRefPtr == NULL) {
return;
}
cascadeEntryPtr = menuRefPtr->parentEntryPtr;
if (cascadeEntryPtr == NULL) {
return;
}
/*
* Singularly linked list deletion. The two special cases are
* 1. one element; 2. The first element is the one we want.
*/
if (cascadeEntryPtr == mePtr) {
if (cascadeEntryPtr->nextCascadePtr == NULL) {
/*
* This is the last menu entry which points to this
* menu, so we need to clear out the list pointer in the
* cascade itself.
*/
menuRefPtr->parentEntryPtr = NULL;
TkFreeMenuReferences(menuRefPtr);
} else {
menuRefPtr->parentEntryPtr = cascadeEntryPtr->nextCascadePtr;
}
mePtr->nextCascadePtr = NULL;
} else {
for (prevCascadePtr = cascadeEntryPtr,
cascadeEntryPtr = cascadeEntryPtr->nextCascadePtr;
cascadeEntryPtr != NULL;
prevCascadePtr = cascadeEntryPtr,
cascadeEntryPtr = cascadeEntryPtr->nextCascadePtr) {
if (cascadeEntryPtr == mePtr){
prevCascadePtr->nextCascadePtr =
cascadeEntryPtr->nextCascadePtr;
cascadeEntryPtr->nextCascadePtr = NULL;
break;
}
}
}
mePtr->childMenuRefPtr = NULL;
}
/*
*----------------------------------------------------------------------
*
* DestroyMenuEntry --
*
* This procedure is invoked by Tcl_EventuallyFree or Tcl_Release
* to clean up the internal structure of a menu entry at a safe time
* (when no-one is using it anymore).
*
* Results:
* None.
*
* Side effects:
* Everything associated with the menu entry is freed.
*
*----------------------------------------------------------------------
*/
static void
DestroyMenuEntry(memPtr)
char *memPtr; /* Pointer to entry to be freed. */
{
register TkMenuEntry *mePtr = (TkMenuEntry *) memPtr;
TkMenu *menuPtr = mePtr->menuPtr;
if (menuPtr->postedCascade == mePtr) {
/*
* Ignore errors while unposting the menu, since it's possible
* that the menu has already been deleted and the unpost will
* generate an error.
*/
TkPostSubmenu(menuPtr->interp, menuPtr, (TkMenuEntry *) NULL);
}
/*
* Free up all the stuff that requires special handling, then
* let Tk_FreeConfigurationOptions handle all the standard option-related
* stuff.
*/
if (mePtr->type == CASCADE_ENTRY) {
UnhookCascadeEntry(mePtr);
}
if (mePtr->image != NULL) {
Tk_FreeImage(mePtr->image);
}
if (mePtr->selectImage != NULL) {
Tk_FreeImage(mePtr->selectImage);
}
if (((mePtr->type == CHECK_BUTTON_ENTRY)
|| (mePtr->type == RADIO_BUTTON_ENTRY))
&& (mePtr->namePtr != NULL)) {
char *varName = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
Tcl_UntraceVar(menuPtr->interp, varName,
TCL_GLOBAL_ONLY|TCL_TRACE_WRITES|TCL_TRACE_UNSETS,
MenuVarProc, (ClientData) mePtr);
}
TkpDestroyMenuEntry(mePtr);
TkMenuEntryFreeDrawOptions(mePtr);
Tk_FreeConfigOptions((char *) mePtr, mePtr->optionTable, menuPtr->tkwin);
ckfree((char *) mePtr);
}
/*
*---------------------------------------------------------------------------
*
* MenuWorldChanged --
*
* This procedure is called when the world has changed in some
* way (such as the fonts in the system changing) and the widget needs
* to recompute all its graphics contexts and determine its new geometry.
*
* Results:
* None.
*
* Side effects:
* Menu will be relayed out and redisplayed.
*
*---------------------------------------------------------------------------
*/
static void
MenuWorldChanged(instanceData)
ClientData instanceData; /* Information about widget. */
{
TkMenu *menuPtr = (TkMenu *) instanceData;
int i;
TkMenuConfigureDrawOptions(menuPtr);
for (i = 0; i < menuPtr->numEntries; i++) {
TkMenuConfigureEntryDrawOptions(menuPtr->entries[i],
menuPtr->entries[i]->index);
TkpConfigureMenuEntry(menuPtr->entries[i]);
}
}
/*
*----------------------------------------------------------------------
*
* ConfigureMenu --
*
* This procedure is called to process an argv/argc list, plus
* the Tk option database, in order to configure (or
* reconfigure) a menu widget.
*
* Results:
* The return value is a standard Tcl result. If TCL_ERROR is
* returned, then the interp's result contains an error message.
*
* Side effects:
* Configuration information, such as colors, font, etc. get set
* for menuPtr; old resources get freed, if there were any.
*
*----------------------------------------------------------------------
*/
static int
ConfigureMenu(interp, menuPtr, objc, objv)
Tcl_Interp *interp; /* Used for error reporting. */
register TkMenu *menuPtr; /* Information about widget; may or may
* not already have values for some fields. */
int objc; /* Number of valid entries in argv. */
Tcl_Obj *CONST objv[]; /* Arguments. */
{
int i;
TkMenu *menuListPtr, *cleanupPtr;
int result;
int tearoff;
for (menuListPtr = menuPtr->masterMenuPtr; menuListPtr != NULL;
menuListPtr = menuListPtr->nextInstancePtr) {
menuListPtr->errorStructPtr = (Tk_SavedOptions *)
ckalloc(sizeof(Tk_SavedOptions));
result = Tk_SetOptions(interp, (char *) menuListPtr,
menuListPtr->optionTablesPtr->menuOptionTable, objc, objv,
menuListPtr->tkwin, menuListPtr->errorStructPtr, (int *) NULL);
if (result != TCL_OK) {
for (cleanupPtr = menuPtr->masterMenuPtr;
cleanupPtr != menuListPtr;
cleanupPtr = cleanupPtr->nextInstancePtr) {
Tk_RestoreSavedOptions(cleanupPtr->errorStructPtr);
ckfree((char *) cleanupPtr->errorStructPtr);
cleanupPtr->errorStructPtr = NULL;
}
return TCL_ERROR;
}
/*
* When a menu is created, the type is in all of the arguments
* to the menu command. Let Tk_ConfigureWidget take care of
* parsing them, and then set the type after we can look at
* the type string. Once set, a menu's type cannot be changed
*/
if (menuListPtr->menuType == UNKNOWN_TYPE) {
Tcl_GetIndexFromObj(NULL, menuListPtr->menuTypePtr,
menuTypeStrings, NULL, 0, &menuListPtr->menuType);
/*
* Configure the new window to be either a pop-up menu
* or a tear-off menu.
* We don't do this for menubars since they are not toplevel
* windows. Also, since this gets called before CloneMenu has
* a chance to set the menuType field, we have to look at the
* menuTypeName field to tell that this is a menu bar.
*/
if (menuListPtr->menuType == MASTER_MENU) {
TkpMakeMenuWindow(menuListPtr->tkwin, 1);
} else if (menuListPtr->menuType == TEAROFF_MENU) {
TkpMakeMenuWindow(menuListPtr->tkwin, 0);
}
}
/*
* Depending on the -tearOff option, make sure that there is or
* isn't an initial tear-off entry at the beginning of the menu.
*/
Tcl_GetBooleanFromObj(NULL, menuListPtr->tearoffPtr, &tearoff);
if (tearoff) {
if ((menuListPtr->numEntries == 0)
|| (menuListPtr->entries[0]->type != TEAROFF_ENTRY)) {
if (MenuNewEntry(menuListPtr, 0, TEAROFF_ENTRY) == NULL) {
if (menuListPtr->errorStructPtr != NULL) {
for (cleanupPtr = menuPtr->masterMenuPtr;
cleanupPtr != menuListPtr;
cleanupPtr = cleanupPtr->nextInstancePtr) {
Tk_RestoreSavedOptions(cleanupPtr->errorStructPtr);
ckfree((char *) cleanupPtr->errorStructPtr);
cleanupPtr->errorStructPtr = NULL;
}
Tk_RestoreSavedOptions(cleanupPtr->errorStructPtr);
ckfree((char *) cleanupPtr->errorStructPtr);
cleanupPtr->errorStructPtr = NULL;
}
return TCL_ERROR;
}
}
} else if ((menuListPtr->numEntries > 0)
&& (menuListPtr->entries[0]->type == TEAROFF_ENTRY)) {
int i;
Tcl_EventuallyFree((ClientData) menuListPtr->entries[0],
DestroyMenuEntry);
for (i = 0; i < menuListPtr->numEntries - 1; i++) {
menuListPtr->entries[i] = menuListPtr->entries[i + 1];
menuListPtr->entries[i]->index = i;
}
menuListPtr->numEntries--;
if (menuListPtr->numEntries == 0) {
ckfree((char *) menuListPtr->entries);
menuListPtr->entries = NULL;
}
}
TkMenuConfigureDrawOptions(menuListPtr);
/*
* After reconfiguring a menu, we need to reconfigure all of the
* entries in the menu, since some of the things in the children
* (such as graphics contexts) may have to change to reflect changes
* in the parent.
*/
for (i = 0; i < menuListPtr->numEntries; i++) {
TkMenuEntry *mePtr;
mePtr = menuListPtr->entries[i];
ConfigureMenuEntry(mePtr, 0, (Tcl_Obj **) NULL);
}
TkEventuallyRecomputeMenu(menuListPtr);
}
for (cleanupPtr = menuPtr->masterMenuPtr; cleanupPtr != NULL;
cleanupPtr = cleanupPtr->nextInstancePtr) {
Tk_FreeSavedOptions(cleanupPtr->errorStructPtr);
ckfree((char *) cleanupPtr->errorStructPtr);
cleanupPtr->errorStructPtr = NULL;
}
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* PostProcessEntry --
*
* This is called by ConfigureMenuEntry to do all of the configuration
* after Tk_SetOptions is called. This is separate
* so that error handling is easier.
*
* Results:
* The return value is a standard Tcl result. If TCL_ERROR is
* returned, then the interp's result contains an error message.
*
* Side effects:
* Configuration information such as label and accelerator get
* set for mePtr; old resources get freed, if there were any.
*
*----------------------------------------------------------------------
*/
static int
PostProcessEntry(mePtr)
TkMenuEntry *mePtr; /* The entry we are configuring. */
{
TkMenu *menuPtr = mePtr->menuPtr;
int index = mePtr->index;
char *name;
Tk_Image image;
/*
* The code below handles special configuration stuff not taken
* care of by Tk_ConfigureWidget, such as special processing for
* defaults, sizing strings, graphics contexts, etc.
*/
if (mePtr->labelPtr == NULL) {
mePtr->labelLength = 0;
} else {
Tcl_GetStringFromObj(mePtr->labelPtr, &mePtr->labelLength);
}
if (mePtr->accelPtr == NULL) {
mePtr->accelLength = 0;
} else {
Tcl_GetStringFromObj(mePtr->accelPtr, &mePtr->accelLength);
}
/*
* If this is a cascade entry, the platform-specific data of the child
* menu has to be updated. Also, the links that point to parents and
* cascades have to be updated.
*/
if ((mePtr->type == CASCADE_ENTRY) && (mePtr->namePtr != NULL)) {
TkMenuEntry *cascadeEntryPtr;
int alreadyThere;
TkMenuReferences *menuRefPtr;
char *oldHashKey = NULL; /* Initialization only needed to
* prevent compiler warning. */
/*
* This is a cascade entry. If the menu that the cascade entry
* is pointing to has changed, we need to remove this entry
* from the list of entries pointing to the old menu, and add a
* cascade reference to the list of entries pointing to the
* new menu.
*
* BUG: We are not recloning for special case #3 yet.
*/
name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
if (mePtr->childMenuRefPtr != NULL) {
oldHashKey = Tcl_GetHashKey(TkGetMenuHashTable(menuPtr->interp),
mePtr->childMenuRefPtr->hashEntryPtr);
if (strcmp(oldHashKey, name) != 0) {
UnhookCascadeEntry(mePtr);
}
}
if ((mePtr->childMenuRefPtr == NULL)
|| (strcmp(oldHashKey, name) != 0)) {
menuRefPtr = TkCreateMenuReferences(menuPtr->interp, name);
mePtr->childMenuRefPtr = menuRefPtr;
if (menuRefPtr->parentEntryPtr == NULL) {
menuRefPtr->parentEntryPtr = mePtr;
} else {
alreadyThere = 0;
for (cascadeEntryPtr = menuRefPtr->parentEntryPtr;
cascadeEntryPtr != NULL;
cascadeEntryPtr =
cascadeEntryPtr->nextCascadePtr) {
if (cascadeEntryPtr == mePtr) {
alreadyThere = 1;
break;
}
}
/*
* Put the item at the front of the list.
*/
if (!alreadyThere) {
mePtr->nextCascadePtr = menuRefPtr->parentEntryPtr;
menuRefPtr->parentEntryPtr = mePtr;
}
}
}
}
if (TkMenuConfigureEntryDrawOptions(mePtr, index) != TCL_OK) {
return TCL_ERROR;
}
if (TkpConfigureMenuEntry(mePtr) != TCL_OK) {
return TCL_ERROR;
}
/*
* Get the images for the entry, if there are any. Allocate the
* new images before freeing the old ones, so that the reference
* counts don't go to zero and cause image data to be discarded.
*/
if (mePtr->imagePtr != NULL) {
char *imageString = Tcl_GetStringFromObj(mePtr->imagePtr, NULL);
image = Tk_GetImage(menuPtr->interp, menuPtr->tkwin, imageString,
TkMenuImageProc, (ClientData) mePtr);
if (image == NULL) {
return TCL_ERROR;
}
} else {
image = NULL;
}
if (mePtr->image != NULL) {
Tk_FreeImage(mePtr->image);
}
mePtr->image = image;
if (mePtr->selectImagePtr != NULL) {
char *selectImageString = Tcl_GetStringFromObj(
mePtr->selectImagePtr, NULL);
image = Tk_GetImage(menuPtr->interp, menuPtr->tkwin, selectImageString,
TkMenuSelectImageProc, (ClientData) mePtr);
if (image == NULL) {
return TCL_ERROR;
}
} else {
image = NULL;
}
if (mePtr->selectImage != NULL) {
Tk_FreeImage(mePtr->selectImage);
}
mePtr->selectImage = image;
if ((mePtr->type == CHECK_BUTTON_ENTRY)
|| (mePtr->type == RADIO_BUTTON_ENTRY)) {
Tcl_Obj *valuePtr;
char *name;
if (mePtr->namePtr == NULL) {
if (mePtr->labelPtr == NULL) {
mePtr->namePtr = NULL;
} else {
mePtr->namePtr = Tcl_DuplicateObj(mePtr->labelPtr);
Tcl_IncrRefCount(mePtr->namePtr);
}
}
if (mePtr->onValuePtr == NULL) {
if (mePtr->labelPtr == NULL) {
mePtr->onValuePtr = NULL;
} else {
mePtr->onValuePtr = Tcl_DuplicateObj(mePtr->labelPtr);
Tcl_IncrRefCount(mePtr->onValuePtr);
}
}
/*
* Select the entry if the associated variable has the
* appropriate value, initialize the variable if it doesn't
* exist, then set a trace on the variable to monitor future
* changes to its value.
*/
if (mePtr->namePtr != NULL) {
char *name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
valuePtr = Tcl_GetObjVar2(menuPtr->interp, name, NULL,
TCL_GLOBAL_ONLY);
} else {
valuePtr = NULL;
}
mePtr->entryFlags &= ~ENTRY_SELECTED;
if (valuePtr != NULL) {
if (mePtr->onValuePtr != NULL) {
char *value = Tcl_GetStringFromObj(valuePtr, NULL);
char *onValue = Tcl_GetStringFromObj(mePtr->onValuePtr,
NULL);
if (strcmp(value, onValue) == 0) {
mePtr->entryFlags |= ENTRY_SELECTED;
}
}
} else {
if (mePtr->namePtr != NULL) {
char *name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
Tcl_SetObjVar2(menuPtr->interp, name, NULL,
(mePtr->type == CHECK_BUTTON_ENTRY)
? mePtr->offValuePtr :
Tcl_NewStringObj("", 0),
TCL_GLOBAL_ONLY);
}
}
if (mePtr->namePtr != NULL) {
name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
Tcl_TraceVar(menuPtr->interp, name,
TCL_GLOBAL_ONLY|TCL_TRACE_WRITES|TCL_TRACE_UNSETS,
MenuVarProc, (ClientData) mePtr);
}
}
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* ConfigureMenuEntry --
*
* This procedure is called to process an argv/argc list in order
* to configure (or reconfigure) one entry in a menu.
*
* Results:
* The return value is a standard Tcl result. If TCL_ERROR is
* returned, then the interp's result contains an error message.
*
* Side effects:
* Configuration information such as label and accelerator get
* set for mePtr; old resources get freed, if there were any.
*
*----------------------------------------------------------------------
*/
static int
ConfigureMenuEntry(mePtr, objc, objv)
register TkMenuEntry *mePtr; /* Information about menu entry; may
* or may not already have values for
* some fields. */
int objc; /* Number of valid entries in argv. */
Tcl_Obj *CONST objv[]; /* Arguments. */
{
TkMenu *menuPtr = mePtr->menuPtr;
Tk_SavedOptions errorStruct;
int result;
/*
* If this entry is a check button or radio button, then remove
* its old trace procedure.
*/
if ((mePtr->namePtr != NULL)
&& ((mePtr->type == CHECK_BUTTON_ENTRY)
|| (mePtr->type == RADIO_BUTTON_ENTRY))) {
char *name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
Tcl_UntraceVar(menuPtr->interp, name,
TCL_GLOBAL_ONLY|TCL_TRACE_WRITES|TCL_TRACE_UNSETS,
MenuVarProc, (ClientData) mePtr);
}
result = TCL_OK;
if (menuPtr->tkwin != NULL) {
if (Tk_SetOptions(menuPtr->interp, (char *) mePtr,
mePtr->optionTable, objc, objv, menuPtr->tkwin,
&errorStruct, (int *) NULL) != TCL_OK) {
return TCL_ERROR;
}
result = PostProcessEntry(mePtr);
if (result != TCL_OK) {
Tk_RestoreSavedOptions(&errorStruct);
PostProcessEntry(mePtr);
}
Tk_FreeSavedOptions(&errorStruct);
}
TkEventuallyRecomputeMenu(menuPtr);
return result;
}
/*
*----------------------------------------------------------------------
*
* ConfigureMenuCloneEntries --
*
* Calls ConfigureMenuEntry for each menu in the clone chain.
*
* Results:
* The return value is a standard Tcl result. If TCL_ERROR is
* returned, then the interp's result contains an error message.
*
* Side effects:
* Configuration information such as label and accelerator get
* set for mePtr; old resources get freed, if there were any.
*
*----------------------------------------------------------------------
*/
static int
ConfigureMenuCloneEntries(interp, menuPtr, index, objc, objv)
Tcl_Interp *interp; /* Used for error reporting. */
TkMenu *menuPtr; /* Information about whole menu. */
int index; /* Index of mePtr within menuPtr's
* entries. */
int objc; /* Number of valid entries in argv. */
Tcl_Obj *CONST objv[]; /* Arguments. */
{
TkMenuEntry *mePtr;
TkMenu *menuListPtr;
int cascadeEntryChanged = 0;
TkMenuReferences *oldCascadeMenuRefPtr, *cascadeMenuRefPtr = NULL;
Tcl_Obj *oldCascadePtr = NULL;
char *newCascadeName;
/*
* Cascades are kind of tricky here. This is special case #3 in the comment
* at the top of this file. Basically, if a menu is the master menu of a
* clone chain, and has an entry with a cascade menu, the clones of
* the menu will point to clones of the cascade menu. We have
* to destroy the clones of the cascades, clone the new cascade
* menu, and configure the entry to point to the new clone.
*/
mePtr = menuPtr->masterMenuPtr->entries[index];
if (mePtr->type == CASCADE_ENTRY) {
oldCascadePtr = mePtr->namePtr;
if (oldCascadePtr != NULL) {
Tcl_IncrRefCount(oldCascadePtr);
}
}
if (ConfigureMenuEntry(mePtr, objc, objv) != TCL_OK) {
return TCL_ERROR;
}
if (mePtr->type == CASCADE_ENTRY) {
char *oldCascadeName;
if (mePtr->namePtr != NULL) {
newCascadeName = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
} else {
newCascadeName = NULL;
}
if ((oldCascadePtr == NULL) && (mePtr->namePtr == NULL)) {
cascadeEntryChanged = 0;
} else if (((oldCascadePtr == NULL) && (mePtr->namePtr != NULL))
|| ((oldCascadePtr != NULL)
&& (mePtr->namePtr == NULL))) {
cascadeEntryChanged = 1;
} else {
oldCascadeName = Tcl_GetStringFromObj(oldCascadePtr,
NULL);
cascadeEntryChanged = (strcmp(oldCascadeName, newCascadeName)
== 0);
}
if (oldCascadePtr != NULL) {
Tcl_DecrRefCount(oldCascadePtr);
}
}
if (cascadeEntryChanged) {
if (mePtr->namePtr != NULL) {
newCascadeName = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
cascadeMenuRefPtr = TkFindMenuReferences(menuPtr->interp,
newCascadeName);
}
}
for (menuListPtr = menuPtr->masterMenuPtr->nextInstancePtr;
menuListPtr != NULL;
menuListPtr = menuListPtr->nextInstancePtr) {
mePtr = menuListPtr->entries[index];
if (cascadeEntryChanged && (mePtr->namePtr != NULL)) {
oldCascadeMenuRefPtr = TkFindMenuReferencesObj(menuPtr->interp,
mePtr->namePtr);
if ((oldCascadeMenuRefPtr != NULL)
&& (oldCascadeMenuRefPtr->menuPtr != NULL)) {
RecursivelyDeleteMenu(oldCascadeMenuRefPtr->menuPtr);
}
}
if (ConfigureMenuEntry(mePtr, objc, objv) != TCL_OK) {
return TCL_ERROR;
}
if (cascadeEntryChanged && (mePtr->namePtr != NULL)) {
if (cascadeMenuRefPtr->menuPtr != NULL) {
Tcl_Obj *newObjv[2];
Tcl_Obj *newCloneNamePtr;
Tcl_Obj *pathNamePtr = Tcl_NewStringObj(
Tk_PathName(menuListPtr->tkwin), -1);
Tcl_Obj *normalPtr = Tcl_NewStringObj("normal", -1);
Tcl_Obj *menuObjPtr = Tcl_NewStringObj("menu", -1);
Tcl_IncrRefCount(pathNamePtr);
newCloneNamePtr = TkNewMenuName(menuPtr->interp,
pathNamePtr,
cascadeMenuRefPtr->menuPtr);
Tcl_IncrRefCount(newCloneNamePtr);
Tcl_IncrRefCount(normalPtr);
CloneMenu(cascadeMenuRefPtr->menuPtr, newCloneNamePtr,
normalPtr);
newObjv[0] = menuObjPtr;
newObjv[1] = newCloneNamePtr;
Tcl_IncrRefCount(menuObjPtr);
ConfigureMenuEntry(mePtr, 2, newObjv);
Tcl_DecrRefCount(newCloneNamePtr);
Tcl_DecrRefCount(pathNamePtr);
Tcl_DecrRefCount(normalPtr);
Tcl_DecrRefCount(menuObjPtr);
}
}
}
return TCL_OK;
}
/*
*--------------------------------------------------------------
*
* TkGetMenuIndex --
*
* Parse a textual index into a menu and return the numerical
* index of the indicated entry.
*
* Results:
* A standard Tcl result. If all went well, then *indexPtr is
* filled in with the entry index corresponding to string
* (ranges from -1 to the number of entries in the menu minus
* one). Otherwise an error message is left in the interp's result.
*
* Side effects:
* None.
*
*--------------------------------------------------------------
*/
int
TkGetMenuIndex(interp, menuPtr, objPtr, lastOK, indexPtr)
Tcl_Interp *interp; /* For error messages. */
TkMenu *menuPtr; /* Menu for which the index is being
* specified. */
Tcl_Obj *objPtr; /* Specification of an entry in menu. See
* manual entry for valid .*/
int lastOK; /* Non-zero means its OK to return index
* just *after* last entry. */
int *indexPtr; /* Where to store converted index. */
{
int i;
char *string = Tcl_GetStringFromObj(objPtr, NULL);
if ((string[0] == 'a') && (strcmp(string, "active") == 0)) {
*indexPtr = menuPtr->active;
goto success;
}
if (((string[0] == 'l') && (strcmp(string, "last") == 0))
|| ((string[0] == 'e') && (strcmp(string, "end") == 0))) {
*indexPtr = menuPtr->numEntries - ((lastOK) ? 0 : 1);
goto success;
}
if ((string[0] == 'n') && (strcmp(string, "none") == 0)) {
*indexPtr = -1;
goto success;
}
if (string[0] == '@') {
if (GetIndexFromCoords(interp, menuPtr, string, indexPtr)
== TCL_OK) {
goto success;
}
}
if (isdigit(UCHAR(string[0]))) {
if (Tcl_GetInt(interp, string, &i) == TCL_OK) {
if (i >= menuPtr->numEntries) {
if (lastOK) {
i = menuPtr->numEntries;
} else {
i = menuPtr->numEntries-1;
}
} else if (i < 0) {
i = -1;
}
*indexPtr = i;
goto success;
}
Tcl_SetResult(interp, (char *) NULL, TCL_STATIC);
}
for (i = 0; i < menuPtr->numEntries; i++) {
Tcl_Obj *labelPtr = menuPtr->entries[i]->labelPtr;
char *label = (labelPtr == NULL) ? NULL
: Tcl_GetStringFromObj(labelPtr, NULL);
if ((label != NULL)
&& (Tcl_StringMatch(label, string))) {
*indexPtr = i;
goto success;
}
}
Tcl_AppendResult(interp, "bad menu entry index \"",
string, "\"", (char *) NULL);
return TCL_ERROR;
success:
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* MenuCmdDeletedProc --
*
* This procedure is invoked when a widget command is deleted. If
* the widget isn't already in the process of being destroyed,
* this command destroys it.
*
* Results:
* None.
*
* Side effects:
* The widget is destroyed.
*
*----------------------------------------------------------------------
*/
static void
MenuCmdDeletedProc(clientData)
ClientData clientData; /* Pointer to widget record for widget. */
{
TkMenu *menuPtr = (TkMenu *) clientData;
Tk_Window tkwin = menuPtr->tkwin;
/*
* This procedure could be invoked either because the window was
* destroyed and the command was then deleted (in which case tkwin
* is NULL) or because the command was deleted, and then this procedure
* destroys the widget.
*/
if (tkwin != NULL) {
Tk_DestroyWindow(tkwin);
}
}
/*
*----------------------------------------------------------------------
*
* MenuNewEntry --
*
* This procedure allocates and initializes a new menu entry.
*
* Results:
* The return value is a pointer to a new menu entry structure,
* which has been malloc-ed, initialized, and entered into the
* entry array for the menu.
*
* Side effects:
* Storage gets allocated.
*
*----------------------------------------------------------------------
*/
static TkMenuEntry *
MenuNewEntry(menuPtr, index, type)
TkMenu *menuPtr; /* Menu that will hold the new entry. */
int index; /* Where in the menu the new entry is to
* go. */
int type; /* The type of the new entry. */
{
TkMenuEntry *mePtr;
TkMenuEntry **newEntries;
int i;
/*
* Create a new array of entries with an empty slot for the
* new entry.
*/
newEntries = (TkMenuEntry **) ckalloc((unsigned)
((menuPtr->numEntries+1)*sizeof(TkMenuEntry *)));
for (i = 0; i < index; i++) {
newEntries[i] = menuPtr->entries[i];
}
for ( ; i < menuPtr->numEntries; i++) {
newEntries[i+1] = menuPtr->entries[i];
newEntries[i+1]->index = i + 1;
}
if (menuPtr->numEntries != 0) {
ckfree((char *) menuPtr->entries);
}
menuPtr->entries = newEntries;
menuPtr->numEntries++;
mePtr = (TkMenuEntry *) ckalloc(sizeof(TkMenuEntry));
menuPtr->entries[index] = mePtr;
mePtr->type = type;
mePtr->optionTable = menuPtr->optionTablesPtr->entryOptionTables[type];
mePtr->menuPtr = menuPtr;
mePtr->labelPtr = NULL;
mePtr->labelLength = 0;
mePtr->underline = -1;
mePtr->bitmapPtr = NULL;
mePtr->imagePtr = NULL;
mePtr->image = NULL;
mePtr->selectImagePtr = NULL;
mePtr->selectImage = NULL;
mePtr->accelPtr = NULL;
mePtr->accelLength = 0;
mePtr->statePtr = Tcl_NewStringObj("disabled", -1);
Tcl_IncrRefCount(mePtr->statePtr);
mePtr->borderPtr = NULL;
mePtr->fgPtr = NULL;
mePtr->activeBorderPtr = NULL;
mePtr->activeFgPtr = NULL;
mePtr->fontPtr = NULL;
mePtr->indicatorOnPtr = Tcl_NewBooleanObj(1);
Tcl_IncrRefCount(mePtr->indicatorOnPtr);
mePtr->indicatorFgPtr = NULL;
mePtr->columnBreakPtr = Tcl_NewBooleanObj(0);
Tcl_IncrRefCount(mePtr->columnBreakPtr);
mePtr->hideMarginPtr = Tcl_NewBooleanObj(0);
Tcl_IncrRefCount(mePtr->hideMarginPtr);
mePtr->commandPtr = NULL;
mePtr->namePtr = NULL;
mePtr->childMenuRefPtr = NULL;
mePtr->onValuePtr = NULL;
mePtr->offValuePtr = NULL;
mePtr->entryFlags = 0;
mePtr->index = index;
mePtr->nextCascadePtr = NULL;
if (Tk_InitOptions(menuPtr->interp, (char *) mePtr,
mePtr->optionTable, menuPtr->tkwin) != TCL_OK) {
ckfree((char *) mePtr);
return NULL;
}
TkMenuInitializeEntryDrawingFields(mePtr);
if (TkpMenuNewEntry(mePtr) != TCL_OK) {
Tk_FreeConfigOptions((char *) mePtr, mePtr->optionTable,
menuPtr->tkwin);
ckfree((char *) mePtr);
return NULL;
}
return mePtr;
}
/*
*----------------------------------------------------------------------
*
* MenuAddOrInsert --
*
* This procedure does all of the work of the "add" and "insert"
* widget commands, allowing the code for these to be shared.
*
* Results:
* A standard Tcl return value.
*
* Side effects:
* A new menu entry is created in menuPtr.
*
*----------------------------------------------------------------------
*/
static int
MenuAddOrInsert(interp, menuPtr, indexPtr, objc, objv)
Tcl_Interp *interp; /* Used for error reporting. */
TkMenu *menuPtr; /* Widget in which to create new
* entry. */
Tcl_Obj *indexPtr; /* Object describing index at which
* to insert. NULL means insert at
* end. */
int objc; /* Number of elements in objv. */
Tcl_Obj *CONST objv[]; /* Arguments to command: first arg
* is type of entry, others are
* config options. */
{
int type, index;
TkMenuEntry *mePtr;
TkMenu *menuListPtr;
int tearoff;
if (indexPtr != NULL) {
if (TkGetMenuIndex(interp, menuPtr, indexPtr, 1, &index)
!= TCL_OK) {
return TCL_ERROR;
}
} else {
index = menuPtr->numEntries;
}
if (index < 0) {
char *indexString = Tcl_GetStringFromObj(indexPtr, NULL);
Tcl_AppendResult(interp, "bad index \"", indexString, "\"",
(char *) NULL);
return TCL_ERROR;
}
Tcl_GetBooleanFromObj(NULL, menuPtr->tearoffPtr, &tearoff);
if (tearoff && (index == 0)) {
index = 1;
}
/*
* Figure out the type of the new entry.
*/
if (Tcl_GetIndexFromObj(interp, objv[0], menuEntryTypeStrings,
"menu entry type", 0, &type) != TCL_OK) {
return TCL_ERROR;
}
/*
* Now we have to add an entry for every instance related to this menu.
*/
for (menuListPtr = menuPtr->masterMenuPtr; menuListPtr != NULL;
menuListPtr = menuListPtr->nextInstancePtr) {
mePtr = MenuNewEntry(menuListPtr, index, type);
if (mePtr == NULL) {
return TCL_ERROR;
}
if (ConfigureMenuEntry(mePtr, objc - 1, objv + 1) != TCL_OK) {
TkMenu *errorMenuPtr;
int i;
for (errorMenuPtr = menuPtr->masterMenuPtr;
errorMenuPtr != NULL;
errorMenuPtr = errorMenuPtr->nextInstancePtr) {
Tcl_EventuallyFree((ClientData) errorMenuPtr->entries[index],
DestroyMenuEntry);
for (i = index; i < errorMenuPtr->numEntries - 1; i++) {
errorMenuPtr->entries[i] = errorMenuPtr->entries[i + 1];
errorMenuPtr->entries[i]->index = i;
}
errorMenuPtr->numEntries--;
if (errorMenuPtr->numEntries == 0) {
ckfree((char *) errorMenuPtr->entries);
errorMenuPtr->entries = NULL;
}
if (errorMenuPtr == menuListPtr) {
break;
}
}
return TCL_ERROR;
}
/*
* If a menu has cascades, then every instance of the menu has
* to have its own parallel cascade structure. So adding an
* entry to a menu with clones means that the menu that the
* entry points to has to be cloned for every clone the
* master menu has. This is special case #2 in the comment
* at the top of this file.
*/
if ((menuPtr != menuListPtr) && (type == CASCADE_ENTRY)) {
if ((mePtr->namePtr != NULL)
&& (mePtr->childMenuRefPtr != NULL)
&& (mePtr->childMenuRefPtr->menuPtr != NULL)) {
TkMenu *cascadeMenuPtr =
mePtr->childMenuRefPtr->menuPtr->masterMenuPtr;
Tcl_Obj *newCascadePtr;
Tcl_Obj *menuNamePtr = Tcl_NewStringObj("-menu", -1);
Tcl_Obj *windowNamePtr =
Tcl_NewStringObj(Tk_PathName(menuListPtr->tkwin), -1);
Tcl_Obj *normalPtr = Tcl_NewStringObj("normal", -1);
Tcl_Obj *newObjv[2];
TkMenuReferences *menuRefPtr;
Tcl_IncrRefCount(windowNamePtr);
newCascadePtr = TkNewMenuName(menuListPtr->interp,
windowNamePtr, cascadeMenuPtr);
Tcl_IncrRefCount(newCascadePtr);
Tcl_IncrRefCount(normalPtr);
CloneMenu(cascadeMenuPtr, newCascadePtr, normalPtr);
menuRefPtr = TkFindMenuReferencesObj(menuListPtr->interp,
newCascadePtr);
if (menuRefPtr == NULL) {
panic("CloneMenu failed inside of MenuAddOrInsert.");
}
newObjv[0] = menuNamePtr;
newObjv[1] = newCascadePtr;
Tcl_IncrRefCount(menuNamePtr);
Tcl_IncrRefCount(newCascadePtr);
ConfigureMenuEntry(mePtr, 2, newObjv);
Tcl_DecrRefCount(newCascadePtr);
Tcl_DecrRefCount(menuNamePtr);
Tcl_DecrRefCount(windowNamePtr);
Tcl_DecrRefCount(normalPtr);
}
}
}
return TCL_OK;
}
/*
*--------------------------------------------------------------
*
* MenuVarProc --
*
* This procedure is invoked when someone changes the
* state variable associated with a radiobutton or checkbutton
* menu entry. The entry's selected state is set to match
* the value of the variable.
*
* Results:
* NULL is always returned.
*
* Side effects:
* The menu entry may become selected or deselected.
*
*--------------------------------------------------------------
*/
static char *
MenuVarProc(clientData, interp, name1, name2, flags)
ClientData clientData; /* Information about menu entry. */
Tcl_Interp *interp; /* Interpreter containing variable. */
char *name1; /* First part of variable's name. */
char *name2; /* Second part of variable's name. */
int flags; /* Describes what just happened. */
{
TkMenuEntry *mePtr = (TkMenuEntry *) clientData;
TkMenu *menuPtr;
char *value;
char *name = Tcl_GetStringFromObj(mePtr->namePtr, NULL);
char *onValue;
menuPtr = mePtr->menuPtr;
/*
* If the variable is being unset, then re-establish the
* trace unless the whole interpreter is going away.
*/
if (flags & TCL_TRACE_UNSETS) {
mePtr->entryFlags &= ~ENTRY_SELECTED;
if ((flags & TCL_TRACE_DESTROYED) && !(flags & TCL_INTERP_DESTROYED)) {
Tcl_TraceVar(interp, name,
TCL_GLOBAL_ONLY|TCL_TRACE_WRITES|TCL_TRACE_UNSETS,
MenuVarProc, clientData);
}
TkpConfigureMenuEntry(mePtr);
TkEventuallyRedrawMenu(menuPtr, (TkMenuEntry *) NULL);
return (char *) NULL;
}
/*
* Use the value of the variable to update the selected status of
* the menu entry.
*/
value = Tcl_GetVar(interp, name, TCL_GLOBAL_ONLY);
if (value == NULL) {
value = "";
}
if (mePtr->onValuePtr != NULL) {
onValue = Tcl_GetStringFromObj(mePtr->onValuePtr, NULL);
if (strcmp(value, onValue) == 0) {
if (mePtr->entryFlags & ENTRY_SELECTED) {
return (char *) NULL;
}
mePtr->entryFlags |= ENTRY_SELECTED;
} else if (mePtr->entryFlags & ENTRY_SELECTED) {
mePtr->entryFlags &= ~ENTRY_SELECTED;
} else {
return (char *) NULL;
}
} else {
return (char *) NULL;
}
TkpConfigureMenuEntry(mePtr);
TkEventuallyRedrawMenu(menuPtr, mePtr);
return (char *) NULL;
}
/*
*----------------------------------------------------------------------
*
* TkActivateMenuEntry --
*
* This procedure is invoked to make a particular menu entry
* the active one, deactivating any other entry that might
* currently be active.
*
* Results:
* The return value is a standard Tcl result (errors can occur
* while posting and unposting submenus).
*
* Side effects:
* Menu entries get redisplayed, and the active entry changes.
* Submenus may get posted and unposted.
*
*----------------------------------------------------------------------
*/
int
TkActivateMenuEntry(menuPtr, index)
register TkMenu *menuPtr; /* Menu in which to activate. */
int index; /* Index of entry to activate, or
* -1 to deactivate all entries. */
{
register TkMenuEntry *mePtr;
int result = TCL_OK;
int state;
if (menuPtr->active >= 0) {
mePtr = menuPtr->entries[menuPtr->active];
/*
* Don't change the state unless it's currently active (state
* might already have been changed to disabled).
*/
Tcl_GetIndexFromObj(NULL, mePtr->statePtr, tkMenuStateStrings,
NULL, 0, &state);
if (state == ENTRY_ACTIVE) {
Tcl_DecrRefCount(mePtr->statePtr);
mePtr->statePtr = Tcl_NewStringObj("normal", -1);
Tcl_IncrRefCount(mePtr->statePtr);
}
TkEventuallyRedrawMenu(menuPtr, menuPtr->entries[menuPtr->active]);
}
menuPtr->active = index;
if (index >= 0) {
mePtr = menuPtr->entries[index];
Tcl_DecrRefCount(mePtr->statePtr);
mePtr->statePtr = Tcl_NewStringObj("active", -1);
Tcl_IncrRefCount(mePtr->statePtr);
TkEventuallyRedrawMenu(menuPtr, mePtr);
}
return result;
}
/*
*----------------------------------------------------------------------
*
* TkPostCommand --
*
* Execute the postcommand for the given menu.
*
* Results:
* The return value is a standard Tcl result (errors can occur
* while the postcommands are being processed).
*
* Side effects:
* Since commands can get executed while this routine is being executed,
* the entire world can change.
*
*----------------------------------------------------------------------
*/
int
TkPostCommand(menuPtr)
TkMenu *menuPtr;
{
int result;
/*
* If there is a command for the menu, execute it. This
* may change the size of the menu, so be sure to recompute
* the menu's geometry if needed.
*/
if (menuPtr->postCommandPtr != NULL) {
Tcl_Obj *postCommandPtr = menuPtr->postCommandPtr;
Tcl_IncrRefCount(postCommandPtr);
result = Tcl_EvalObj(menuPtr->interp, postCommandPtr,
TCL_EVAL_GLOBAL);
Tcl_DecrRefCount(postCommandPtr);
if (result != TCL_OK) {
return result;
}
TkRecomputeMenu(menuPtr);
}
return TCL_OK;
}
/*
*--------------------------------------------------------------
*
* CloneMenu --
*
* Creates a child copy of the menu. It will be inserted into
* the menu's instance chain. All attributes and entry
* attributes will be duplicated.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* Allocates storage. After the menu is created, any
* configuration done with this menu or any related one
* will be reflected in all of them.
*
*--------------------------------------------------------------
*/
static int
CloneMenu(menuPtr, newMenuNamePtr, newMenuTypePtr)
TkMenu *menuPtr; /* The menu we are going to clone */
Tcl_Obj *newMenuNamePtr; /* The name to give the new menu */
Tcl_Obj *newMenuTypePtr; /* What kind of menu is this, a normal menu
* a menubar, or a tearoff? */
{
int returnResult;
int menuType, i;
TkMenuReferences *menuRefPtr;
Tcl_Obj *menuDupCommandArray[4];
if (newMenuTypePtr == NULL) {
menuType = MASTER_MENU;
} else {
if (Tcl_GetIndexFromObj(menuPtr->interp, newMenuTypePtr,
menuTypeStrings, "menu type", 0, &menuType) != TCL_OK) {
return TCL_ERROR;
}
}
menuDupCommandArray[0] = Tcl_NewStringObj("tkMenuDup", -1);
menuDupCommandArray[1] = Tcl_NewStringObj(Tk_PathName(menuPtr->tkwin), -1);
menuDupCommandArray[2] = newMenuNamePtr;
if (newMenuTypePtr == NULL) {
menuDupCommandArray[3] = Tcl_NewStringObj("normal", -1);
} else {
menuDupCommandArray[3] = newMenuTypePtr;
}
for (i = 0; i < 4; i++) {
Tcl_IncrRefCount(menuDupCommandArray[i]);
}
Tcl_Preserve((ClientData) menuPtr);
returnResult = Tcl_EvalObjv(menuPtr->interp, 4, menuDupCommandArray, "",
-1, 0);
for (i = 0; i < 4; i++) {
Tcl_DecrRefCount(menuDupCommandArray[i]);
}
/*
* Make sure the tcl command actually created the clone.
*/
if ((returnResult == TCL_OK) &&
((menuRefPtr = TkFindMenuReferencesObj(menuPtr->interp,
newMenuNamePtr)) != (TkMenuReferences *) NULL)
&& (menuPtr->numEntries == menuRefPtr->menuPtr->numEntries)) {
TkMenu *newMenuPtr = menuRefPtr->menuPtr;
Tcl_Obj *newObjv[3];
char *newArgv[3];
int i, numElements;
/*
* Now put this newly created menu into the parent menu's instance
* chain.
*/
if (menuPtr->nextInstancePtr == NULL) {
menuPtr->nextInstancePtr = newMenuPtr;
newMenuPtr->masterMenuPtr = menuPtr->masterMenuPtr;
} else {
TkMenu *masterMenuPtr;
masterMenuPtr = menuPtr->masterMenuPtr;
newMenuPtr->nextInstancePtr = masterMenuPtr->nextInstancePtr;
masterMenuPtr->nextInstancePtr = newMenuPtr;
newMenuPtr->masterMenuPtr = masterMenuPtr;
}
/*
* Add the master menu's window to the bind tags for this window
* after this window's tag. This is so the user can bind to either
* this clone (which may not be easy to do) or the entire menu
* clone structure.
*/
newArgv[0] = "bindtags";
newArgv[1] = Tk_PathName(newMenuPtr->tkwin);
if (Tk_BindtagsCmd((ClientData)newMenuPtr->tkwin,
newMenuPtr->interp, 2, newArgv) == TCL_OK) {
char *windowName;
Tcl_Obj *bindingsPtr =
Tcl_DuplicateObj(Tcl_GetObjResult(newMenuPtr->interp));
Tcl_Obj *elementPtr;
Tcl_ListObjLength(newMenuPtr->interp, bindingsPtr, &numElements);
for (i = 0; i < numElements; i++) {
Tcl_ListObjIndex(newMenuPtr->interp, bindingsPtr, i,
&elementPtr);
windowName = Tcl_GetStringFromObj(elementPtr, NULL);
if (strcmp(windowName, Tk_PathName(newMenuPtr->tkwin))
== 0) {
Tcl_Obj *newElementPtr = Tcl_NewStringObj(
Tk_PathName(newMenuPtr->masterMenuPtr->tkwin), -1);
Tcl_IncrRefCount(newElementPtr);
Tcl_ListObjReplace(menuPtr->interp, bindingsPtr,
i + 1, 0, 1, &newElementPtr);
newArgv[2] = Tcl_GetStringFromObj(bindingsPtr, NULL);
Tk_BindtagsCmd((ClientData)newMenuPtr->tkwin,
menuPtr->interp, 3, newArgv);
break;
}
}
Tcl_DecrRefCount(bindingsPtr);
}
Tcl_ResetResult(menuPtr->interp);
/*
* Clone all of the cascade menus that this menu points to.
*/
for (i = 0; i < menuPtr->numEntries; i++) {
TkMenuReferences *cascadeRefPtr;
TkMenu *oldCascadePtr;
if ((menuPtr->entries[i]->type == CASCADE_ENTRY)
&& (menuPtr->entries[i]->namePtr != NULL)) {
cascadeRefPtr =
TkFindMenuReferencesObj(menuPtr->interp,
menuPtr->entries[i]->namePtr);
if ((cascadeRefPtr != NULL) && (cascadeRefPtr->menuPtr)) {
Tcl_Obj *windowNamePtr =
Tcl_NewStringObj(Tk_PathName(newMenuPtr->tkwin),
-1);
Tcl_Obj *newCascadePtr;
oldCascadePtr = cascadeRefPtr->menuPtr;
Tcl_IncrRefCount(windowNamePtr);
newCascadePtr = TkNewMenuName(menuPtr->interp,
windowNamePtr, oldCascadePtr);
Tcl_IncrRefCount(newCascadePtr);
CloneMenu(oldCascadePtr, newCascadePtr, NULL);
newObjv[0] = Tcl_NewStringObj("-menu", -1);
newObjv[1] = newCascadePtr;
Tcl_IncrRefCount(newObjv[0]);
ConfigureMenuEntry(newMenuPtr->entries[i], 2, newObjv);
Tcl_DecrRefCount(newObjv[0]);
Tcl_DecrRefCount(newCascadePtr);
Tcl_DecrRefCount(windowNamePtr);
}
}
}
returnResult = TCL_OK;
} else {
returnResult = TCL_ERROR;
}
Tcl_Release((ClientData) menuPtr);
return returnResult;
}
/*
*----------------------------------------------------------------------
*
* MenuDoYPosition --
*
* Given arguments from an option command line, returns the Y position.
*
* Results:
* Returns TCL_OK or TCL_Error
*
* Side effects:
* yPosition is set to the Y-position of the menu entry.
*
*----------------------------------------------------------------------
*/
static int
MenuDoYPosition(interp, menuPtr, objPtr)
Tcl_Interp *interp;
TkMenu *menuPtr;
Tcl_Obj *objPtr;
{
int index;
TkRecomputeMenu(menuPtr);
if (TkGetMenuIndex(interp, menuPtr, objPtr, 0, &index) != TCL_OK) {
goto error;
}
Tcl_ResetResult(interp);
if (index < 0) {
Tcl_SetObjResult(interp, Tcl_NewIntObj(0));
} else {
Tcl_SetObjResult(interp, Tcl_NewIntObj(menuPtr->entries[index]->y));
}
return TCL_OK;
error:
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* GetIndexFromCoords --
*
* Given a string of the form "@int", return the menu item corresponding
* to int.
*
* Results:
* If int is a valid number, *indexPtr will be the number of the menuentry
* that is the correct height. If int is invaled, *indexPtr will be
* unchanged. Returns appropriate Tcl error number.
*
* Side effects:
* If int is invalid, interp's result will set to NULL.
*
*----------------------------------------------------------------------
*/
static int
GetIndexFromCoords(interp, menuPtr, string, indexPtr)
Tcl_Interp *interp; /* interp of menu */
TkMenu *menuPtr; /* the menu we are searching */
char *string; /* The @string we are parsing */
int *indexPtr; /* The index of the item that matches */
{
int x, y, i;
char *p, *end;
TkRecomputeMenu(menuPtr);
p = string + 1;
y = strtol(p, &end, 0);
if (end == p) {
goto error;
}
if (*end == ',') {
x = y;
p = end + 1;
y = strtol(p, &end, 0);
if (end == p) {
goto error;
}
} else {
Tk_GetPixelsFromObj(interp, menuPtr->tkwin,
menuPtr->borderWidthPtr, &x);
}
for (i = 0; i < menuPtr->numEntries; i++) {
if ((x >= menuPtr->entries[i]->x) && (y >= menuPtr->entries[i]->y)
&& (x < (menuPtr->entries[i]->x + menuPtr->entries[i]->width))
&& (y < (menuPtr->entries[i]->y
+ menuPtr->entries[i]->height))) {
break;
}
}
if (i >= menuPtr->numEntries) {
/* i = menuPtr->numEntries - 1; */
i = -1;
}
*indexPtr = i;
return TCL_OK;
error:
Tcl_SetResult(interp, (char *) NULL, TCL_STATIC);
return TCL_ERROR;
}
/*
*----------------------------------------------------------------------
*
* RecursivelyDeleteMenu --
*
* Deletes a menu and any cascades underneath it. Used for deleting
* instances when a menu is no longer being used as a menubar,
* for instance.
*
* Results:
* None.
*
* Side effects:
* Destroys the menu and all cascade menus underneath it.
*
*----------------------------------------------------------------------
*/
static void
RecursivelyDeleteMenu(menuPtr)
TkMenu *menuPtr; /* The menubar instance we are deleting */
{
int i;
TkMenuEntry *mePtr;
for (i = 0; i < menuPtr->numEntries; i++) {
mePtr = menuPtr->entries[i];
if ((mePtr->type == CASCADE_ENTRY)
&& (mePtr->childMenuRefPtr != NULL)
&& (mePtr->childMenuRefPtr->menuPtr != NULL)) {
RecursivelyDeleteMenu(mePtr->childMenuRefPtr->menuPtr);
}
}
Tk_DestroyWindow(menuPtr->tkwin);
}
/*
*----------------------------------------------------------------------
*
* TkNewMenuName --
*
* Makes a new unique name for a cloned menu. Will be a child
* of oldName.
*
* Results:
* Returns a char * which has been allocated; caller must free.
*
* Side effects:
* Memory is allocated.
*
*----------------------------------------------------------------------
*/
Tcl_Obj *
TkNewMenuName(interp, parentPtr, menuPtr)
Tcl_Interp *interp; /* The interp the new name has to live in.*/
Tcl_Obj *parentPtr; /* The prefix path of the new name. */
TkMenu *menuPtr; /* The menu we are cloning. */
{
Tcl_Obj *resultPtr = NULL; /* Initialization needed only to prevent
* compiler warning. */
Tcl_Obj *childPtr;
char *destString;
int i;
int doDot;
Tcl_CmdInfo cmdInfo;
Tcl_HashTable *nameTablePtr = NULL;
TkWindow *winPtr = (TkWindow *) menuPtr->tkwin;
char *parentName = Tcl_GetStringFromObj(parentPtr, NULL);
if (winPtr->mainPtr != NULL) {
nameTablePtr = &(winPtr->mainPtr->nameTable);
}
doDot = parentName[strlen(parentName) - 1] != '.';
childPtr = Tcl_NewStringObj(Tk_PathName(menuPtr->tkwin), -1);
for (destString = Tcl_GetStringFromObj(childPtr, NULL);
*destString != '\0'; destString++) {
if (*destString == '.') {
*destString = '#';
}
}
for (i = 0; ; i++) {
if (i == 0) {
resultPtr = Tcl_DuplicateObj(parentPtr);
if (doDot) {
Tcl_AppendToObj(resultPtr, ".", -1);
}
Tcl_AppendObjToObj(resultPtr, childPtr);
} else {
Tcl_Obj *intPtr;
Tcl_DecrRefCount(resultPtr);
resultPtr = Tcl_DuplicateObj(parentPtr);
if (doDot) {
Tcl_AppendToObj(resultPtr, ".", -1);
}
Tcl_AppendObjToObj(resultPtr, childPtr);
intPtr = Tcl_NewIntObj(i);
Tcl_AppendObjToObj(resultPtr, intPtr);
Tcl_DecrRefCount(intPtr);
}
destString = Tcl_GetStringFromObj(resultPtr, NULL);
if ((Tcl_GetCommandInfo(interp, destString, &cmdInfo) == 0)
&& ((nameTablePtr == NULL)
|| (Tcl_FindHashEntry(nameTablePtr, destString) == NULL))) {
break;
}
}
Tcl_DecrRefCount(childPtr);
return resultPtr;
}
/*
*----------------------------------------------------------------------
*
* TkSetWindowMenuBar --
*
* Associates a menu with a window. Called by ConfigureFrame in
* in response to a "-menu .foo" configuration option for a top
* level.
*
* Results:
* None.
*
* Side effects:
* The old menu clones for the menubar are thrown away, and a
* handler is set up to allocate the new ones.
*
*----------------------------------------------------------------------
*/
void
TkSetWindowMenuBar(interp, tkwin, oldMenuName, menuName)
Tcl_Interp *interp; /* The interpreter the toplevel lives in. */
Tk_Window tkwin; /* The toplevel window */
char *oldMenuName; /* The name of the menubar previously set in
* this toplevel. NULL means no menu was
* set previously. */
char *menuName; /* The name of the new menubar that the
* toplevel needs to be set to. NULL means
* that their is no menu now. */
{
TkMenuTopLevelList *topLevelListPtr, *prevTopLevelPtr;
TkMenu *menuPtr;
TkMenuReferences *menuRefPtr;
TkMenuInit();
/*
* Destroy the menubar instances of the old menu. Take this window
* out of the old menu's top level reference list.
*/
if (oldMenuName != NULL) {
menuRefPtr = TkFindMenuReferences(interp, oldMenuName);
if (menuRefPtr != NULL) {
/*
* Find the menubar instance that is to be removed. Destroy
* it and all of the cascades underneath it.
*/
if (menuRefPtr->menuPtr != NULL) {
TkMenu *instancePtr;
menuPtr = menuRefPtr->menuPtr;
for (instancePtr = menuPtr->masterMenuPtr;
instancePtr != NULL;
instancePtr = instancePtr->nextInstancePtr) {
if (instancePtr->menuType == MENUBAR
&& instancePtr->parentTopLevelPtr == tkwin) {
RecursivelyDeleteMenu(instancePtr);
break;
}
}
}
/*
* Now we need to remove this toplevel from the list of toplevels
* that reference this menu.
*/
for (topLevelListPtr = menuRefPtr->topLevelListPtr,
prevTopLevelPtr = NULL;
(topLevelListPtr != NULL)
&& (topLevelListPtr->tkwin != tkwin);
prevTopLevelPtr = topLevelListPtr,
topLevelListPtr = topLevelListPtr->nextPtr) {
/*
* Empty loop body.
*/
}
/*
* Now we have found the toplevel reference that matches the
* tkwin; remove this reference from the list.
*/
if (topLevelListPtr != NULL) {
if (prevTopLevelPtr == NULL) {
menuRefPtr->topLevelListPtr =
menuRefPtr->topLevelListPtr->nextPtr;
} else {
prevTopLevelPtr->nextPtr = topLevelListPtr->nextPtr;
}
ckfree((char *) topLevelListPtr);
TkFreeMenuReferences(menuRefPtr);
}
}
}
/*
* Now, add the clone references for the new menu.
*/
if (menuName != NULL && menuName[0] != 0) {
TkMenu *menuBarPtr = NULL;
menuRefPtr = TkCreateMenuReferences(interp, menuName);
menuPtr = menuRefPtr->menuPtr;
if (menuPtr != NULL) {
Tcl_Obj *cloneMenuPtr;
TkMenuReferences *cloneMenuRefPtr;
Tcl_Obj *newObjv[4];
Tcl_Obj *windowNamePtr = Tcl_NewStringObj(Tk_PathName(tkwin),
-1);
Tcl_Obj *menubarPtr = Tcl_NewStringObj("menubar", -1);
/*
* Clone the menu and all of the cascades underneath it.
*/
Tcl_IncrRefCount(windowNamePtr);
cloneMenuPtr = TkNewMenuName(interp, windowNamePtr,
menuPtr);
Tcl_IncrRefCount(cloneMenuPtr);
Tcl_IncrRefCount(menubarPtr);
CloneMenu(menuPtr, cloneMenuPtr, menubarPtr);
cloneMenuRefPtr = TkFindMenuReferencesObj(interp, cloneMenuPtr);
if ((cloneMenuRefPtr != NULL)
&& (cloneMenuRefPtr->menuPtr != NULL)) {
Tcl_Obj *cursorPtr = Tcl_NewStringObj("-cursor", -1);
Tcl_Obj *nullPtr = Tcl_NewStringObj("", -1);
cloneMenuRefPtr->menuPtr->parentTopLevelPtr = tkwin;
menuBarPtr = cloneMenuRefPtr->menuPtr;
newObjv[0] = cursorPtr;
newObjv[1] = nullPtr;
Tcl_IncrRefCount(cursorPtr);
Tcl_IncrRefCount(nullPtr);
ConfigureMenu(menuPtr->interp, cloneMenuRefPtr->menuPtr,
2, newObjv);
Tcl_DecrRefCount(cursorPtr);
Tcl_DecrRefCount(nullPtr);
}
TkpSetWindowMenuBar(tkwin, menuBarPtr);
Tcl_DecrRefCount(cloneMenuPtr);
Tcl_DecrRefCount(menubarPtr);
Tcl_DecrRefCount(windowNamePtr);
} else {
TkpSetWindowMenuBar(tkwin, NULL);
}
/*
* Add this window to the menu's list of windows that refer
* to this menu.
*/
topLevelListPtr = (TkMenuTopLevelList *)
ckalloc(sizeof(TkMenuTopLevelList));
topLevelListPtr->tkwin = tkwin;
topLevelListPtr->nextPtr = menuRefPtr->topLevelListPtr;
menuRefPtr->topLevelListPtr = topLevelListPtr;
} else {
TkpSetWindowMenuBar(tkwin, NULL);
}
TkpSetMainMenubar(interp, tkwin, menuName);
}
/*
*----------------------------------------------------------------------
*
* DestroyMenuHashTable --
*
* Called when an interp is deleted and a menu hash table has
* been set in it.
*
* Results:
* None.
*
* Side effects:
* The hash table is destroyed.
*
*----------------------------------------------------------------------
*/
static void
DestroyMenuHashTable(clientData, interp)
ClientData clientData; /* The menu hash table we are destroying */
Tcl_Interp *interp; /* The interpreter we are destroying */
{
Tcl_DeleteHashTable((Tcl_HashTable *) clientData);
ckfree((char *) clientData);
}
/*
*----------------------------------------------------------------------
*
* TkGetMenuHashTable --
*
* For a given interp, give back the menu hash table that goes with
* it. If the hash table does not exist, it is created.
*
* Results:
* Returns a hash table pointer.
*
* Side effects:
* A new hash table is created if there were no table in the interp
* originally.
*
*----------------------------------------------------------------------
*/
Tcl_HashTable *
TkGetMenuHashTable(interp)
Tcl_Interp *interp; /* The interp we need the hash table in.*/
{
Tcl_HashTable *menuTablePtr;
menuTablePtr = (Tcl_HashTable *) Tcl_GetAssocData(interp, MENU_HASH_KEY,
NULL);
if (menuTablePtr == NULL) {
menuTablePtr = (Tcl_HashTable *) ckalloc(sizeof(Tcl_HashTable));
Tcl_InitHashTable(menuTablePtr, TCL_STRING_KEYS);
Tcl_SetAssocData(interp, MENU_HASH_KEY, DestroyMenuHashTable,
(ClientData) menuTablePtr);
}
return menuTablePtr;
}
/*
*----------------------------------------------------------------------
*
* TkCreateMenuReferences --
*
* Given a pathname, gives back a pointer to a TkMenuReferences structure.
* If a reference is not already in the hash table, one is created.
*
* Results:
* Returns a pointer to a menu reference structure. Should not
* be freed by calller; when a field of the reference is cleared,
* TkFreeMenuReferences should be called.
*
* Side effects:
* A new hash table entry is created if there were no references
* to the menu originally.
*
*----------------------------------------------------------------------
*/
TkMenuReferences *
TkCreateMenuReferences(interp, pathName)
Tcl_Interp *interp;
char *pathName; /* The path of the menu widget */
{
Tcl_HashEntry *hashEntryPtr;
TkMenuReferences *menuRefPtr;
int newEntry;
Tcl_HashTable *menuTablePtr = TkGetMenuHashTable(interp);
hashEntryPtr = Tcl_CreateHashEntry(menuTablePtr, pathName, &newEntry);
if (newEntry) {
menuRefPtr = (TkMenuReferences *) ckalloc(sizeof(TkMenuReferences));
menuRefPtr->menuPtr = NULL;
menuRefPtr->topLevelListPtr = NULL;
menuRefPtr->parentEntryPtr = NULL;
menuRefPtr->hashEntryPtr = hashEntryPtr;
Tcl_SetHashValue(hashEntryPtr, (char *) menuRefPtr);
} else {
menuRefPtr = (TkMenuReferences *) Tcl_GetHashValue(hashEntryPtr);
}
return menuRefPtr;
}
/*
*----------------------------------------------------------------------
*
* TkFindMenuReferences --
*
* Given a pathname, gives back a pointer to the TkMenuReferences
* structure.
*
* Results:
* Returns a pointer to a menu reference structure. Should not
* be freed by calller; when a field of the reference is cleared,
* TkFreeMenuReferences should be called. Returns NULL if no reference
* with this pathname exists.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
TkMenuReferences *
TkFindMenuReferences(interp, pathName)
Tcl_Interp *interp; /* The interp the menu is living in. */
char *pathName; /* The path of the menu widget */
{
Tcl_HashEntry *hashEntryPtr;
TkMenuReferences *menuRefPtr = NULL;
Tcl_HashTable *menuTablePtr;
menuTablePtr = TkGetMenuHashTable(interp);
hashEntryPtr = Tcl_FindHashEntry(menuTablePtr, pathName);
if (hashEntryPtr != NULL) {
menuRefPtr = (TkMenuReferences *) Tcl_GetHashValue(hashEntryPtr);
}
return menuRefPtr;
}
/*
*----------------------------------------------------------------------
*
* TkFindMenuReferencesObj --
*
* Given a pathname, gives back a pointer to the TkMenuReferences
* structure.
*
* Results:
* Returns a pointer to a menu reference structure. Should not
* be freed by calller; when a field of the reference is cleared,
* TkFreeMenuReferences should be called. Returns NULL if no reference
* with this pathname exists.
*
* Side effects:
* None.
*
*----------------------------------------------------------------------
*/
TkMenuReferences *
TkFindMenuReferencesObj(interp, objPtr)
Tcl_Interp *interp; /* The interp the menu is living in. */
Tcl_Obj *objPtr; /* The path of the menu widget */
{
char *pathName = Tcl_GetStringFromObj(objPtr, NULL);
return TkFindMenuReferences(interp, pathName);
}
/*
*----------------------------------------------------------------------
*
* TkFreeMenuReferences --
*
* This is called after one of the fields in a menu reference
* is cleared. It cleans up the ref if it is now empty.
*
* Results:
* None.
*
* Side effects:
* If this is the last field to be cleared, the menu ref is
* taken out of the hash table.
*
*----------------------------------------------------------------------
*/
void
TkFreeMenuReferences(menuRefPtr)
TkMenuReferences *menuRefPtr; /* The menu reference to
* free */
{
if ((menuRefPtr->menuPtr == NULL)
&& (menuRefPtr->parentEntryPtr == NULL)
&& (menuRefPtr->topLevelListPtr == NULL)) {
Tcl_DeleteHashEntry(menuRefPtr->hashEntryPtr);
ckfree((char *) menuRefPtr);
}
}
/*
*----------------------------------------------------------------------
*
* DeleteMenuCloneEntries --
*
* For every clone in this clone chain, delete the menu entries
* given by the parameters.
*
* Results:
* None.
*
* Side effects:
* The appropriate entries are deleted from all clones of this menu.
*
*----------------------------------------------------------------------
*/
static void
DeleteMenuCloneEntries(menuPtr, first, last)
TkMenu *menuPtr; /* the menu the command was issued with */
int first; /* the zero-based first entry in the set
* of entries to delete. */
int last; /* the zero-based last entry */
{
TkMenu *menuListPtr;
int numDeleted, i;
numDeleted = last + 1 - first;
for (menuListPtr = menuPtr->masterMenuPtr; menuListPtr != NULL;
menuListPtr = menuListPtr->nextInstancePtr) {
for (i = last; i >= first; i--) {
Tcl_EventuallyFree((ClientData) menuListPtr->entries[i],
DestroyMenuEntry);
}
for (i = last + 1; i < menuListPtr->numEntries; i++) {
menuListPtr->entries[i - numDeleted] = menuListPtr->entries[i];
menuListPtr->entries[i - numDeleted]->index = i;
}
menuListPtr->numEntries -= numDeleted;
if (menuListPtr->numEntries == 0) {
ckfree((char *) menuListPtr->entries);
menuListPtr->entries = NULL;
}
if ((menuListPtr->active >= first)
&& (menuListPtr->active <= last)) {
menuListPtr->active = -1;
} else if (menuListPtr->active > last) {
menuListPtr->active -= numDeleted;
}
TkEventuallyRecomputeMenu(menuListPtr);
}
}
/*
*----------------------------------------------------------------------
*
* TkMenuInit --
*
* Sets up the hash tables and the variables used by the menu package.
*
* Results:
* None.
*
* Side effects:
* lastMenuID gets initialized, and the parent hash and the command hash
* are allocated.
*
*----------------------------------------------------------------------
*/
void
TkMenuInit()
{
if (!menusInitialized) {
TkpMenuInit();
menusInitialized = 1;
}
}
|