Source

ecb / ecb.texi

Full commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
\input texinfo   @c -*-texinfo-*-

@c Copyright (C) 2000 - 2003 Jesper Nordenberg,
@c                           Klaus Berndl,
@c                           Kevin A. Burton,
@c                           Free Software Foundation, Inc.

@c Author: Jesper Nordenberg <mayhem@home.se>
@c         Klaus Berndl <klaus.berndl@sdm.de>
@c         Kevin A. Burton <burton@openprivacy.org>
@c Maintainer: Klaus Berndl <klaus.berndl@sdm.de>
@c             Kevin A. Burton <burton@openprivacy.org>
@c Keywords: browser, code, programming, tools
@c Created: 2001

@c This program is free software; you can redistribute it and/or modify it under
@c the terms of the GNU General Public License as published by the Free Software
@c Foundation; either version 2, or (at your option) any later version.

@c This program is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
@c FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
@c details.

@c You should have received a copy of the GNU General Public License along with
@c GNU Emacs; see the file COPYING.  If not, write to the Free Software
@c Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

@c $Id$

@setfilename ecb.info

@settitle ECB - the Emacs Code Browser

@c If we want only one index for concepts, functions and variables
@c @syncodeindex vr cp
@c @syncodeindex fn cp

@c in info we do not want paragraph indenting
@ifinfo
@paragraphindent 0
@end ifinfo

@exampleindent   3

@footnotestyle end

@c The version number is auto-frobbed from the Makefile, so you should
@c edit the Makefile to change the version number. mechanism stolen
@c from Tramp
@macro ecbver{}
2.20
@end macro


@dircategory GNU Emacs Lisp
@direntry
* ECB: (ecb).           Emacs Code Browser
@end direntry

@titlepage
@sp 10
@center @titlefont{ECB version @ecbver{} - User manual}
@vskip 0pt plus 1 fill
Copyright @copyright{} 2000, 2001, 2002 Jesper Nordenberg, Klaus Berndl
@end titlepage

@node Top, Install and first steps, (dir), (dir)
@comment  node-name,  next,  previous,  up

@ifnottex
This is the user manual for ECB version @ecbver{}.
@end ifnottex

ECB stands for ``Emacs Code Browser'' and is a source-code-browser for
(X)Emacs. It is a global minor-mode which offers a
language-independent and complete IDE (Integrated Development
Environment) within one Emacs-frame. It displays a couple of windows
that can be used to browse directories, files and file-contents like
methods and variables. It supports source-code parsing for
semantic-supported languages like Java, C, C++, Elisp and Scheme as
well as for source-types supported ``only'' by imenu or etags (e.g.
perl, TeX, LaTeX etc.). In addition it offers (optional) a durable
``compile-window'' at the bottom of the frame which is used to display
all help-, grep-, compile- and etc.-output. The rest of the frame is
called the ``edit-area'' which can be divided in several (no limit)
edit-windows which are used for editing of sources. Deleting some of
the edit-windows does neither destroy the compile-window nor the
browsing-windows.

@iftex
@sp 1
@end iftex

@strong{Please note}: Experienced ECB users find a complete
alphabetical list of all commands and user-options in @ref{Interactive
ECB commands} and @ref{Customizable options}.

@c In the following two paragraphs we distinct between HTML-, info-,
@c and tex-format concerning the display of the URLs.
@ifinfo
The latest version of ECB can always be found at the URL
@url{http://ecb.sourceforge.net}.

To send bug reports, or participate in discussions about ECB, use the
mailing list @email{ecb-list@@lists.sourceforge.net} via the URL
@url{http://lists.sourceforge.net/lists/listinfo/ecb-list}.
@end ifinfo

@iftex
@sp 1

The latest version of ECB can always be found at the URL @*
@url{http://ecb.sourceforge.net}.

@sp 1

To send bug reports, or participate in discussions about ECB, use the
mailing list @*@email{ecb-list@@lists.sourceforge.net} via the URL @*
@url{http://lists.sourceforge.net/lists/listinfo/ecb-list}.
@end iftex

@ifhtml
The latest version of ECB can always be found at 
@uref{http://ecb.sourceforge.net}

To send bug reports, or participate in discussions about ECB, use the
mailing list @email{ecb-list@@lists.sourceforge.net} via 
@uref{http://lists.sourceforge.net/lists/listinfo/ecb-list}
@end ifhtml

@menu
* Install and first steps::     Installing ECB and first steps
* Overview::                    Introduce basic concepts
* Activation and Deactivation:: How to start and end ECB
* Usage of ECB::                How to use ECB
* Customizing::                 How to customize ECB
* Submitting problem report::   What to do when problems occur
* Upgrading::                   Upgrading and downloading packages
* Tips and tricks::             Useful hints and tips
* Elisp programming::           Entry points for Elisp programmers
* Conflicts and bugs::          Known Conflicts with other packages and bugs
* FAQ::                         Frequently asked questions
* Command Index::               Index for interactive commands
* Option Index::                Index for user options
* Concept Index::               Index for concepts and terms
@comment * Index::

@detailmenu
 --- The Detailed Node Listing ---

Installation and first steps of ECB

* Installation::                Installation of ECB
* Setting up Emacs::            How to set up Emacs for file parsing with ECB
* First steps::                 First steps after activating ECB first time

Installation of ECB

* XEmacs Installation::         Installation of ECB for XEmacs users
* GNU Emacs Installation::      Installation of ECB for GNU Emacs users

How to set up Emacs for file parsing with ECB

* General hints::               General hints for a correct setup
* Setting up semantic::         How to setup semantic correctly
* Non-semantic files::          Setup for file types not supported by semantic

Overview

* ECB Directories-buffer::      Contents of the ECB Directories-buffer
* ECB Sources-buffer::          Contents of the ECB Sources/history-buffer
* ECB Methods-buffer::          Contents of the ECB Methods-buffer

Activation and Deactivation

* Standard activation::         How to manually (de)activate ECB
* Automatic activation::        Automatically (de)activating ECB

Usage of ECB

* Using the mouse::             Working with the mouse
* Using the keyboard::          Working with the keyboard
* The edit-area::               How to use the edit-area
* Temp- and compile-buffers::   Displaying temp- and compilation-buffers
* The other window::            How the ``other window'' is determined
* The Methods buffer::          Using and customizing he Methods-buffer
* The ECB-layout::              Changing, customizing, redrawing, creating
* Hiding the ECB windows::      Hiding/Showing the ECB-windows
* Maximizing the ECB windows::  Maximizing the ECB-windows
* Back/forward navigation::     Back- and forward navigation like a browser
* ECB-window synchronizing::    Auto./manual synchronizing the ECB-windows
* Interactive ECB commands::    All interactive user-commands of ECB

Working with the keyboard in the ECB-windows

* Navigation/Selection::        Keyboard navigation/selection in a tree-buffer
* Incremental search::          Find nodes as fast as possible
* Personal keybindings::        Adding personal keybindings to a tree-buffer
* Using popup-menus::           Using the popup-menus from keyboard.

Using and customizing the ECB-Methods buffer

* Visiting tags::               Possible actions after visiting a tag
* Expanding::                   Explicit and automatic expanding
* Customizing the display::     How to customize the Methods-buffer display
* Rebuilding the Methods::      When to rebuild the Methods-buffer      

Changing, customizing, redrawing and creating layouts

* Changing the ECB-layout::     How to change and customize the layout
* Redrawing the ECB-layout::    How and when redrawing the layout
* Changing window sizes::       Changing sizes of the ECB-windows
* Fixing window sizes::         Fixing sizes of the ECB-windows
* Creating a new ECB-layout::   Interactively creating new layouts

Customizing ECB

* General aspects::             General aspects for customizing ECB
* Most important options::      Which option you must know
* Customizable options::        All customizable options of ECB

General aspects for customizing ECB

* setq or customize::           Should i use setq or customize?
* Site-wide customizing::       Site-wide customizing of ECB

All customizable options of ECB

* ecb-general::                 General customizing ECB
* ecb-tree-buffer::             Customizing the general tree layout
* ecb-directories::             Customizing the ECB-directories-tree
* ecb-sources::                 Customizing the ECB-sources-tree
* ecb-methods::                 Customizing the ECB-methods-tree
* ecb-history::                 Customizing the ECB-history-tree
* ecb-layout::                  Customizing the ECB-layout
* ecb-compilation::             Customizing the compile-window
* ecb-create-layout::           Customizing options for creating layouts
* ecb-face-options::            Customizing options for faces
* ecb-faces::                   Customizing the faces
* ecb-download::                Customizing how to download ECB
* ecb-help::                    Customizing the online help of ECB
* ecb-eshell::                  Customizing the eshell-integration
* ecb-non-semantic::            Customizing parsing non-semantic sources
* ecb-winman::                  Customizing window-manager support
* ecb-mode-line::               Customizing the tree-buffer-modelines

Upgrading and downloading packages

* Downloading new versions::    How to download newer versions of packages
* Auto. option-upgrading::      ECB can auto. upgrade your options

Automatic upgrading of options

* User interface::              Options and commands you should know
* Background information::      Maybe some interesting informations

Tips and tricks

* Changing faces::              Changing faces in the ECB tree-buffers
* Small screens::               Working with small screens
* Big screens::                 Working with big screens
* Simulating speedbar::         Simulating speedbar without an extra frame
* Integrating speedbar::        Integrating speedbar in the ECB-frame
* Optimize scrolling::          Optimize scrolling in the edit-window
* Large directories::           Working with large directories
* Using eshell::                Optimal using of eshell in ECB
* Grepping directories::        Grepping directories with ECB
* Working with JDEE::           Working best with ECB and JDEE
* Compile-window on demand::    Displaying the compile-window on demand
* Non-semantic sources::        Parsing and displaying non-semantic sources
* Hide-show::                   Using hide-show from the methods-buffer-menu
* Window-managers and ECB::     Support of several Emacs-window-managers
* Tree-buffer styles::          Displaying the trees with different styles
* Using semanticdb::            Using semanticdb for going to external nodes

Displaying the trees of the ECB-windows with different styles

* Style basics::                Basic knowledge about the styles
* Ascii-based styles::          How to customize the ascii-styles
* Tree-buffers with images::    Which images are used for the tree

Entry points for Elisp programmers

* List of variables::           Which variables an Elisp-program can use
* List of hooks::               All available hooks
* tree-buffer::                 Some words to the tree-buffer-library
* Adviced functions::           How to deal with the adviced functions
* The layout-engine::           Programming new layouts and special windows

How to program new layouts and new special windows

* Programming a new layout::    How to program a new layout
* Programming special windows:: Aspects of programming special windows
* Possible layout-outlines::    The wide range of possible layouts
* The layout-engine API::       The complete layout-engine API

Conflicts and bugs of ECB

* Conflicts::                   Conflicts with other packages
* Bugs::                        Known bugs

@end detailmenu
@end menu

@node Install and first steps, Overview, Top, Top
@chapter Installation and first steps of ECB

This chapter describes how to install ECB and setup (X)Emacs correctly
and what are the first steps after activation of ECB.

@menu
* Installation::                Installation of ECB
* Setting up Emacs::            How to set up Emacs for file parsing with ECB
* First steps::                 First steps after activating ECB first time
@end menu

@node Installation, Setting up Emacs, Install and first steps, Install and first steps
@section Installation of ECB

This section describes how to install ECB.

@menu
* XEmacs Installation::         Installation of ECB for XEmacs users
* GNU Emacs Installation::      Installation of ECB for GNU Emacs users
@end menu

@node XEmacs Installation, GNU Emacs Installation, Installation, Installation
@subsection Installation of ECB for XEmacs users

For XEmacs-users it is strongly recommended to use the
package-management-system of XEmacs for first-time
downloading/installing ECB or for upgrading to a newer version of ECB.
Here is a short guide (for details about the package-manager of XEmacs
see the related info-manual):

@strong{Caution}: If ECB is already installed and you just want
upgrading to a newer version then it is recommended to deactivate ECB
before proceeding with the steps below!

@enumerate
@item Choose a download-site

This can be done via the menu ``Tools --> Packages --> Add Download
Site'': Choose one of the listed sites. Or you can customize the
option @code{package-get-remote} by hand and save it for future
sessions.

@item Activate the packages list

This can be done either by the menu ``Tools --> Packages --> List and
Install'' or via the command @code{pui-list-packages}. After that a
special packages-buffer is displayed where you can interactively
install or upgrade packages. At the end of this buffer there is a
short description how to use this buffer.

@item Install ECB and all required packages

Mark the package named ``ecb'' for install. Do this also for the
required packages ``semantic'', ``eieio'' and ``speedbar''. The
package ``mail-lib'' is needed for easy submitting of problem-reports
to the ECB-maintainers and the package ``c-support'' is needed for
easy using hideshow within the Methods-buffer of ECB@footnote{All
required packages can simply autom. marked by hitting @kbd{r} in the
packages buffer. But this installs a lot of packages more (e.g. the
Newsreader Gnus) which are really not essential for ECB. Therefore it
is recommended to mark the required packages by hand.}.

After marking all needed packages for installation hit @kbd{x} to
install them.

If you have already installed ECB and you want just upgrading to the
latest available version then proceed as described above - same if you
want to upgrade one of the required packages.

@item Start ECB

Now you can immediately start ECB via the command @code{ecb-activate};
there is no need to restart XEmacs! As an alternative you can first
read the online-help via @code{ecb-show-help}.

@end enumerate

If you do not like the package-manager of XEmacs but you want
installing ECB ``by hand'' direct from the ECB-website then you have
to follow the instructions for GNU Emacs, see @ref{GNU Emacs Installation}.

@node GNU Emacs Installation, , XEmacs Installation, Installation
@subsection Installation of ECB for GNU Emacs users

@strong{IMPORTANT}: If you are a XEmacs-user please read @ref{XEmacs
Installation} before proceeding with the following instructions!

@c TODO: Klaus Berndl <klaus.berndl@sdm.de>: Remove this when we
@c support upgrading also with cedet.

@strong{Using the new cedet 1.0 suite}: From beginning with version
2.01 ECB supports the next generation of the cedet-tools. But before
the cedet 1.0 suite becomes stable this means that ECB runs correctly
with loaded cedet 1.0 but the ECB-upgrading feature
(@pxref{Downloading new versions}) does not support autom. upgrading
to latest available cedet versions. This will be first available after
first stable release of the new cedet-library 1.0.

So, if the cedet 1.0 suite is loaded then the min- and max-version of
semantic, eieio and speedbar (mentioned in the Requirements-section of
the file @file{README}) have no relevance! If the new cedet 1.0 suite
should be used then just install and load cedet 1.0 like described in
the cedet-installation-instructions and go one with step 3.

@enumerate

@item
Download and unpack the ECB archive (probably you have already done
this :-)

@item
Read the file @file{README} in the ECB-directory and install the
required semantic-, eieio- and speedbar-version@footnote{The
speedbar-version shipped with GNU Emacs <= 21.3 does not satisfy the
requirements for this feature - download a newer one!}.

@strong{Please note}: ECB maybe requires a newer version of these
libraries than shipped with (X)Emacs. You have to install exactly a
version ECB requires and also to make sure that the correct version is
loaded into (X)Emacs!

But ECB performs two autom checks:

@itemize @minus
@item At load-time:
It checks if the packages semantic, eieio and speedbar are at least
installed so ECB can be loaded. If not it offers to download and
install them.

@item At start-time:
It checks if the correct versions of semantic, eieio and speedbar are
installed and gives you proper feedback. @xref{Download required
packages}.
@end itemize

So if you are not sure if you have installed the required packages at
all or if you have installed the correct versions of these packages
then do not worry about this, just go on with the following
installation steps: If ECB is missing something it will give you
proper feedback and support not later than at load-time or start-time!

@item
Add the new ECB-directory to your @code{load-path} variable.

You @strong{MUST} add the ECB-install-directory to the
@code{load-path} either by changing the @code{load-path} variable
directly in your @file{.emacs} or @file{site-lisp/site-start.el} or by
working with a file @file{subdirs.el}@footnote{This works at least for
Emacs 20.X and Emacs 21.X but XEmacs may have slightly different
mechanisms; see the XEmacs documentation}.

@strong{ATTENTION}:
ECB is NOT properly installed if it's directory is not added to
@code{load-path} and for example just loaded by

@example
(load-file "/path/to/ecb/ecb.el")
@end example

Do not do this!

@item
Load ECB by adding code to your @file{.emacs}:

If you want to load the complete ECB at (X)Emacs-loadtime (Advantage:
All ECB-options available after loading ECB. Disadvantage: Increasing
loadtime@footnote{Cause of full loading of ECB itself and also the
packages semantic, eieio and speedbar regardless if ECB is started.}):

@example
(require 'ecb)
@end example

If you want to load the ECB first after starting it by
@code{ecb-activate} (Advantage: Fast loading@footnote{ECB, semantic,
eieio and speedbar are first loaded after starting ECB or with other
words: ECB and semantic are not loaded if you do not use/need them}.
Disadvantage: ECB- and semantic-options first available after starting
ECB):

@example
(require 'ecb-autoloads)
@end example

This loads all available autoloads of ECB, e.g. @code{ecb-activate},
@code{ecb-minor-mode}, @code{ecb-byte-compile} and
@code{ecb-show-help}.

@item Restart (X)Emacs.
@end enumerate

ECB is now ready for use and can be activated by calling @code{M-x
ecb-activate} or @code{ecb-minor-mode}. Now you can either starting
using ECB or you can do these optional installation steps:

@enumerate 6

@item Reading the online help with @code{ecb-show-help}

Maybe you are interested to read the online-help of ECB before first
start.

@item Bytecompiling ECB with @code{ecb-byte-compile}

This byte compiles ECB. You can safely ignore all messages if there
are any. (You can also bytecompile ECB from the command-line either by
using the @file{Makefile} or by using the batch-file @file{make.bat};
just read the comments in that file you choose.)

@item Installing the Info-help of ECB

The ECB distribution contains a subdirectory @file{info-help} which
contains the online-help of ECB in Info-format. You can install this
online help so it's available in the Top-directory of Info. There are
two ways to do this:

@itemize @minus
@item Use ``install-info'' (recommended):

@enumerate
@item
Copy the files of the subdirectory @file{info-help} into the
info-directory of Emacs

@item
Install the file @file{info-help/ecb.info} with the command
``install-info'' (if available on your system) in the @file{dir}-file.
@end enumerate

The supplied @file{Makefile} offers a target @code{install-help} which
does both of these steps. You have just to call @code{make
install-help} with the correct EMACSINFOPATH set (see the comment in
@file{Makefile}). Here is an example:

@example
make EMACSINFOPATH=/path/to/emacs/info install-help
@end example

@item Manual Installation:

Copy the files of the subdirectory @file{info-help} into the
info-directory of Emacs and modify the file @file{dir} manually.
@end itemize

But it doesn't matter if you do not execute this step (8.) because the
online help of ECB is always available though, see
@code{ecb-show-help} (@pxref{Interactive ECB commands}).

@end enumerate

@node Setting up Emacs, First steps, Installation, Install and first steps
@section How to set up Emacs for file parsing with ECB

@strong{Please note}: Normally it should not necessary for you to
bother with the following stuff unless you have problems getting ECB
working correctly for you.

@menu
* General hints::               General hints for a correct setup
* Setting up semantic::         How to setup semantic correctly
* Non-semantic files::          Setup for file types not supported by semantic
@end menu

@node General hints, Setting up semantic, Setting up Emacs, Setting up Emacs
@subsection General hints for a correct setup

ECB is for browsing files and therefore you have to setup your
Emacs-configuration properly so the file-parsing engines like
semantic, imenu or etags can be activated automatically for parsing
your Emacs-Lisp, C, C++ or Java buffers@footnote{semantic supports
some more ``languages'' like Makefiles etc. but these are the most
important ones.}. For this Emacs must activate the correct
@code{major-mode} for the source-files and Emacs can only do this if
the option @code{auto-mode-alist} is setup correctly. The correct
major-modes and possible file-extensions@footnote{Especially for C++
and C you can use any extension you want but these are the most common
ones!} are:

@multitable @columnfractions 0.20 0.50 0.30

@item
@ifnotinfo
@strong{Language}
@end ifnotinfo
@ifinfo
LANGUAGE
@end ifinfo
@tab
@ifnotinfo
@strong{Major-mode}
@end ifnotinfo
@ifinfo
MAJOR-MODE
@end ifinfo
@tab
@ifnotinfo
@strong{Extension(s)}
@end ifnotinfo
@ifinfo
EXTENSION(S)
@end ifinfo

@item Emacs Lisp @tab @code{emacs-lisp-mode} @tab .el

@item C @tab @code{c-mode} @tab .h, .c

@item C++ @tab @code{c++-mode} @tab .h, .hxx, .hh, .HH, .cxx, .cpp,
.cc, .CC

@item Java @tab @code{java-mode} or @code{jde-mode} (if you use JDEE)
@tab .java
@end multitable

Example: If you want files with extension ``.cpp'' being c++-parsed by
semantic and ECB, your @code{auto-mode-alist} must contain an entry
like:

@example
("\\.cpp\\'" . c++-mode)
@end example

After this ECB will correctly parse your ``.cpp''-sources and display
all the parsing information in the ECB-methods buffer.

@node Setting up semantic, Non-semantic files, General hints, Setting up Emacs
@subsection Setting up semantic

To ensure ECB and semantic are working correctly for all by semantic
supported languages you have to pay attention to the following aspects
concerning your Emacs-setup:

@enumerate
@item Setting up semantic itself

For all semantic-supported file-types parsing files is done completely
by semantic. ECB just displays the parsing results. For all needs of
ECB semantic is completely setup by ECB itself, i.e. ECB sets up
semantic for you! You have only to add the installation directory of
semantic to your @code{load-path} (in an appropriate way)!

@strong{Please note}: If you setup semantic for yourself following the
recommendations in the installation instructions of semantic then you
have probably added code to your startup-file like:

@example
(setq semantic-load-turn-everything-on t)
(require 'semantic-load)
@end example

Be aware that this also enables the minor-modes
@code{semantic-show-dirty-mode} and
@code{semantic-show-unmatched-syntax-mode} where the former one
highlights all code which has to be reparsed with dark background
(which results in large portions of dark background ;-) and the latter
one underlines all syntax which can not be parsed. Especially the
former one can be really annoying.

To switch off these modes you can add to your startup-file:

@example
(global-semantic-show-dirty-mode -1)
(global-semantic-show-unmatched-syntax-mode -1)
@end example

@anchor{Checking your hooks}
@item Checking your hooks

If you have already checked point (1.) and if you have still problems
getting ECB/semantic working properly for your sources you should
check the related major-mode hook. Every major-mode X has a hook with
name ``X-hook'' which is evaluated after activating the major-mode
(see above, 2.), e.g. the hook for the major-mode @code{c++-mode} is
@code{c++-mode-hook}.

Semantic adds automatically during load-time a special
``semantic-setup'' to these major-mode hooks@footnote{Of course only
for major-modes supported by semantic!} in form of a
``setup-function''. Example: For c and c++ modes semantic adds
@code{semantic-default-c-setup} to @code{c-mode-hook} and
@code{c++-mode-hook}.

If your own Emacs-setup (e.g. in @file{.emacs} or
@file{site-lisp/site-start.el}) overwrites such a major-mode-hook then
semantic can not be activated for this major-mode and in consequence
ECB can not work properly too!

Check if your Emacs-setup uses somewhere @code{setq} for adding code
to a major-mode-hook. @strong{IMPORTANT}: Use @code{add-hook} instead of
@code{setq}@footnote{@code{setq} replaces/overwrites the current
value of a hook with the new value whereas @code{add-hook}
@strong{adds} the new value to the old-value of the hook!}!

@end enumerate

If your source-files are ``running'' with correct @code{major-mode}
and correct major-mode hooks ECB and semantic will do what you expect
them doing!

@node Non-semantic files, , Setting up semantic, Setting up Emacs
@subsection Setup for file types not supported by semantic

From version 1.94 on ECB supports also parsing and displaying
file-contents for file-types not supported by semantic (i.e. there is
no semantic-grammar available for such file-types).

Such non-semantic file-types can often be parsed by imenu and/or
etags. Both of these parsing methods are now supported: ECB can
display the results of imenu and/or etags in its Method-buffer. ECB
uses for this speedbar-logic. Therefore the following speedbar options
takes effect for this feature:

@itemize @minus
@item @code{speedbar-dynamic-tags-function-list}
@item @code{speedbar-tag-split-minimum-length}
@item @code{speedbar-tag-regroup-maximum-length}
@item @code{speedbar-tag-hierarchy-method}
@end itemize

Normally there should no need for you to bother with these options,
because the default values are suitable for most situations! But if
you are not satisfied with the parsing/display results then you can
change some of these options.

@node First steps, , Setting up Emacs, Install and first steps
@section First steps after activating ECB first time

This section of the ECB online-help is displayed automatically by ECB
after activating ECB first time and describes what are the first basic
steps:

@enumerate

@item Configure where ECB can find your sources:

Call @code{M-x customize-option RET ecb-source-path RET}@footnote{This
means first hitting the keys @kbd{M} (Meta- or Alt-key) and @kbd{x}
simultaneously, inserting ``customize-option'' in the minibuffer,
hitting RETURN, inserting ``ecb-source-path'' in the minibuffer and
finally hitting RETURN again}. This lets you customize the option
@code{ecb-source-path} with the customize-feature of Emacs. This opens
a customize-buffer where you can insert all the directories where ECB
can find your source-files. Save your changes with the button ``Save
for future sessions'' and then throw away this customize-buffer either
by killing it with @code{M-x kill-buffer} or clicking at the button
``Finish''.

@item Take a look at the most important options of ECB
Call @code{M-x ecb-customize-most-important RET} and see a list of
options which you should at least know that these options exist.

@item Read the online-help of ECB:

The online-help of ECB is available via

@itemize @minus
@item calling @code{M-x ecb-show-help},
@item pressing @kbd{C-c . o} or
@item using the menu ``ECB''.
@end itemize

(The section you are currently reading is part of the online-help of
ECB)

Here is also the chapter ``Tips and tricks'' very interesting!

@item Start working with ECB.
@end enumerate

@node Overview, Activation and Deactivation , Install and first steps, Top
@chapter Overview

@cindex tree-buffer
@cindex ECB-windows
ECB is a global minor-mode which offers a couple of @dfn{ECB-windows}
for browsing your sources comfortable with the mouse and the keyboard.
These ``special'' windows are also called @dfn{tree-buffer} in this
manual. Every @dfn{item} in such a tree-buffer, i.e. every line, is
also called a @dfn{node} of this tree-buffer. See @ref{Tree-buffer
styles} to get an impression about the look&feel of these
tree-buffers. There are currently three different types of
ECB-windows/tree-buffers:

@itemize @minus
@item ECB-Directories
@item ECB-Sources
@item ECB-Methods
@end itemize

In addition to these ``special'' ECB-windows you have always an
@dfn{edit-area} where you can edit sour source-files. The edit-area
can be divided into several @dfn{edit-windows} - as many as you need
(@pxref{The edit-area}). And at the bottom of the ECB-frame a
durable @dfn{compilation-window} (also called @dfn{compile-window})
can be displayed (optional), where all the output of Emacs-compilation
(compile, grep etc.) is shown (@pxref{Temp- and compile-buffers}).

The following ``ascii-screenshot'' illustrates the typical layout of
the ECB-frame@footnote{This is only one example of the layouts ECB
offers, see @ref{Changing the ECB-layout}}:

@example
@group
------------------------------------------------------------------
|              |                                                 |
|  Directories |                                                 |
|              |                                                 |
|--------------|                                                 |
|              |                                                 |
|  Sources     |                                                 |
|              |                                                 |
|--------------|                   Edit-area                     |
|              |   (can be splitted in several edit-windows)     |
|  Methods     |                                                 |
|              |                                                 |
|--------------|                                                 |
|              |                                                 |
|  History     |                                                 |
|              |                                                 |
------------------------------------------------------------------
|                                                                |
|                 Compilation-window (optional)                  |
|                                                                |
------------------------------------------------------------------
@end group
@end example

In the following subsections the ``special'' ECB-windows will be
explained in detail.

@menu
* ECB Directories-buffer::      Contents of the ECB Directories-buffer
* ECB Sources-buffer::          Contents of the ECB Sources/history-buffer
* ECB Methods-buffer::          Contents of the ECB Methods-buffer
@end menu

@node ECB Directories-buffer, ECB Sources-buffer, Overview, Overview
@section ECB Directories-buffer

@cindex Directories
@itemize @bullet
@item
Select directories (and - if enabled - source files) in the
@dfn{ECB-Directories} buffer by clicking a mouse button on the directory
name or by hitting RETURN when the cursor is placed on the item line,
see @ref{Usage of ECB}.

IMPORTANT: If you use the POWER-click (i.e. hold down the SHIFT-key
while clicking with the primary mouse button (@pxref{Using the mouse})
or RETURN (@pxref{Using the keyboard})) on a directory node in the
this buffer then the directory-contents-cache for this directory will
be refreshed and actualized.

@item
Directory names with a ``[+]'' symbol after (or before) them can be
expanded/collapsed by clicking on the symbol, pressing the TAB key
(@pxref{Using the keyboard}) when the cursor is placed on the package
line or clicking a mouse button on the item, see @ref{Using the mouse}.

@item
Right clicking on an item will open a popup menu where different
operations on the item under the mouse cursor can be performed.

@item
Pressing F2 will open the ECB customization group
(@pxref{Customizing}) in the edit window. F3 shows the online help in
the edit-window. Pressing F4 in the ECB-directories buffer will offer
adding a new source-path.
@end itemize

@node ECB Sources-buffer, ECB Methods-buffer, ECB Directories-buffer, Overview
@section ECB Sources-buffer

@cindex Sources
@cindex History
@itemize @bullet
@item
Source files can be selected by clicking with the primary mouse button
(@pxref{Using the mouse}) or hitting RETURN (@pxref{Using the
keyboard}) on the source row in the @dfn{ECB-Sources} or
@dfn{ECB-History} windows. The buffer of the selected source-file will
be displayed in an edit-window - which one depends on the setting in
@code{ecb-mouse-click-destination}.

IMPORTANT: If you use the POWER-click (i.e. hold down the SHIFT-key
while clicking with the primary mouse button (@pxref{Using the mouse})
or RETURN (@pxref{Using the keyboard})) on a source row in the
ECB-Sources or ECB-History windows then the source will not be
displayed in an edit-window but it will be scanned in the background
and all its contents (e.g. methods and variables) are listed in the
@dfn{ECB Methods} window (@pxref{ECB Methods-buffer}. So you can get an
overlook over the source without changing the buffer in the
edit-window.

@item
Clicking on the source file with the secondary mouse button or
C-RETURN (@pxref{Usage of ECB}) will open the source file in
another edit window - which one depends on the setting in
@code{ecb-mouse-click-destination}. 

@item
Right clicking on a source file (mouse-button 3) will open a popup
menu where different operation on the item under the mouse cursor can
be performed.
@end itemize

@node ECB Methods-buffer, , ECB Sources-buffer, Overview
@section ECB Methods-buffer

@cindex Methods
The @dfn{ECB-Methods} buffer contains all parsed and recognized tags
of the current source-buffer. It is called ``Method-buffer'' because
ECB is mostly designed for browsing sourcecode files and for
programming-languages these tags are often methods (and variables
etc.) To simplify explanations we talk in the following only about
methods and variables - but in general the method-buffer can contain
any kind of tags (e.g. sections and subsections for texinfo
buffers).

@itemize @bullet
@item
When a method/variable is selected with the primary mouse button
(@pxref{Using the mouse}) or RETURN (@pxref{Using the keyboard}) the
buffer in the edit-window (which one depends on the setting in
@code{ecb-mouse-click-destination}) will jump to the method/variable.

IMPORTANT: If you use the POWER-click (i.e. hold down the SHIFT-key
while clicking with the primary mouse button (@pxref{Using the mouse})
or RETURN (@pxref{Using the keyboard})) on a node in this buffer then
the edit-buffer will be narrowed to the selected tag (see also
option @code{ecb-tag-visit-post-actions}). But this works only for
sources parsed by semantic, not by imenu or etags!

@item
Clicking on a method/variable with the secondary mouse button or C-RETURN
(@pxref{Usage of ECB}) will jump to the method in another edit window
- which one depends on the setting in
@code{ecb-mouse-click-destination}.

@item
Right clicking on a method/variable will open a popup menu where
different operation on the item under the mouse cursor can be
performed.
@end itemize

@node Activation and Deactivation, Usage of ECB, Overview, Top
@chapter Activation and Deactivation

@noindent
This chapter describes all aspects of activating and deactivating ECB.

@menu
* Standard activation::         How to manually (de)activate ECB
* Automatic activation::        Automatically (de)activating ECB
@end menu

@strong{IMPORTANT}: Regardless of the activation-type (standard or
automatic) the activation-process of ECB is always completely
failure-save. This means any error during any step of the
activation-process forces a complete cleanup (e.g. removing hooks,
disabling advices etc.) of all settings ECB did (e.g. adding hooks,
activating advices etc.) until the failure. Therefore if
ECB-activation stops cause of a failure then you can be sure that your
Emacs has the same state as before the ECB-activation-start!

@node Standard activation, Automatic activation, Activation and Deactivation, Activation and Deactivation
@section Standard activation and deactivation

Call @kbd{M-x ecb-activate} and @kbd{M-x ecb-deactivate} to activate
or deactivate ECB@footnote{Activation is also possible via the menu
``Tools --> Start Code Browser (ECB)''.}. If you want ECB started in a
new frame see the option @code{ecb-new-ecb-frame} (default is nil).
@code{ecb-activate} always raises and selects the ECB-frame even if
ECB is already started.

@cindex minor mode
Because ECB is a global minor-mode it can also be
(de)activated/toggled by @kbd{M-x ecb-minor-mode}.

@cindex Activation hook-sequence
@anchor{Activation hook-sequence}
The following sequence of hooks is evaluated during activation of ECB:
@enumerate
@item @code{ecb-before-activate-hook}
@item <All actions for activation but no layout drawing>
@item @code{ecb-activate-before-layout-draw-hook}
@item @code{ecb-redraw-layout-before-hook}
@item <Drawing the layout>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-activate-hook}
@end enumerate

@anchor{Deactivation hook-sequence}
@cindex Deactivation hook-sequence
The following sequence of hooks is evaluated during deactivation of
ECB:
@enumerate
@item @code{ecb-before-deactivate-hook}
@item <All actions for deactivation of ECB>
@item @code{ecb-deactivate-hook}
@end enumerate

@node Automatic activation, , Standard activation, Activation and Deactivation
@section Automatic activation and deactivation

@cindex Automatic activation
@cindex Automatic deactivation
There are two ways for auto. (de)activation ECB after Emacs-start and
for different window-configurations.

@table @code
@item ecb-auto-activate
This option is for auto. activating ECB after Emacs-startup. Set this
to not nil and ECB will automatically be started after Emacs comes up.

@item window-manager support
The window-manager support of ECB deactivates ECB when going to
another window-configuration and reactivates ECB when coming back to
the ECB-window-configuration. For all details about this see
@ref{Window-managers and ECB}.
@end table

@node Usage of ECB, Customizing, Activation and Deactivation, Top
@chapter Usage of ECB

This chapter describes in a detailed manner all aspects of using the
Emacs Code Browser.

@menu
* Using the mouse::             Working with the mouse
* Using the keyboard::          Working with the keyboard
* The edit-area::               How to use the edit-area
* Temp- and compile-buffers::   Displaying temp- and compilation-buffers
* The other window::            How the ``other window'' is determined
* The Methods buffer::          Using and customizing he Methods-buffer
* The ECB-layout::              Changing, customizing, redrawing, creating
* Hiding the ECB windows::      Hiding/Showing the ECB-windows
* Maximizing the ECB windows::  Maximizing the ECB-windows
* Back/forward navigation::     Back- and forward navigation like a browser
* ECB-window synchronizing::    Auto./manual synchronizing the ECB-windows
* Interactive ECB commands::    All interactive user-commands of ECB
@end menu

@node Using the mouse, Using the keyboard, Usage of ECB, Usage of ECB
@section Working with the mouse in the ECB-windows

@cindex primary button
@cindex secondary button
@cindex mouse button
Normally you get best usage if you use ECB with a mouse. ECB
distinguishes between a @dfn{primary} and a @dfn{secondary}
mouse-button.

With the option @code{ecb-primary-secondary-mouse-buttons} the following
combinations of primary and secondary mouse-buttons are possible:

@itemize @minus
@item
primary: mouse-2, secondary: C-mouse-2@footnote{means mouse-2 while CTRL-key
is pressed.}. This is the default.

@item
primary: mouse-1, secondary: C-mouse-1

@item
primary: mouse-1, secondary: mouse-2
@end itemize

If you change this during ECB is activated you must deactivate and activate
ECB again to take effect.

@subsection The primary mouse-button

A click with the primary button causes the main effect in each ECB-buffer:

@itemize @minus
@item ECB Directories:
Expanding/collapsing nodes and displaying files in the ECB-Sources
buffer.

@item ECB sources/history:
Opening the file in that edit-window specified by the option
@code{ecb-mouse-click-destination}.

@item ECB Methods:
Jumping to the method in that edit-window specified by the option
@code{ecb-mouse-click-destination}.
@end itemize

@subsection The POWER- or SHIFT-click

@cindex SHIFT-click
@cindex POWER-click
A click with the primary mouse-button while the SHIFT-key is pressed
is called the POWER-click and does the following (depending on the
ECB-buffer where the POWER-click occurs):

@itemize @minus
@item ECB Directory:
Refreshing the directory-contents-cache (see
@code{ecb-cache-directory-contents}).

@item ECB sources/history:
Only displaying the source-contents in the method-buffer but not
displaying the source-file in an edit-window. This means it opens the
clicked source only in the background and shows all its
methods/variables in ECB-Methods; the buffer of the edit-window is not
changed! This is very useful to get only an overlook for a certain
source.

@item ECB Methods:
Narrowing to the clicked method/variable/ect... (see
@code{ecb-tag-visit-post-actions}). But this works only for sources
parsed by semantic, not by imenu or etags!
@end itemize

Per default the complete node-name of an item in a tree-buffer is
displayed in the echo-area if the mouse moves over it, regardless if
the related window is the active one or not. You get the same effect
always after a POWER-click. In general: Via
@code{ecb-show-node-info-in-minibuffer} you can specify in a detailed
manner for every ECB tree-buffer when and which node-info should be
displayed in the minibuffer.

@subsection The secondary mouse-button

The secondary mouse-button is for opening (jumping to) the file in
another edit-window (see the documentation of the option
@code{ecb-mouse-click-destination}).

@subsection The right mouse-button

In each ECB-buffer mouse-3 (= right button) opens a special context
popup-menu for the clicked item where you can choose several senseful
actions.

With the options @code{ecb-directories-menu-user-extension},
@code{ecb-sources-menu-user-extension},
@code{ecb-methods-menu-user-extension} and
@code{ecb-history-menu-user-extension} you can add statically new
commands to the popup-menus. See the docstring of
@code{ecb-directories-menu-user-extension} for more details.

With the options @code{ecb-directories-menu-user-extension-function},
@code{ecb-sources-menu-user-extension-function},
@code{ecb-methods-menu-user-extension-function} and
@code{ecb-history-menu-user-extension-function} you can add new
commands to the popup-menus in a dynamic manner. See the docstring of
@code{ecb-directories-menu-user-extension-function} for more details.

With the options @code{ecb-directories-menu-sorter},
@code{ecb-sources-menu-sorter}, @code{ecb-methods-menu-sorter} and
@code{ecb-history-menu-sorter} you can even re-arrange all the entries
of the popup-menus.

@subsection Horizontal scrolling with the mouse

In each tree-buffer of ECB you can easily scroll left and right with
the mouse if the option @code{ecb-tree-easy-hor-scroll} is not
@code{nil}.

The reason for this is: XEmacs has horizontal scroll-bars so invisible
parts beyond the right window-border of a tree-buffer can always made
visible very easy.

GNU Emacs does not have hor. scroll-bars so especially with the mouse
it is quite impossible to scroll smoothly right and left. The
functions @code{scroll-left} and @code{scroll-right} can be annoying
and are also not bound to mouse-buttons.

ECB offers three ways for smoothly hor. scrolling with GNU Emacs if
@code{ecb-tree-easy-hor-scroll} is a positive integer-value S:

@itemize @bullet
@item
In all ECB-tree-buffers the keys @kbd{M-mouse-1} and @kbd{M-mouse-3}
are bound to scrolling left rsp. right with scroll-step S.

@item
Clicking with mouse-1 or mouse-2 onto the edge of the modeline has the
same effect, i.e. if you click with mouse-1 onto the left \(resp
right) edge of the modeline you will scroll left \(resp. right) with
scroll-step S.

@item
Additionally @kbd{C-M-mouse-1} and @code{C-M-mouse-3} are bound to
scrolling left rsp. right with scroll-step @code{window-width} - 2.
@end itemize

This is NOT done for XEmacs cause of its horizontal scrollbars. If you
want scrolling left and right with the mouse in XEmacs then activate
the horizontal scrollbars.


@node Using the keyboard, The edit-area, Using the mouse, Usage of ECB
@section Working with the keyboard in the ECB-windows

ECB offers the @code{ecb-mode-map} which binds the most important
functions of ECB to keys so you can easily use ECB in every
window@footnote{Regardless if a tree-window or an edit-window} without
a mouse.

IMPORTANT: Do not modify @code{ecb-mode-map} directly! The option
@code{ecb-key-map} defines all ECB keybindings, including a common
prefix-key (This is by default @kbd{C-c .}). If there are conflicts
with other minor-modes or packages you can define very easy another
prefix. Please read carefully the description of @code{ecb-key-map}
(@pxref{ecb-general}).!

The following sections describe special topics about using the
keyboard in the ECB-tree-buffers:

@menu
* Navigation/Selection::        Keyboard navigation/selection in a tree-buffer
* Incremental search::          Find nodes as fast as possible
* Personal keybindings::        Adding personal keybindings to a tree-buffer
* Using popup-menus::           Using the popup-menus from keyboard.
@end menu

@node Navigation/Selection, Incremental search, Using the keyboard, Using the keyboard
@subsection Navigation and Selection in a tree-buffer

@cindex RETURN key
@cindex TAB key
@cindex expanding
@cindex collapsing
In the ECB-buffers RETURN and TAB are the most important keys:

@itemize @bullet
@item
RETURN does the same as the primary button and C-RETURN does the same
as the secondary button. S-RETURN is the same as the SHIFT-click or
POWER-click. The terms ``primary'', ``secondary'', ``SHIFT-'' and
``POWER-click'' are explained in @ref{Using the mouse}. See also the
option @code{ecb-tree-RET-selects-edit-window} and the function
@code{ecb-toggle-RET-selects-edit-window} which is bound to @kbd{C-t}
in each tree-buffer of ECB!

@item
TAB always expands or collapses expandable nodes.
@end itemize

The RETURN and TAB keys can not be (re)defined with @code{ecb-key-map}!

If you set @code{ecb-tree-navigation-by-arrow} to not nil then the left- and
right-arrow keys work in the ECB tree-window in the following smart way:

@itemize @bullet
@item
Left-arrow: If node is expanded then it will be collapsed otherwise
(i.e. current node is either not expandable or not expanded) point
jumps to the next ``higher'' node in the hierarchical tree (higher
means the next higher level or - if no higher level available
- the next higher node on the same level).

@item
Right-arrow: If node is expandable but not expanded then it will be
expanded. Otherwise (i.e. current node is either not expandable or
already expanded) point jumps to the next following node (which is the
first subnode in case of an already expanded node or simply the next
node in the following line).
@end itemize


@node Incremental search, Personal keybindings, Navigation/Selection, Using the keyboard
@subsection Incremental search for a node in current tree-buffer

@cindex Incremental search
Each display-able key (e.g. all keys normally bound to @code{self-insert-command})
is appended to the current search-pattern. The tree-buffer tries to jump to the
first node which matching the current search-pattern either as substring or as
prefix (see below). If no match is found then nothing is done. There are some
special keys:

@itemize @bullet
@item @kbd{backspace} and @kbd{delete}:
Delete the last character from the search-pattern.

@item @kbd{home}:
Delete the complete search-pattern

@item @kbd{end}:
Expand either to a complete node if current search-pattern is already
unique or expands to the greatest common substring or prefix of the
nodes. If there are at least two nodes with the same greatest
common-prefix than every hit of @kbd{end} jumps to the next node with this
common prefix.
@end itemize

For better overlooking the current search-pattern is shown in the echo area.
After selecting a node with RET the search-pattern is cleared out. With
@code{ecb-tree-incremental-search} you can specify if the current search-pattern
must be a real prefix of the node (default) or if any substring is matched.

For faster and easier finding the right node in a ecb-window the incremental
search ignores the following non interesting stuff:

@itemize @minus
@item any leading spaces
@item expand/collapse-buttons: [+] rsp. [-]
@item protection-signs (+, -, #) in the method-window if uml-notation is used
@item variables types or return-types in front of variable- or method-names.
@item const specifier for variables
@end itemize

This means: Just type in the prefix (rsp. a substring) of a class-,
variable-, method-, directory- or filename and ECB will bring you as
fast as possible to the node you want. Incremental node-search uses
the value of @code{case-fold-search}.

Tip: The @code{ecb-minor-mode} offers you in the @code{ecb-mode-map}
(customizable via @code{ecb-key-map}) some keys for selecting every window
of the ecb-frame. This makes window-selection a child�s play. For
example you can jump into the method-window by hitting @kbd{C-c . gm}.

@node Personal keybindings, Using popup-menus, Incremental search, Using the keyboard
@subsection Adding personal keybindings

There are five hooks which can be used for adding personal keybindings
to the ECB tree-buffers:

@itemize @minus
@item @code{ecb-common-tree-buffer-after-create-hook}
@item @code{ecb-directories-buffer-after-create-hook}
@item @code{ecb-sources-buffer-after-create-hook}
@item @code{ecb-methods-buffer-after-create-hook}
@item @code{ecb-history-buffer-after-create-hook}
@end itemize

These hooks are called directly after tree-buffer creation so they can
be used to add personal local keybindings@footnote{To be more general:
They can be used to run any arbitrary lisp code after a tree-buffer
creation!} either to all tree-buffers
(@code{ecb-common-tree-buffer-after-create-hook}) or just to a certain
tree-buffer. Here is a list which keys MUST NOT be rebound:

@itemize @bullet
@item @kbd{RET} and all combinations with @kbd{Shift} and @kbd{Ctrl}:
Used for selecting nodes in all tree-buffers.
@item @kbd{TAB}:
Used for expanding/collapsing nodes in all tree-buffers.
@item @kbd{C-t}:
Used for toggling ``jump after selection'' in all tree-buffers, see
command @code{ecb-toggle-RET-selects-edit-window}.
@item All self-inserting characters:
Used for easy and fast navigation in all tree-buffers,
@xref{Incremental search}.
@item @kbd{F2}, @kbd{F3}, @kbd{F4}:
Used for customizing ECB, adding source-path in the directories buffer.
@end itemize

The following example binds @kbd{C-a} to some useful code in ALL
tree-buffers and @kbd{C-d} to even more useful code ONLY in the
directories buffer:

@example
@group
(add-hook 'ecb-common-tree-buffer-after-create-hook
          (lambda ()
             (local-set-key (kbd "C-a")
                            (lambda ()
                               (interactive)
                               (message "ECB is great!")))))

(add-hook 'ecb-directories-buffer-after-create-hook
          (lambda ()
             (local-set-key (kbd "C-d")
                            (lambda ()
                               (interactive)
                               (message "ECB is wonderful!")))))
@end group
@end example

@node Using popup-menus, ,Personal keybindings, Using the keyboard
@subsection Using the popup-menu of a tree-buffer from keyboard.

@cindex tmm
A popup-menu of a tree-buffer can be activated from keyboard with the
command @code{tree-buffer-show-menu-keyboard} which is bound to
@kbd{M-m} in every tree-buffer. How the popup-menu is displayed
depends if this command is called with a prefix-argument or not:

If called without a prefix-arg then the popup-menu is displayed
graphically as if it would be activated via mouse (for GNU Emacs this
works perfectly but for XEmacs there is a bug which results in a wrong
menu-position - but the menu itself works also with XEmacs).

If called with a prefix-arg (@kbd{C-u M-m}) then the popup-menu is
displayed with the tmm-mechanism (like the Emacs-[menu-bar] is
displayed when `tmm-menubar' is called). This tmm-display is only
available for GNU Emacs.


@node The edit-area, Temp- and compile-buffers, Using the keyboard, Usage of ECB
@section Working with the edit-window(s) of the edit-area

@cindex edit-window
ECB offers you all what you need to work with the edit-area as if the
edit-windows of the edit-area would be the only windows of the
ECB-frame.

@cindex Adviced functions
ECB offers you to advice the following functions so they work best with ECB:

@itemize @minus
@item @code{other-window}
@item @code{delete-window}
@item @code{delete-other-windows}
@item @code{delete-windows-on}
@item @code{split-window-horizontally}
@item @code{split-window-vertically}
@item @code{split-window}
@item @code{display-buffer}
@item @code{switch-to-buffer}
@item @code{switch-to-buffer-other-window}
@item @code{other-window-for-scrolling}
@item @code{balance-windows}
@end itemize


The behavior of the adviced functions is (slightly simplified):

@itemize @bullet
@item
All these adviced functions behaves exactly like their corresponding
original functions but they always act as if the edit-window(s) of ECB
would be the only window(s) of the ECB-frame. So the edit-window(s) of
ECB seems to be a normal Emacs-frame to the user. This means that you
can split and delete edit-windows without any restriction - ECB
ensures that neither the special ECB-windows nor the compile-window
will be damaged.

@item
If there is a durable compile-window (@pxref{Temp- and
compile-buffers}) then all compilation-buffers in the sense of
@code{ecb-compilation-buffer-p} will be displayed in the
compile-window.

@item
If called in another frame than the ECB-frame these functions behave
exactly like the not adviced original versions!
@end itemize

ATTENTION: If you want to work within the edit-area with splitting and
unsplitting (i.e. deleting) the edit-window(s) it is highly
recommended to use the adviced-functions of ECB instead of the
original Emacs-functions (see above). Per default ECB advices all of
the functions mentioned above but with the option
@code{ecb-advice-window-functions} you can customizes which functions
should be adviced by ECB. Please read carefully the documentation of
this option!

Another interesting option in the context of the edit-window and these
adviced functions is @code{ecb-layout-always-operate-in-edit-window}!

@subsection Documentation of the adviced window functions

This section describes for every adviced window function (s.a.) how it
differs from the original version. Only the differences are mentioned,
so if you want the full documentation of such a function call
@code{describe-function} or @kbd{C-h f}.

@deffn Command other-window ARG &optional ALL-FRAMES
Around-advice @code{ecb}: The ECB-version of @code{other-window}.
Works exactly like the original function with the following
ECB-adjustment: The behavior depends on
@code{ecb-other-window-behavior}.
@end deffn

@deffn Command delete-window &optional WINDOW
Around-advice @code{ecb}: The ECB-version of @code{delete-window}.
Works exactly like the original function with the following
ECB-adjustment:

If optional argument WINDOW is nil (i.e. probably called
interactively): If called in a splitted edit-window then it works like
as if all the edit-windows would be the only windows in the frame.
This means the current edit-window which contains the point will be
destroyed and its place will be occupied from another one. If called
in an unsplitted edit-window then nothing is done. If called in the
compile-window of ECB then the compile-window will be hidden (like
with @code{ecb-toggle-compile-window}). If called in an ecb-window
of the current ECB-layout there are two alternatives:

@itemize
@item If the function is contained in
@code{ecb-layout-always-operate-in-edit-window} the right edit-window
is selected (depends on the value of the option
@code{ecb-mouse-click-destination}) and does then it�s job.

@item Otherwise the behavior depends on the value of the option
@code{ecb-advice-window-functions-signal-error}.
@end itemize

If optional argument WINDOW is a living window (i.e. called from
program): If WINDOW is an edit-window then this window is deleted, if
WINDOW is the compile-window then it will be hidden and otherwise the
behavior depends on @code{ecb-advice-window-functions-signal-error}.
@end deffn

@deffn Command delete-other-windows &optional WINDOW
Around-advice @code{ecb}: The ECB-version of
@code{delete-other-windows}. Works exactly like the original function
with the following ECB-adjustment:

If optional argument WINDOW is nil (i.e. probably called
interactively): If called in a splitted edit-window then it works like
as if all the edit-windows would be the only windows in the frame.
This means all other edit-windows besides the current edit-window
which contains the point will be destroyed and the current edit-window
fills the whole edit-area. Neither the special ecb-windows nor the
compile-window will be destroyed!

@itemize

@item
If called in an unsplitted edit-window then either the compile-window
will be hidden (if there is one) otherwise nothing is done.

@item
If called in one of the ecb-windows then the current one is maximized,
i.e. the other ecb-windows (not the edit-windows!) are deleted.

@item
If called in the compile window there are two alternatives:

@itemize @minus
@item
If the function is contained in
@code{ecb-layout-always-operate-in-edit-window} the right edit-window
is selected (depends on the value of the option
@code{ecb-mouse-click-destination}) and then it does it�s job.

@item
Otherwise the behavior depends on the value of the option
@code{ecb-advice-window-functions-signal-error}.
@end itemize
@end itemize

If optional argument WINDOW is a living window (i.e. called from
program): If WINDOW is an edit-window then this window is maximized
(i.e. the other edit-window is deleted) if there are more at least 2
edit-windows otherwise the compile-window is deleted (if there is
one). If WINDOW is an ecb-window then only the other ecb-windows are
deleted and in all other cases the behavior depends on
@code{ecb-advice-window-functions-signal-error}.
@end deffn


@deffn Command delete-windows-on BUFFER &optional FRAME
Around-advice @code{ecb}: The ECB-version of @code{delete-windows-on}.
Works exactly like the original function with the following
ECB-adjustment:

An error is reported if @var{BUFFER} is an ECB-tree-buffer. These
windows are not allowed to be deleted.
@end deffn

@deffn Command split-window &optional WINDOW SIZE HORFLAG
Around-advice @code{ecb}: The ECB-version of @code{split-window}.
Works exactly like the original function with the following
ECB-adjustment:

If called for a not-edit-window in the @code{ecb-frame} it stops with
an error if @code{split-window} is not contained in the option
@code{ecb-layout-always-operate-in-edit-window}! Besides this (e.g.
called for a window in another frame than the @code{ecb-frame}) it
behaves like the original version.
@end deffn


@deffn Command split-window-horizontally
Around-advice @code{ecb}: The ECB-version of
@code{split-window-horizontally}. Works exactly like the original
function with the following ECB-adjustment:

If called in any other window of the current ECB-layout it stops with
an error if this @code{split-window-horizontally} is not contained in
the option @code{ecb-layout-always-operate-in-edit-window}!
@end deffn

@deffn Command split-window-vertically
Around-advice @code{ecb}: The ECB-version of
@code{split-window-vertically}. Works exactly like the original
function with the following ECB-adjustment:

If called in any other window of the current ECB-layout it stops with
an error if this @code{split-window-vertically} is not contained in
the option @code{ecb-layout-always-operate-in-edit-window}!
@end deffn


@deffn Command display-buffer BUFFER &optional NOT-THIS-WINDOW FRAME
Around-advice @code{ecb}: Makes this function compatible with ECB if
called in or for the ecb-frame. It displays all buffers which are
``compilation-buffers'' in the sense of
@code{ecb-compilation-buffer-p} in the compile-window of ECB. If the
compile-window is temporally hidden then it will be displayed first.

If there is no compile-window (@code{ecb-compile-window-height} is
nil) then it splits the edit-window if unsplitted and displays BUFFER
in another edit-window but only if @code{pop-up-windows} is not nil
(otherwise the edit-window will not be splitted).

If called from outside the edit-area for a non-``compilation-buffers''
(s.a.) then it behaves as if called from within an edit-window if
@code{display-buffer} is contained in
@code{ecb-layout-always-operate-in-edit-window}: It depends on
@code{pop-up-windows} if the edit-window is automatically splitted ot
not. If @code{ecb-layout-always-operate-in-edit-window} does not
contain @code{display-buffer} then the buffer is displayed in the
edit-window without splitting it (if unsplitted).

If BUFFER is contained in @code{special-display-buffer-names} or
matches @code{special-display-regexps} then
@code{special-display-function} will be called (if not nil). But this
behavior depends on the value of the option
@code{ecb-ignore-special-display}. The values of
@code{same-window-buffer-names} and @code{same-window-regexps} are
supported as well.

See the option @code{ecb-ignore-display-buffer-function}!

If called for other frames it works like the original version.
@end deffn

@deffn Command switch-to-buffer BUFFER &optional NORECORD
Around-advice @code{ecb}: The ECB-version of @code{switch-to-buffer}.
Works exactly like the original but with the following enhancements
for ECB:

``compilation-buffers'' in the sense of
@code{ecb-compilation-buffer-p} will be displayed always in the
compile-window of ECB (if @code{ecb-compile-window-height} is not nil)
- if the compile-window is temporally hidden then it will be displayed
first. If you do not want this you have to modify the options
@code{ecb-compilation-buffer-names},
@code{ecb-compilation-major-modes} or
@code{ecb-compilation-predicates}.

If called for non ``compilation-buffers'' (s.a.) from outside the
edit-area of ECB it behaves as if called from an edit-window if
@code{switch-to-buffer} is contained in the option
@code{ecb-layout-always-operate-in-edit-window}. Otherwise an error is
reported.
@end deffn

@deffn Command switch-to-buffer-other-window BUFFER &optional FRAME
Around-advice @code{ecb}: The ECB-version of
@code{switch-to-buffer-other-window}. Works exactly like the original
but with some adaptions for ECB so this function works in a
``natural'' way:

If called in any special ecb-window of the current ECB-layout then it
goes always to an edit-window (which one depends on the setting in
@code{ecb-mouse-click-destination}) and then goes on as if called from
this edit-window.

If a compile-window is used (i.e. @code{ecb-compile-window-height} is
not nil) then ``compilation-buffers'' in the sense of
@code{ecb-compilation-buffer-p} are always displayed in the
compile-window. If the compile-window is temporally hidden then it
will be displayed first. If no compile-window is used it behaves like
the original.

If called from within the compile-window then ``compilation-buffers''
will be displayed still there and all other buffers are displayed in
one of the edit-windows - if the destination-buffer is already
displayed in one of the edit-windows then this one is used otherwise
it behaves like the original.

If called within an edit-window it behaves like the original function
except for compilation-buffers (if a compile-window is used, see
above).
@end deffn


@deffn Function other-window-for-scrolling
Around-advice @code{ecb}: This function determines the window which is
scrolled if any of the ``other-window-scrolling-functions'' is called
(e.g. @code{scroll-other-window}):

If the option @code{ecb-scroll-other-window-scrolls-compile-window} is
not nil (maybe set by
@code{ecb-toggle-scroll-other-window-scrolls-compile}) and a
compile-window is visible then always the current buffer in the
compile-window is scrolled!

Otherwise it depends completely on the setting in
@code{ecb-other-window-behavior}.
@end deffn

@deffn Command balance-windows
Around-advice @code{ecb}: When called in the @code{ecb-frame} then
only the edit-windows are balanced.
@end deffn

@node Temp- and compile-buffers, The other window, The edit-area, Usage of ECB
@section Temp- and compile-buffers display in ECB

@cindex temporary buffers
@cindex help buffers
@cindex compilation buffers
@cindex grep buffers
If you call any help in Emacs, e.g. by calling @code{describe-function}, or
if you do a completion in the minibuffer, then Emacs displays the
result-buffer in another window. This behavior you have also in ECB.

@subsection Standard Emacs behavior

If the edit-area is already splitted into at least two edit-windows
then the temp-buffer is displayed in another edit-window otherwise the
edit-are will be splitted first into two edit-windows, one above the
other. The variables @code{temp-buffer-max-height} and
@code{temp-buffer-resize-mode} (the latter one does not exist in
XEmacs) work also correctly with ECB.

Same for all compilation output-buffers (e.g. after a @code{compile} or
@code{grep}) and the variable @code{compilation-window-height}.

This is default behavior of ECB. But there is also another way to
display such buffers: Using a durable extra window at the bottom of
the ECB-frame:

@subsection Using a durable compile window

With the option @code{ecb-compile-window-height} you can define if the
ECB layout should contain per default a compile-window at the
bottom (just specify the number of lines which should be used for the
compile-window at the bottom of the frame). If ``yes'' ECB displays
all buffers for which the function @code{ecb-compilation-buffer-p}
returns not nil (e.g. all output of compilation-mode (compile, grep
etc.) or all temp-buffers like *Help*-buffers) in this special
window.

In general: With the options @code{ecb-compilation-buffer-names},
@code{ecb-compilation-major-modes} and
@code{ecb-compilation-predicates} you can define which buffers should
be displayed in the compile-window of ECB (for example if you call
@code{switch-to-buffer} or @code{display-buffer} or if you run
@code{compile} or if you display *Help*-buffers). Per default these
are all temp-buffers like *Help*-buffers, all compile- and grep
buffers, *Occur*-buffers etc. See the default values of these options.

With the command @code{ecb-toggle-compile-window} (bound to @kbd{C-c .
\}) you can toggle the visibility of the compile-window
(@pxref{Interactive ECB commands}).

There are some more useful options and commands related to the
compile-window of ECB (to see all options for the compile-window see
the customization group @ref{ecb-compilation}):

@itemize @bullet
@item
With the option @code{ecb-compile-window-temporally-enlarge} you can
allow Emacs to enlarge temporally the ECB-compile-window in some
situations. Please read the comment of this option. See also the
description of the command
@code{ecb-toggle-compile-window-height}.

@item
With the option @code{ecb-enlarged-compilation-window-max-height} you
specify how @code{ecb-toggle-compile-window-height} should
enlarge the compile-window.

@item
With the command @code{ecb-cycle-through-compilation-buffers}
(@pxref{Interactive ECB commands}) you can cycle through all current
open compilation-buffers (in the sense of
@code{ecb-compilation-buffer-p}) very fast.
@end itemize

ECB offers the same compile-window functionality regardless if the
ECB-window are hidden or not. The state of the compile-window will be
preserved when toggling the ecb-windows or when maximizing one
ecb-windows! So you have the advantage of one special window for all
help-, grep or compile-output (see above) also when the ecb-windows
are hidden - a window which will not be deleted if you call
@code{delete-other-windows} (bound to @kbd{C-x 1}) for one of the
edit-windows. In general: All features of the compile-window work with
hidden ecb-windows exactly as when the ecb-windows are visible.


@anchor{Problems with the compile window}
@subsection What to do if there are problems with the compile-window

Normally displaying temp- and compilation-buffers (or more general:
displaying buffer for which @code{ecb-compilation-buffer-p} is not
nil) should work reliable. But if there are problems which you can not
handle with the options @code{ecb-compilation-buffer-names},
@code{ecb-compilation-major-modes} or
@code{ecb-compilation-predicates} then please go on like follows:

@enumerate
@item
Set the option @code{ecb-layout-debug-mode} to not nil.

@item
Reproduce the wrong behavior exactly by repeating all the operations
which lead to the problem. If possible then restart Emacs before
reproducing the problem so you can begin from the beginning!

@item
Now send immediately a bug report with
@code{ecb-submit-problem-report}.

@item
Set @code{ecb-layout-debug-mode} back to nil if you do not want
further debugging output in the *Messages* buffer"
@end enumerate

@anchor{Using special-display with ECB}
@cindex special-display
@subsection Handling special-display-buffers

Emacs offers three options for a special-display-handling of certain
buffers: @code{special-display-function},
@code{special-display-buffer-names} and
@code{special-display-regexps} (see the Emacs manual for a description
of these options). ECB offers an option
@code{ecb-ignore-special-display} for specification in which
situations ECB should take account for the values of these
special-display-options.

Default-behavior of ECB is to ignore these special-display-options
when a durable compile-window is active (i.e.
@code{ecb-compile-window-height} is not nil). But with
@code{ecb-ignore-special-display} you can tell ECB, that either always
the special-display-options should be ignored as long as ECB is active
or that they should be never igored regardless if a durable
compile-window is set or not. In the latter case using
@code{display-buffer} or @code{pop-to-buffer} takes always account for
the values of these options - like the original behavior of Emacs.

@node The other window, The Methods buffer, Temp- and compile-buffers, Usage of ECB
@section How the ``other window'' is determined by ECB

@cindex other window
Normally all windows in an Emacs-frame are arranged in a cyclic order
and window-selecting-commands like @code{other-window} or
window-scrolling-commands like @code{scroll-other-window} choose
simply the next@footnote{@code{other-window} allows to select ARG'th
different window, i.e. the window ARG steps away from current window
in the cyclic order of the windows} window after the current window as
``other window''.

@subsection ``Other window''-basics in ECB

With a typical window-layout of ECB such a cyclic order of
@strong{all} windows in the ECB-frame does not make sense because it
would be not very intuitive and against that what the user wants to
``say'' when calling @code{other-window} or
@code{scroll-other-window}.

Therefore ECB divides the whole set of windows of the ECB-frame in
several subsets:

@itemize @bullet
@item The edit-windows of the edit-area
@item The special tree-windows for browsing-tasks
@item The compile-window at the bottom (if there is one)
@item The minibuffer-window of the ECB-frame (if active)
@end itemize

Each of these subsets will be treated as a cyclic ordered subset, i.e.
all windows in each of these subsets are ordered as the function
@code{walk-windows} would visit the windows when the windows of a
subset would be the only windows of a
frame@footnote{@code{other-window} uses the same window-ordering as
@code{walk-windows}}.

@subsection Builtin ``other window'' behaviors of ECB

ECB now offers to specify the behavior of commands like
@code{other-window} or @code{scroll-other-window} within the
ECB-frame. This can be done with the option
@code{ecb-other-window-behavior}. This option offers several builtin
behaviors:

@itemize @bullet
@item All windows of the ECB-frame are considered

ECB will cycle through all windows of the ECB-frame or scroll simply
the next window in the ECB-frame, means it behaves like the original
@code{other-window} rsp. the original
@code{other-window-for-scrolling}.

@item Only the windows of the edit-area are considered

ECB will only cycle through the edit-windows of ECB or only scroll
another edit-window. If the selected window is not an edit-window then
all windows are taken into account.

@item The edit-windos and the compile-window are considered

Like above but the compile-window will be added to the subset of the
edit-windows.

@item Behave as smart and intuitive as possible

This is the default behavior of ECB. ECB tries to choose the
@code{other-window}-destination or the ``other window'' to scroll in a
smart and intuitive way: If point is in one of the edit-windows and if
the edit-area is splitted then always the ``next'' edit-window is
choosen (whereas the next edit-window of the last edit-window is the
first edit-window)- if the edit-area is unsplitted then the
compile-window is used if there is one. In the context of an
@code{other-window}-call the @var{ARG} of @code{other-window} will be
taken into account.

If one of the special ecb-windows is selected then always the ``next''
ecb-window is choosen (whereas the next ecb-window of the last
ecb-window is the first ecb-window). In the context of an
@code{other-window}-call the @var{ARG} of @code{other-window} will be
taken into account.

If the compile-window is selected then always the last edit-window
which had the point will be used unless @code{other-window} has been
called with a prefix-argument unequal 1.
@end itemize

Regardless of the different behaviors above ECB handles the situation
of an active minibuffer during a call to @code{other-window} or
@code{scroll-other-window} like follows:

If the minibuffer-window is selected then ECB always chooses the
window @code{minibuffer-scroll-window} points to (when this variable
is set, otherwise the compile-window or the last selected edit-window
is choosen) when the called command is called to choose the 1. next
window (always true for scrolling another window or true when
@code{other-window} called without prefix-arg or with prefix-arg equal
1). Otherwise the window ARG steps away is choosen (in case of
@code{other-window}).

If there is an active minibuffer but the minibuffer-window is not
selected then @code{other-window} and @code{scroll-other-window}
behave like the original version.

@subsection User-defined ``other window'' behavior

In addition to the builtin ``other window'' behaviors ECB offers a
user to completely define for himself how ECB should choose another
window for scrolling it or selecting it. This can be done with the
option @code{ecb-other-window-behavior} too because this option can
also have a function-symbol as value:

Such a function gets seven arguments:
@enumerate
@item
A canonical list of all currently visible windows of the
@code{ecb-frame}
@item
A canonical list of all currently visible edit-windows
@item
A canonical list of all currently visible ecb-windows
@item
The window-object of the compile-window if there is any.
@item
The minibuffer-window of the ECB-frame if there is an active
minibuffer.
@item
The result of the function @code{ecb-where-is-point} - see the
documentation of this function for details.
@item
An integer which indicates how many steps away from the current
selected window the ``other-window'' is. Is nil when this function is
called in another context then for @code{other-window}.
@end enumerate

The function has to return a window-object which is then used as
``other window'' for the command @code{other-window} or for scrolling
another window (e.g. with @code{scroll-other-window}). Such a function
has to handle properly all situation for itself.

Here is an example for such a function:

@example
@group
(defun ecb-get-other-window-smart (win-list
                                   edit-win-list
                                   ecb-win-list
                                   comp-win
                                   minibuf-win
                                   point-loc
                                   nth-window)
  (if minibuf-win
      ;; if we have an active mini-buffer we delegate this to
      ;; `ecb-get-other-window-minibuf-active'
      (ecb-get-other-window-minibuf-active win-list
                                           edit-win-list
                                           ecb-win-list
                                           comp-win
                                           minibuf-win
                                           point-loc
                                           nth-window)
    ;; here we have no active minibuffer!
    (let* ((nth-win (or nth-window 1))
           (next-listelem-fcn (if (< nth-win 0)
                                  'ecb-prev-listelem
                                'ecb-next-listelem)))
      (cond ((equal point-loc 'ecb)
             (funcall next-listelem-fcn ecb-win-list
                      (selected-window) nth-win))
            ((equal point-loc 'compile)
             (if (= nth-win 1)
                 (or (and ecb-last-edit-window-with-point
                          (window-live-p ecb-last-edit-window-with-point)
                          ecb-last-edit-window-with-point)
                     (car edit-win-list))
               (funcall next-listelem-fcn
                        (append edit-win-list (list (selected-window)))
                        (selected-window)
                        nth-win)))
            (t ;; must be an edit-window
             (funcall next-listelem-fcn
                      (append edit-win-list
                              (if (and comp-win
                                       (= (length edit-win-list) 1))
                                  (list comp-win)))
                      (selected-window)
                      nth-win))))))
@end group
@end example

This example implements the builtin smart behavior described above.

@node The Methods buffer, The ECB-layout, The other window, Usage of ECB
@section Using and customizing the ECB-Methods buffer

ECB is mostly designed to display parsing information for files
supported by semantic. But beginning with version 1.94 it also
supports other parsing engines like imenu and etags, so also files not
supported by semantic but by imenu/etags can be displayed in the
Method-buffer of ECB. Therefore we have to introduce some terminology:

@cindex semantic-sources
@anchor{Definition of semantic- and non-semantic-sources}
@itemize @minus
@item @dfn{semantic-sources}:
These are file-types for which a semantic grammar is available, so the
files are parse-able by semantic. These sources are supported best by
ECB and most of the following options and descriptions are related to
these file-types. Examples are programming-sources like C++, C, Java,
Emacs-Lisp and Texinfo-file and some more.

@cindex non-semantic-sources
@item @dfn{non-semantic-sources}:
For these files there is no semantic-grammar available so they can not
be parsed by semantic. Examples are Perl-, LaTeX- and TeX-files. But
for many of these files imenu and/or etags parsers exist. ECB supports
now parsing and displaying these file-types too and it uses for this
some speedbar-logic.
@end itemize

This chapter describes how to use and customize the Methods-buffer of
ECB.

@menu
* Visiting tags::               Possible actions after visiting a tag
* Expanding::                   Explicit and automatic expanding
* Customizing the display::     How to customize the Methods-buffer display
* Rebuilding the Methods::      When to rebuild the Methods-buffer      
@end menu

@node Visiting tags, Expanding, The Methods buffer, The Methods buffer
@subsection Possible actions after visiting a tag

You visit a tag by clicking with either the primary oder secondary
mouse-button (or by hitting @kbd{RET} or @kbd{C-RET} if using the
keyboard) onto a node in the Methods-tree-buffer of ECB. This simply
selects the ``right'' edit-window (depends if clicked with the primary
or secondary button, in how many windows the edit-area is splitted and
the value of @code{ecb-mouse-click-destination}) and puts the point
onto the first line of the clicked tag.

But you can define if after this ``basic'' tag-visit-action more
additional actions should be performed by ECB. You can either use some
of the predefined actions (e.g. highlighting the header-line of the
tag) or define own actions. You can set different actions for
different major-modes. All this is done via the option
@code{ecb-tag-visit-post-actions}.

The following actions are currently predefined:
@itemize @minus
@item @code{ecb-tag-visit-highlight-tag-header}
@item @code{ecb-tag-visit-smart-tag-start}
@item @code{ecb-tag-visit-recenter}
@item @code{ecb-tag-visit-recenter-top}
@item @code{ecb-tag-visit-goto-doc-start}
@item @code{ecb-tag-visit-narrow-tag}
@end itemize

See the documentation of these function for details what they do.

Per default ECB performs the actions
@code{ecb-tag-visit-smart-tag-start} and
@code{ecb-tag-visit-highlight-tag-header} for all major-modes.


@node Expanding, Customizing the display, Visiting tags, The Methods buffer
@subsection Explicit and automatic expanding of the ECB-methods-buffer

@subsubsection Explicit expanding to a certain expanding level

With the command @code{ecb-expand-methods-nodes} (bound to @kbd{C-c .
x}) you can get a fast overlook of the contents of the source-buffer,
because this command allows precisely expanding tags with a certain
indentation-level. So you can either expand no tags (or with other
words collapse all tags) or expand all tags so see the contents of
a buffer at one glance. Or you can expand exactly that tags of a
certain indentation level.

Which node-types are expanded (rsp. collapsed) by this command
depends for semantic-sources on the options
@code{ecb-methods-nodes-expand-spec} and
@code{ecb-methods-nodes-collapse-spec}! For non-semantic-sources always
all node-types are expanded/collapsed, i.e. the two options above
takes no effect for these files.

@subsubsection Automatic expanding the ECB-methods-buffer

If the option @code{ecb-highlight-tag-with-point} is switched on, then
then always that node in the method-buffer is highlighted which
belongs to the current semantic-tag under point in the current active
edit-window. But if this node is invisible (probably because its
parent node is collapsed) then no node is highlighted if the auto.
expanding feature is switched off.

You can either switch on this feature with the option
@code{ecb-auto-expand-tag-tree} or even easier with the command
@code{ecb-toggle-auto-expand-tag-tree}.

There is another option
@code{ecb-expand-methods-switch-off-auto-expand} which makes both
explicit and auto. expanding best working together. See the
documentation of this option to get the details.

The autom. expanding feature is only available for semantic-sources!

@node Customizing the display, Rebuilding the Methods, Expanding, The Methods buffer
@subsection Customizing the display of the Methods-buffer

@cindex semantic tag
@cindex tag
The ECB-Methods buffer is probably the most important browsing window
offered by ECB. It displays all parsing informations of the current
source-buffer (the buffer displayed in the current active
edit-window).

Normally ECB gets all informations displayed in this Methods-buffer
from the semantic-library - at least for semantic-sources. This
library parses auto. the current source-buffer in the edit-window of
ECB and returns all information in form of @dfn{tags} to ECB which
displays them in a browse-able form in its Method-buffer. See @ref{ECB
Methods-buffer} for information how to use the Methods-buffer.

There are several options to customize which tags ECB should display
in general, if the tags should be collapsed or expanded, how to
fontify them (i.e. syntax-highlighting) and something more.

@table @code
@item ecb-show-tags
Which semantic-tags (e.g. types, methods, variables etc.) should be
displayed and should they be collapsed, flattened or expanded. Sorting
is also possible.

@item ecb-font-lock-tags
@itemx ecb-type-tag-display
How to fontify the tags in the Method-buffer

@item ecb-tag-display-function
ECB and semantic offer several predefined functions for displaying the
tags. Here you can customize, what informations tags should
contain (only the method-name or the whole signature or something
else) and what notation should be used, e.g. UML or not.

@end table

These are the most important options for this topic but it is
recommended to have a look into the customize-group @code{ecb-methods}
(@pxref{ecb-methods}) and check all the options offered there!

All these options are only relevant for semantic-sources and take no
effect for non-semantic-sources!

@node Rebuilding the Methods, , Customizing the display, The Methods buffer
@subsection Rebuilding the Methods-buffer

In almost all cases there is @strong{NO} need to manually rebuild the
method-buffer, because it is always done automatically if necessary;
the mechanism depends on the sources:

@itemize @minus
@item semantic-sources:
The command @code{global-semantic-auto-parse-mode} switches on autom.
reparsing of semantic-sources.

@item non-semantic-sources (imenu supported):
You can switch on autom. rescanning/reparsing with the option
@code{imenu-auto-rescan}. But nevertheless you have to manually
rebuild the Method-buffer (with the autom. updated imenu-tags) via the
command @code{ecb-rebuild-methods-buffer} (bound to @kbd{C-c . r}).

@item non-semantic-sources (etags supported):
For these sources there is no built-in auto-rescan mechanism, because
etags is an external tool it can only operate on the saved
file-contents. So rescanning the buffer contents would need to save
the buffer before. Therefore there is no built-in auto-rescan mechanism
because this would always result in saving the buffer and running an
external tool. But of course you can program such a an
etags-auto-rescan mechanism for yourself!
@end itemize

Besides for etags-supported non-semantic-sources there exist a few rare
scenarios also for the other sources where a complete manual rebuild
can be necessary. Here is one example:

Depending on the semantic-version: If an Elisp-file is parsed which
contains a defun X in the middle where the closing ) is missing, then
semantic parses only until this defun X is reached and you will get an
incomplete ECB-method buffer. In such a case you must complete the
defun X and then completely reparse the Elisp-file and rebuild the ECB
method buffer!

A complete manually rebuild is done by
@code{ecb-rebuild-methods-buffer}. For etags-parsed
non-semantic-sources this causes an automatic saving of the
source-buffer because otherwise etags would not operate with the
latest contents!

@node The ECB-layout, Hiding the ECB windows, The Methods buffer, Usage of ECB
@section Changing, customizing, redrawing and creating layouts

@cindex layout
@cindex ECB-layout
The term @dfn{ECB-layout} means in which windows the ECB-frame is
divided. This chapter describes all aspects concerning this layout,
especially changing, customizing, redrawing and also creating new
layouts.

@menu
* Changing the ECB-layout::     How to change and customize the layout
* Redrawing the ECB-layout::    How and when redrawing the layout
* Changing window sizes::       Changing sizes of the ECB-windows
* Fixing window sizes::         Fixing sizes of the ECB-windows
* Creating a new ECB-layout::   Interactively creating new layouts
@end menu

@node Changing the ECB-layout, Redrawing the ECB-layout, The ECB-layout, The ECB-layout
@subsection Changing and customizing the ECB-layout

ECB offers several predefined layouts with different sets and also
different locations of ECB-windows. See below the ``ascii-screenshot''
of all currently built-in layouts@footnote{The command
@code{ecb-show-layout-help'} shows the outline-picture for all built-in
layouts.}.

In addition to these predefined layouts you can either interactively
create new layouts ``by example'' (@pxref{Creating a new ECB-layout})
or program new layouts with the macro @code{ecb-layout-define}
(@pxref{The layout-engine}). The former method is the recommended
one!

There are two ways to interactively change the layout:
@itemize @bullet
@item Changing permanently:
Customize the option @code{ecb-layout-name} and store it for future
Emacs sessions.

@item Switching between several layouts at runtime:
If you want to switch fast between a certain sequence of layouts see
the option @code{ecb-toggle-layout-sequence} and the command
@code{ecb-toggle-layout} (@pxref{Simulating speedbar}). For just
selecting another layout during current Emacs-session use the command
@code{ecb-change-layout}.
@end itemize

With the option @code{ecb-show-sources-in-directories-buffer} you can
define if sources are displayed in the directory-window of a layout
(@pxref{ECB Directories-buffer}).

In addition to the general layout you can specify if the layout should
contain a durable compilation-window at the bottom of the frame, see
@code{ecb-compile-window-height} (@pxref{Temp- and compile-buffers}).

Maybe you want also change the look&feel of the tree-buffers. Then you
can change the general style of the tree-buffers with the option
@code{ecb-tree-buffer-style} and the location of the collapse- and
expand-symbols and the indentation of sub-nodes in a tree. See
@code{ecb-tree-indent} and @code{ecb-tree-expand-symbol-before}. More
details about the different tree-buffer-styles are described in
@ref{Tree-buffer styles}.

Here are all currently available layouts (for creating own new layouts
see @ref{Creating a new ECB-layout}); just customize the option
@code{ecb-layout-name} to the related name:

@table @asis
@item Layout ``left1''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|      |       |                                      |
| Sour | Hist  |                 Edit                 |
|      |       |                                      |
|      |       |                                      |
|--------------|                                      |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example
   
@item Layout ``left2''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|  Sources     |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left3''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  Sources     |                 Edit                 |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left4''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                 Edit                 |
|      |       |                                      |
|      |       |                                      |
|      |       |                                      |
| Sour | Hist  |                                      |
|      |       |                                      |
|      |       |                                      |
|      |       |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left5''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  Sources     |                 Edit                 |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  History     |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``right1''
@example
@group
-------------------------------------------------------
|                                      |              |
|                                      |  Directories |
|                                      |              |
|                                      |              |
|                                      |--------------|
|                                      |              |
|                                      |              |
|             Edit                     |  Sources     |
|                                      |              |
|                                      |              |
|                                      |--------------|
|                                      |              |
|                                      |  Methods     |
|                                      |              |
|                                      |              |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left6''
@example
@group
-------------------------------------------------------
|  Sources     |                                      | 
|--------------|                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|  Methods     |                 Edit                 |
|              |                                      | 
|              |                                      |
|              |                                      |
|--------------|                                      |
|  History     |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``top1''
@example
@group
-------------------------------------------------------
|                        |             |              |
|                        |             |              |
|      Directories       |  Sources    |  Methods     |
|                        |             |              |
|                        |             |              |
|-----------------------------------------------------|
|                                                     |
|                                                     |
|                                                     |
|                                                     |
|                    Edit                             |
|                                                     |
|                                                     |
|                                                     |
|                                                     |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left7''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                 Edit                 |
|              |                                      |
|  History     |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left8''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  Sources     |                                      |
|              |                                      |
|--------------|                 Edit                 |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|  History     |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``top2''
@example
@group
-------------------------------------------------------
|                                                     |
|                                                     |
|                    Methods                          |
|                                                     |
|                                                     |
|-----------------------------------------------------|
|                                                     |
|                                                     |
|                                                     |
|                                                     |
|                    Edit                             |
|                                                     |
|                                                     |
|                                                     |
|                                                     |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left9''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|   Methods    |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left10''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|  Methods     |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|      |       |                                      |
| Sou  | Hist  |                                      |
|      |       |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left11''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|  Methods     |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  History     |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left12''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|   History    |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left13''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
| Directories  |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left14''
@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
| Directories  |                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  History     |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left15''
@example
@group
-------------------------------------------------------
|              |                                      |
|  Directories |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
|--------------|                 Edit                 |
|              |                                      |
|              |                                      |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
|              |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``leftright1''
@example
@group
-------------------------------------------------------
|             |                         |             |
| Directories |                         |  Methods    |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|-------------|          Edit           |             |
|             |                         |             |
| Sources     |                         |             |
|             |                         |             |
|-------------|                         |             |
|             |                         |             |
| History     |                         |             |
|             |                         |             |
-------------------------------------------------------
|                                                     |
|                   Compilation                       |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``leftright2''
@example
@group
-------------------------------------------------------
|             |                         |             |
| Directories |                         |  Methods    |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |          Edit           |             |
|-------------|                         |-------------|
|             |                         |             |
| Sources     |                         |  History    |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
-------------------------------------------------------
|                                                     |
|                   Compilation                       |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``leftright3''
@example
@group
-------------------------------------------------------
|             |                         |             |
| Directories |                         |  Methods    |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |          Edit           |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
|             |                         |             |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@item Layout ``left-dir-plus-speedbar''
@example
@group
-------------------------------------------------------
|             |                                       |
| Directories |                                       |
|             |                                       |
|             |                                       |
|             |                                       |
|             |                                       |
|             |                                       |
|-------------|                                       |
|             |                                       |
|             |                                       |
|             |                                       |
| Speedbar    |                                       |
|             |                                       |
|             |                                       |
|             |                                       |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@end table

@node Redrawing the ECB-layout, Changing window sizes, Changing the ECB-layout, The ECB-layout
@subsection Redrawing the ECB-layout

@cindex Redraw
If you have unintentionally destroyed the ECB-layout, you can always
restore the layout with calling @code{ecb-redraw-layout}. This is even
true, if you get messages like ``wrong-type-argument window-live-p
#<window 222>''.

If the variable @code{ecb-redraw-layout-quickly} is not nil then the redraw
is done by the @code{ecb-redraw-layout-quickly} function, otherwise by
@code{ecb-redraw-layout-full}. But it's strongly recommended to use the
quick redraw only if you have really slow machines where a full redraw
takes several seconds because the quick redraw is not really safe and
may have some drawbacks! On normal machines the full redraw should be
done in << 1s!

Please read the documentation of the command @code{ecb-redraw-layout}!

See also the hooks @code{ecb-redraw-layout-after-hook} and
@code{ecb-redraw-layout-before-hook}!

@node Changing window sizes, Fixing window sizes, Redrawing the ECB-layout, The ECB-layout
@subsection Changing the sizes of the special ECB-windows

The standard width and height of the special ECB-windows is defined
with the options @code{ecb-windows-width} and
@code{ecb-windows-height}. But changing these options always
influences all layouts which is not always desired.

ECB offers to re-adjust the width and height of the ECB-windows (e.g. by
dragging the windows-borders via the mouse) and then saving exactly
these current window-sizes for the current layout so after activating
this layout all windows have autom. the stored sizes.

This is done via the option @code{ecb-layout-window-sizes} and the
commands @code{ecb-store-window-sizes},
@code{ecb-restore-window-sizes} and
@code{ecb-restore-default-window-sizes}.

Here is an example how to resize and store the sizes of the
ECB-windows of layout ``left1'':

@enumerate
@item
Switch to layout ``left1'' via @code{ecb-change-layout} (@kbd{C-c . lc})
@item
Resize the ECB-windows by dragging the window-borders with the mouse
@item
Call @code{ecb-store-window-sizes}
@end enumerate

After this layout ``left1'' will be always drawn with the new sizes
until you call @code{ecb-restore-default-window-sizes} during layout
``left1'' is active.

@strong{Please note}: @code{ecb-store-window-sizes} stores the width
and height of the windows per default as fractions of the width (rsp.
height) of the ECB-frame, so the stored sizes are always correct
regardless of the current frame-size! But if called with a prefix
argument then fixed sizes are stored.

@node Fixing window sizes, Creating a new ECB-layout, Changing window sizes, The ECB-layout
@subsection Fixing the sizes of the special ECB-windows

GNU Emacs 21 introduced a new feature which can fix the sizes of a
window displaying a certain buffer even after resizing the frame. This
new feature is driven by the new buffer-local variable
@code{window-size-fixed}.

ECB offers an option @code{ecb-fix-window-size} for fixing the sizes
of the special ECB-windows/buffers even after frame-resizing. The fix
type (valid values are @code{nil}, @code{t}, @code{width} and
@code{height}) can either be set on a layout-basis (means a different
value for each layout) or one value can be set for all layouts. In the
latter case there is an additional value @code{auto} which choose
autom. the senseful fix-type depending on the current layout-type: For
top-layouts the fix-type @code{height} and for all other layout-types
the fix-type @code{width}.

Probably the most senseful value is @code{auto} for all layouts
because it makes less sense to fix the height of the ecb-windows in a
left-, right- or leftright-layout. Same for fixing the width in a
top-layout.

Note: With current Emacs 21.2.X there seems to be no distinction
between @code{width}, @code{height} and @code{t}. Therefore this
option takes no effect (means all ecb-windows have always unfixed
sizes) if @code{ecb-compile-window-height} is not @code{nil}.

@node Creating a new ECB-layout, , Fixing window sizes, The ECB-layout
@subsection Interactively creating new layouts

@cindex New layouts
@cindex Creating new layouts

If you want to create your own ECB-layout then you can do this very
easy ``by example'' with the command @code{ecb-create-new-layout}.
This command creates a new empty frame and offers a small set of keys
to create the new layout by splitting windows.
@code{ecb-create-new-layout} and this couple of keys are your guide
during the layout-creation-process@footnote{During the creation
process you will be asked in the minibuffer for several options; here
you can use TAB-completion and an ``empty'' RET chooses always the
first option!}.

After calling @code{ecb-create-new-layout} you will be asked which
type of layout you want to create: ``left'', ``right'', ``top'' or
``left-right''. Here you specify where the ECB-tree-windows/buffers
should be located in the ECB-frame:

@itemize @minus
@item left: All ECB-tree-windows are located on the left side
@item right: All ECB-tree-windows are located on the right side
@item top: All ECB-tree-windows are located on the top side
@item left-right: All ECB-tree-windows are located on the left and
right side
@end itemize

Depending on the type you choose the window is splitted by the values
of the options @code{ecb-windows-width} (types ``left'', ``right'' and
``left-right'') or @code{ecb-windows-height} (type ``top'').

Afterwards you will see a frame like follows (here the layout-type is
``left-right''):

@example
@group
-----------------------------------------------------------------
|<point>       |                                   |            |
|              | ECB-layout creation mode          |            |
|              | ========================          |            |
|              |                                   |            |
|              | <This is a durable help-screen>   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
|              |                                   |            |
-----------------------------------------------------------------
               |
               |   ,---
               `---| Splitted by the value of @code{ecb-windows-width}.
                   `---
@end group
@end example

The big window (here the middle window) will be the edit-area of the
new layout and can not be selected, deleted or splitted during the
creation process. It displays the help-screen for the layout-creation
mode. Here all the available commands are displayed.

The small window(s) (here the left and right windows) can be splitted
by you wherever you want (@kbd{C-s}). The left one contains the point.
You must give every ECB-tree-window you create a type (@kbd{C-t})
which can be either

@itemize @bullet
@item One of the built-in types

This can be either ``directories'', ``sources'', ``methods'',
``history'' or ``speedbar''.

@item Any user-defined type:

In this case you insert ``other'' after hitting @kbd{C-t} and you will
then be asked for the name of the user-defined type. You can insert
any arbitrary type name X. But to get this layout working you have to
define a function with name @code{ecb-set-X-buffer} whereas X is the
name of the user-defined type you have specified during
layout-creation.

This function @code{ecb-set-X-buffer} has first to switch to the
buffer you want to display in this window and then making this window
dedicated. You have to use the macro @code{ecb-with-dedicated-window}
in such a function!

Here is an example: Suppose you have inserted as type name ``example''
then you have to define and load a function
@code{ecb-set-example-buffer} which could be defined like follows:

@example
(defun ecb-set-example-buffer ()
  (ecb-with-dedicated-window
    " *ECB example-buffer*"
    'ecb-set-example-buffer
      (switch-to-buffer (get-buffer-create " *ECB example-buffer*"))))
@end example

If you forget to define such a function for the user-defined type then
nevertheless ECB will draw this layout but it will use the
default-function @code{ecb-set-default-ecb-buffer} instead.
@end itemize

If you are satisfied with your new layout just hit @kbd{C-q}. You will
be asked for a new layout-name (TAB-completion is offered to get a
list of all names already in use) and after inserting a new(!) name
the new layout is saved in the file defined by the option
@code{ecb-create-layout-file}. The new layout is now available via the
option @code{ecb-layout-name}.

There is no need for you to load the file
@code{ecb-create-layout-file} manually into your Emacs because it's
automatically loaded by ECB!

@strong{Please note}: During the layout-creation process only the
commands displayed in the help-screen are available. ALL other
commands are temporally disabled (even the mouse-commands).

For programming new layouts with emacs-lisp see @ref{The layout-engine}.

With the command @code{ecb-delete-new-layout} you can delete
previously created layouts (TAB-completion is offered for all names of
user created layouts).

@node Hiding the ECB windows, Maximizing the ECB windows, The ECB-layout, Usage of ECB
@section Hiding/Showing the ECB windows

@cindex Hide windows
@cindex Show windows
With @code{ecb-toggle-ecb-windows}, @code{ecb-hide-ecb-windows} and
@code{ecb-show-ecb-windows} you can hide/show all the ECB windows
without changing the activation state of ECB and also without
deactivating the advices for @code{delete-other-windows} and/or
@code{delete-window}. This is most useful if you use a layout like
``top2'' (@pxref{Tips and tricks}) or if you want to have maximum space
for editing and you don't need the browsing windows all the time.

The following sequence of hooks is evaluated during showing again the
hidden ECB-windows:
@enumerate
@item @code{ecb-show-ecb-windows-before-hook}
@item @code{ecb-redraw-layout-before-hook}
@item <Redrawing the layout to show the hidden ECB-windows>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-show-ecb-windows-after-hook}
@end enumerate

The following sequence of hooks is evaluated during hiding the
ECB-windows:
@enumerate
@item @code{ecb-hide-ecb-windows-before-hook}
@item @code{ecb-redraw-layout-before-hook}
@item <Hiding the ECB-windows>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-hide-ecb-windows-after-hook}
@end enumerate

If the special ECB-windows are hidden (e.g. by
`ecb-toggle-ecb-windows') all adviced functions behave as their
originals. So the frame can be used as if ECB would not be active but
ECB IS still active in the ``background'' and all ECB-commands and all
ECB-keybindings can be used. Of course some of them doesn't make much
sense but nevertheless they can be called. Toggling the visibility of
the ECB-windows preserves the splitting-state of the edit-area: If you
hide the ECB-windows then the frame will be divided in the same
window-layout the edit-area had before the hiding and if you show the
ECB-windows again the edit-area will be divided into all the
edit-windows the ECB-frame had before the showing.

Therefore it should be enough to hide the ECB-windows to run other
Emacs-applications which have their own window-layout-managing. There
should be no conflicts. But nevertheless the most recommended method
for running ECB and other applications (e.g. xrefactory, Gnus etc.) in
the same frame is to use a window-manager like winring.el or
escreen.el (@pxref{Window-managers and ECB}).


@node Maximizing the ECB windows, Back/forward navigation, Hiding the ECB windows, Usage of ECB
@section Maximizing the ECB windows

To get a better overlook about the contents of a certain ECB-window
every ECB-window can be ``maximized'', means all other ECB-windows are
deleted so only the edit-window(s) and this maximized ECB-window are
visible (and maybe a compile-window if active). There are several ways
to do this:

@itemize @bullet
@item
Via the popup-menus of the ECB-windows

@item
Via the main ``ECB''-menu and here ``Display window maximized''

@item
Via calling the adviced version of
@code{delete-other-windows}@footnote{This command is adviced per
default, see @ref{The edit-area}.} (bound to @kbd{C-x 1}) in one of
the ECB windows.

@item
Via one of the commands @code{ecb-maximize-window-directories},
@code{ecb-maximize-window-sources}, @code{ecb-maximize-window-methods},
@code{ecb-maximize-window-history} or
@code{ecb-maximize-window-speedbar} or the bound short-cuts for those
commands.

@item
Via the new command @code{ecb-cycle-maximized-ecb-buffers} which
cycles through all ecb-buffers of current layout by maximizing exactly
one of the ecb-windows after every cycle-step.

@item
Via the option @code{ecb-maximize-ecb-window-after-selection} and then
just by selecting an ECB-window. ``Deselecting'' an ECB-window brings
back all ECB-windows of current layout.

@item
Via the default modeline-mechanisms for deleting other windows. GNU
Emacs binds @kbd{mouse-2} in its modeline to
@code{delete-other-window}. ECB now supports this mechanism by binding
a toggle-command to @kbd{mouse-2} in the modeline of each tree-buffer:
If all ECB-windows are visible then this command maximizes the current
tree-window and if current tree-window is maximized all ECB-windows
are displayed again. XEmacs binds a popup-menu with some window
commands to @kbd{button-3} in its modeline. ECB supports this
mechanism by replacing this menu by a menu which offers exactly 2
commands: Maximizing current tree-window and displaying all
ECB-windows.
@end itemize

Minimizing such a maximized ECB-window, i.e. bringing back to its
original size, can simply be done by redrawing the layout via the
command @code{ecb-redraw-layout} (bound to @kbd{C-c . lr}).

@node Back/forward navigation, ECB-window synchronizing, Maximizing the ECB windows, Usage of ECB
@section Back- and forward navigation like a browser

With ECB you can ``browse'' in your source-files like with a
web-browser. This means ECB stores the current buffer- and
window-position relative to the current tag@footnote{e.g. a method,
a variable or any other semantic tag} in the edit-window after

@itemize @minus
@item selecting a tag in the ECB-methods buffer or
@item selecting a source-file in the ECB-sources/history-buffer.
@end itemize

ECB offers two commands @code{ecb-nav-goto-next} (@kbd{C-c . n}) and
@code{ecb-nav-goto-previous} (@kbd{C-c . p}) to go forward and
backward within this navigation history-list. These commands are also
available via the menu ``ECB --> Navigate''.

Aside normal ``location-browsing'' this is useful for example in a
scenario where the buffer is narrowed to a tag (see
@code{ecb-tag-visit-post-actions}):

@enumerate
@item You edit a function
@item Goto another function above the current in the same file
@item Add a few lines
@item Call ecb-nav-goto-previous

Now you will edit at the same place in the function.
@end enumerate

@node ECB-window synchronizing, Interactive ECB commands, Back/forward navigation, Usage of ECB
@section Synchronization of the ECB-windows

Per default ECB synchronizes automatically the contents of the
ECB-windows/tree-buffers with the current active edit-window (rsp. the
current buffer of the edit window):

@itemize @bullet

@item ECB-directories:

This windows is synchronized to display the directory where the
source-file which is displayed in the current active edit-window is
located. If the source-path (i.e. an element of the option
@code{ecb-source-path}) containing this directory is not expanded it
will be auto. expanded according to the value of the option
@code{ecb-auto-expand-directory-tree} (@pxref{ecb-directories}).

@item ECB-sources:

The ECB-sources-buffer contains after synchronizing all the sources of
the directory of the ``current'' source-file displayed in the
edit-window. The entry of the ``current'' source-file is highlighted.

@item ECB-methods:

Contains after synchronizing all the tags of the buffer in the current
selected edit-window, i.e. all methods, variables etc... depending of
the major-mode.

@item ECB-history:

Highlights the entry of the buffer displayed in the current active
edit-window if this buffer is a source-file.

@end itemize

This feature can be customized with the option @code{ecb-window-sync}:

If active then the synchronization takes place always a buffer changes
in an edit window or if another edit-window with another buffer will
be selected, if deactivated then never. But you can also set this
option to a list of major-modes and then the sync. will only be done
if the major-mode of the current buffer belongs NOT to this list.

But in every case the synchronization takes only place if the
major-mode of the current-buffer in the current selected edit-window
has a relation to files or directories. Examples for the former one
are all programming-language-modes like @code{c++-mode} or
@code{java-mode}, @code{Info-mode} too, an example for the latter one
is @code{dired-mode}. For all major-modes related to
non-file/directory-buffers like @code{help-mode},
@code{customize-mode} and others never a synchronization will be done!

It's recommended to exclude at least @code{Info-mode} because it makes
no sense to synchronize the ECB-windows after calling the Info help.
Per default also @code{dired-mode} is excluded but it can also making
sense to synchronize the ECB-directories/sources windows with the
current directory of the dired-buffer in the edit-window.

If you often need to toggle between autom. synchronization on and off
then customizing the option @code{ecb-window-sync} is inefficient and
therefore ECB offers the command @code{ecb-toggle-window-sync}.

@strong{Please note}: With the command @code{ecb-window-sync} you can
do a manually synchronization if the automatic one is switched off or
if you just want to do this!

@node Interactive ECB commands, , ECB-window synchronizing, Usage of ECB
@section Interactive ECB commands

@noindent
ECB offers a lot of interactive commands. Some of these commands
prompt the user in the minibuffer if called with a prefix argument.

Example: If @code{ecb-clear-history} is called with a prefix argument
then you will be prompted in the minibuffer with:

@example
Clear from history: [all, not-existing-buffers, existing-buffers]
@end example 

You can choose one of the options enclosed in brackets with
TAB-completion; hitting RET direct after the prompt chooses auto. the
first offered option (in the example above ``all'').

@strong{Please note}: The following interactive commands of ECB are
listed without the prefix ``ecb-'' (e.g. the command
@code{ecb-activate} is listed with name ``activate''). This has been
done for a better readable command index. @xref{Command Index}.

@deffn Command activate
Activates ECB and creates the special buffers for the choosen layout.
For the layout see @code{ecb-layout-name}. This function raises always
the ECB-frame if called from another frame. This is the same as
calling @code{ecb-minor-mode} with a positive argument.
@end deffn

@deffn Command add-all-buffers-to-history
Add all current file-buffers to the history-buffer of ECB. If
@code{ecb-sort-history-items} is not nil then afterwards the history
is sorted alphabetically. Otherwise the most recently used buffers are
on the top of the history and the seldom used buffers at the bottom.
@end deffn

@deffn Command change-layout &optional preselect-type
Select a layout-name from all current available layouts
(TAB-completion is offered) and change the layout to the selected
layout-name. If optional argument PRESELECT-TYPE is not nil then you
can preselect a layout-type \(TAB-completion is offered too) and then
you will be asked only for layouts of that preselected type. Note:
This function works by changing the option @code{ecb-layout-name} but
only for current Emacs-session.
@end deffn

@deffn Command clear-history
Clears the history-buffer.
@end deffn

@deffn Command customize
Open a customize-buffer for all customize-groups of ECB.
@end deffn

@deffn Command customize-most-important
Open a customize-buffer for the most important options of ECB.
@end deffn

@deffn Command create-new-layout
Start process for interactively creating a new ECB-layout
(@pxref{Creating a new ECB-layout}).
@end deffn

@deffn Command cycle-maximized-ecb-buffers
Cycles through all ecb-buffers of current layout by maximizing exactly
one of the ecb-windows after every cycle-step.
@end deffn

@deffn Command cycle-through-compilation-buffers &optional choose-buffer
Cycle through all compilation buffers currently open and display them
within the compilation window @code{ecb-compile-window}. If the
currently opened buffer within the compilation window is not a
compilation buffer, we jump to the first compilation buffer. If not we
try to loop through all compilation buffers. If we hit the end we go
back to the beginning.

If @var{CHOOSE-BUFFER} is not @code{nil} then the user will be
prompted for the compilation-buffer to switch to.
@end deffn

@deffn Command deactivate
Deactivates the ECB and kills all ECB buffers and windows.
@end deffn

@deffn Command delete-new-layout
Select a layout-name for a layout created by
@code{ecb-create-new-layout} and delete this layout. This means the
layout-definition is removed from the file
@code{ecb-create-layout-file} and the layout-function and associated
aliases are unbound.
@end deffn

@deffn Command display-news-for-upgrade &optional FULL-NEWS
Display the most important NEWS after an ECB-upgrade. If you call this
function but no ECB-upgrade has been performed before starting ECB
then nothing is display unless @var{FULL-NEWS} is not nil.

If @var{FULL-NEWS} is not nil then the NEWS-file is displayed in
another window.
@end deffn

@deffn Command display-upgraded-options
Display a message-buffer which options have been upgraded or reset.
@end deffn

@deffn Command download-ecb
Download ECB from the ECB-website and install it. For this the option
@code{ecb-download-url} must be set correct, whereas the default value of
this option should always be correct.

If @code{ecb-download-package-version-type} is set to -1 (means asking
for a version) then you will be ask in the minibuffer for the version
to download. Otherwise ECB downloads autom. the latest version
available for the type specified in
@code{ecb-download-package-version-type}. If no newer version than the
current one is available no download will be done.

For details about downloading and what requirements must be satisfied
see function @code{ecb-package-download} and option
@code{ecb-download-package-version-type}!

After successful downloading the new ECB will be installed in a
subdirectory of @code{ecb-download-install-parent-dir}. After adding
this subdirectory to @code{load-path} and restarting Emacs the new ECB
version can be activated by @code{ecb-activate}.

If current running ECB is installed as regular XEmacs-package and not
with the archive available at the ECB website then this function asks
for proceeding!
@end deffn

@deffn Command download-semantic
Download semantic from the semantic-website and install it. For this
the variable @code{ecb-cedet-url} must be set correct,
whereas the default value of this variable should always be correct.

If @code{ecb-download-package-version-type} is set to -1 (means asking
for a version) then you will be ask in the minibuffer for the version
to download. Otherwise ECB downloads autom. the latest version
available for the type specified in
@code{ecb-download-package-version-type}. If no newer version than the
current one is available no download will be done.

For details about downloading and what requirements must be satisfied
see function @code{ecb-package-download} and option
@code{ecb-download-package-version-type}!

After successful downloading the new semantic will be installed in a
subdirectory of @code{ecb-download-install-parent-dir}. After adding
this new subdirectory to @code{load-path} and restarting Emacs the new
semantic version is loaded and is used after next start of ECB.

If current running semantic is installed as regular XEmacs-package and
not with the archive available at the semantic website then this
function asks for proceeding!
@end deffn

@deffn Command expand-methods-nodes &optional force-all
Set the expand level of the nodes in the ECB-methods-buffer.

This command asks in the minibuffer for an indentation level LEVEL. With this
LEVEL you can precisely specify which level of nodes should be expanded. LEVEL
means the indentation-level of the nodes.

A LEVEL value X means that all nodes with an indentation-level <= X are
expanded and all other are collapsed. A negative LEVEL value means all visible
nodes are collapsed.

Nodes which are not indented have indentation-level 0!

Which node-types are expanded (rsp. collapsed) by this command
depends on the options @code{ecb-methods-nodes-expand-spec} and
@code{ecb-methods-nodes-collapse-spec}! With optional argument
@var{FORCE-ALL} all tags will be expanded/collapsed regardless of
the values of these options.

Examples:
@itemize @minus
@item LEVEL = 0
expands only nodes which have no indentation itself.
@item LEVEL = 2
expands nodes which are either not indented or indented indented once
or twice
@item LEVEL ~ 10
should normally expand all nodes expect there are nodes which are
indented deeper than 10.
@end itemize

Note 1: This command switches off auto. expanding of the method-buffer
if @code{ecb-expand-methods-switch-off-auto-expand} is not nil. But it
can be switched on again quickly with
@code{ecb-toggle-auto-expand-tag-tree} or @kbd{[C-c . a]}.

Note 2: All this is only valid for file-types parsed by semantic. For
other file types which are parsed by imenu or etags (see
@code{ecb-process-non-semantic-files}) @var{FORCE-ALL} is always true!
@end deffn

@deffn Command eshell-current-buffer-sync
Synchronize the eshell with the directory of current source-buffer.
This is only done if the eshell is currently visible in the
compile-window of ECB and if either this function is called
interactively or @code{ecb-eshell-synchronize} is not nil.
@end deffn

@deffn Command eshell-recenter
Recenter the eshell window so that the prompt is at the buffer-end.
@end deffn

@deffn Command expand-directory-nodes
Set the expand level of the nodes in the ECB-directories-buffer. For
argument LEVEL see @code{ecb-expand-methods-nodes}.

Be aware that for deep structured paths and a lot of source-paths this
command can last a long time - depending of machine- and
disk-performance.
@end deffn

@deffn Command goto-window-compilation
Goto the ecb compilation window @code{ecb-compile-window}.
@end deffn

@deffn Command goto-window-directories
Make the ECB-directories window the current window. If
@code{ecb-use-speedbar-instead-native-tree-buffer} is @code{dir} then
goto to the speedbar-window.
@end deffn

@deffn Command goto-window-edit1
Make the (first) edit-window window the current window.
@end deffn

@deffn Command goto-window-edit2
Make the second edit-window (if available) window the current window.
@end deffn

@deffn Command goto-window-edit-last
Make the last selected edit-window window the current window. This is
the same as if @code{ecb-mouse-click-destination} is set to
@code{last-point}.
@end deffn


@deffn Command goto-window-history
Make the ECB-history window the current window.
@end deffn

@deffn Command goto-window-methods
Make the ECB-methods window the current window. If
@code{ecb-use-speedbar-instead-native-tree-buffer} is @code{method}
then goto to the speedbar-window.
@end deffn

@deffn Command goto-window-sources
Make the ECB-sources window the current window. If
@code{ecb-use-speedbar-instead-native-tree-buffer} is @code{source}
then goto to the speedbar-window.
@end deffn

@deffn Command history-filter
Apply a filter to the history-buffer to reduce the number of entries.
So you get a better overlooking. There are three choices:

@itemize @minus
@item Filter by extension:
Just insert the extension you want the History-buffer being filtered.
Insert the extension without leading dot!

@item Filter by regexp:
Insert the filter as regular expression.

@item No filter:
This means to display an entry for all currently living file-buffers.
@end itemize
@end deffn



@deffn Command jde-display-class-at-point
Display in the ECB-methods-buffer the contents (methods, attributes
etc...) of the class which contains the definition of the ``thing''
under point (this can be a variable-name, class-name, method-name,
attribute-name). This function needs the same requirements to work as
the method-completion feature of JDEE (see
@code{jde-complete})!. The source-file is searched first in
@code{jde-sourcepath}, then in @code{jde-global-classpath}, then in
@var{$CLASSPATH}, then in current-directory.

Works only for classes where the source-code (i.e. the *.java-file) is
available.
@end deffn

@deffn Command maximize-window-directories
Maximize the ECB-directories-window, i.e. delete all other
ECB-windows, so only one ECB-window and the edit-window(s) are visible
(and maybe a compile-window). Works also if the ECB-directories-window
is not visible in current layout.
@end deffn

@deffn Command maximize-window-sources
Maximize the ECB-sources-window, i.e. delete all other ECB-windows, so
only one ECB-window and the edit-window(s) are visible (and maybe a
compile-window). Works also if the ECB-sources-window is not visible
in current layout.
@end deffn

@deffn Command maximize-window-methods
Maximize the ECB-methods-window, i.e. delete all other ECB-windows, so
only one ECB-window and the edit-window(s) are visible (and maybe a
compile-window). Works also if the ECB-methods-window is not visible
in current layout.
@end deffn

@deffn Command maximize-window-history
Maximize the ECB-history-window, i.e. delete all other ECB-windows, so
only one ECB-window and the edit-window(s) are visible (and maybe a
compile-window). Works also if the ECB-history-window is not visible
in current layout.
@end deffn

@deffn Command maximize-window-speedbar
Maximize the ECB-speedbar-window, i.e. delete all other ECB-windows,
so only one ECB-window and the edit-window(s) are visible (and maybe a
compile-window). Does nothing if the speedbar-window is not visible
within the ECB-frame.
@end deffn

@deffn Command minor-mode &optional arg
Toggle ECB minor mode. With prefix argument @var{ARG}, turn on if
positive, otherwise off. Return non-@code{nil} if the minor mode is
enabled.
@end deffn

@deffn Command nav-goto-previous
Go backward in the navigation history-list, see @ref{Back/forward
navigation}.
@end deffn

@deffn Command nav-goto-next
Go forward in the navigation history-list, see @ref{Back/forward
navigation}.
@end deffn

@deffn Command rebuild-methods-buffer
Updates the methods buffer with the current buffer after deleting the
complete previous parser-information, means no semantic-cache is used!
Point must stay in an edit-window otherwise nothing is done. This
method is merely needed for semantic parsed buffers if semantic parses
not the whole buffer because it reaches a not parse-able code or for
buffers not supported by semantic but by imenu or etags.

Examples when a call to this function can be necessary:

@itemize
@item
If an Elisp-file is parsed which contains in the middle a defun X
where the closing ) is missing then semantic parses only until this
defun X is reached and you will get an incomplete ECB-method buffer.
In such a case you must complete the defun X and then call this
function to completely reparse the Elisp-file and rebuild the ECB
method buffer!

@item
For not semantic supported buffers which can be parsed by imenu or
etags (see @code{ecb-process-non-semantic-files}) because for these
buffers there is no built-in auto-rebuild mechanism. For these buffers
this command calls @code{ecb-rebuild-methods-buffer-for-non-semantic}.
@end itemize
@end deffn

@deffn Command redraw-layout &optional ARG
Redraw the ECB screen.

Do not call this command from elisp-program but only interactively!

Called without a prefix-argument the state of the ECB-frame-layout
will preserved. This means:

@itemize @minus
@item
The state of compile-window (hidden or visible) will be preserved but
if visible then the height will be as specified in
@code{ecb-compile-window-height}.

@item
The state of the ECB-windows will be preserved (hidden or visible) but
if visible then the sizes will be as specified in the layout (and with
the options @code{ecb-windows-width} and @code{ecb-windows-height}) or
as stored with @code{ecb-store-window-sizes}.
@end itemize

If called with ONE prefix-argument (@kbd{[C-u]}) then the layout will
be drawn with all ECB-windows and also with a visible compile-window
(when @code{ecb-compile-window-height} is not nil). The
splitting-state of the edit-area will be preserved.

If called with TWO prefix-arguments (i.e. hitting @kbd{[C-u]} twice:
(@kbd{[C-u]} @kbd{[C-u]}) then an emergency-redraw will be performed.
This means the same as if called with one prefix-argument (s.a.) but
the splitting-state of the edit-area will NOT be preserved but all
edit-windows besides the current one will be deleted. Use this only if
there are some anomalies after standard redraws!

If the variable @code{ecb-redraw-layout-quickly} is not nil then the
redraw is done by the @code{ecb-redraw-layout-quickly} function,
otherwise by @code{ecb-redraw-layout-full}.

Please not: It's strongly recommended to use the quick redraw only if
you have really slow machines where a full redraw takes several
seconds because the quick redraw is not really safe and has some
annoying drawbacks! On normal machines the full redraw should be done
in << 1s so there should be no need for the quick version!
@end deffn


@deffn Command restore-default-window-sizes
Resets the sizes of the ECB windows to their default values.
@end deffn

@deffn Command restore-window-sizes
Sets the sizes of the ECB windows to their stored values. See option
@code{ecb-layout-window-sizes} and command
@code{ecb-store-window-sizes}.
@end deffn

@deffn Command select-ecb-frame
Selects the @code{ecb-frame} if ECB is activated - otherwise reports
an error.
@end deffn

@deffn Command show-help &optional format
Shows the online help of ECB either in Info or in HTML format
depending of the value of @code{ecb-show-help-format}. If called with
prefix argument, i.e. if @var{FORMAT} is not nil then the user is
prompted to choose the format of the help (Info or HTML). If an error
about not finding the needed help-file occurs please take a look at
the options @code{ecb-help-info-start-file} and
@code{ecb-help-html-start-file}!

Note: If you got ECB as a standard XEmacs-package maybe the
HTML-online-documentation is not included.
@end deffn

@deffn Command show-layout-help
Select a name of a layout and shows the documentation of the
associated layout-function. At least for the built-in layouts the
documentation contains a picture of the outline of the chosen layout.
@end deffn

@deffn Command show-tip-of-the-day
Show tip of the day if @code{ecb-tip-of-the-day} is not nil or if
called interactively.
@end deffn

@deffn Command sources-filter
Apply a filter to the sources-buffer to reduce the number of entries.
So you get a better overlooking. There are three choices:

@itemize @minus
@item Filter by extension:
Just insert the extension you want the Sources-buffer being filtered.
Insert the extension without leading dot!

@item Filter by regexp:
Insert the filter as regular expression.

@item No filter:
This means to display an entry for every file in the current selected
directory (all except these filter already filtered out by
@code{ecb-source-file-regexps} and
@code{ecb-sources-exclude-cvsignore}).
@end itemize

Such a filter is only applied to the current selected directory, i.e. each
directory has its own filtered sources-buffer.
@end deffn


@deffn Command store-window-sizes &optional fix
Stores the sizes of the ECB windows for the current layout. The size
of the ECB windows will be set to their stored values when
@code{ecb-redraw-layout} or @code{ecb-restore-window-sizes} is called.
To reset the window sizes to their default values call
@code{ecb-restore-default-window-sizes}. Please read also the
documentation of @code{ecb-layout-window-sizes}!

The windows sizes are stored per default as fractions of current
frame-width and -height of the ecb-frame, so the stored values will
``work'' for other frame sizes too. But if @var{FIX} is not nil (means
called with a prefix argument) then the fixed values of current width
and height are stored!
@end deffn

@deffn Command submit-problem-report
Submit a problem report for the ECB to the ECB mailing-list. This
command generates in the edit-window a problem-report which contains
already the current values of all ECB options, the current
backtrace-buffer if there is any and the current message-buffer. You
will be asked for a problem-report subject and then you must insert a
description of the problem. Please describe the problem as detailed as
possible!
@end deffn

@deffn Command toggle-auto-expand-tag-tree &optional arg
Toggle auto expanding of the ECB-methods-buffer. With prefix argument
@var{ARG}, make switch on if positive, otherwise switch off. If the
effect is that auto-expanding is switched off then the current value
of @code{ecb-auto-expand-tag-tree} is saved so it can be used for
the next switch on by this command.
@end deffn

@deffn Command toggle-compile-window &optional arg
Toggle the visibility of the compile-window of ECB. With prefix
argument ARG, make visible if positive, otherwise invisible. The
height of the compile-window is always the current value of
@code{ecb-compile-window-height}! If called and
@code{ecb-compile-window-height} is nil then ECB asks for the height
of the compile-window, sets this height as new value of
@code{ecb-compile-window-height} and displays the compile-window (so
if you have called this command by mistake and you do not want a
compile-window you have to quit with @key{C-g}).
@end deffn


@deffn Command toggle-compile-window-height &optional arg
Toggle whether the @code{ecb-compile-window} is enlarged or not. If
@var{ARG} > 0 then shrink or enlarge the the compile-window according
to the value of @code{ecb-enlarged-compilation-window-max-height}. But
never shrink below the value of @code{ecb-compile-window-height}. If
@var{ARG} <= 0 then shrink @code{ecb-compile-window} to
@code{ecb-compile-window-height} and if @var{ARG} is nil then toggle
the enlarge-state.
@end deffn

@deffn Command toggle-ecb-windows &optional arg
Toggle visibility of the ECB-windows. With prefix argument @var{ARG},
make visible if positive, otherwise invisible. This has nothing to do
with (de)activating ECB but only affects the visibility of the ECB
windows. ECB minor mode remains active!
@end deffn

@deffn Command toggle-layout
Toggles between the layouts defined in
@code{ecb-toggle-layout-sequence} (See also option
@code{ecb-show-sources-in-directories-buffer}). Note: This function
works by changing the options @code{ecb-layout-name} but only for
current Emacs-session.
@end deffn

@deffn Command toggle-scroll-other-window-scrolls-compile &optional ARG
Toggle the state of
@code{ecb-scroll-other-window-scrolls-compile-window}. With prefix
argument @var{ARG}, set it to @code{t}, otherwise to @code{nil}. For
all details about the scroll-behavior of @code{scroll-other-window}
see the advice documentation of @code{other-window-for-scrolling}.
@end deffn

@deffn Command toggle-window-sync &optional arg
Toggle auto synchronizing of the ECB-windows. With prefix argument
@var{ARG}, switch on if positive, otherwise switch off. If the effect
is that auto-synchronizing is switched off then the current value of
the option @code{ecb-window-sync} is saved so it can be used for the
next switch on by this command. See also the option
@code{ecb-window-sync}.
@end deffn

@deffn Command update-directories-buffer
Updates the ECB directories buffer.
@end deffn

@deffn Command upgrade-options
Check for all ECB-options if their current value is compatible to the
defined type. If not upgrade it to the new type or reset it to the
default-value of current ECB. Try also to upgrade renamed options.
Displays all upgraded or reset options with their old (before the
upgrade/reset) and new values.
@end deffn

@deffn Command window-sync
Synchronizes all special ECB-buffers with current buffer.

Depending on the contents of current buffer this command performs different
synchronizing tasks but only if ECB is active and point stays in an
edit-window.

@itemize
@item
If current buffer is a file-buffer then all special ECB-tree-buffers are
synchronized with current buffer.

@item
If current buffer is a dired-buffer then the directory- and
the sources-tree-buffer are synchronized if visible
@end itemize

In addition to this the hooks in @code{ecb-current-buffer-sync-hook}
run.
@end deffn

Most of these functions are also available via the menu ``ECB'' and
also via the ECB key-map with prefix @kbd{C-c .} (see
@code{ecb-minor-mode} for a complete list of the keybindings).

@node Customizing, Submitting problem report, Usage of ECB, Top
@chapter Customizing ECB

This chapter describes how to customize ECB for your personal taste.
The first section introduces some general aspects (which you should
really know!), the second one gives an overview of the most important
options and the third one lists all options of ECB (divided into the
customize groups).

@menu
* General aspects::             General aspects for customizing ECB
* Most important options::      Which option you must know
* Customizable options::        All customizable options of ECB
@end menu

@node General aspects, Most important options, Customizing, Customizing
@section General aspects for customizing ECB

This chapter contains all important informations you should know about
customizing ECB. The first section gives an answer to the question
``@code{setq} or @code{customize}'' and the second section describes
what to do when you have to customize ECB for a lot of people.

@menu
* setq or customize::           Should i use setq or customize?
* Site-wide customizing::       Site-wide customizing of ECB
@end menu

@node setq or customize, Site-wide customizing, General aspects, General aspects
@subsection Setq or customize - what should i use?

The best way to customize all the options of ECB is via the
customize-feature of (X)Emacs, i.e. means calling the commands
@code{customize-option} or @code{customize-group} etc. This is also
the strongly recommended way!

But of course you can also use @code{setq} or some Elisp-code to
change the values of many but not all of the options. The values of
the following options @strong{MUST NOT} be changed via @code{setq} or
Elisp-code but only with the customize-feature!

@itemize @minus
@item @code{ecb-advice-window-functions}
@item @code{ecb-bucket-node-display}
@item @code{ecb-compile-window-height}
@item @code{ecb-compile-window-temporally-enlarge}
@item @code{ecb-compile-window-width}
@item @code{ecb-exclude-parents-regexp}
@item @code{ecb-fix-window-size}
@item @code{ecb-font-lock-tags}
@item @code{ecb-highlight-tag-with-point-delay}
@item @code{ecb-key-map}
@item @code{ecb-layout-name}
@item @code{ecb-layout-window-sizes}
@item @code{ecb-mode-line-data}
@item @code{ecb-mode-line-display-window-number}
@item @code{ecb-mode-line-prefixes}
@item @code{ecb-show-node-info-in-minibuffer}
@item @code{ecb-show-tags}
@item @code{ecb-source-path}
@item @code{ecb-toggle-layout-sequence}
@item @code{ecb-tag-display-function}
@item @code{ecb-tree-RET-selects-edit-window}
@item @code{ecb-type-tag-display}
@item @code{ecb-type-tag-expansion}
@item @code{ecb-use-speedbar-instead-native-tree-buffer}
@item @code{ecb-window-sync-delay}
@item @code{ecb-windows-height}
@item @code{ecb-windows-width}
@end itemize

@node Site-wide customizing, , setq or customize, General aspects
@subsection Site-wide customizing of ECB

If you are the administrator for an Emacs-site, means you are
responsible for the basic customization of a lot of Emacs users, then
you maybe need a way to customize Emacs and ECB without changing
everyones @file{.emacs}-file and normally you will do this with the
file @file{site-start.el}. You can customize all options of ECB in a
central @file{site-start.el} (even the options mentioned above!) but
you @strong{MUST NOT} do this via @code{setq} but you have to use a
mechanism like the following@footnote{At least for the options for
which @code{setq} is explicitly forbidden, but it is recommended to
use always such a mechanism}!

This section describes two methods how to pre-customize ECB site-wide.
The elisp-code contained in the following two subsections has to be
copied to the file @file{site-start.el} before it can be used.

But ensure for both methods that you customize the options with the
correct lisp format. Read carefully the docstrings of the options you
want to customize from within Elisp-code!

@subsubsection Storing all option-settings in the users custom-file

The mechanism described here defines all site-wide-settings in a file
@file{site-lisp.el} but stores the values in the users
@code{custom-file} which is probably @file{.emacs}!

First two helper functions are needed, namely
@code{customize-option-get-value} and
@code{customize-save-variable-save} whereas the latter one sets the
value for an option via the customize-mechanism (and is therefore
allowed for the setq-forbidden options!) but only if the option has no
saved value until now (i.e. the user has not saved this option for
future sessions until now)

@example
@group
(defun customize-option-get-value (option type)
  "Return the value of a customizable option OPTION with TYPE, where TYPE
can either be 'standard-value \(the default-value of the defcustom) or
'saved-value \(the value stored durable by the user via customize)."
  (let ((val (car (get option type))))
    (cond ((not (listp val)) val)
          ((equal 'quote (car val)) (car (cdr val)))
          (t (car val)))))

(defun customize-save-variable-save (option value &optional override)
  "Calls `customize-save-variable' with OPTION and VALUE if OPTION is a
custom-type and if OPTION has no saved-value until now.
If OVERRIDE is a function or lambda-form then it is called with two arguments:
- OLD-SAVED-VAL: The saved value of OPTION
- NEW-VALUE: see argument VALUE.
OVERRIDE is only called if OPTION has already a saved-value. If OVERIDE
returns not nil then `customize-save-variable' is called for OPTION with VALUE
even if OPTION has no saved-value until now."
  (and (get option 'custom-type)
       (or (not (get option 'saved-value))
           (and (functionp override)
                (funcall override
                         (customize-option-get-value option 'saved-value)
                         value)))
       (progn
         (message "Overriding saved value for option %s with %s" option value)
         (customize-save-variable option value))))
@end group
@end example

With @code{customize-save-variable-save} all ECB-options can be
site-wide pre-customized like follows:

@example
@group
(customize-save-variable-save 'ecb-show-tags
                              '((include collapsed nil)
                                (parent collapsed nil)
                                (type flattened nil)
                                (variable collapsed name)
                                (function flattened name)
                                (rule flattened name)
                                (section flattened nil)
                                (def collapsed name)
                                (t collapsed name)))
(customize-save-variable-save 'ecb-font-lock-tags t)
;; add here more options of ECB it you want
@end group
@end example

@subsubsection Using a special setq for site-wide settings

The mechanism above saves the pre-customized values always in the
users @code{custom-file} (probably @file{.emacs}). If this is not
preferred, then you can use the following mechanism but of course the
offered @code{setq-save} is only allowed for options which are not
setq-forbidden (@pxref{setq or customize}).

The mechanism below does not change the users @code{custom-file}. This
mechanism is needed especially if ECB should be autoloaded and all
site-wide settings should first loaded when ECB is activated by the
user. This can be achieved for example via@footnote{The file
@file{site-ecb.el} contains all site-wide settings for ECB}:

@example
@group
(require 'ecb-autoloads))
(eval-after-load "ecb"
  '(require 'site-ecb))
@end group
@end example

In such a situation the whole @code{custom-file} of a user is mostly
loaded @strong{before} ECB is activated and therefore before the
site-wide-settings are loaded. So the users own customizations are
loaded before the site-wide ones.

The @code{setq-save}-mechanism described below prevents the users own
customisations contained in his @code{custom-file} from being
overridden by the site-wide setq-settings. If @code{setq} would be
used for the site-wide settings then in an autoload-situation the
site-wide settings would override the users-settings and this should
not be done!

First two helper-macros are needed:

@example
@group
(defmacro custom-saved-p (option)
  "Return only not nil if OPTION is a defcustom-option and has a
saved value. Option is a variable and is literal \(not evaluated)."
  `(and (get (quote ,option) 'custom-type)
        (get (quote ,option) 'saved-value)))

(defmacro setq-save (option value)
  "Sets OPTION to VALUE if and only if OPTION is not already saved
by customize. Option is a variable and is literal \(not evaluated)."
  `(and (not (custom-saved-p ,option))
        (set (quote ,option) ,value)))
@end group
@end example

With @code{setq-save} all ``not-setq-forbidden''-ECB-options can be
site-wide pre-customized like follows:

@example
@group
(setq-save ecb-tree-indent 4)
(setq-save ecb-tree-expand-symbol-before t)
(setq-save ecb-primary-secondary-mouse-buttons 'mouse-1--mouse-2)
@end group
@end example

@node Most important options, Customizable options, General aspects, Customizing
@section The most important options of ECB

Here are the most important options (it is recommended to check at
least the following options before working with ECB). You can
customize them via the customize-group ``ecb-most-important'' or via
the command @code{ecb-customize-most-important}.

@table @code
@item ecb-source-path
Where ECB can find your sources. You must set this option!
@item ecb-show-help-format
Should the online help of ECB be displayed in the standard Info format
or in HTML format in a web-browser.
@item ecb-auto-activate
@item ecb-major-modes-show-or-hide
Auto. activation of ECB after start (@pxref{Automatic activation}) or
major-mode-based showing or hiding the ecb-windows.
@item ecb-winman-escreen-number
@itemx ecb-winman-winring-name
Support of several window-managers (@pxref{Window-managers and ECB}).
@item ecb-key-map
All ECB-keybindings incl. a common prefix-key (@pxref{Using the
keyboard}).
@item ecb-new-ecb-frame
Should ECB create a new frame at activation time.
@item  ecb-primary-secondary-mouse-buttons
@itemx ecb-mouse-click-destination
Define how to use the mouse (@pxref{Using the mouse}).
@item ecb-tree-buffer-style
@itemx ecb-tree-expand-symbol-before
@itemx ecb-tree-indent
@itemx ecb-truncate-lines
The look&feel of the trees in the tree-buffers. The former option
defines the general style of the tree-buffers and the latter ones
allow to customize the ascii-style tree-buffers (maybe you like a
value of 4 for the latter one if you display the expand-symbol before
(@pxref{Tree-buffer styles}).
@item ecb-source-file-regexps
Which files will (not) be shown in ECB.
@item ecb-show-node-info-in-minibuffer
When and which node-info should be displayed in the minibuffer?
@item ecb-layout-name
@itemx ecb-compile-window-height
@itemx ecb-compile-window-width
@itemx ecb-other-window-behavior
The ECB layout, means which windows you want to be displayed in the
ECB-frame and also the location of these windows (@pxref{Changing the
ECB-layout}).
@item  ecb-tag-display-function
@itemx ecb-type-tag-display
@itemx ecb-type-tag-expansion
@itemx ecb-show-tags
How to display the entries in the ECB-method window for semantic
supported sources (@pxref{Customizing the display}). These options
take only effect for semantic-sources (@pxref{Definition of semantic-
and non-semantic-sources}).
@item ecb-process-non-semantic-files
Displaying file-contents for not by semantic supported files too, e.g.
for LaTeX- and perl-sources (@pxref{Non-semantic sources}).
@end table

But to make ECB working best for you it is also recommended to have a
look at @ref{Customizable options}!

@node Customizable options, ,Most important options, Customizing
@section All customizable options of ECB

@noindent
All customization of ECB is divided into the following ``customize
groups''. You can highly customize all the ECB behavior/layout so just
go to these groups and you will see all well documented ECB-options.

@strong{Please note}: All options in the following subsections are
listed without the prefix ``ecb-'' (e.g. the option
@code{ecb-layout-name} is listed with name ``layout-name''). This has
been done for a better readable option index. @xref{Option Index}.

@menu
* ecb-general::                 General customizing ECB
* ecb-tree-buffer::             Customizing the general tree layout
* ecb-directories::             Customizing the ECB-directories-tree
* ecb-sources::                 Customizing the ECB-sources-tree
* ecb-methods::                 Customizing the ECB-methods-tree
* ecb-history::                 Customizing the ECB-history-tree
* ecb-layout::                  Customizing the ECB-layout
* ecb-compilation::             Customizing the compile-window
* ecb-create-layout::           Customizing options for creating layouts
* ecb-face-options::            Customizing options for faces
* ecb-faces::                   Customizing the faces
* ecb-download::                Customizing how to download ECB
* ecb-help::                    Customizing the online help of ECB
* ecb-eshell::                  Customizing the eshell-integration
* ecb-non-semantic::            Customizing parsing non-semantic sources
* ecb-winman::                  Customizing window-manager support
* ecb-mode-line::               Customizing the tree-buffer-modelines
@end menu

@node ecb-general, ecb-tree-buffer, Customizable options, Customizable options
@subsection Group ecb-general

@noindent
This group contains general settings for the Emacs code browser:

@defopt activate-before-layout-draw-hook
Normal hook run at the end of activating the ecb-package by running
@code{ecb-activate}. This hooks are run after all the internal setup
process but directly before(!) drawing the layout specified in
@code{ecb-layout} (means before dividing the frame into several
windows).

A senseful using of this hook can be maximizing the Emacs-frame for
example, because this should be done before the layout is drawn
because ECB computes the size of the ECB-windows with the current
frame size! If you need a hook-option for the real end of the
activating process (i.e. after the layout-drawing) look at
@code{ecb-activate-hook}.

IMPORTANT: The difference between this hook and
@code{ecb-redraw-layout-before-hook} is that the latter one is
evaluated always before the layout is redrawn (for example after
calling @code{ecb-redraw-layout}) whereas the former one (this hook)
is only evaluated exactly once during the activation-process of ECB.
So during the activation process there is the following sequence of
hooks:
@enumerate
@item @code{ecb-activate-before-layout-draw-hook} \(this one)
@item @code{ecb-redraw-layout-before-hook}
@item <Drawing the layout>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-activate-hook}
@end enumerate
@end defopt

@defopt activate-hook
Hook run at the end of activating ECB by @code{ecb-activate}. This
hooks are run at the real end of the activating process, means after
the layout has been drawn!. If you need hooks which are run direct
before the layout-drawing look at
@code{ecb-activate-before-layout-draw-hook}.
@end defopt

@defopt activation-selects-ecb-frame-if-already-active
Trying to activate an already activated ECB selects the ECB-frame. If
t then the ECB-frame is selected, if nil then it is not. If 'ask then
ECB asks if the ECB-frame should be selected if the current-frame is
not the @code{ecb-frame}.
@end defopt

@defopt auto-activate
Automatically startup ECB when Emacs starts up. This should only be
true if you always want to run @code{ecb-activate}.
@end defopt

@defopt auto-compatibility-check
Check at ECB-startup if all ECB-options have correct values. If not
nil then all ECB-options are checked if their current value have the
correct type. It the type is incorrect the option is either auto.
upgraded to the new type or reset to the default-value of current ECB
if no upgrade is possible. This feature can also upgrade options which
are renamed in current ECB and try to transform the old-value to the
new named option. After startup all upgraded or reset options are
displayed with their old (before upgrade/reset) and new values. See
also the commands @code{ecb-upgrade-options} and
@code{ecb-display-upgraded-options}. If this option is off then the
user can perform the check and reset manually with
@code{ecb-upgrade-options}.
@xref{Auto. option-upgrading}.
@end defopt

@defopt before-activate-hook
Normal hook run at the beginning of activating the ecb-package by
running @code{ecb-activate}. These hooks run before any other tasks of
the activating process are performed. If any of these hooks returns
nil then ECB will not be activated!

This can be used to check some conditions and then only start ECB if
all conditions are true. For example a function could be added which
returns only nil if Gnus is running. Then calling @code{ecb-activate}
or @code{ecb-minor-mode} will only start ECB if Gnus is not already
running.
@end defopt

@defopt before-deactivate-hook
Normal hook run at the beginning of deactivating ECB by running
@code{ecb-deactivate}. These hooks run before any other tasks of the
deactivating process are performed. If any of these hooks returns nil
then ECB will not be deactivated! See also
@code{ecb-before-activate-hook}.
@end defopt

@defopt bucket-node-display
How ECB displays bucket-nodes in a ECB tree-buffer. Bucket-nodes have
only one job: Nodes with similar properties will be dropped into one
bucket for such a common property and all these nodes will be added as
children to the bucket-node. Besides being expandable and collapsable
a bucket-node has no senseful action assigned. Examples for
bucket-nodes are ``[+] Variables, ``[+] Dependencies'' etc. in the
Methods-buffer or buckets which combine filenames with same extension
under a bucket-node with name this extension.

This option defines how bucket-node should be displayed. The name of
the bucket-node is computed by ECB but you can define a prefix, a
suffix and a special face for the bucket-node

The default are empty prefix/suffix-strings and
@code{ecb-bucket-node-face}. But an alternative can be for example
'(``['' ``]'' nil) which means no special face and a display like
``[+] [<bucket-name>]''.
@end defopt


@defopt clear-caches-before-activate
Clear all ECB internal caches before startup. If t then ECB clears all
its internal caches before starting up. Caches are used for files- and
subdirs (see @code{ecb-cache-directory-contents} and
@code{ecb-cache-directory-contents-not}) for semantic-tags and for
the history-filter.

This caches are completely clean at load-time of the ECB-library!

Default is nil, because is makes sense not to clear these caches at
start-time because ECB is often deacticated temporally especially in
combination with window-managers like escreen.el. In these situations
the internal state of ECB should be preserved for next activation.
@end defopt


@defopt current-buffer-sync-hook
Normal hook run at the end of @code{ecb-current-buffer-sync}.

See documentation of @code{ecb-current-buffer-sync} for conditions when
synchronization takes place and so in turn these hooks are evaluated.

Precondition for such a hook:
Current buffer is the buffer of the current selected edit-window.

Postcondition for such a hook:
Point must stay in the same edit-window as before evaluating the hook.

Important note: If @code{ecb-window-sync} is not nil
@code{ecb-current-buffer-sync} is running either every time Emacs is
idle or even after every command (see @code{ecb-window-sync-delay}).
So these hooks can be really called very often! Therefore each
function of this hook should/must check in an efficient way at
beginning if its task have to be really performed and then do them
only if really necessary! Otherwise performance of Emacs could slow
down dramatically!

It is strongly recommended that each function added to this hook uses
the macro @code{ecb-do-if-buffer-visible-in-ecb-frame} at beginning!
See @code{ecb-speedbar-current-buffer-sync} and
@code{ecb-eshell-current-buffer-sync} for examples how to use this
macro!
@end defopt



@defopt deactivate-hook
Normal hook run at the end of deactivating (but before the ecb-layout
is cleared!) ECB by running @code{ecb-deactivate}.
@end defopt

@defopt debug-mode
If not nil ECB displays debug-information in the Messages-buffer. This
is done for some critical situations concerning semantic-tags and
their overlays (or extends for XEmacs). Normally you should not need
this switched on! But if you get errors like ``destroyed extend'' for
XEmacs or ``wrong-argument-type'' concerning overlays for GNU Emacs then
you should switch on this option and submitting a bug-report to the
ecb-mailing-list (@code{ecb-submit-problem-report}) after getting the
error again!
@end defopt

@defopt grep-function
Function used for performing a grep. The popup-menu of the
tree-buffers ``Directories'', ``Sources'' and ``History'' offer to
grep the ``current'' directory:
@itemize @minus
@item
Directory-buffer: The grep is performed in the current popup-directory
after clicking the right mouse-button onto a node.
@item
Sources-buffer: The grep is performed in the current selected directory.
@item
History-buffer: The grep is performed in the directory of the current
popup-source after clicking the right mouse-button onto a node.
@end itemize
@end defopt

@defopt grep-find-function
Function used for performing a recursive grep. For more Details see
option `ecb-grep-function' and replace ``grep'' with ``recursive
grep''.
@end defopt

@defopt key-map
Specifies all keybindings for the ECB minor-mode key-map. The value is
a cons-cell where the car is a common-prefix key for all the
keybindings. The cdr is a list of keybindings each of them a list
again. A key-binding has the following form:

@example
'(<common-prefix-flag> <keysequence> <function>) where
@end example

@table @code
@item <common-prefix-flag>
If t then the common-prefix-key defined as car of the value (see above)
is used.

@item <keysequence>
If the common prefix-key is used then the final key-binding is the
concatenation of the common-prefix-key (see above) and this
keysequence.

@item <function>:
The function to bind to the key. This can also be a lambda-expression
.
@end table

It is highly recommended to use one of the standard keys C-c or C-x as
first key of your common-prefix-key!

You MUST change this option via customize to take effect!

All keysequences must be inserted as a string and must follow the
syntax needed by @code{read-kbd-macro} or @code{kbd}. This means you
can insert the key in the same manner @kbd{C-h k} displays keysequences.
Here is the summary of the syntax:

Text is divided into ``words'' separated by whitespace. Except for the words
described below, the characters of each word go directly as characters of the
keysequence. The whitespace that separates words is ignored. Whitespace in the
macro must be written explicitly, as in @kbd{C-c SPC}.

@itemize @bullet
@item
The special words RET, SPC, TAB, DEL, LFD, ESC, and NUL represent
special control characters. The words must be written in uppercase.

@item
A word in angle brackets, e.g., <return>, <down>, <left> or <f1>,
represents a function key. (Note that in the standard configuration,
the function key <return> and the control key RET are synonymous.).
You can use angle brackets on the words RET, SPC, etc., but they are
not required there.

@item
Keys can be written by their ASCII code, using a backslash followed by
up to six octal digits. This is the only way to represent keys with
codes above �.

@item
One or more prefixes M- (meta), C- (control), S- (shift), A- (alt), H-
(hyper), and s- (super) may precede a character or key notation. For
function keys, the prefixes may go inside or outside of the brackets:
C-<down> = <C-down>. The prefixes may be written in any order: M-C-x =
C-M-x. Prefixes are not allowed on multi-key words, e.g., C-abc,
except that the Meta prefix is allowed on a sequence of digits and
optional minus sign: M--123 = M-- M-1 M-2 M-3.

@item
The @code{^} notation for control characters also works: ^M = C-m.
@end itemize
@end defopt

@defopt major-modes-show-or-hide
List of major-modes which show or hide the ecb-windows. The value is a
cons-cell where the car contains all major-mode-symbols which should
show the special ecb-windows and the cdr contains all
major-mode-symbols which should hide the special ecb-windows. If the
symbol of a major-mode is neither contained in the car-``show-list''
nor in the cdr-``hide-list'' then the visibility-state of the
ecb-windows does not change.
@end defopt


@defopt minor-mode-text
String to display in the mode line when ECB minor mode is active.
(When the string is not empty, make sure that it has a leading space.)
@end defopt


@defopt mouse-click-destination
Destination of a mouse-button click. Defines in which edit-window (if
splitted) ECB does the ``right'' action (opening a source, jumping to
a method/variable etc.) after clicking with the primary mouse-button
(see @code{ecb-primary-secondary-mouse-buttons}) onto a node. There
are two possible choices:

@itemize @minus
@item @code{left-top}:
Does the ``right'' action always in the left/topmost edit-window.
@item @code{last-point}:
Does the ``right'' action always in that edit-window which had the point
before.
@end itemize
This is if the user has clicked either with the primary mouse-button or
has activated a popup-menu in the tree-buffer.

If the edit-area is not splitted this setting doesn't matter.

A click with the secondary mouse-button (see again
@code{ecb-primary-secondary-mouse-buttons} does the ``right'' action
always in another edit-window related to the setting in this option:
If there are two edit-windows then the ``other'' edit-window is used
and for more than 2 edit-windows the ``next'' edit-window is used
(whereas the next edit-window of the last edit-window is the first
edit-window).

Note: If the tree-buffers are used with the keyboard instead with the
mouse then this option takes effect too because @kbd{RET} is
interpreted as primary mouse-button and @kbd{C-RET} as secondary
mouse-button!
@end defopt

@defopt run-ediff-in-ecb-frame
Run ediff-sessions in the same frame as ECB is running.
If not nil then ECB ensures that ediff runs in the same frame as ECB and ECB
restores exactly the ``before-ediff''-window-layout after quiting ediff. If
nil then ediff decides in which frame it will run - depending on the current
window-layout (e.g. if the ecb-windows are currently hidden) this can be the
ecb-frame but this can also be a newly created frame or any other frame.
@end defopt

@defopt tip-of-the-day
Show tip of the day at start time of ECB.
@end defopt

@defopt tip-of-the-day-file
File where tip-of-the-day cursor is stored.
@end defopt

@defopt use-recursive-edit
Tell ECB to use a recursive edit. If set then it can easily be
deactivated by (keyboard-escape-quit).
@end defopt

@defopt version-check
Checks at start-time if the requirements are fulfilled.
It checks if the required versions of the libraries semantic, eieio and
speedbar are installed and loaded into Emacs.

It is strongly recommended to set this option to not @code{nil}!
@end defopt

@defopt window-sync
Synchronize the ECB-windows automatically with current edit window. If
@code{always} then the synchronization takes place always a buffer
changes in the edit window, if @code{nil} then never. If a list of
major-modes then only if the @code{major-mode} of the new buffer
belongs NOT to this list.

But in every case the synchronization takes only place if the
current-buffer in the current active edit-window has a relation to
files or directories. Examples for the former one are all
programming-language-modes, @code{Info-mode} too, an example for the
latter one is @code{dired-mode}. For all major-modes related to
non-file/directory-buffers like @code{help-mode},
@code{customize-mode} and others never an autom. synchronization will
be done!

It's recommended to exclude at least @code{Info-mode} because it makes
no sense to synchronize the ECB-windows after calling the Info help.
Per default also @code{dired-mode} is excluded but it can also making
sense to synchronize the ECB-directories/sources windows with the
current directory in the dired-buffer.

IMPORTANT NOTE: Every time the synchronization is done the hook
@code{ecb-current-buffer-sync-hook} is evaluated.
@end defopt


@defopt window-sync-delay
Time Emacs must be idle before the ECB-windows are synchronized with
current edit window. If nil then there is no delay, means
synchronization takes place immediately. A small value of about 0.25
seconds saves CPU resources and you get even though almost the same
effect as if you set no delay.
@end defopt


@node ecb-tree-buffer, ecb-directories, ecb-general, Customizable options
@subsection Group ecb-tree-buffer

@noindent
This group contains general settings related to the tree-buffers of
ECB:

@defopt common-tree-buffer-after-create-hook
Local hook running at the end of each tree-buffer creation. Every
function of this hook is called once without arguments direct after
creating a tree-buffer of ECB and it's local key-map. So for example a
function could be added which performs calls of @code{local-set-key}
to define new keybindings for EVERY tree-buffer.

The following keys must not be rebind in all tree-buffers:
@itemize @minus
@item @kbd{RET} and all combinations with @kbd{Shift} and @kbd{Ctrl}
@item @kbd{TAB}
@item @code{C-t}
@end itemize
@end defopt

@defopt primary-secondary-mouse-buttons
Primary- and secondary mouse button for using the ECB-buffers. A click
with the primary button causes the main effect in each ECB-buffer:

@itemize @bullet
@item ECB Directories:
Expanding/collapsing nodes and displaying files in the ECB
Sources buffer.

@item ECB sources/history:
Opening the file in that edit-window specified by the option
@code{ecb-mouse-click-destination}.

@item ECB Methods:
Jumping to the method in that edit-window specified by the option
@code{ecb-mouse-click-destination}.
@end itemize

A click with the primary mouse-button while the SHIFT-key is pressed called
the POWER-click and does the following (depending on the ECB-buffer where the
POWER-click occurs):

@itemize @bullet
@item ECB Directories:
Refreshing the directory-contents-cache (see
@code{ecb-cache-directory-contents}).

@item ECB sources/history:
Only displaying the source-contents in the method-buffer but not
displaying the source-file in the edit-window.

@item ECB Methods:
Narrowing to the clicked method/variable/ect... (see
@code{ecb-tag-visit-post-actions}). This works only for semantic
supported sources but not for imenu- or etags-supported ones!
@end itemize

In addition always the whole node-name is displayed in the minibuffer after a
POWER-click \(for this see also `ecb-show-node-info-in-minibuffer').

The secondary mouse-button is for opening (jumping to) the file in
another edit-window (see the documentation
@code{ecb-mouse-click-destination}).

The following combinations are possible:

@itemize @minus
@item
primary: mouse-2, secondary: C-mouse-2 (means mouse-2 while CTRL-key is
pressed). This is the default setting.
@item
primary: mouse-1, secondary: C-mouse-1
@item
primary: mouse-1, secondary: mouse-2
@end itemize

Please note: If the tree-buffers are used with the keyboard instead
with the mouse then @kbd{RET} is interpreted as primary mouse-button and
@kbd{C-RET} as secondary mouse-button!

If you change this during ECB is activated you must deactivate and
activate ECB again to take effect
@end defopt

@defopt show-node-info-in-minibuffer
Node info to display in a tree-buffer. Define which node info should
displayed in a tree-buffer after mouse moving over the node or after a
shift click onto the node.

For every tree-buffer you can define ``when'' node info should be
displayed:

@itemize @minus
@item @code{always}:
Node info is displayed by moving with the mouse over a node.
@item @code{if-too-long}:
Node info is only displayed by moving with the mouse over a node does
not fit into the window-width of the tree-buffer window. In the ECB
directories buffer this means also if a node is shortened or if the
node has an alias (see @code{ecb-source-path}).
@item @code{shift-click}:
Node info is only displayed after a shift click with the primary mouse
button onto the node.
@item @code{never}:
Node info is never displayed.
@end itemize

For every tree-buffer you can define what info should be displayed:

@itemize @bullet
@item Directory-buffer:
@itemize @minus
@item @code{name}: Only the full node-name is displayed.
@item @code{path}: The full-path of the node is displayed.
@end itemize

@item Sources-buffer:
@itemize @minus
@item @code{name}: Only the full node-name is displayed.
@item @code{file-info}: File infos for this file are displayed.
@item @code{file-info-full}: Fill infos incl. full path for this file are
displayed.
@end itemize
@item History-buffer: see Directories-buffer.
@item Methods-buffer:
@itemize @minus
@item @code{name}: Only the full node name is displayed.
@item @code{name+type}: The full name + the type of the node (function, class,
variable) is displayed.
@end itemize
@end itemize

Do NOT set this option directly via setq but use always customize!
@end defopt

@defopt tree-RET-selects-edit-window
In which tree-buffers RET should finally select an edit-window. If a
name of an ECB tree-buffer is contained in this list then hitting RET
in this tree-buffer selects as last action the right edit-window
otherwise only the right action is performed (opening a new source,
selecting a method etc.) but point stays in the tree-buffer.

A special remark for the @code{ecb-directories-buffer-name}: Of course
here the edit-window is only selected if
@code{ecb-show-sources-in-directories-buffer} is not nil (otherwise
this would not make any sense)!

The setting in this option is only the default for each tree-buffer.
With @code{ecb-toggle-RET-selects-edit-window} the behavior of RET can
be changed fast and easy in a tree-buffer without customizing this
option, but of course not for future Emacs sessions!
@end defopt

@defopt tree-buffer-style
The style of the tree-buffers.
There are three different styles available:

Image-style (value @code{image}): Very nice and modern - just try it.
For this style the options @code{ecb-tree-indent} and
@code{ecb-tree-expand-symbol-before} have no effect! Note: GNU Emacs
<= 21.3.X for Windows does not support image-display so ECB uses
always 'ascii-guides even when here 'image is set!

Ascii-style with guide-lines (value @code{ascii-guides}):
@example
@group
[-] ECB
 |  [+] code-save
 `- [-] ecb-images
     |  [-] directories
     |   |  [-] height-15
     |   |   |  * close.xpm
     |   |   |  * empty.xpm
     |   |   |  * leaf.xpm
     |   |   `- * open.xpm
     |   |  [+] height-17
     |   |  [+] height-19
     |   `- [+] height-21
     |  [x] history
     |  [x] methods
     `- [x] sources
@end group
@end example

Ascii-style without guide-lines (value @code{ascii-no-guides}) - this
is the style used by ECB <= 1.96:
@example
@group
[-] ECB
    [+] code-save
    [-] ecb-images
        [-] directories
            [-] height-15
                * close.xpm
                * empty.xpm
                * leaf.xpm
                * open.xpm
            [+] height-17
            [+] height-19
            [+] height-21
        [x] history
        [x] methods
        [x] sources
@end group
@end example

With both ascii-styles the tree-layout can be affected with the
options @code{ecb-tree-indent} and
@code{ecb-tree-expand-symbol-before}.
@end defopt

@defopt tree-easy-hor-scroll
Scroll step for easy hor. scrolling via mouse-click in tree-buffers.
XEmacs has horizontal scroll-bars so invisible parts beyond the right
window-border of a tree-buffer can always made visible very easy.

GNU Emacs does not have hor. scroll-bars so especially with the mouse
it is quite impossible to scroll smoothly right and left. The
functions @code{scroll-left} and @code{scroll-right} can be annoying
and are also not bound to mouse-buttons.

If this option is a positive integer S then in all ECB-tree-buffers
the keys @kbd{M-mouse-1} and @code{M-mouse-3} are bound to scrolling
left rsp. right with scroll-step S - clicking with @kbd{mouse-1} or
@kbd{mouse-2} onto the edge of the modeline has the same effect, i.e.
if you click with mouse-1 onto the left (rsp right) edge of the
modeline you will scroll left (rsp. right).

Additionally @code{C-M-mouse-1} and @code{C-M-mouse-3} are bound to
scrolling left rsp. right with scroll-step @code{window-width} - 2.

Default is a scroll-step of 5. If the value is @code{nil} then no keys
for horizontal scrolling are bound.
@end defopt

@defopt tree-expand-symbol-before
Show the expand symbol before the items in a tree. When the
expand-symbol is located before the items then the tree looks like:

@example
@group
[-] ECB
    [+] code-save
    [-] ecb-images
        [-] directories
@end group
@end example

When located after then the tree looks like:

@example
@group
ECB [-]
  code-save [+]
  ecb-images [-]
    directories [-]
@end group
@end example

The after-example above use a value of 2 for @code{ecb-tree-indent}
whereas the before-example uses a value of 4.

It is recommended to display the expand-symbol before because
otherwise it could be that with a deep nested item-structure with
and/or with long item-names (e.g. a deep directory-structure with some
long subdirectory-names) the expand-symbol is not visible in the
tree-buffer and the tree-buffer has to be horizontal scrolled to
expand an item.
@end defopt

@defopt tree-image-icons-directories
Directories where the images for the tree-buffer can be found.
This is a five-element list where:
@enumerate
@item element: Default directory where the default images for the
tree-buffer can be found. It should contain an image for every name of
@code{tree-buffer-tree-image-names}. The name of an image-file must
be: ``ecb-<NAME of TREE-BUFFER-TREE-IMAGE-NAMES>.<ALLOWED
EXTENSIONS>''.
@item element: Directory for special images for the Directories-buffer.
@item element: Directory for special images for the Sources-buffer.
@item element: Directory for special images for the Methods-buffer.
@item element: Directory for special images for the History-buffer.
@end enumerate

The directories of the element 2 - 5 are additional image-directories
which are searched first for images needed for the respective
tree-buffer. If the image can not be found in this directory then the
default-directory (1. element) is searched. If the image can't even
found there the related ascii-symbol is used.

All but the first element (the default directory) can be nil.

ECB comes with images in four diffenent heights - so for the most
senseful font-heights of a tree-buffer a fitting image-size should be
available. The images reside either in the subdirectory ``ecb-images''
of the ECB-installation or - if ECB is installed as regular
XEmacs-package - in the ECB-etc data-directory.
@end defopt

@defopt tree-incremental-search
Enable incremental search in the ECB-tree-buffers. For a detailed
explanation see the online help section ``Working with the keyboard in
the ECB buffers''. If you change this during ECB is activated you must
deactivate and activate ECB again to take effect.
@end defopt

@defopt tree-indent
Indent size for tree buffer. If you change this during ECB is
activated you must deactivate and activate ECB again to take effect.
@end defopt

@defopt tree-navigation-by-arrow
Enable smart navigation in the tree-windows by horiz. arrow-keys. If
not nil then the left- and right-arrow keys work in the ECB
tree-window in the following smart way if onto an expandable node:

@itemize @bullet
@item Left-arrow:
If node is expanded then it will be collapsed otherwise point jumps to
the next ``higher'' node in the hierarchical tree (higher means the next
higher tree-level or - if no higher level available - the next higher
node on the same level).

@item Right-arrow:
If node is not expanded then it will be expanded. Onto a not
expandable node the horizontal arrow-keys go one character in the
senseful correct direction.
@end itemize

If this option is changed the new value takes first effect after deactivating
ECB and then activating it again!
@end defopt

@defopt truncate-lines
Truncate lines in ECB buffers. If you change this during ECB is
activated you must deactivate and activate ECB again to take effect.
@end defopt

@defopt truncate-long-names
Truncate long names that don't fit in the width of the ECB windows. If
you change this during ECB is activated you must deactivate and
activate ECB again to take effect.
@end defopt


@node ecb-directories, ecb-sources, ecb-tree-buffer, Customizable options
@subsection Group ecb-directories

@noindent
This group contains settings for the directories-buffer in the ECB:

@defopt add-path-for-not-matching-files
Add path of a file to @code{ecb-source-path} if not already contained.
This is done during the auto. windows synchronization which happens if
a file is opened not via the file/directory-browser of ECB. In such a
situation ECB adds the path of the new file auto. to
@code{ecb-source-path} at least temporally for the current Emacs
session. This option defines two things:

@enumerate
@item
Should only the root-part (which means for Unix-like systems always
'/' and for windows-like systems the drive) of the new file be added
as source-path to @code{ecb-source-path} or the whole directory-part?
@item
Should this path be added for future sessions too?
@end enumerate

The value of this option is a cons-cell where the car is a boolean for
1. and the cdr is a boolean for 2.

A value of not nil for the car (1.) is reasonably if a user often
opens files not via the ECB-browser which are not located in any of
the paths of @code{ecb-source-path} because then only one path for
each drive (windows) or the root-path (Unix) is added to the directory
buffer of ECB.
@end defopt

@defopt auto-expand-directory-tree
Automatically expand the directory tree to the current source file.
There are three options:

@itemize @minus
@item @code{best}: Expand the best-matching source-path
@item @code{first}: Expand the first matching source-path
@item @code{nil}: Do not automatically expand the directory tree.
@end itemize
@end defopt

@defopt cache-directory-contents
Cache contents of directories.

This can be useful if @code{ecb-source-path} contains directories with
many files and subdirs, especially if these directories are mounted
net-drives (``many'' means here something > 500, dependent of the speed
of the net-connection and the machine). For these directories
actualizing the sources- and/or directories- buffer of ECB (if
displayed in current layout!) can slow down dramatically so a caching
increases speed a lot.
 
The value of this option is a list where each element is a cons-cell
and looks like:

@example
  (<dir-regexp> . <filenumber threshold>) with
@end example

@table @code
@item <dir-regexp>:
Regular expression a directory must match to be cached.
@item <filenumber threshold>:
Number of directory contents must exceed this number.
@end table

A directory will only be cached if and only if the directory-name
matches at least one rexexp of this option and its content-number
exceeds the related threshold AND the directory-name matches NOT any
regexp of @code{ecb-cache-directory-contents-not}!

The cache entry for a certain directory will be refreshed and
actualized only by using the POWER-click (see
@code{ecb-primary-secondary-mouse-buttons}) in the directories-buffer
of ECB (@pxref{Using the mouse}).

Examples:

A value of @code{(("/usr/home/john_smith/bigdir*" . 1000))} means the
contents of every subdirectory of the home-directory of John Smith
will be cached if the directory contains more than 1000 entries and
its name begins with ``bigdir''.

A value of @code{((".*" . 1000))} caches every directory which has more
than 1000 entries.

A value of @code{((".*" . 0))} caches every directory regardless of the
number of entries."

Please note: If you want your home-dir being cached then you MUST NOT
use ``~'' because ECB tries always to match full path-names!
@end defopt

@defopt cache-directory-contents-not
Do not cache the contents of certain directories. The value of this
option is a list where the each element is a regular expression a
directory must match if it should not being cached.

If a directory-name matches at least one of the regexps of this option
the directory-contents will never being cached. See
@code{ecb-cache-directory-contents} to see when a directory will be
cached.

This option can be useful when normally all directories with a certain
amount of content (files and subdirs) should be cached but some
special directories not. This can be achieved by:

@itemize @minus
@item
Setting @code{ecb-cache-directory-contents} to ((``.*'' . 500)):
Caches all directories with more then 500 entries

@item
Setting @code{ecb-cache-directory-contents-not} to a value which
matches these directories which should not being cached (e.g.
(``/usr/home/john_smith'') excludes the HOME-directory of John Smith
from being cached).
@end itemize

Please note: If you want your home-dir exclude from being cached then
you MUST NOT use ``~'' because ECB tries always to match full
path-names!
@end defopt



@defopt directories-buffer-after-create-hook
Local hook running after the creation of the directories-buffer. Every
function of this hook is called once without arguments direct after
creating the directories-buffer of ECB and it's local key-map. So for
example a function could be added which performs calls of
@code{local-set-key} to define new keybindings only for the
directories-buffer of ECB.

The following keys must not be rebind in the directories-buffer:
@kbd{F2}, @kbd{F3} and @kbd{F4}
@end defopt


@defopt directories-buffer-name
Name of the ECB directory buffer. Because it is not a normal buffer
for editing you should enclose the name with stars, e.g. `` *ECB
Directories*''.

If it is necessary for you you can get emacs-lisp access to the buffer-object of
the ECB-directory-buffer by this name, e.g. by a call of @code{set-buffer}.

Changes for this option at runtime will take affect only after
deactivating and then activating ECB again!
@end defopt

@defopt directories-menu-sorter
Function which re-sorts the menu-entries of the directories buffer.

If a function then this function is called to re-arrange the
menu-entries of the combined menu-entries of the user-menu-extensions
of @code{ecb-directories-menu-user-extension} and the built-in-menu
@code{ecb-directories-menu}. If nil then no special sorting will be
done and the user-extensions are placed in front of the
built-in-entries.

The function get one argument, a list of menu-entries. For the format
of this argument see @code{ecb-directories-menu-user-extension}. The
function must return a new list in the same format. Of course this
function can not only re-arrange the entries but also delete entries
or add new entries.
@end defopt


@defopt directories-menu-user-extension
Static user extensions for the popup-menu of the directories buffer.
Value is a list of elements of the following type: Each element
defines a new menu-entry and is either:

@enumerate
@item Menu-command:
A list containing two sub-elements, whereas the first is the function
(a function symbol) being called if the menu-entry is selected and the
second is the name of the menu-entry.

@item Separator:
A one-element-list and the element is the string ``---'': Then a
non-selectable menu-separator is displayed.

@item Submenu:
A list where the first element is the title of the submenu displayed
in the main-menu and all other elements are either menu-commands (see
1) or separators (see 2).
@end enumerate

The function of a menu-command must follow the following guidelines:
Such a function must be defined with the macro
@code{tree-buffer-defpopup-command}! This macro defines a new
popup-command whereas the newly defined command gets one argument
@var{NODE}. See the docstring of @code{tree-buffer-defpopup-command}
for further details.

Example for the definition of such a menu-function:

@example
(tree-buffer-defpopup-command ecb-my-special-dir-popup-function
  "Prints the name of the directory of the node under point."
  (let ((node-data=dir (tree-node-get-data node)))
     (message ``Dir under node: %s'' node-data=dir)))
@end example

Per default the static user-extensions are added at the beginning of
the built-in menu-entries of @code{ecb-directories-menu} but the whole
menu can be re-arranged with @code{ecb-directories-menu-sorter}.

These menu-extensions are static. A dynamic menu-extension can be
achieved via @code{ecb-directories-menu-user-extension-function}.
@end defopt

@defopt directories-menu-user-extension-function
Dynamic user extensions for the popup-menu of the directories buffer.
A function which has to return a list in the same format like the
option @code{ecb-directories-menu-user-extension}. This function is
called when the user opens the popup-menu for the directories buffer.

Per default the dynamic user-extensions are added in front of the
static extensions of @code{ecb-directories-menu-user-extension} but
the whole menu can be re-arranged with
@code{ecb-directories-menu-sorter}.
@end defopt



@defopt display-default-dir-after-start
Automatically display current default-directory after activating ECB.

If a file-buffer is displayed in the current active edit-window then
ECB synchronizes its tree-buffers to this file-buffer - at least if
the option @code{ecb-window-sync} it not nil. So for this situation
@code{ecb-display-default-dir-after-start} takes no effect but this
option is for the case if no file-buffer is displayed in the
edit-window after startup:

If true then ECB selects autom. the current default-directory after
activation even if no file-buffer is displayed in the current active
edit-window. This is useful if ECB is autom. activated after startup
of Emacs and Emacs is started without a file-argument. So the
directory from which the startup has performed is auto. selected in
the ECB-directories buffer and the ECB-sources buffer displays the
contents of this directory.
@end defopt


@defopt excluded-directories-regexp
Directories that should not be included in the directories list. The
value of this variable should be a regular expression.
@end defopt

@defopt show-sources-in-directories-buffer
Show source files in directories buffer.
@end defopt

@defopt source-path
Paths where to find code sources. Each path can have an optional alias
that is used as it's display name. If no alias is set, the path is
used as display name.
@end defopt

@defopt use-speedbar-instead-native-tree-buffer
If true then uses speedbar for directories, sources or methods. This
means that speedbar is integrated in the ECB-frame and is displayed in
that window normally displaying the standard ECB-directories-buffer,
ECB-sources-buffer or ECB-methods-buffer.

This option takes effect in all layouts which contain either a
directory window, a sources window or a method window.

This option can have four valid values:
@itemize @minus
@item @code{nil}: Do not use speedbar (default)
@item @code{dir}: Use speedbar instead of the standard directories-buffer
@item @code{source}: Use speedbar instead of the standard sources-buffer
@item @code{method}: Use speedbar instead of the standard methods-buffer
@end itemize

Note: For directories and sources a similar effect and usability is
available by setting this option to @code{nil} (or @code{method}) and
setting @code{ecb-show-sources-in-directories-buffer} to not
@code{nil}, because this combination displays also directories and
sources in one window.

@code{ecb-use-speedbar-instead-native-tree-buffer} is for people who
like the speedbar way handling directories and source-files or methods
and want it in conjunction with ECB.
@end defopt


@node ecb-sources, ecb-methods, ecb-directories, Customizable options
@subsection Group ecb-sources

@noindent
This group contains settings for the sources-buffer in the ECB:

@defopt show-source-file-extension
Show the file extension of source files.
@end defopt

@defopt source-file-regexps
Specifies which files are shown as source files.

This is done on directory-base, which means for each directory-regexp
the files to display can be specified. If more than one
directory-regexp matches the current selected directory then always the
first one (and its related file-exclude/include-regexps) is used! If
no directory-regexp matches then all files are displayed for the
currently selected directory.

Important note: It is recommended that the *LAST* element of this list
should contain an always matching directory-regexp (@code{".*"})!

So the value of this option is a list of cons-cells where the car is a
directory regexp and the cdr is a 2 element list where the first
element is a exclude regexp and the second element is a include
regexp. A file is displayed in the source-buffer of ECB iff: The file
does not match the exclude regexp OR the file matches the include
regexp.

But regardless of the value of this option a file F is never displayed
in the sources-buffer if the directory matches
@code{ecb-sources-exclude-cvsignore} and the directory contains a file
.cvsignore which contains F as an entry!

There are three predefined and useful combinations of an exclude and
include regexp:

@itemize @bullet
@item All files

@item All, but no backup, object, lib or ini-files (except .emacs and .gnus). This
means all files except those starting with ``.'', ``#'' or ending with
``~'', ``.elc'', ``.obj'', ``.o'', ``.lib'', ``.dll'', ``.a'',
``.so''. (but including .emacs and .gnus)

@item Common source file types (.c, .java etc.)
@end itemize

In addition to these predefined values a custom exclude and include
combination can be defined.

Tips for the directory- and file-rexexps: @code{"$^"} matches no
files/directories, @code{".*"} matches all files/directories.
@end defopt

@defopt sources-buffer-after-create-hook
Local hook running after the creation of the sources-buffer. Every
function of this hook is called once without arguments direct after
creating the sources-buffer of ECB and it's local key-map. So for
example a function could be added which performs calls of
@code{local-set-key} to define new keybindings only for the
sources-buffer of ECB.
@end defopt


@defopt sources-buffer-name
Name of the ECB sources buffer. Because it is not a normal buffer for
editing you should enclose the name with stars, e.g. ``*ECB Sources*''.

If it is necessary for you you can get emacs-lisp access to the
buffer-object of the ECB-sources-buffer by this name, e.g. by a call
of @code{set-buffer}.

Changes for this option at runtime will take affect only after
deactivating and then activating ECB again!
@end defopt


@defopt sources-exclude-cvsignore
Specify if files contained in a @file{.cvsignore} should be
excluded.

Value is a list of regular expressions or nil. If you want to exclude
files listed in a @file{.cvsignore}-file from being displayed in the
ecb-sources-buffer then specify a regexp for such a directory.

If you want to exclude the contents of @file{.cvsignore}-files for
every directory then you should add one regexp ``.*'' which matches
every directory.

If you never want to exclude the contents of @file{.cvsignore}-files
then set this option to nil.
@end defopt


@defopt sources-menu-sorter
Function which re-sorts the menu-entries of the directories buffer.

If a function then this function is called to sort the menu-entries of
the combined menu-entries of the user-menu-extensions of
@code{ecb-sources-menu-user-extension} and the built-in-menu
@code{ecb-sources-menu}. If nil then no special sorting will be done
and the user-extensions are placed in front of the built-in-entries.

For the guidelines for such a sorter-function see
@code{ecb-directories-menu-sorter}.
@end defopt


@defopt sources-menu-user-extension
Static user extensions for the popup-menu of the sources buffer. For
further explanations see @code{ecb-directories-menu-user-extension}.

The node-argument of a menu-function contains as data the filename of
the source for which the popup-menu has been opened.

Per default the static user-extensions are added at the beginning of
the built-in menu-entries of @code{ecb-sources-menu} but the whole
menu can be re-arranged with @code{ecb-sources-menu-sorter}.
@end defopt

@defopt sources-menu-user-extension-function
Dynamic user extensions for the popup-menu of the sources buffer. A
function which has to return a list in the same format like the option
@code{ecb-sources-menu-user-extension}. This function is called when
the user opens the popup-menu for the sources buffer.

Per default the dynamic user-extensions are added in front of the
static extensions of @code{ecb-sources-menu-user-extension} but the
whole menu can be re-arranged with @code{ecb-sources-menu-sorter}.
@end defopt



@defopt sources-sort-method
Defines how the source files are sorted.

@itemize @minus
@item @code{name}:
Sorting by name.
@item @code{extension}:
Sorting first by name and then by extension.
@item @code{nil}:
No sorting, means source files are displayed in the sequence returned
by @code{directory-files} (called without sorting).
@end itemize
@end defopt


@node ecb-methods, ecb-history, ecb-sources, Customizable options
@subsection Group ecb-methods

@noindent
This group contains settings for the methods-buffer in the ECB:

@defopt auto-expand-tag-tree
Expand the methods-tag-tree automatically if node invisible.

This option has only an effect if option @code{ecb-highlight-tag-with-point} is
switched on too. There are three possible choices:
@itemize @minus
@item @code{nil}:
No auto. expanding of the method buffer.
@item @code{expand-spec}:
Auto expand the method-buffer nodes if the node belonging to current
tag under point is invisible because its parent-node is collapsed.
But expanding is only done if the type of the tag under point in the
edit-buffer is contained in @code{ecb-methods-nodes-expand-spec}.
@item @code{all}:
Like expand-spec but expands all tags regardless of the setting in
@code{ecb-methods-nodes-expand-spec}.
@end itemize

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt


@defopt auto-update-methods-after-save
Automatically updating the ECB method buffer after saving a source.
@end defopt

@defopt exclude-parents-regexp
Regexp which parent classes should not be shown in the methods buffer
(see also @code{ecb-show-parents}). If nil then all parents will be
shown if @code{ecb-show-parents} is not nil.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt expand-methods-switch-off-auto-expand
Switch off auto expanding in the ECB-method buffer. If on then auto
expanding is switched off after explicit expanding or collapsing by
@code{ecb-expand-methods-nodes}.

This is done with @code{ecb-toggle-auto-expand-tag-tree} so after
the switch off the auto expanding feature can again switched on
quickly.

But after explicitly expanding/collapsing the methods-buffer to a
certain level the auto. expanding could undo this when the node
belonging to current tag under point in the current active edit-window
is invisible after @code{ecb-expand-methods-nodes} - then the auto.
expand feature would make this node immediately visible and destroys
the explicitly set expand-level.
@end defopt


@defopt font-lock-tags
Adds font-locking (means highlighting) to the ECB-method buffer.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt highlight-tag-with-point
How to highlight the method or variable under the cursor.

@itemize @minus
@item @code{highlight-scroll}:
Always scroll the method buffer, so the current method of the
edit-window is highlighted in the method-window.
@item @code{highlight}:
Only highlight the current method of the edit window in the
method window if the method is visible in the method-window.
@item @code{nil}:
No highlighting is done.
@end itemize

See also @code{ecb-highlight-tag-with-point-delay}.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt highlight-tag-with-point-delay
Time Emacs must be idle before current tag is highlighted. If nil
then there is no delay, means current tag is highlighted
immediately. A small value of about 0.25 seconds saves CPU resources
and you get even though almost the same effect as if you set no delay.
But such a delay prevents also ``jumping backward/forward'' during
scrolling within java-classes if point goes out of method-definition
into class-definition. Therefore the default value is a delay of 0.25
seconds.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt methods-buffer-after-create-hook
Local hook running after the creation of the methods-buffer. Every
function of this hook is called once without arguments direct after
creating the methods-buffer of ECB and it's local key-map. So for
example a function could be added which performs calls of
@code{local-set-key} to define new keybindings only for the
methods-buffer of ECB.
@end defopt


@defopt methods-buffer-name
Name of the ECB methods buffer. Because it is not a normal buffer for
editing you should enclose the name with stars, e.g. `` *ECB
Methods*''.

If it is necessary for you you can get emacs-lisp access to the
buffer-object of the ECB-methods-buffer by this name, e.g. by a call
of @code{set-buffer}.

Changes for this option at runtime will take affect only after
deactivating and then activating ECB again!
@end defopt

@defopt methods-menu-sorter
Function which re-sorts the menu-entries of the directories buffer.

If a function then this function is called to sort the menu-entries of
the combined menu-entries of the user-menu-extensions of
@code{ecb-methods-menu-user-extension} and the built-in-menu
@code{ecb-methods-menu}. If nil then no special sorting will be done
and the user-extensions are placed in front of the built-in-entries.

For the guidelines for such a sorter-function see
@code{ecb-directories-menu-sorter}.
@end defopt


@defopt methods-menu-user-extension
Static user extensions for the popup-menu of the methods buffer. For
further explanations see @code{ecb-directories-menu-user-extension}.

The node-argument of a menu-function contains as data the semantic-tag
of the method/variable/tag for which the popup-menu has been opened.

Per default the static user-extensions are added at the beginning of
the built-in menu-entries of @code{ecb-methods-menu} but the whole
menu can be re-arranged with @code{ecb-methods-menu-sorter}.
@end defopt

@defopt methods-menu-user-extension-function
Dynamic user extensions for the popup-menu of the methods buffer. A
function which has to return a list in the same format like the option
@code{ecb-methods-menu-user-extension}. This function is called when
the user opens the popup-menu for the methods buffer. For an example
how such a function can be programmed see
@code{ecb-methods-menu-editwin-entries}.

Per default the dynamic user-extensions are added in front of the
static extensions of @code{ecb-methods-menu-user-extension} but the
whole menu can be re-arranged with @code{ecb-methods-menu-sorter}.
@end defopt


@defopt methods-nodes-collapse-spec
Semantic tag-types collapsed by @code{ecb-expand-methods-nodes}.
For valid values of this option see @code{ecb-methods-nodes-expand-spec}!

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt


@defopt methods-nodes-expand-spec
Semantic tag-types expanded by @code{ecb-expand-methods-nodes}.

The value of this option is either the symbol @code{all} (all tags
are expanded regardless of their type) or a list of symbols where each
symbol is a valid semantic tag-type. For a description of semantic
tag types see option @code{ecb-show-tags}.

But this option also defines if bucket-nodes in the ECB-method-buffer
(e.g. ``[Variables]'') should be expanded. Therefore valid symbols for
this list are also all cars of the variable returned by
@code{ecb--semantic-symbol->name-assoc-list}.

If there is a bucket-name (the node-name stripped of the settings in
@code{ecb-bucket-node-display}) which is not contained as cdr in the
value returned by @code{ecb--semantic-symbol->name-assoc-list} then
the symbol with this bucket-name as name is also a valid symbol for
this list. Example: In ECB there are buckets ``[Parents]''. The
bucket-name is ``Parents'' and the valid symbol-name is then
@code{Parents}.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt


@defopt post-process-semantic-taglist
Define mode-dependent post-processing for the semantic-taglist. This
is an alist where the car is a major-mode symbol and the cdr is a list
of function-symbols of functions which should be used for
post-processing the taglist (returned by
@code{ecb--semantic-bovinate-toplevel}) for a buffer in this
major-mode. The first function in the list is called with current
semantic taglist of current buffer and must return a valid taglist
again. All other functions are called with the result-taglist of its
preceding function and have to return a new taglist again.

For oo-programming languages where the methods of a class can be
defined outside the class-definition (e.g. C++, Eieio) the function
@code{ecb-group-function-tags-with-parents} can be used to get a much
better method-display in the methods-window of ECB, because all method
implementations of a class are grouped together.

Another senseful usage is to filter out certain tags, e.g. prototype
tags in @code{c-mode}. For this you can set
@code{ecb-filter-c-prototyp-tags}.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt show-only-positioned-tags
Show only nodes in the method-buffer which are ``jump-able''. If not nil
then ECB displays in the method-buffer only nodes which are
``jump-able'', i.e. after selecting it by clicking or with RET then ECB
jumps to the corresponding location in the edit-window. Example: With
CLOS or Eieio source-code there can exist some position-less nodes like
variable-attributes in a @code{defclass} form which are only displayed
if this option is nil. Displaying such nodes can be senseful even if
they can not be jumped.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt show-tags
How to show tags in the methods buffer first time after find-file.
This variable is a list where each element represents a type of
tags:

@example
(<tag type> <display type> <sort method>)
@end example

The tags in the methods buffer are displayed in the order as they appear in
this list.

@table @code
@item <tag type>
A Semantic tag type symbol (function, variable, rule, include etc.)
or one of the following:

@itemize @minus
@item @code{t}: All tag types not specified anywhere else in the list.
@item @code{parent}: The parents of a type.
@end itemize

@item <display type>
A symbol which describes how the tags of this type shall be shown:

@itemize @minus
@item @code{expanded}: The tags are shown in an expanded node.
@item @code{collapsed}: The tags are shown in a collapsed node.
@item @code{flattened}: The tags are added to the parent node.
@item @code{hidden}: The tags are not shown.
@end itemize

@item <sort method>
A symbol describing how to sort the tags of this type:

@itemize @minus
@item @code{name}:
Sort by the tag name.
@item @code{access}:
Sort by tag access (public, protected, private) and then by name.
@item @code{nil}:
Don't sort tags. They appear in the same order as in the source
buffer.
@end itemize
@end table


This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt tag-display-function
Function to use for displaying tags in the methods buffer. This
functionality is set on major-mode base, i.e. for every major-mode a
different function can be used. The value of this option is a list of
cons-cells:

@itemize @minus
@item
The car is either a major-mode symbol or the special symbol 'default which
means if no function for a certain major-mode is defined then the cdr of
the 'default cons-cell is used.
@item
The cdr is the function used for displaying a tag in the related
major-mode.
@end itemize

Every function is called with 3 arguments:

@enumerate
@item The tag
@item The parent-tag of tag (can be nil)
@item The value of @code{ecb-font-lock-tags}.
@end enumerate

Every function must return the display of the tag as string,
colorized if the third argument is not nil.

The following functions are predefined:

@itemize @bullet
@item
For each element E of @code{ecb--semantic-format-function-alist}
exists a function with name ``ecb--<(cdr E)>''. These functions are
just aliase to the builtin format-functions of semantic. See the
docstring of these functions to see what they do. Example:
(semantic-name-nonterminal . semantic-format-tag-name) is an element
of @code{ecb--semantic-format-function-alist}. Therefore the
alias-function for this element is named
@code{ecb--semantic-format-tag-name}.
  
@item
For every cdr in @code{ecb--semantic-format-function-alist} with name
``semantic-XYZ'' a function with name ``ecb-XYC'' is predefined. The
differences between the semantic- and the ECB-version are:

@itemize @minus
@item
The ECB-version displays for type tags only the type-name and nothing
else (exception: In c++-mode a template specifier is appended to the
type-name if a template instead a normal class).
@item
The ECB-version displays type-tags according to the setting in
@code{ecb-type-tag-display}. This is useful for better recognizing
different classes, structs etc. in the ECB-method window.
@end itemize

For all tags which are not types the display of the ECB-version is
identical to the semantic version. Example: For
@code{ecb--semantic-format-tag-name} (one of the builtin semantic
formatters) the pendant is @code{ecb-format-tag-name}.
@end itemize

This functionality also allows the user to display tags as UML. To
enable this functionality set the function for a major-mode \(e.g.
@code{jde-mode}) to
@code{ecb--semantic-format-tag-uml-concise-prototype},
@code{ecb--semantic-format-tag-uml-prototype}, or
@code{ecb--semantic-format-tag-uml-abbreviate} the ECB-versions of
these functions.

If the value is @code{nil}, i.e. neither a function for a major-mode
is defined nor the special 'default, then
@code{ecb--semantic-format-tag-prototype} is used for displaying the
tags.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt tag-jump-sets-mark
Set the mark after jumping to a tag from the ECB-method buffer. If
set the user can easily jump back.
@end defopt

@defopt tag-visit-post-actions
Actions to perform after visiting a tag from the Method-buffer. With
this option actions can be added which will be performed after
visiting the start of the tag in the source-buffer.

This functionality is set on a @code{major-mode} base, i.e. for every
@code{major-mode} a different setting can be used. The value of this
option is a list of cons-cells:
@itemize @minus
@item
The car is either a @code{major-mode} symbol or the special symbol
'default.

@item
The cdr is a list of action-functions or nil.
@end itemize

ECB first performs all actions defined for the special symbol 'default
(if any) and then all actions defined for current @code{major-mode}
(if any).

ECB offers some predefined senseful action-functions. Currently there
are: @code{ecb-tag-visit-highlight-tag-header}
@code{ecb-tag-visit-smart-tag-start}
@code{ecb-tag-visit-recenter} @code{ecb-tag-visit-recenter-top}
@code{ecb-tag-visit-goto-doc-start}
@code{ecb-tag-visit-narrow-tag} See the documentation of these
function for details what they do.

But you can add any arbitrary function if the following conditions are
fulfilled: The function gets the semantic tag as argument returns
the (new) point after finishing its job.
@end defopt



@defopt type-tag-display
How to display semantic type-tags in the methods buffer. Normally
all tag displaying, colorizing and facing is done by semantic
according to the value returned by
@code{ecb--semantic-format-face-alist} and the semantic
display-function (e.g. one from
@code{ecb--semantic-format-tag-functions}). But sometimes a finer
distinction in displaying the different type specifiers of type-tags
can be useful. For a description when this option is evaluated look at
@code{ecb-tag-display-function}!

This functionality is set on a major-mode base, i.e. for every
major-mode a different setting can be used. The value of this option
is a list of cons-cells:

@itemize @bullet
@item
The car is either a major-mode symbol or the special symbol 'default which
means if no setting for a certain major-mode is defined then the cdr of
the 'default cons-cell is used.

@item
The cdr is a list of 3-element-lists:

@enumerate
@item
First entry is a semantic type specifier in string-form. Current
available type specifiers are for example ``class'', ``interface'',
``struct'', ``typedef'' and ``enum''. In addition to these ones there
is also a special ECB type specifier ``group'' which is related to
grouping tags (see @code{ecb-post-process-semantic-taglist} and
@code{ecb-group-function-tags-with-parents}). Any arbitrary
specifier can be set here but if it is not ``group'' or not known by
semantic it will be useless.
@item
Second entry is a flag which indicates if the type-specifier string
from (1.) itself should be removed (if there is any) from the display.
@item
Third entry is the face which is used in the ECB-method window to
display type-tags with this specifier. ECB has some predefined faces
for this (@code{ecb-type-tag-class-face},
@code{ecb-type-tag-interface-face}, @code{ecb-type-tag-struct-face},
@code{ecb-type-tag-typedef-face}, @code{ecb-type-tag-union-face},
@code{ecb-type-tag-enum-face} and @code{ecb-type-tag-group-face}) but
any arbitrary face can be set here. This face is merged with the faces
semantic already uses to display a tag,
i.e. the result is a display where all face-attributes of the ECB-face
take effect plus all face-attributes of the semantic-faces which are not
set in the ECB-face (with XEmacs this merge doesn't work so here the
ECB-face replaces the semantic-faces; this may be fixed in future
versions).
@end enumerate
@end itemize

The default value is nil means there is no special ECB-displaying of
type-tags in addition to the displaying and colorizing semantic
does. But a value like the following could be a useful setting:

@example
@group
((default
   ("class" t ecb-type-tag-class-face)
   ("group" nil ecb-type-tag-group-face))
 (c-mode
  ("struct" nil ecb-type-tag-struct-face)
  ("typedef" nil ecb-type-tag-typedef-face)))
@end group
@end example

This means that in @code{c-mode} only ``struct''s and ``typedef''s are
displayed with special faces (the specifiers itself are not removed)
and in all other modes ``class''s and grouping-tags (see
@code{ecb-tag-display-function},
@code{ecb-group-function-tags-with-parents}) have special faces and
the ``class'' specifier-string is removed from the display.

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt

@defopt type-tag-expansion
Default expansion of semantic type-tags. Semantic groups type-tags in
different type-specifiers. Current available type specifiers are for
example ``class'', ``interface'', ``struct'', ``typedef'', ``union''
and ``enum''. In addition to these ones there is also a special ECB
type-specifier ``group'' which is related to grouping tags (see
@code{ecb-post-process-semantic-taglist}).

This option defines which type-specifiers should be expanded at
file-open-time. Any arbitrary specifier can be set here but if it is
not ``group'' or not known by semantic it will be useless.

This functionality is set on a major-mode base, i.e. for every
major-mode a different setting can be used. The value of this option
is a list of cons-cells:

@itemize
@item
The car is either a major-mode symbol or the special symbol
@code{default} which means if no setting for a certain major-mode is
defined then the cdr of the @code{default} cons-cell is used.

@item
The cdr is either a list of type-specifiers which should be expanded
at file-open-time or the symbol @code{all-specifiers} (then a type-tag
is always expanded regardless of its type-specifier).
@end itemize

This options takes only effect for semantic-sources - means sources
supported by semantic!
@end defopt


@node ecb-history, ecb-layout, ecb-methods, Customizable options
@subsection Group ecb-history

@noindent
This group contains settings for the history-buffer in the ECB:

@defopt history-buffer-after-create-hook
Local hook running after the creation of the history-buffer. Every
function of this hook is called once without arguments direct after
creating the history-buffer of ECB and it's local key-map. So for
example a function could be added which performs calls of
@code{local-set-key} to define new keybindings only for the
history-buffer of ECB.
@end defopt


@defopt history-buffer-name
Name of the ECB history buffer. Because it is not a normal buffer for
editing you should enclose the name with stars, e.g. ``*ECB
History*''.

If it is necessary for you you can get emacs-lisp access to the
buffer-object of the ECB-history-buffer by this name, e.g. by a call
of @code{set-buffer}.

Changes for this option at runtime will take affect only after
deactivating and then activating ECB again!
@end defopt

@defopt history-item-name
The name to use for items in the history buffer.
@end defopt

@defopt history-menu-sorter
Function which re-sorts the menu-entries of the directories buffer.

If a function then this function is called to sort the menu-entries of
the combined menu-entries of the user-menu-extensions of
@code{ecb-history-menu-user-extension} and the built-in-menu
@code{ecb-history-menu}. If nil then no special sorting will be done
and the user-extensions are placed in front of the built-in-entries.

For the guidelines for such a sorter-function see
@code{ecb-directories-menu-sorter}.
@end defopt


@defopt history-menu-user-extension
Static user extensions for the popup-menu of the history buffer. For
further explanations see @code{ecb-directories-menu-user-extension}.

The node-argument of a menu-function contains as data the filename of
the source for which the popup-menu has been opened.

Per default the static user-extensions are added at the beginning of
the built-in menu-entries of @code{ecb-history-menu} but the whole
menu can be re-arranged with @code{ecb-history-menu-sorter}.
@end defopt

@defopt history-menu-user-extension-function
Dynamic user extensions for the popup-menu of the history buffer. A
function which has to return a list in the same format like the option
@code{ecb-history-menu-user-extension}. This function is called when
the user opens the popup-menu for the history buffer.

Per default the dynamic user-extensions are added in front of the
static extensions of @code{ecb-history-menu-user-extension} but the
whole menu can be re-arranged with @code{ecb-history-menu-sorter}.
@end defopt

@defopt kill-buffer-clears-history
Define if @code{kill-buffer} should also clear the history. There are
three options:

@itemize @minus
@item @code{auto}:
Removes automatically the corresponding history-entry after the buffer
has been killed.
@item @code{ask}:
Asks, if the history-entry should be removed after the kill.
@item @code{nil}:
@code{kill-buffer} does not affect the history (this is the default).
@end itemize
@end defopt

@defopt sort-history-items
Sorts the items in the history buffer.
@end defopt

@node ecb-layout, ecb-compilation, ecb-history, Customizable options
@subsection Group ecb-layout

@noindent
This group contains settings for the screen-layout of the ECB:

@defopt activate-before-new-frame-created-hook
Normal hook run before the new ECB-frame is created if
@code{ecb-new-ecb-frame} is not nil (otherwise this hook is not
evaluated).
@end defopt

@defopt advice-window-functions
Advice functions to be more intelligent if used with ECB. You can
choose the following functions to be adviced by ECB so they behave as
if the edit-window(s) of ECB would be the only windows(s) of the
ECB-frame:

@itemize @bullet
@item @code{other-window}
For this one see also the option @code{ecb-other-window-behavior}!
@item @code{delete-window}
@item @code{delete-other-windows}
@item @code{delete-windows-on}
@item @code{split-window-horizontally}
@item @code{split-window-vertically}
@item @code{split-window}
If this advice is enabled then @code{split-window-vertically} and
@code{split-window-horizontally} are autom. enabled too!
@item @code{switch-to-buffer}
@item @code{switch-to-buffer-other-window}
@item @code{display-buffer}
Especially if @code{ecb-compile-window-height} is not nil it is
strongly recommended not to disable this advice!
@item @code{other-window-for-scrolling}
If this advice is enabled then the behavior of the following functions
depends on @code{ecb-other-window-behavior}:
@itemize @minus
@item @code{scroll-other-window}
@item @code{scroll-other-window-down}
@item @code{beginning-of-buffer-other-window}
@item @code{end-of-buffer-other-window}
@end itemize
@item @code{balance-windows}:
Only the edit-windows are balanced
@end itemize

For working most conveniently with ECB it is the best to advice all
these functions, because then all the standard shortcuts of these
functions are also usable with ECB without doing anything else. Also
other packages can interact best with ECB if these functions are all
adviced. If these adviced functions are called in another frame than
the ECB-frame they behave all exactly like the not adviced versions!

But please read also the following:

Normally all packages should work correct with ECB and it�s adviced
functions but if there occur problems with a package cause of some of
these adviced functions ECB offers the following fall-back solution:

@enumerate
@item
Deactivate in @code{ecb-advice-window-functions} all the
adviced-functions which make problems with other packages.
@item
For every of the advice-able functions <adv-func> ECB offers a
interactively function named ``ecb-<adv-func>'' which does exactly the
same as the adviced version of <adv-func>. Use ``ecb-<adv-func>''
instead the original one to get the proper ECB behavior even if the
function is not adviced anymore.
@item
You can bind in @code{ecb-activate-hook} the standard-shortcut of
<adv-func> to ``ecb-<adv-func>'' and rebind it in
@code{ecb-deactivate-hook} to <adv-func>.
@item 
Now you have the best of both worlds: The problematic package works
and you have the ECB-behavior of <adv-func> as if it would be adviced.
@end enumerate

Here is an example: Suppose you must deactivating the advice for
@code{switch-to-buffer-other-window}. Then you deactivate this
function with this option and you can use
@code{ecb-switch-to-buffer-other-window} instead. Bind the shortcut
you normally use for @code{switch-to-buffer-other-window} to
@code{ecb-switch-to-buffer-other-window} (use @code{ecb-activate-hook}
for this) and rebind it to the original function in the
@code{ecb-deactivate-hook}.
@end defopt

@defopt advice-window-functions-signal-error
Signal an error if an adviced function can not do its job. If not nil
then an error is signaled if one of the adviced functions (see
@code{ecb-advice-window-functions}) can not do its job. So for example
if the user tries to split the compile-window or an ecb-tree-window or
if one tries to switch to another buffer in one of the
ecb-tree-windows. For details see the documentation of each of the
adviced functions to get info when an error is signaled.

If this option is nil then no error is signaled but the called adviced
function does simply nothing.

Default is nil but it can also be useful to signal errors - so you see
when call a function in a situation which is not supported by this
function.
@end defopt

@defopt fix-window-size
Fix size of the ECB-windows/buffers even after frame-resizing. The fix
type (valid values are nil, t, width and height) can either be set on
a layout-basis (means a different value for each layout) or one value
can be set for all layouts.

For a detailed description of the valid values see description of
@code{window-size-fixed} which is newly introduced in GNU Emacs 21 and
is only available there. Therefore this option takes only effect with
GNU Emacs 21.

Note1: Manually resizing the ECB-windows via @code{enlarge-window},
@code{shrink-window}, @code{mouse-drag-vertical-line} and
@code{mouse-drag-mode-line} is still possible even if the window-sizes
are fixed for frame-resizing!

Note2: The description of @code{window-size-fixed} in the
Elisp-info-manual is more detailed than the description offered by
@kbd{C-h v}!

Note3: With current Emacs 21.2.X there seems to be no distinction
between @code{width}, @code{height} and @code{t}. Therefore this
option takes no effect (means all ecb-windows have always unfixed
sizes) if @code{ecb-compile-window-height} is not @code{nil}.

Per default no window-size fixing has been done.
@end defopt

@defopt hide-ecb-windows-after-hook
Hooks run direct after the ECB windows have been hidden. Hiding was
done either by @code{ecb-toggle-ecb-windows} or
@code{ecb-hide-ecb-windows}.

IMPORTANT: Hiding the ECB-windows is internally done by calling
@code{ecb-redraw-layout} and therefore also the hooks
@code{ecb-redraw-layout-before-hook} and
@code{ecb-redraw-layout-after-hook} are evaluated. The hook-sequence
is analogous to that described in
@code{ecb-show-ecb-windows-after-hook}.
@end defopt

@defopt hide-ecb-windows-before-hook
Hook run direct before the ECB windows will be hidden. Hiding is done
either by @code{ecb-toggle-ecb-windows} or
@code{ecb-hide-ecb-windows}. This means that at runtime of this hook
all the ECB-tree-windows of current layout are visible.

IMPORTANT: Hiding the ECB-windows is internally done by calling
@code{ecb-redraw-layout} and therefore also the hooks
@code{ecb-redraw-layout-before-hook} and
@code{ecb-redraw-layout-after-hook} are evaluated. The hook-sequence
is analogous to that described in
@code{ecb-show-ecb-windows-before-hook}.
@end defopt

@defopt ignore-display-buffer-function
Adviced @code{display-buffer} ignores @code{display-buffer-function}.
This means, that the adviced version of @code{display-buffer} (see
@code{ecb-advice-window-functions}) ignores the value of
@code{display-buffer-function} when called for the @code{ecb-frame}.
If this variable should not be ignored then the function of
@code{display-buffer-function} is completely responsible which window
is used for the buffer to display - no smart ECB-logic will help to
deal best with the ECB-window-layout! You can define if and when
@code{display-buffer-function} should be ignored:

@itemize @minus
@item
only when durable compile window is used - i.e. if
@code{ecb-compile-window-height} is not nil

@item
always when ECB is active - that means ignore when ECB is active
otherwise not - this is the default value

@item
never, the adviced version of @code{display-buffer} always uses the
value of @code{display-buffer-function} if the value is a function.
@end itemize
@end defopt



@defopt ignore-special-display
Ignore special-display-handling. This means, that all values of
@code{special-display-function}, @code{special-display-buffer-names}
and @code{special-display-regexps} are ignored

@itemize
@item
only when durable compile window is used - i.e. if
@code{ecb-compile-window-height} is not nil - this is the default
value.

@item
always when ECB is active - that means no special-display-handling of
buffers when ECB is active

@item
never, i.e. special-dislay-handling depends on the values of the
options @code{special-display-function},
@code{special-display-buffer-names} and
@code{special-display-regexps}.

@end itemize
@end defopt

@defopt layout-always-operate-in-edit-window
Adviced window functions work always in the edit-window. If we are in
an ECB special buffer (methods, directories, etc), and any of the
adviced windowing functions is called interactively (see
@code{ecb-advice-window-functions}), we will select first an
edit-window according to the value of
@code{ecb-mouse-click-destination}. This is useful if you have any
functions that use such functions and you don't want them to fail with
an error complaining that the current buffer can not be split, or
something similar.

Because this may not be desirable in all situations and for all
adviced functions this can be enabled separately for every advicable
function (see also @code{ecb-advice-window-functions}). If the symbol
of an adviced function is contained in the value of this option, then
a edit-window is first selected otherwise either an error is
reported or some other special reaction (depends on
@code{ecb-advice-window-functions-signal-error}); see the
documentation of the adviced functions for this.

For @code{other-window}, @code{other-window-for-scrolling} and
@code{switch-to-buffer-other-window} this makes no sense, therefore
you can not enable this for them.

Per default this is enabled for @code{switch-to-buffer} and
@code{display-buffer}.
@end defopt


@defopt layout-debug-mode
Write debug-information about layout-operations in the
Messages-buffer. Normally there should be no need to set this option
to true but if there are problems to display buffers in the
compile-window of ECB (e.g. buffers which should be displayed there
aren't or the temporally enlarging-mechanism does not do what you
think it should do etc...) then please do the following steps:

@enumerate
@item
Set @code{ecb-layout-debug-mode} to not nil

@item
Reproduce the wrong behavior exactly by repeating all the operations
which lead to the problem.

@item
Now send immediately a bug report with
@code{ecb-submit-problem-report}.

@item
Set @code{ecb-layout-debug-mode} back to nil if you do not want
further debugging output in the *Messages* buffer
@end enumerate
@end defopt



@defopt layout-name
Select a window layout of ECB. Value is any arbitrary string. There are
four different types of layouts: left, right, top and left-right,
which means the location of the ECB-tree-windows in the ECB-frame.
Currently there are 20 predefined layouts; names see below. You can
savely try out any of them by changing this value and saving it only
for the current session. If you are sure which layout you want you can
save it for future sessions. To get a picture of the layout for name
<name> call `ecb-show-layout-help'. @code{ecb-layout-function-9}.

Currently available layouts:

@itemize @bullet
@item Left layouts:
left1 left2 left3 left4 left5 left6 left7 left8 left9 left10 left11
left12 left13 left14 left15

@item Right layouts:
right1

@item Top layouts:
top1 top2

@item Left-right layouts:
leftright1 leftright2
@end itemize

Regardless of the settings you define here: If you have destroyed or
changed the ECB-screen-layout by any action you can always go back to
this layout with @code{ecb-redraw-layout}
@end defopt


@defopt layout-window-sizes
Specifies the sizes of the ECB windows for each layout. The easiest
way (and also the strongly recommended way) to change this variable is
to change the window sizes by dragging the window borders using the
mouse and then store the window sizes by calling the command
@code{ecb-store-window-sizes}. Next time the layout is redrawn the
values stored in this option will be used.

If @code{ecb-store-window-sizes} is used then the windows sizes are
stored per default as fractions of current frame-width and -height of
the ecb-frame, so the stored values will ``work'' for other frame
sizes too. But if you call @code{ecb-store-window-sizes} with a
prefix-argument then the fixed values of current width and height are
stored!

If this option is set ``by hand'' (i.e. not by
@code{ecb-store-window-sizes}) then the following is important:
@itemize @minus
@item
It is recommended to use fractions of frame-width and -height!.
@item
The order of the sequence of the inserted window sizes must be the same as
@code{other-window} (the not-adviced version!) would walk!
@end itemize
@end defopt

@defopt maximize-ecb-window-after-selection
If not nil maximize current tree-window after selection. When
selecting another not-tree-window after such an automatic maximizing
all tree-windows of current layout are displayed again. But a
tree-window is not maximized if either a node has been selected via
primary- oder secondarc mouse-button or the popup-menu of that
tree-buffer has been opened.
@end defopt

@defopt new-ecb-frame
Create a new frame at activation time of ECB.
@end defopt

@defopt other-window-behavior
The behavior of ECB concerning getting an ``other window''. This has
an effect if either @code{other-window} or
@code{other-window-for-scrolling} is adviced by ECB, see
@code{ecb-advice-window-functions}. The following settings are
possible:

@code{all}:

ECB will cycle through all windows of the ECB-frame or scroll simply
the next window in the ECB-frame, means it behaves like the original
@code{other-window} rsp. the original
@code{other-window-for-scrolling}.

@code{only-edit}:

ECB will only cycle through the edit-windows of ECB or only scroll
another edit-window. If the selected window is not an edit-window then
it behaves like with value @code{all}.

@code{edit-and-compile}:

Like @code{only-edit} plus the compile window if any. If the selected
window is neither an edit-window nor the compile-window then it
behaves like with value @code{all}.

@code{smart}:

With this setting ECB tries to choose the
@code{other-window}-destination or the ``other window'' to scroll in a
smart and intuitive way: If point is in one of the edit-windows and if
the edit-area is splitted then always the ``next'' edit-window is
choosen (whereas the next edit-window of the last edit-window is the
first edit-window)- if the edit-area is unsplitted then the
compile-window is used if there is one. In the context of an
@code{other-window}-call the @var{ARG} of @code{other-window} will be
taken into account.

If one of the special ecb-windows is selected then always the ``next''
ecb-window is choosen (whereas the next ecb-window of the last
ecb-window is the first ecb-window). In the context of an
@code{other-window}-call the @var{ARG} of @code{other-window} will be
taken into account.

If the compile-window is selected then always the last edit-window
which had the point will be used unless @code{other-window} has been
called with a prefix-argument unequal 1.

If there is an active minibuffer:

Regardless of the allowed values above ECB handles the situation of an
active minibuffer during a call to @code{other-window} or
@code{scroll-other-window} like follows:

If the minibuffer-window is selected then ECB always chooses the
window @code{minibuffer-scroll-window} points to (when this variable
is set, otherwise the compile-window or the last selected edit-window
is choosen) when the called command is called to choose the 1. next
window (always true for scrolling another window or true when
@code{other-window} called without prefix-arg or with prefix-arg equal
1). Otherwise the window ARG steps away is choosen (in case of
@code{other-window}).

If there is an active minibuffer but the minibuffer-window is not
selected then @code{other-window} and @code{scroll-other-window}
behave like the original version.

In addition to the allowed values above the value of this option can
also be a function:

A function:

This function gets seven arguments:
@enumerate
@item
A canonical list of all currently visible windows of the
@code{ecb-frame}
@item
A canonical list of all currently visible edit-windows
@item
A canonical list of all currently visible ecb-windows
@item
The window-object of the compile-window if there is any.
@item
The minibuffer-window of the ECB-frame if there is an active
minibuffer.
@item
The result of the function @code{ecb-where-is-point} - see the
documentation of this function for details.
@item
An integer which indicates how many steps away from the current
selected window the ``other-window'' is. Is nil when this function is
called in another context then for @code{other-window}.
@end enumerate

The function has to return a window-object which is then used as
``other window'' for the command @code{other-window} or for scrolling
another window (e.g. with @code{scroll-other-window}). Such a function
has to handle properly all situation for itself.
@code{ecb-get-other-window-smart} is an example for such a function.
@end defopt

@defopt redraw-layout-after-hook
Hooks run direct before the ECB windows will be shown either by
@code{ecb-toggle-ecb-windows} or @code{ecb-show-ecb-windows}. This
means that at runtime of this hook the ECB-windows are already
visible.
@end defopt

@defopt redraw-layout-before-hook
Hooks run direct before the ECB-layout will be redrawn by either
@code{ecb-redraw-layout}.
@end defopt

@defopt redraw-layout-quickly
If non-nil, we will attempt to redraw the layout quickly. Please read
also carefully the documentation of @code{ecb-redraw-layout}.
@end defopt

@defopt select-edit-window-on-redraw
Select the first edit window on @code{ecb-redraw-layout}.
@end defopt

@defopt show-ecb-windows-after-hook
Hooks run direct before the ECB windows will be shown either by
@code{ecb-toggle-ecb-windows} or @code{ecb-show-ecb-windows}. This
means that at runtime of this hook the ECB-windows are already
visible.

IMPORTANT: Showing the hidden ECB-windows is internally done by
calling @code{ecb-redraw-layout} and therefore also the hooks
@code{ecb-redraw-layout-before-hook} and
@code{ecb-redraw-layout-after-hook} are evaluated. So there is the
following sequence of hooks during the process of showing the hidden
ECB-windows:
@enumerate
@item @code{ecb-show-ecb-windows-before-hook}
@item @code{ecb-redraw-layout-before-hook}
@item <redrawing the layout to show the hidden ECB-windows>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-show-ecb-windows-after-hook}
@end enumerate
So be aware which code you add to which hook!
@end defopt

@defopt show-ecb-windows-before-hook
Hooks run direct before the ECB windows will be shown either by
@code{ecb-toggle-ecb-windows} or @code{ecb-show-ecb-windows}. This
means that at runtime of this hook the ECB-windows are still hidden.

IMPORTANT: Showing the hidden ECB-windows is internally done by
calling @code{ecb-redraw-layout} and therefore also the hooks
@code{ecb-redraw-layout-before-hook} and
@code{ecb-redraw-layout-after-hook} are evaluated. So there is the
following sequence of hooks during the process of showing the hidden
ECB-windows:
@enumerate
@item @code{ecb-show-ecb-windows-before-hook}
@item @code{ecb-redraw-layout-before-hook}
@item <redrawing the layout to show the hidden ECB-windows>
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-show-ecb-windows-after-hook}
@end enumerate
So be aware which code you add to which hook!
@end defopt


@defopt split-edit-window-after-start
Sets if and how the edit window should be splitted after ECB-start.
But be aware: This option determines only if and how the edit-window
should be splitted at start-time of ECB. There are five different
values allowed for this option:

@itemize @minus
@item @code{nil}:
Do not split the edit-area of ECB after activation, i.e. there will be
only one edit-window after starting ECB.

@item @code{horizontal}:
Split the edit-area in 2 edit-windows side by side.

@item @code{vertical}:
Split the edit-area in 2 edit-windows, one above the other.

@item @code{before-activation}:
Split the edit-area as before the ECB-start, i.e. the edit-area will
have after start a window-layout as the whole frame had before the
start of ECB.

@item @code{before-deactivation}:
Split the edit-area into a window-layout ECB had in its edit-area
direct before the ECB-deactivation. This value preserves the full
state between activations of ECB, i.e. the visibility of the
ECB-windows, the visibility of a compile-window and also the full
split-state of the edit-area. But this can only be done if important
layout-options have not been changed in the meanwhile. These are the
options @code{ecb-layout-name}, @code{ecb-compile-window-height},
@code{ecb-compile-window-width}, @code{ecb-windows-width} and
@code{ecb-windows-height}.
@end itemize

Default value is @code{before-deactivation}.

Some remarks to the value @code{before-activation}: If this value has
been set then ECB needs three permanent adivces even when ECB is
deactivated: @code{split-window}, @code{delete-window} and
@code{delete-other-windows}. But these advices do not change any
behavior of these functions but only storing in an internal
ECB-variable the facts that a window has been splitted or deleted. In
addition to this these advices are 100% error-save, means the
functionality of the original functions will be performed in every(!)
case even if within the advice an error occurs (but normally there can
no errors occur in these advices because they are very simple).
Conclusion: If you want really all ECB-advices being disabled after
deactivating ECB then you have to set this option to other values then
@code{before-activation}. But setting this variable to this value is
really completely save.
@end defopt

@defopt toggle-layout-sequence
Toggle sequence for layout toggling with @code{ecb-toggle-layout}.
Every element of this list has to be a valid layout-name i.e. either
one of the predefined layouts or one of the user-defined layouts.

You can add here as many layouts as you want but to use this option
most effective you should not add more than 2 or 3 layouts so every
layout can be accessed very fast by toggling with
@code{ecb-toggle-layout}. It is also senseful to add layouts which
have the same principal outline, i.e. all their tree-buffers are on
the same side of the frame and the tree-buffer-''column'' (or
-''row'') has identical size for the layouts.

Recommended values are for example:

@itemize @minus
@item (``left10'' ``left15''), toggles between methods and directories/history
@item (``left10'' ``left13''), toggles between methods and directories
@item (``left10'' ``left14''), toggles between methods and history
@item (``left10'' ``left13'' ``left14''), toggles between methods, history and directories
@end itemize

See also option @code{ecb-show-sources-in-directories-buffer}.

This option makes only sense if the value is a list with more than 1
element!
@end defopt

@defopt windows-height
The height of the ECB windows in lines for top-layouts. If the number
is less than 1.0 the width is a fraction of the frame height.
@end defopt

@defopt windows-width
The width of the ECB windows in columns for left- and right layouts.
If the number is less than 1.0 the width is a fraction of the frame
width.
@end defopt

@node ecb-compilation, ecb-create-layout, ecb-layout, Customizable options
@subsection Group ecb-compilation

@noindent
This group contains settings for the compile window of ECB:

@defopt compilation-buffer-names
Additional buffer names that should be displayed in the
compile-window. Buffer names can either be defined as strings or as
regexps. If the buffer-name of a buffer matches one of the defined
string or regexp then it will be displayed in the compile-window of
ECB even if @code{compilation-buffer-p} says nil for this buffer.

It is not recommended to add the eshell-buffer-names to this list
because ECB already handles the eshell-integration as best as
possible (@pxref{Using eshell}).
@end defopt

@defopt compilation-major-modes
Additional major-mode that should be displayed in the compile-window.
All buffers of a major-mode contained in this list are displayed in
the compile-window even if @code{compilation-buffer-p} says nil for
such a buffer.

It is not recommended to add @code{eshell-mode} to this list because
ECB already handles the eshell-integration as best as possible
(@pxref{Using eshell}).
@end defopt

@defopt compilation-predicates
Predicates when a buffer should be treated as compilation-buffer.
Every element of this list has to be a function or lambda-expression
which gets as argument a buffer-object and which has to return not nil
when this buffer should be treated as compilation-buffer (even if
@code{compilation-buffer-p} says nil) and therefore be displayed in
the compile-window of ECB (if there is any).

In combination with the values of @code{ecb-compilation-buffer-names}
and @code{ecb-compilation-major-modes} ECB decides when a buffer is
displayed in the compile-window.

Default value is the function @code{comint-check-proc} which returns
not nil when the buffer is related to a living process.
@end defopt

@defopt compile-window-height
Height of the durable compilation-window of ECB. If you want a
compilation window shown at the bottom of the ECB-layout then set here
the height of it (Default is a height of 5). If you redraw the current
layout with @code{ecb-redraw-layout} then the compilation window (if
any) has the height you set here. If the number is less than 1.0 the
height is a fraction of the frame height.

If you do not set a durable compilation window then doing a
compilation or displaying temp-buffers (e.g. *Help*-buffers) splits
temporally the edit window vertically if the edit window is not
splitted already or uses another edit window temporally for
compilation output if the edit window is already splitted. This is the
recommended value for this option because this is the
standard-behavior of Emacs.

Beware: If you set a durable compilation window then ECB displays all
buffers for which @code{ecb-compilation-buffer-p} returns not nil in
that durable compilation window. If a buffer which should being
displayed there is not displayed there then try to modify the options
@code{ecb-compilation-buffer-names},
@code{ecb-compilation-major-modes} or
@code{ecb-compilation-predicates} (in this sequence).

See also the options @code{ecb-compile-window-temporally-enlarge} and
@code{ecb-enlarged-compilation-window-max-height} and also the command
@code{ecb-toggle-compile-window-height}!

ECB offers the functionality of such a durable compile-window
regardless if the special ECB-windows are visible or not (see the
command @code{ecb-toggle-ecb-windows}).

Regardless of the settings you define here: If you have destroyed or
changed the ECB-screen-layout by any action you can always go back to
this layout with @code{ecb-redraw-layout}
@end defopt

@defopt compile-window-prevent-shrink-below-height
Allow the compile-window to be shrunken below its height. A non nil
value means ECB prevents the compile-window from being shrunken below
the threshold of @code{ecb-compile-window-height} by displaying
temp-buffers (e.g. *Help* etc.) or after running compilations or
greps. But interactively it is always allowed to shrink it to every
height!

If nil then ECB does nothing to prevent being shrunken below the value
of @code{ecb-compile-window-height}.

Default is t.
@end defopt



@defopt compile-window-temporally-enlarge
Let Emacs temporally enlarge the compile-window of the ECB-layout.
This option has only an effect if @code{ecb-compile-window-height} is
not nil!

The following values are possible:
@itemize @minus
@item @code{after-display}:
After displaying a ``compilation-buffer'' (in the sense of
@code{ecb-compilation-buffer-p}!) in the compile-window of ECB. For
the max. height of the enlarged compile-window see the option
@code{ecb-enlarged-compilation-window-max-height}.

@item @code{after-selection}:
Selecting the @code{ecb-compile-window} auto. enlarges it and
de-selecting (means leaving @code{ecb-compile-window}) auto. shrinks
it. Enlarging and shrinking the @code{ecb-compile-window} is done with
@code{ecb-toggle-compile-window-height}. See also the
documentation of this function!

@item @code{both}:
The combination of 'after-display and 'after-selection.

@item @code{nil}:
ECB fixes always the height of the @code{ecb-compile-window} at the
value of @code{ecb-compile-window-height}.
@end itemize

To restore the ECB-layout after such a buffer-enlarge just call
@code{ecb-toggle-compile-window-height} or
@code{ecb-redraw-layout}.
@end defopt

@defopt compile-window-width
Width of the compile-window.

Possible values are @code{frame} and @code{edit-window}.
With @code{frame} the compile-window looks like:


@example
@group
   -------------------------------------------------------
   |              |                                      |
   |  Directories |                                      |
   |              |                                      |
   |--------------|            edit-window(s)            |
   |              |                                      |
   |  Methods     |                                      |
   |              |                                      |
   -------------------------------------------------------
   |                                                     |
   |                    Compilation                      |
   |                                                     |
   -------------------------------------------------------
@end group
@end example

With @code{edit-window} the compile-window looks like:

@example
@group
   -------------------------------------------------------
   |              |                                      |
   |  Directories |                                      |
   |              |                                      |
   |--------------|            edit-window(s)            |
   |              |                                      |
   |  Methods     |                                      |
   |              |                                      |
   |              |---------------------------------------
   |              |                                      |
   |              |            Compilation               |
   |              |                                      |
   -------------------------------------------------------
@end group
@end example
   
This option takes only effect if @code{ecb-compile-window-height} is
not nil!
@end defopt

@defopt change-layout-preserves-compwin-state
Changing the layout preserves the state of the compile-window. This is
for example useful if the user toggles between several layouts (see
@code{ecb-toggle-layout}) and wants to preserve the hidden-state of
the compile-window.
@end defopt


@defopt enlarged-compilation-window-max-height
The max height of the compile-window after enlarging it. The max
height of the compilation window after enlarged by
@code{ecb-toggle-compile-window-height}. The following values are
allowed:

@code{best}:

ECB fits the height of the compile-window exactly to the size of its
current contents but never shrinks below the value of
@code{ecb-compile-window-height} or enlarges over the half of the
frame-height of the ECB-frame. The values of the options
@code{compilation-window-height} and @code{temp-buffer-max-height} are
taken into account dependent of the current @code{major-mode} of the
buffer in the compile-window: If @code{compilation-mode} then
@code{compilation-window-height} is used otherwise
@code{temp-buffer-max-height}.

@code{half}:

1/2 the frame-height of the ECB-frame

Any number:

Max height in lines. If the number is less than 1.0 the height is a
fraction of the frame height (e.g. 0.33 results in a max-height of 1/3
the frame-height).
@end defopt

@defopt scroll-other-window-scrolls-compile-window
@code{scroll-other-window} scrolls always the compile-window. For all
details about the scroll-behavior of @code{scroll-other-window} see
the advice documentation of @code{other-window-for-scrolling}.
@end defopt


@node ecb-create-layout, ecb-face-options, ecb-compilation, Customizable options
@subsection Group ecb-create-layout

@noindent
This group contains settings for creating new ECB-layouts:

@defopt create-layout-file
File where all layouts created by @code{ecb-create-new-layout} are
stored.
@end defopt

@defopt ecb-create-layout-frame-height
Frame height of the layout creation frame.
@end defopt

@defopt ecb-create-layout-frame-width
Frame width of the layout creation frame.
@end defopt

@node ecb-face-options, ecb-faces, ecb-create-layout, Customizable options
@subsection Group ecb-face-options

@noindent
This group contains settings for all faces used in ECB:

@defopt directories-general-face
Basic face for the ECB directories buffer. This defines the basic face
the whole directory buffer should displayed with. If the face
@code{ecb-default-general-face} is used then the display of all
ECB-tree-buffers can be changed by modifying only the face
@code{ecb-default-general-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt directory-face
Face used for highlighting current directory in the directories
buffer. If the face @code{ecb-default-highlight-face} is used then the
display of all ECB-tree-buffers can be changed by modifying only the
face @code{ecb-default-highlight-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt history-face
Face used for highlighting current history-entry in the history
buffer. If the face @code{ecb-default-highlight-face} is used then the
display of all ECB-tree-buffers can be changed by modifying only the
face @code{ecb-default-highlight-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt history-general-face
Basic face for the ECB directory buffer. This defines the basic face
the whole history buffer should displayed with. If the face
@code{ecb-default-general-face} is used then the display of all
ECB-tree-buffers can be changed by modifying only the face
@code{ecb-default-general-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt method-face
Face used for highlighting current method, class or variable in the
methods buffer. If the face @code{ecb-default-highlight-face} is used
then the display of all ECB-tree-buffers can be changed by modifying
only the face @code{ecb-default-highlight-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt method-non-semantic-face
Face used for for displaying tags of sources not supported by
semantic.

Changes take first effect after finishing and reactivating ECB!
@end defopt


@defopt methods-general-face
Basic face for the ECB methods buffer. This defines the basic face the
whole methods buffer should displayed with. If the face
@code{ecb-default-general-face} is used then the display of all
ECB-tree-buffers can be changed by modifying only the face
@code{ecb-default-general-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt source-face
Face used for highlighting current source in the sources buffer. If
the face @code{ecb-default-highlight-face} is used then the display of
all ECB-tree-buffers can be changed by modifying only the face
@code{ecb-default-highlight-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt source-in-directories-buffer-face
Face for source files in the directories buffer.
@end defopt

@defopt sources-general-face
Basic face for the ECB sources buffer. This defines the basic face the
whole sources buffer should displayed with. If the face
@code{ecb-default-general-face} is used then the display of all
ECB-tree-buffers can be changed by modifying only the face
@code{ecb-default-general-face}.

Changes take first effect after finishing and reactivating ECB!
@end defopt

@defopt tag-header-face
Face used for highlighting the tag header after jumping to it by
clicking onto a node in the methods buffer.
@end defopt



@node ecb-faces, ecb-download, ecb-face-options, Customizable options
@subsection Group ecb-faces

@noindent
This group contains all faces used in ECB:

@table @code
@item ecb-bucket-node-face:
Face which can be used for displaying bucket tags in the methods
buffer. See also @code{ecb-bucket-node-display}.

@item ecb-default-general-face:
Basic face for all ECB tree-buffers.
It's recommended to define here the font-family, the font-size, the basic
color etc.

In GNU Emacs 21.X all faces (even the face
@code{ecb-default-highlight-face}) used in the ECB tree-buffers inherit
from this face. Therefore the default attributes like font etc. of a
face used in a tree-buffer can be very easily changed with face
@code{ecb-default-general-face}.

With XEmacs and GNU Emacs 20.X there is no inheritance-feature but the
options @code{ecb-directories-general-face},
@code{ecb-sources-general-face}, @code{ecb-methods-general-face} and
@code{ecb-history-general-face} offer the choice to use the face
@code{ecb-default-general-face} so also with XEmacs and GNU Emacs 20.X
the basic face-settings can be easily changed just by customizing the
face @code{ecb-default-general-face}!

@item ecb-default-highlight-face:
Define basic face for highlighting the selected node in an ECB
tree-buffer.

In GNU Emacs 21.X all highlighting faces in the ECB tree-buffers
inherit from this face. Therefore the default attributes like font
etc. of a face used in a tree-buffer for highlighting the current
tag can be very easily changed with face
@code{ecb-default-highlight-face}.

With XEmacs and GNU Emacs 20.X there is no inheritance-feature but the
options @code{ecb-directory-face}, @code{ecb-source-face},
@code{ecb-method-face} and @code{ecb-history-face} offer the choice to
use the face @code{ecb-default-highlight-face} so also with XEmacs and
GNU Emacs 20.X the basic face-settings can be easily changed just by
customizing the face @code{ecb-default-highlight-face}!

@item ecb-directories-general-face:
Basic face for the ECB directories buffer. It�s recommended to define
here the font-family, the font-size, the basic color etc.

@item ecb-directory-face:
Define face used for highlighting current directory in the directories
buffer.

@item ecb-history-face:
Define face used for highlighting current history-entry in the history
buffer.

@item ecb-history-general-face:
Basic face for the ECB history buffer. It�s recommended to define here
the font-family, the font-size, the basic color etc.

@item ecb-method-face:
Define face used for highlighting current method, class or variable in
the methods buffer.

@item ecb-methods-general-face:
Basic face for the ECB methods buffer. It�s recommended to define here
the font-family, the font-size, the basic color etc.

@item ecb-method-non-semantic-face:
Define face used for displaying tags of sources not supported by semantic.

@item ecb-mode-line-data-face
Define face for the data in the mode-line. See
@code{ecb-mode-line-data}.

@item ecb-mode-line-prefix-face
Define face for the prefix in the mode-line. See
@code{ecb-mode-line-prefixes}.

@item ecb-source-face:
Define face used for highlighting current source in the sources
buffer.

@item ecb-source-in-directories-buffer-face:
Define a face for displaying sources in the directories buffer.

@item ecb-sources-general-face:
Basic face for the ECB sources buffer. It�s recommended to define here
the font-family, the font-size, the basic color etc.

@item ecb-tag-header-face:
Define face used for highlighting the tag header after jumping to it
by clicking onto a node in the methods buffer.

@item ecb-tree-guide-line-face:
Define face for the guide-lines in the tree-buffers. See the option
@code{ecb-tree-buffer-style} for a explanation of guide-lines.

@item ecb-type-tag-class-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-enum-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-group-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-interface-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-struct-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-typedef-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-type-tag-union-face:
Define face used with option @code{ecb-type-tag-display}.

@item ecb-mode-line-win-nr-face
Define face for the window-number in the mode-line. See
@code{ecb-mode-line-display-window-number}.

@end table

Just call @code{customize-face <face-name>} to customize these faces
for your personal taste. Or customize the related option in the group
@ref{ecb-face-options}.

@node ecb-download, ecb-help, ecb-faces, Customizable options
@subsection Group ecb-download

@noindent
This group contains settings for downloading and installing a new ECB
from within ECB:

@defopt download-delete-archive
Should the downloaded archive be deleted after successful
installation or after failure during the installation-process.
Possible values are:

@itemize @minus
@item @code{only-after-success}:
Archive is only deleted after successful installation
but not if a failure occurs during the installation process.
@item @code{always}:
Archive is also deleted if an error occurs.
@item @code{nil}:
Archive will never be deleted.
@end itemize
@end defopt

@defopt download-install-parent-dir
Parent directory where downloaded packages are installed.

ECB installs a downloaded package in this directory, i.e. the downloaded
archive X.tar.gz will be extracted in this directory so afterwards this
directory contains a new subdirectory X which contains the downloaded package.

This directory must be write-able!
@end defopt

@defopt download-package-version-type
Version type ECB is allowed to download for upgrading.

If you want to upgrade to a newer ECB-version via
@code{ecb-download-ecb} or if you must upgrade to newer semantic-
eieio- and/or speedbar-versions (because ECB requires these newer
versions) then this option specifies which version-types are allowed.
ECB checks on the download-sites of ECB/semantic/eieio/speedbar which
versions are currently available and then downloads always the latest
version matching the specified type:

@itemize @minus
@item 2: Get the newest version of all stable versions available.
@item 1: Get the newest version of all stable and beta versions available.
@item 0: Get the newest version of all stable, beta and alpha versions
available.
@item -1: Ask before downloading in the minibuffer for a version
(TAB-completion of all available versions is possible).
@end itemize

So, 2 means stable, 1 means stable and betas, 0 means stable, betas and alphas
and -1 means ask the user for a version.

Per default stable and beta-versions are allowed (value 1).

But all versions must match the restrictions of the specified min- and
max-versions of the required packages. For this see the file README!
@end defopt

@defopt download-url
URL where download-able ECB-versions are located. The ECB-archive-file
(e.g. ecb-1.70.tar.gz) will be appended to this URL and
@code{ecb-download-ecb} will try to download this archive.

Note: Normally this URL should never change but who knows...
@end defopt


@node ecb-help, ecb-eshell, ecb-download, Customizable options
@subsection Group ecb-help

@noindent
This group contains settings for the ECB online help:


@defopt help-html-path
Path where the ECB online help in HTML format resides. This must be
the location of the @file{ecb.html} which comes with the ECB
distribution. If is installed by unpacking the archive available on
the ECB website then this is the subdir @code{ecb-help-html-subdir} of
the installation directory of ECB. If it is installed as
XEmacs-package (e.g. via the package manager of XEmacs) then this is
probably either the directory ``../../html/'' or
``../../etc/ecb/html/'' (both relative to the Elisp directory of ECB).

The path can either be an absolute path or a path relative to the directory
where the Elisp files of ECB are.

Normally there should be no need to change this option!
@end defopt


@defopt help-info-path
Path where the ECB online help in info format resides. This must be
the location of the @file{ecb.info} which comes with the ECB
distribution. If is installed by unpacking the archive available on
the ECB website then this is the subdir @code{ecb-help-info-subdir} of
the installation directory of ECB. If it is installed as
XEmacs-package (e.g. via the package manager of XEmacs) then this is
probably the directory ``../../info/'' (relative to the Elisp directory
of ECB).

The path can either be an absolute path or a path relative to the directory
where the Elisp files of ECB are.

Normally there should be no need to change this option!
@end defopt


@defopt show-help-format
The format @code{ecb-show-help} shows its online help. Allowed values
are 'info (for the Info format) and 'html (for HTML format). If the
value is 'html then @code{browse-url-browser-function} says which
browser is used.

Note: If you got ECB as a standard XEmacs-package maybe the
HTML-online-documentation is not included.
@end defopt

@node ecb-eshell, ecb-non-semantic, ecb-help, Customizable options
@subsection Group ecb-eshell

@noindent
This group contains settings for eshell integration within the ECB:

@defopt eshell-auto-activate
Startup the eshell and display it in the compile-window. If current
layout does not display a compile-window (see
@code{ecb-compile-window-height}) then nothing is done.
@end defopt

@defopt eshell-enlarge-when-eshell
Enlarge the compile-window if it is selected by @code{eshell}. This
takes only effect if the command @code{eshell} is called!
@end defopt

@defopt eshell-fit-window-to-command-output
Fit the compile-window after an eshell-command to the output. This is
done by the function @code{ecb-eshell-fit-window-to-output} which is
added to @code{eshell-post-command-hook} ie. which is running autom.
after each eshell-command.
@end defopt

@defopt eshell-synchronize
Synchronize eshell with the default-directory of current
source-buffer. The synchronization is done by
@code{ecb-eshell-current-buffer-sync} which can be called
interactively but normally it is called autom. by the
@code{ecb-current-buffer-sync-hook}.
@end defopt


@node ecb-non-semantic, ecb-winman, ecb-eshell, Customizable options
@subsection Group ecb-non-semantic

@noindent
This group contains settings for parsing and displaying non-semantic files:

@defopt auto-save-before-etags-methods-rebuild
Automatic saving of current buffer before rebuilding its methods.

This option is only relevant for sources which are supported and
parsed by etags (see @code{ecb-process-non-semantic-files}). Because
etags is an external tool a source-buffer can only be reparsed if the
buffer is saved to disk. So the command
@code{ecb-rebuild-methods-buffer} checks for sources which are not
supported by semantic or imenu if either this option is t or if the
major-mode of the source-buffer is contained in this list: In both
cases ECB saves the current source-buffer before it re-runs etags for
reparsing the source. If nil or if the major-mode is not contained
then no automatic saving will be done!

For all source supported by semantic or by imenu this option takes no
effect.
@end defopt

@defopt non-semantic-exclude-modes
Exclude modes from parsing with imenu or etags. Per default, ECB tries
to parse all file-types not supported by semantic with imenu or etags
or some other method (for details see the option
@code{ecb-non-semantic-parsing-function}). If a file-type can not be
parsed by semantic, imenu or etags than this simply results in an
empty method-buffer for this file. But nevertheless you will get a
message ``Sorry, no support for a file of that extension'' which comes
from the speedbar-library and can not switched off. Therefore if a
@code{major-mode} is known as not parse-able by semantic, imenu or etags
it can be added to this option and then it will be excluded from being
tried to parsed.
@end defopt

@defopt non-semantic-methods-initial-expand
Initially expand all tags for not by semantic supported sources.
This option can be customized on a major-mode basis, i.e. if a
@code{major-mode} is contained in this option then all tags for this
modes will be initially expanded - otherwise not.
@end defopt

@defopt non-semantic-parsing-function
Define mode-dependent parsing functions for non-semantic files. This
is an alist where the car is a major-mode symbol and the cdr is a
function-symbol of a function which should be used for parsing a
non-semantic buffer, i.h. a buffer for which no semantic grammar
exists. Such a function gets one argument - the filename of current
buffer - and has to generate and return a tag/tag list which is
understandable by @code{speedbar-insert-generic-list}. speedbar has
already included two functions @code{speedbar-fetch-dynamic-imenu} and
@code{speedbar-fetch-dynamic-etags} which can be used for parsing
buffers with imenu rsp. etags.

This option takes only effect if @code{ecb-process-non-semantic-files}
is not nil: Then ECB checks for non-semantic buffers if current
@code{major-mode} is contained in this option and if yes, then the
specified parsing function is called; if not then the cars of the
elements of @code{speedbar-dynamic-tags-function-list} are called in
that sequence they are listed in this variable. See option
@code{speedbar-dynamic-tags-function-list} for further details.

In most cases imenu-parsing is preferable over etags-parsing because
imenu operates on Emacs-buffers and needs no external tool and
therefore parsing works also if current contents of a buffer are not
saved to disk. But maybe sometimes etags may return better parsing
results

IMPORTANT: if imenu-parsing should be used then the option
@code{speedbar-use-imenu-flag} must be set to not nil!
@end defopt

@defopt process-non-semantic-files
Display content of non-semantic-files in the ECB-methods-buffer. See
also @code{ecb-non-semantic-parsing-function}.
@end defopt

@defopt rebuild-non-semantic-methods-before-hook
Hook running at beginning of the function
@code{ecb-rebuild-methods-buffer-for-non-semantic}. This function is
always called by the command @code{ecb-rebuild-methods-buffer} for not
semantic supported source-types.

Every function of this hook gets one argument: The complete filename
of the current source-buffer in the edit-window. The Method-buffer is
only rebuild by @code{ecb-rebuild-methods-buffer-for-non-semantic} if
either the hook contains no function (the default) or if no function
of this hook returns nil! See @code{run-hook-with-args-until-failure}
for description how these function are processed.
@end defopt

@node ecb-winman, ecb-mode-line, ecb-non-semantic, Customizable options
@subsection Group ecb-winman

@noindent
This group contains settings for supporting several window-managers:

@defopt winman-escreen-number
Number of the escreen which is reserved for ECB. If you go to the
escreen with this number you go always to the escreen with activated
ECB. All other escreen-numbers are escreens with deactivated ECB!
@end defopt

@defopt winman-winring-name
Name of the winring-window-configuration reserved for ECB. If you go
to the window-configuration with this name you go always to the
window-configuration with activated ECB. All other
window-configuration are configurations with deactivated ECB!
@end defopt

@node ecb-mode-line, , ecb-winman, Customizable options
@subsection Group ecb-mode-line

@noindent
This group contains settings for the modelines of the
ECB-tree-buffers:

@defopt mode-line-data
Data shown in the modelines of the special ECB-buffers. Everey element
of this list is a cons-cell where the car is used to define a
buffer-name and the cdr to define the modeline-data for that buffer.
For details about how to defining a buffer-name see
@code{ecb-mode-line-prefixes} - its completely the same.

The cdr is the data for ths modeline and can either be the symbol
@code{sel-dir} or @code{sel-source} whereas the former one displays
the current selected directory as modeline-data and the latter one the
current selected source-file (without path).

In addition to these two predefined values for every special
ECB-buffer a plain string (which is displayed) or a function can be
specified which gets three args (name of the buffer, current selected
directory and current selected source-file) and must return a string
which will be displayed in the modeline (or nil if no data should be
displayed).

If a special ECB-buffer should not display special data in its
modeline then this buffer-name should either not being added to this
option or added with ``No data'' (= nil as cdr).

The whole modeline of the special ECB-buffer consists of the prefix of
@code{ecb-mode-line-prefixes} and the data of
@code{ecb-mode-line-data} - eventually prepended by the window-number,
see @code{ecb-mode-line-display-window-number}.
@end defopt

@defopt mode-line-data-face
Face used for the data in the mode-line. See
@code{ecb-mode-line-data}. For XEmacs the face should inherit from the
face @code{modeline} (see @code{set-face-parent})!
@end defopt


@defopt mode-line-display-window-number
Display in the modeline of every special ECB-window the window-number.
The left-top-most window in a frame has the window-number 0 and all
other windows are numbered with increasing numbers in the sequence,
functions like @code{other-window} or @code{next-window} would walk
through the frame.

This can be used to jump to windows by number with commands like:

@lisp
@group
  (defun my-switch-to-window-number (number)
    ``Switch to the nth window''
    (interactive ``P'')
    (if (integerp number)
        (select-window (nth number (window-list)))))
@end group
@end lisp

Currently this feature is only available for GNU Emacs 21.X, because
neither GNU Emacs < 21 nor XEmacs can evaluate dynamically forms in
the mode-line.
@end defopt

@defopt mode-line-prefixes
Prefixes shown in the modelines of the special ECB-buffers. The
displayed prefix then looks like: ``[ <PREFIX>[: ]]'', means if a
prefix is defined for an special ECB-buffer then a single space is
prepended and if there is additional text to display (e.g. the current
directory in the sources buffer, see @code{ecb-mode-line-data}) then
also the string ``: '' is appended.

Everey element of this list is a cons-cell where the car is used to
define a buffer-name and the cdr to define the modeline-prefix for
that buffer.

The buffer-name can either be defined as plain string or with a symbol
which contains the buffer-name as value. The latter one is recommended
to define a prefix for one of the builtin ECB-tree-buffers because
then simply the related option-symbol can be used. To add a prefix for
the builtin directories tree-buffer just set the symbol
@code{ecb-directories-buffer-name} as car.

The cdr is the prefix for a buffer and can either be a string which
used as it is or a function-symbol which is called with three argument
(the buffer-name, the current selected directory and the current
selected source-file) and must return either nil (for no prefix) or a
string which is then used a prefix.

If a special ECB-buffer should not have a prefix in its modeline then
this buffer-name should either not being added to this option or added
with ``No prefix'' (= nil as cdr).
@end defopt

@defopt mode-line-prefix-face
Face used for the prefix in the mode-line. See
@code{ecb-mode-line-prefixes}. For XEmacs the face should inherit from
the face @code{modeline} (see @code{set-face-parent})!
@end defopt

@defopt mode-line-win-nr-face
Face used for the window-number in the mode-line. See
@code{ecb-mode-line-display-window-number}. For XEmacs the face should
inherit from the face @code{modeline} (see @code{set-face-parent})!
@end defopt


@node Submitting problem report, Upgrading, Customizing, Top
@chapter Submitting a problem report

@cindex Bug report
@cindex Problem report
If you run into problems with ECB you should first take a look into

@itemize @minus
@item @ref{FAQ} or
@item @ref{Conflicts and bugs} or
@item @ref{Tips and tricks} or
@item the appropriate section of this online-manual.
@end itemize

If your problem(s) still remain you can/should send a problem report
to the ECB mailing list @email{ecb-list@@lists.sourceforge.net}. ECB
offers you a command which does all necessary for you to send a
problem report. Just call @code{ecb-submit-problem-report}! Please
read the documentation of this command, see @ref{Interactive ECB
commands}.

This command creates a problem-report buffer for you. After that you
get a menu ``Mail'' (dependent on the mail-package used, the menu can
have a different name) with commands to send the problem report. But
for this the variable @code{mail-user-agent} must be configured right for
your system. If you can�t get working this mechanism you can simply
copy the whole problem-report buffer after filling it out and sending
it with your standard mail-client to
@email{ecb-list@@lists.sourceforge.net}!

Please read also the documentation of the option @code{ecb-debug-mode} and
switch on the debug mode of ECB (also available in the Help-menu of
ECB!) before submitting a problem-report!

@node Upgrading, Tips and tricks, Submitting problem report, Top
@chapter Upgrading and downloading packages

This chapter describes all aspects of upgrading to a newer version of
ECB.

The first section describes how to download and install a new
package from the web, where ``package'' means either ECB itself or the
required libraries semantic, eieio and speedbar.

After installing a new ECB-version ECB checks if the values of the
customized ECB-options are still compatible. If not ECB does some
smart things. This is the topic of the second section.

@menu
* Downloading new versions::    How to download newer versions of packages
* Auto. option-upgrading::      ECB can auto. upgrade your options
@end menu

@node Downloading new versions, Auto. option-upgrading, Upgrading, Upgrading
@section Downloading new versions of ECB and/or required packages

@cindex Download
ECB offers the possibility to upgrade to newer versions direct from
the ECB-website. This can be done if the following requirements are
satisfied:

@enumerate
@item A connection to the web is available
@item The tools ``wget'', ``tar'' and ``gzip'' are installed

With Unix-systems these tools are in the
standard-distribution. If you are running any Microsoft Windows system
then you need cygwin@footnote{cygwin is available at
@ifhtml
@uref{http://cygwin.com/}
@end ifhtml
@ifnothtml
@url{http://cygwin.com/}
@end ifnothtml
} which offers these tools too. On every
system these tools must reside in the @env{PATH} environment-variable!

If you are behind a firewall and you have to use a proxy you maybe
need the following wget-configuration in your file @file{~/.wgetrc}:

@example
@group
# Define your proxies (where 8080 and 8081 are examples
# for the port-numbers)
http_proxy = http://your.proxy.com:8080
ftp_proxy  = http://your.ftpproxy.com:8081
  
# If you do not want to use proxy at all, set this to off.
use_proxy = on
@end group
@end example
@end enumerate

If these requirements are satisfied you can download and install both
ECB itself and also the required versions of semantic, eieio and
speedbar:

@itemize @bullet
@item Download a new ECB-version with @code{ecb-download-ecb}:

A description for this command you will find in @ref{Interactive ECB
commands}. Check also the options of the customize-group
'ecb-download' (@pxref{ecb-download}).

@anchor{Download required packages}
@item Download and install of required packages:

ECB checks at load-time if the packages semantic, eieio and speedbar
are at least installed and at start-time if the required versions of
semantic, eieio and speedbar (see @file{README}) are installed and
loaded into Emacs. If not you will be asked if you want auto. download
and install them. If you confirm this then ECB does the following:

@enumerate
@item
Checking which versions are available at the download-site of the
required packages. With the option
@code{ecb-download-package-version-type} you can specify which type of
versions (only stable, stable and betas or stable, betas and alphas)
you allow to download and install. This option offers also the choice
of asking you for a certain version. Depending of this setting ECB
either ask you which version it should download and install or chooses
autom. the newest version available which is matching both its
min-max-requirements and the setting in
@code{ecb-download-package-version-type}.

NOTE: Currently there are only beta-versions of speedbar available
therefore this option has to be set to 1 (allow stable and beta
versions). But the speedbar beta-versions are very stable!

@item
Downloading and installing the right version (see 1.) of the required
packages. ECB downloads and installs the new package versions in
subdirectories of @code{ecb-download-install-parent-dir}.
@end enumerate

If both of these actions succeed then you will get a message-buffer
which tells you something like:

@example
@group
-----------------------------------------------------------------
Current state of the required packages semantic, eieio, speedbar:

- semantic author-version must be [1.4, 1.4.9]:
  Installed in /usr/local/lib/site-lisp/semantic-1.4
  
- eieio author-version must be [0.17, 0.17.9]:
  Correct version already loaded!

- speedbar author-version must be [0.14beta1, 0.15.9]:
  Correct version already loaded!

After adding the new directory to your @code{load-path} and then
restarting Emacs the new package(s) can be activated.
-----------------------------------------------------------------

@end group
@end example

@strong{Remark 1}: "P author-version must be [x y]" means, that ECB
requires package P in a version-number >= x and <= y.

@strong{Remark 2}: By setting the option @code{ecb-version-check} to
@code{nil} you can prevent ECB from checking correct versions of
semantic, eieio and speedbar but it's strongly recommended not to do
this!
@end itemize

@node Auto. option-upgrading, , Downloading new versions, Upgrading
@section Automatic upgrading of options

@menu
* User interface::              Options and commands you should know
* Background information::      Maybe some interesting informations
@end menu

@node User interface, Background information, Auto. option-upgrading, Auto. option-upgrading
@subsection User interface for option-upgrading

There are two interactive commands (@pxref{Interactive ECB commands}):

@itemize @minus
@item @code{ecb-upgrade-options}:
Does all necessary beginning with a incompatibility-check for all
options, upgrading/resetting incompatible options and ending with the
display of all upgraded or reset options.

@item @code{ecb-display-upgraded-options}:
Displays a temp. buffer with all upgraded or reseted ECB-options with
their old and new values.
@end itemize

If the option @code{ecb-auto-compatibility-check} has a non-nil value
(which is the default) then ECB does all this stuff automatically at
startup. This is very recommended!

If you are interested in some background information, read
@ref{Background information}!

@node Background information, , User interface, Auto. option-upgrading
@subsection Background information

Big packages like ECB will be enhanced and developed continuously so
sometimes a new version must be released. Such packages offer in
general a lot of customizable options so probably some of these
options change the type or are renamed because the old type and/or
name of the option makes no sense in the new release.

Especially options which have changed the type of their value are now
a problem for the user which want to upgrade to the latest
ECB-version: If the user has saved a certain value for option X in its
file @file{.emacs} but the type of this saved value doesn't match the
new defined type in the defcustom-form after an ECB-upgrade then there
can occur serious problems like ECB can not be started anymore or even
Emacs can not be started without errors.

Until now there was only one way to fix these problems: The user must
manually edit his file @file{.emacs} and remove all entries for
options which have now another type. After this and after restarting
Emacs the new default-values of the type-changed options in the new
ECB-release are active and the user can go on using Emacs and ECB. But
this approach to fix the incompatible-option-problem has two serious
drawbacks:

@enumerate
@item
The user must manually edit the customize-section in his file
@file{.emacs}. This should normally not be done and if then only by
old-handed Emacs-users.

@item
The customized value of the option X in the old-release (with the old
type) is lost because after removing the related entry from the
file @file{.emacs} the new default-value is active, so the user must
re-customize the option X.
@end enumerate

OK, this is one half of the option-upgrade-problem but a new ECB-release
can also rename a option from name X to name Y because the new name Y makes
much more sense and/or is more mnemonic. If only the name has changed but
not the type this is not a serious problem like above but also annoying
because the customized value of the old-option X takes no effect in the new
release but instead the default-value of the new-option Y is now active.
But nevertheless this problem has the drawback number 2 (see above).

The last category of upgrade-problems is a renamed option which has also
changed its type.

@noindent
ECB has a solution for all these problems:

@itemize @bullet

@item
It checks all customized values of all ECB-options if they are still
type-compatible. If not then it tries to upgrade the old-value to the
new value-type and if this is not possible then it resets the option
to the new default value and store it via customize in the .emacs-file
(or in any file which is used for customized options).

@item
It offers a special constant @code{ecb-upgradable-option-alist} which
allows the ECB-maintainers to define special transformings for renamed
options so even the value of an old-option X can be savely transformed
to the new-option Y and the old setting is not lost.
@end itemize

All these checks and transformings are done at beginning of activating
ECB - if the option @code{ecb-auto-compatibility-check} is not nil. If
ECB has recognized incompatible or renamed options it does its
upgrading/reseting-job so all ECB-options have correct types so ECB
can start correct. After ECB is started it displays a list of all
upgraded or reseted option with their old and new values.


@node Tips and tricks, Elisp programming, Upgrading, Top
@chapter Tips and tricks

This chapter contains some tips and tricks how to deal best with some
situations.

@menu
* Changing faces::              Changing faces in the ECB tree-buffers
* Small screens::               Working with small screens
* Big screens::                 Working with big screens
* Simulating speedbar::         Simulating speedbar without an extra frame
* Integrating speedbar::        Integrating speedbar in the ECB-frame
* Optimize scrolling::          Optimize scrolling in the edit-window
* Large directories::           Working with large directories
* Using eshell::                Optimal using of eshell in ECB
* Grepping directories::        Grepping directories with ECB
* Working with JDEE::           Working best with ECB and JDEE
* Compile-window on demand::    Displaying the compile-window on demand
* Non-semantic sources::        Parsing and displaying non-semantic sources
* Hide-show::                   Using hide-show from the methods-buffer-menu
* Window-managers and ECB::     Support of several Emacs-window-managers
* Tree-buffer styles::          Displaying the trees with different styles
* Using semanticdb::            Using semanticdb for going to external nodes
@end menu

@node Changing faces, Small screens, Tips and tricks, Tips and tricks
@section Changing faces in the ECB tree-buffers

@cindex Faces
There are two basic faces:

@itemize @bullet
@item @code{ecb-default-general-face}:
Basic face for displaying an ECB-tree-buffer.

It�s recommended to define the font-family, the font-size, the basic
color etc. with this face.

In GNU Emacs 21.X all faces (even the face
@code{ecb-default-highlight-face}) used in the ECB tree-buffers
inherit from this face. Therefore the default attributes like font
etc. of a face used in a tree-buffer can be very easily changed with
face @code{ecb-default-general-face}.

With XEmacs and GNU Emacs 20.X there is no inheritance-feature but the
options @code{ecb-directories-general-face},
@code{ecb-sources-general-face}, @code{ecb-methods-general-face} and
@code{ecb-history-general-face} offer the choice to use the face
@code{ecb-default-general-face} so also with XEmacs and GNU Emacs 20.X
the basic face-settings can be easily changed just by customizing the
face @code{ecb-default-general-face}.

@item @code{ecb-default-highlight-face}:
Basic face for highlighting the current node in an ECB-tree-buffer.

In GNU Emacs 21.X all highlighting faces used in the ECB tree-buffers
inherit from this face. Therefore the default attributes like font
etc. of a highlighting face used in a tree-buffer can be very easily
changed with face @code{ecb-default-highlight-face}.

With XEmacs and GNU Emacs 20.X there is no inheritance-feature but the
options @code{ecb-directory-face}, @code{ecb-source-face},
@code{ecb-method-face} and @code{ecb-history-face} offer the choice to
use the face @code{ecb-default-highlight-face} so also with XEmacs and
GNU Emacs 20.X the basic face-settings can be easily changed just by
customizing the face @code{ecb-default-highlight-face}.

@end itemize

With these faces you can change the basic attributes easily and fast
for ALL ECB-tree-buffers. But you are also able to display each
ECB-tree-buffer with different faces, see the different options for
every tree-buffer mentioned above.

@strong{Please note} (only for XEmacs users): Cause of the lack of the
font-inheritance feature using ONE other font for the ECB-methods
buffer can NOT be achieved just by setting
@code{ecb-methods-general-face} to @code{ecb-default-general-face} and
changing the font of this default face. In addition you have to set
the same font also for the face @code{ecb-bucket-node-face} like in
the following example:

@example
(defconst my-ecb-font
          "-outline-Courier-normal-normal-13-97-96-96-c-*-iso8859-1")
(set-face-font 'ecb-default-general-face my-ecb-font)
(set-face-font 'ecb-bucket-node-face my-ecb-font)
@end example

This code sets the new defined font @code{my-ecb-font} as font for
all@footnote{Of course @code{ecb-directories-general-face},
@code{ecb-sources-general-face}, @code{ecb-methods-general-face} and
@code{ecb-history-general-face} must be set to
@code{ecb-default-general-face}!} ECB-tree-buffers (incl. the methods
buffer).

@node Small screens, Big screens, Changing faces, Tips and tricks
@section Working with small screens

@cindex Small screen
If your screen is very small so you need every square-centimeter for
displaying the buffer which you want to edit, ECB offers you a special
layouts, where only the ECB-methods buffer is displayed on top or on
left-side. Here comes what you should/can do to work best with ECB in
such a situation:

@itemize @bullet
@item First customize your ECB:

@enumerate
@item
Customize @code{ecb-layout-name} to layout-name ``top2'' (on top) or
``left9'' (on left-side)

@item
Ensure that @code{ecb-compile-window-height} is nil.

@item
Optional: Adjust the @code{ecb-windows-height} rsp. @code{ecb-windows-width}.

@item
Save your changes.
@end enumerate

@item To edit your buffers:
Call @code{ecb-toggle-ecb-windows} (also available via the menu ``ECB'' and
by @kbd{C-c . lw}) or @code{ecb-hide-ecb-windows} to hide the ECB-method buffer
so you get all the place of your screen for editing.

@item To browse and select functions:
Call @code{ecb-toggle-ecb-windows} or @code{ecb-show-ecb-windows} to
make the ECB-method buffer visible if not already. If you want select
a method/variable with the keyboard instead with the mouse you should
read the section @ref{Using the keyboard} in this online help!
@end itemize

The possibility of hiding temporally the ECB windows like described
above is also useful for all the other layouts.


@node Big screens, Simulating speedbar, Small screens, Tips and tricks
@section Working with big screens

ECB offers a layout type ``left-right'' with special ECB-tree-windows
on the left and right side of the edit-area. The layouts
``leftright1'' and ``leftright2''are examples for this layout type.
See @ref{Creating a new ECB-layout} and @ref{The layout-engine}
for details about how to create or program more layouts of this type.

Such a layout is eventually the best choice for big screens because
the several ECB-tree-windows are bigger and can display more
informations without scrolling.

With such a layout it can could be senseful to reduce the value of the
option @code{ecb-windows-width} compared to layouts of type left or
right. A value of max. 0.25 should be enough.

@node Simulating speedbar, Integrating speedbar, Big screens, Tips and tricks
@section Simulating speedbar without an extra frame

@cindex Speedbar
You can simulate a speedbar-like layout within ONE frame by doing the
following:

@enumerate
@item
Customize @code{ecb-layout-name} to layout name ``left9'', ``left12'',
``left13'' or ``left14'' dependent to what you like.

@item
Optional: Ensure that @code{ecb-compile-window-height} is nil.

@item
Optional: Adjust the @code{ecb-windows-width}.

@item
Optional: Customize @code{ecb-toggle-layout-sequence} and toggle very fast
between several layouts by @code{ecb-toggle-layout}. See the doc-strings!

@item
Optional: Customize @code{ecb-show-sources-in-directories-buffer} to
not nil if the chosen layout (see 1. and 4.) contains a
directories-tree-buffer.

@item
Save your changes.
@end enumerate

But not only simulating speedbar is possible but also full integrating
it into the ECB and the ECB-frame, @xref{Integrating speedbar}.

@node Integrating speedbar, Optimize scrolling, Simulating speedbar, Tips and tricks
@section Integrating speedbar in the ECB-frame

It is very easy to integrate speedbar into ECB. There are two
different ways to do this:

@enumerate
@item
You can either use speedbar in the directories-, sources- or
methods-window of ECB instead of the built-in directory-, sources- or
methods-browser of ECB. This can be done via the option
@code{ecb-use-speedbar-instead-native-tree-buffer}.

@item
Or you can integrate an extra speedbar-window into a layout
independent of the existence of a directory-, sources- or
methods-window. For this you can either use the built-in layout
``left-dir-plus-speedbar'' or you have to create your own layout
interactively with the command @code{ecb-create-new-layout}. This way
is not described in more details because there is nothing more to
describe - just create your layout.
@end enumerate

In general integrating speedbar into the ECB-frame makes sense for
people...

@itemize @bullet
@item
...who like the speedbar way of handling directories and source-files
but also like the ECB-way of displaying the buffer-contents (like
methods and variables in a source-file). This people should use the
option @code{ecb-use-speedbar-instead-native-tree-buffer} and set it
to @code{dir}.

@item
...who like the speedbar way of browsing things like directories,
files, file-contents etc. but who dislike the extra speedbar-frame.
@end itemize

Note: It is not necessary to integrate speedbar if you only want
parsing sources not supported by semantic. From version 1.94 on ECB
supports native parsing and displaying of such sources
(@pxref{Non-semantic sources})!

Regardless the group you belong, with the speedbar-integration feature
of ECB you can combine both worlds, the speedbar- and the ECB-world:

@enumerate
@item Choose a layout which either contains a directories- or a
sources-window but not both of them@footnote{Only one of them is
needed if you use speedbar because speedbar displays directories and
sources in one window. But if you like wasting space then you can also
use a layout with both windows...}.

Because speedbar has also display-modes for buffers and info-nodes and
some other useful things (which can be changed by the speedbar-command
@code{speedbar-change-initial-expansion-list} we recommend layouts
like ``left15'' or ``leftright3'' for using with speedbar.

@item Set the option
@code{ecb-use-speedbar-instead-native-tree-buffer} to not nil. After
this the chosen window of ECB will contain a full featured speedbar
(the only difference to standard speedbar is not residing in an extra
frame).
@end enumerate

Note: If you belong to the first group of people (s.a.) a similar
effect and usability is available by setting
@code{ecb-use-speedbar-instead-native-tree-buffer} to nil and setting
@code{ecb-show-sources-in-directories-buffer} to not nil, because this
combination displays also directories and sources in one window.

So with the option @code{ecb-use-speedbar-instead-native-tree-buffer}
you have the choice which way of displaying and handling ``things''
(directories, sources, methods...) you want (the speedbar- or the
ECB-way).

During speedbar is running within ECB (i.e.
@code{ecb-use-speedbar-instead-native-tree-buffer} is not nil) the
speedbar-command @code{speedbar} is disabled and the speedbar-command
@code{speedbar-get-focus} switches between the speedbar-window and the
edit-window@footnote{The standard behavior is switching between the
speedbar-frame and the attached frame, but this make obviously no
sense during running speedbar with ECB.}.

@strong{IMPORTANT}: ECB can only integrate speedbar-versions >=
0.14beta1! If you use lower versions of speedbar
@code{ecb-use-speedbar-for-directories} has no effect.

@node Optimize scrolling, Large directories, Integrating speedbar, Tips and tricks
@section Optimize scrolling in the edit-window

@cindex Scrolling
Emacs 20.X seems to slow down scrolling if there is a horizontal split
in the frame and/or a lot of overlays in the buffer which is scrolled.
This is independent of ECB! But because almost all layouts of ECB uses
horizontal splits of the frame and because ECB is based on semantic
which uses overlays intensively there can be poor scrolling
performance in large buffers, especially with java-buffers in
@code{jde-mode}.

This scrolling performance can be increased a lot if the options
@code{scroll-conservatively} and @code{scroll-step} are set
appropriately: The former one should have a value of 0 during ECB is
active and the latter one a value of either 0 or > 1 (the exact value
depends on the power of your machine).

As far as we know this is not a problem of Emacs 21.X or XEmacs. With
these versions of Emacs there should be no scrolling problem even with
@code{scroll-step} has value 1.


@node Large directories, Using eshell, Optimize scrolling, Tips and tricks
@section Working with large directories

If @code{ecb-source-path} contains directories with many files and
subdirs, especially if these directories are mounted net-drives
(``many'' means here something > 500, dependent on the speed of the
net-connection and the machine), actualizing the sources- and/or
directories- buffer of ECB (if displayed in current layout!) can slow
down dramatically. If this is a problem the contents of certain
directories and also the contents of the sources-buffer can be cached
which increases the speed a lot. See the option
@code{ecb-cache-directory-contents}.

IMPORTANT: The full speed-advantage of this cache-mechanism is only
available if @code{ecb-show-sources-in-directories-buffer} is
@code{nil}, i.e. sources of a directory are displayed in the
ECB-sources-window. The reason is that only with a sources window the
tree-buffer contents for the sources can be cached (i.e. the
buffer-content of the ECB-sources-window) whereas with sources
displayed in the directories buffer only the disk-contents of a
directory are cached - which increases speed too but not so much as
with sources displayed in the extra window ECB-sources.

The cache of a directory can be only refreshed by a POWER-click (with
mouse or keyboard) onto the related directory-node in the
directories-buffer of ECB (@pxref{Using the mouse}).

See also the option @code{ecb-cache-directory-contents-not}. Here are
some useful settings for both of these options:

@itemize @bullet
@item Cache all directories with more than 500 entries:
Set @code{ecb-cache-directory-contents} to ((``.*'' . 500)) and set
@code{ecb-cache-directory-contents-not} to nil.

@item Cache only all directories > 200 beginning with /usr/
Set @code{ecb-cache-directory-contents} to ((``^/usr/.*'' . 200)) and
set @code{ecb-cache-directory-contents-not} to nil.

@item Cache all directories > 500 but NOT these beginning with /usr/:
Set @code{ecb-cache-directory-contents} to ((``.*'' . 500)) and set
@code{ecb-cache-directory-contents-not} to (``^/usr/.*'').
@end itemize

Another way for getting a faster overlook for large directories with
many source-entries is to apply an online-filter to the
sources-buffer. This can be done via the command
@code{ecb-sources-filter} or via the popup-menu of the sources-buffer.

@node Using eshell, Grepping directories, Large directories, Tips and tricks
@section Optimal using of eshell in ECB

@cindex eshell
ECB offers a very smart integration of the ``eshell'' if you are using
a compile window (@pxref{Temp- and compile-buffers})@footnote{Of
course you can use eshell also if there is no compile-window. Then it
is just displayed in the edit-area and there is no special
integration.}

Here is a short summary of provided features:

@itemize @bullet
@item
Ability to jump to the eshell buffer within the compilation window by
simply call @code{eshell} (bound to @kbd{C-c . e}). If the eshell
isn't running it will be started.

@item
Expands the compilation window when you run commands. So for example
it allows you to view the eshell in minimized mode and then when you
run ``ls'' the window automatically expands (but always depending of
the output of the command you run).

@item
Synchronizes the current directory of the eshell with the current
buffer in the current active edit-window of ECB.

@item
Provides smart window layout of the eshell buffer. This makes sure
that the eshell is taking up the exact amount of space and that
nothing is hidden.
@end itemize

Here comes a detailed explanation of these features and how to use it
(all these features are only available if you use a durable
compile-window, i.e. if @code{ecb-compile-window-height} is not nil):

You have not to learn a new command for the eshell-start - just call
@code{eshell} (for convenience also bound to @kbd{C-c . e}) and the
eshell will displayed in the compile-window of ECB (if eshell is not
already alive then it will be started automatically).

ECB tries to display the contents of the eshell-buffer as best as
possible, means ECB can autom. enlarge and shrink the compile-window
so the contents of the eshell are fitting the window. See option
@code{ecb-eshell-enlarge-when-eshell} and
@code{ecb-eshell-fit-window-to-command-output}. Normally this is done
autom. but you can also you the standard compile-window
enlarging-command of ECB: @code{ecb-toggle-compile-window-height}.

ECB tries also to recenter the eshell-buffer as best as possible.
Normally this is done autom but you can do it on demand with the
command @code{ecb-eshell-recenter}.

If option @code{ecb-eshell-synchronize} is true then ECB always
synchronizes the command prompt of eshell with the directory of
current source-buffer of the current active edit-window.

With the option @code{ecb-eshell-auto-activate} you can start eshell
autom. in the compile-window when ECB is started but of course if a
compile-window exists.

@node Grepping directories, Working with JDEE, Using eshell, Tips and tricks
@section Grepping directories with ECB

ECB offers in the popup-menus in the directories- and
sources-tree-buffer commands for easy (recursive) grepping the current
directory under point (directory-buffer) rsp. the current-directory
(sources-buffer). In every case just the function of the options
@code{ecb-grep-function} rsp. @code{ecb-grep-find-function} is called
and the @code{default-directory} is tempor. set to the chosen
directory so the grep will performed in this directory regardless of
the @code{default-directory} of current buffer in the edit-window.

Other smart things beyond that are not done by ECB, see also
@code{ecb-grep-function}!

So, how to exclude some subdirectories or files from the grep?

Basically this has to be done with the ``-prune'' option of the
find-utility: If the standard-grep facility of Emacs is used then this
is not easy but with the library @file{igrep.el} there is a convenient
way to exclude things like CVS- or RCS-directories from the find-call:
See the variable @code{igrep-find-prune-clause} of the library
@file{igrep.el}.

@node Working with JDEE, Compile-window on demand, Grepping directories, Tips and tricks
@section Working best with ECB and JDEE

ECB is completely language independent, i.e. it works with any
language supported by semantic (e.g. C, C++, Java, Elisp etc.).

But there are some special integrations for the great
Java-Development-Environment JDEE:

@itemize @bullet
@item Displaying contents of class under point

With the command @code{ecb-jde-display-class-at-point} you can display
the contents of the class which contains the definition of the
``thing'' at point (which can be a method, variable etc.).

@item Creating new source-files

The popup-menus in the directories- and the sources-buffer offer a
command ``Create Source'' which allows easy creating new java-sources
by calling the command @code{jde-gen-class-buffer}.

@item Adding user-extensions to the popup-menus

The options @code{ecb-directories-menu-user-extension} and
@code{ecb-sources-menu-user-extension}@footnote{If you need a dynamic
way of menu-extension then you should have a look at the options
@code{ecb-directories-menu-user-extension-function} and
@code{ecb-sources-menu-user-extension-function}.} allow adding often
used JDEE-commands to the popup-menus of the directories- or
sources-buffer. One example is to add building the project of current
directory. Here is a function which could be added to
@code{ecb-directories-menu-user-extension}:

@example
@group
(defun ecb-dir-popup-jde-build (node)
  "Build project in directory."
  (let ((project-file 
	 (expand-file-name jde-ant-buildfile (tree-node-get-data node))))
    (jde-ant-build project-file "build")))
@end group
@end example

@end itemize



@node Compile-window on demand, Non-semantic sources, Working with JDEE, Tips and tricks
@section Displaying the compile-window on demand

If you like displaying all output of compile/grep/etc. an all
temp-buffers like *Help*-buffers in an extra compile-window
(@pxref{Temp- and compile-buffers}) but you dislike wasting the space
of this compile-window if you are just editing then you can get a
compile-window ``on demand''. Just do the following:

@enumerate
@item
Customize @code{ecb-compile-window-height} to not nil and save it for
future sessions. This gives you an extra compile-window at the
bottom.

@item
Add the following to your .emacs:

@example
(add-hook 'ecb-activate-hook
          (lambda ()
            (let ((compwin-buffer (ecb-get-compile-window-buffer)))
            (if (not (and compwin-buffer
                          (ecb-compilation-buffer-p compwin-buffer)))
                (ecb-toggle-compile-window -1)))))
@end example

This hides the extra compile-window direct after the start of ECB
because there is no need for a compile-window at this moment. But the
hiding will not be done if there is a compile-window and if a
``compile-buffer'' in the sense of @code{ecb-compilation-buffer-p} is
displayed in this compile-window. Without this additional check the
compile-window would always be hidden after the ECB-start even when
ECB is reactivated after a deactivation by the window-manager-support
of ECB (@pxref{Window-managers and ECB}); but in these cases we want
to preserve the state before deactivation as good as possible (see
also option @code{ecb-split-edit-window-after-start}).

@end enumerate

This is all you have to do. Now if you run @code{compile} (or
@code{grep} or other compile-modes) or display temp-buffers like
*Help*-buffers then ECB autom. displays the compile-window at the
bottom and display the output there.

If you have finished with using the compile- or temp-output (e.g.
fixing errors) then you can throw away the compile-window just by
@code{ecb-toggle-compile-window} - ECB will reactivate it autom.
before next compilation or help-buffer-display.!

@node Non-semantic sources, Hide-show, Compile-window on demand, Tips and tricks
@section Parsing and displaying non-semantic sources

ECB is mostly designed to display parsing information for files
supported by semantic. But beginning with version 1.94 it also
supports other parsing engines like imenu and etags, so also files not
supported by semantic but by imenu/etags can be displayed in the
Method-buffer of ECB. See @ref{Definition of semantic- and
non-semantic-sources} for a description of ``semantic-sources'' and
``non-semantic-sources''.

If support of non-semantic-sources is enabled then ECB will display
the contents of all sources which can be displayed by speedbar too.
This comes from the fact that ECB uses speedbar-logic to parse sources
with imenu or etags.

In most cases imenu-parsing is preferable over etags-parsing because
imenu operates on Emacs-buffers and needs no external tool and
therefore parsing works also if current contents of a buffer are not
saved to disk.

This section describes all important aspects about parsing and
displaying file-contents of file-types not supported by semantic but
by imenu and/or etags.

@subsection Enabling parsing and displaying of non-semantic-sources

Enabling is simply done with the option @code{ecb-process-non-semantic-files}.

ECB offers an option @code{ecb-non-semantic-parsing-function} to
specify on a major-mode basis which parsing-method should be used:
imenu or etags. Normally there should be no need to change this option
but read the documentation of this option (@pxref{ecb-non-semantic})
for further details.

IMPORTANT:

@itemize
@item
If imenu-parsing should be used then the option
@code{speedbar-use-imenu-flag} must be set to not @code{nil}!

@item
If some non-semantic-sources are not parsed (i.e. there is an empty
Methods-buffer) and you think that they should then maybe they are neither
supported by imenu nor by etags or you have to check the options
@code{ecb-non-semantic-parsing-function} and
@code{speedbar-dynamic-tags-function-list} and - especially for etags -
@code{speedbar-fetch-etags-parse-list}, @code{speedbar-fetch-etags-arguments}
and @code{speedbar-fetch-etags-command}.

@item
Even with support for semantic-, imenu- and etags-parsing there will
remain some file-types rsp. @code{major-modes} which are not
parse-able, neither by semantic, imenu nor etags. This is no problem
because these files simply have an empty Methods-buffer. But
nevertheless you will get a message ``Sorry, no support for a file of
that extension'' which comes from the speedbar-library and can not
switched off. Therefore if a @code{major-mode} is known as not
parse-able by semantic, imenu or etags it can be added to the option
@code{ecb-non-semantic-exclude-modes} and then it will be excluded
from being tried to parsed and this (annoying) message will not occur.
@end itemize

@subsection Automatic rescanning/reparsing of non-semantic-sources

In contrast to semantic (see @code{global-semantic-auto-parse-mode})
there is no built-in mechanism for autom. reparsing
non-semantic-sources and then updating the contents of the
Methods-buffer.

For non-semantic-sources you have always at least to call
@code{ecb-rebuild-methods-buffer} (bound to @kbd{C-c . r}) or saving
the source-file (if @code{ecb-auto-update-methods-after-save} is true)
to update the Method-buffer@footnote{Maybe future versions of ECB (>
1.94) will offer an autom. mechanism for this.}.

Depending on the parsing-mechanism the following options have to be
switched on so ECB can rebuild the methods-buffer for
non-semantic-sources:

@itemize @bullet
@item imenu:

The imenu-option @code{imenu-auto-rescan} must be enabled and
@code{imenu-auto-rescan-maxout} has to be set big enough to auto-parse
big files too! But this results not directly in an autom. updated
Method-buffer. This is first done after calling the command
@code{ecb-rebuild-methods-buffer} or saving the source-file (if
@code{ecb-auto-update-methods-after-save} is true).

@item etags:

Only if @code{ecb-auto-save-before-etags-methods-rebuild} is switched on
the command @code{ecb-rebuild-methods-buffer} rebuilds the
method-buffer with current source-contents. See description of this
option for an explanation.
@end itemize

Tip: If you want to program your own real. automatic
rescan/reparse/rebuild mechanism for non-semantic-sources you can do:

Adding to @code{after-change-functions} a function F which either runs
itself @code{ecb-rebuild-methods-buffer-for-non-semantic} or which
adds only another function FF to an idle-timer and the function FF
runs @code{ecb-rebuild-methods-buffer-for-non-semantic}. The latter
approach has the advantage that the reparse/rebuild is not performed
immediately after every change but first after Emacs is idle for a
senseful interval (e.g. 4 seconds) after last change. Of course the
function FF has to cancel its own idle-timer at the end, so the next
idle-timer is first started again after the next change (i.e. by
function F which is still contained in @code{after-change-functions}.

@subsection Customizing the display of the tags

For non-semantic-sources ECB uses does no special organizing of tags
in groups and sub-tags but it completely uses the tag-hierarchy the
imenu- and etags-parsers of speedbar return. So the displayed tag
hierarchy can only be customized with some options speedbar offers for
this:

@code{speedbar-tag-hierarchy-method},
@code{speedbar-tag-group-name-minimum-length},
@code{speedbar-tag-split-minimum-length} and
@code{speedbar-tag-regroup-maximum-length}. See the speedbar
documentation for details about these options.

With the option @code{ecb-method-non-semantic-face} you can define the
face used for displaying the tags in the Method-buffer for
non-semantic-sources.

@code{ecb-non-semantic-methods-initial-expand} can be useful too.


@node Hide-show, Window-managers and ECB, Non-semantic sources, Tips and tricks
@section Using hide-show from the methods-buffer-menu

The popup-menu of the Methods-buffer offer two entries for either
hiding or showing the block which is related to the selected tag
(that tag for which the popup-menu was opened):

@itemize @bullet
@item ``Jump to tag and hide block'':
Jumps to the tag and calls @code{hs-hide-block} from the
hideshow-library which is shipped with (X)Emacs. After that the block
is hidden, i.e. only the header-line of that tag (method, variable
etc.) is visible, the rest is hidden behind the ``...''.

@item ``Jump to tag and show block'':
Jumps to the tag and calls @code{hs-show-block}. This shows the related
hidden block if the block was hidden via @code{hs-hide-block} or the
menu-entry ``Jump to tag and hide block'' (s.a.).
@end itemize

For this feature the library @file{hideshow.el} is used which should
normally being included in the (X)Emacs-distribution. If this library
is not loaded into Emacs, ECB does this automatically before the first
call to one of these menu-entries.

IMPORTANT: If in some @code{major-mode} hiding and showing does not
work as you expect it to work then you must probably add an entry for
this @code{major-mode} to the hideshow-variable
@code{hs-special-modes-alist}. See the documentation of this variable
for further details. One example of such a @code{major-mode} is
@code{jde-mode} of the Java Development Environment JDEE; just add an
entry for it like the already contained entries for @code{c++-mode} or
@code{java-mode} and hiding and showing will work for you with JDEE
too.

@node Window-managers and ECB, Tree-buffer styles, Hide-show, Tips and tricks
@section Support of several Emacs-window-managers

@cindex winring
@cindex escreen
@cindex window-manager
There are several window-managers available which offer an easy
interface to jump between different window-configurations within the
same frame. A window configuration is the layout of windows and
associated buffers within a frame. There is always at least one
configuration, the current configuration. You can create new
configurations and cycle through the layouts in either direction.
Window configurations are often named or numbered, and you can jump to
and delete named rsp. numbered configurations.

Without special support by ECB these window-managers would not work in
combination with ECB!

ECB currently supports the following managers:
 
@itemize @bullet
@item winring.el:
Written by Barry A. Warsaw @email{bwarsaw@@python.org}, available at
@ifhtml
@uref{http://www.python.org/emacs/}
@end ifhtml
@ifnothtml
@url{http://www.python.org/emacs/}
@end ifnothtml

@item escreen.el:
Written by Noah Friedman @email{friedman@@splode.com}, available at
@ifhtml
@uref{http://www.splode.com/~friedman/software/emacs-lisp/}
@end ifhtml
@ifnothtml
@url{http://www.splode.com/~friedman/software/emacs-lisp/}
@end ifnothtml
@end itemize

@strong{IMPORTANT}: With one of these window-managers installed and
active you can run applications like Gnus, VM or BBDB in the same
frame as ECB! Just use different window-configurations (winring.el) or
escreens (escreen.el) for ECB and the other applications. Especially
with winring.el you can give every configuration a descriptive name
like ``ECB'' or ``Gnus''; afterwards you can jump to a
window-configuration by name!

When you go back to the ECB-window-configuration (winring.el) or the
ECB-escreen (escreen.el) with any of the special
window-manager-commands then the state of ECB will be restored exactly
as you have left it when going to another window-configuration rsp.
escreen. This includes the whole splitting state of the edit-area and
the visibilty of the ecb-windows and of the compile-window!

The rest of this section describes how to enable the special
ECB-support for these window-managers and how to use them.

@subsection Enabling of the support

Every support must be enabled explicitly:
@itemize @bullet
@item winring:
Call @code{ecb-winman-winring-enable-support}. This @strong{MUST} be
done @strong{BEFORE} the first call to any winring-command, so also
before calling @code{winring-initialize}!

@item escreen:
Call @code{ecb-winman-escreen-enable-support}. This @strong{MUST} be
done @strong{BEFORE} the first call to any escreen-command, so also
before calling @code{escreen-install}!
@end itemize

If a window-manager-support should be enabled autom. after Emacs-start
just put the following into your @file{.emacs}:

@lisp
@group
(ecb-winman-winring-enable-support)
(winring-initialize)

;; or - if you like escreen more

(ecb-winman-escreen-enable-support)
(escreen-install)
@end group
@end lisp

@subsection Usage of a window-manager in combination with ECB

After enabling the support of one of the supported window-managers
just go on as described in the commentary or introduction of the
respective library-file(s) of the window-manager. Here is a short
description:

@itemize @bullet
@item winring:
First you have to define how to identify the ECB-window-configuration,
i.e. the configuration with activated ECB. This done with the option
@code{ecb-winman-winring-name}. There is always only one
window-configurations with name @code{ecb-winman-winring-name}!

Then run @code{winring-initialize}. If ECB is active then the
resulting window-configuration is the ECB-window-configuration.
Otherwise you can create the ECB-window-configuration when you first
time call @code{winring-new-configuration} with name equal to
@code{ecb-winman-winring-name}. In general you can run all commands of
the winring-library. If you jump to the ECB-window-configuration then
ECB will be autom. activated and if you leave the
ECB-window-configuration then ECB will autom. deactivated.

@item escreen:
First you have to define how to identify the ECB-escreen
i.e. that escreen with activated ECB. This done with the option
@code{ecb-winman-escreen-number}. There is always only one
escreen with number @code{ecb-winman-escreen-number}!

Then run @code{escreen-install} (deactivates ECB if currently
running). After that you can call @code{escreen-create-screen} and
@code{escreen-goto-screen}@footnote{And of course all other
@code{escreen-goto-*} commands!}. These commands autom. activate ECB
if creating or selecting the escreen with number
@code{ecb-escreen-number} (default = 1) and autom. deactivate ECB if
leaving the ECB-escreen.
@end itemize

@subsection Disabling the support

There is normally no need to do this but nevertheless it can be done
by @code{ecb-winman-escreen-disable-support} rsp.
@code{ecb-winman-winring-disable-support}.

@node Tree-buffer styles, Using semanticdb, Window-managers and ECB, Tips and tricks
@section Displaying the trees of the ECB-windows with different styles

ECB offers three different styles for the tree-buffers in the
ECB-windows. Two of the styles are ascii-based and one style uses
images for drawing the tree-structure.

@menu
* Style basics::                Basic knowledge about the styles
* Ascii-based styles::          How to customize the ascii-styles
* Tree-buffers with images::    Which images are used for the tree
@end menu

@node Style basics, Ascii-based styles, ,Tree-buffer styles
@subsection Basic knowledge about the styles

There are nine image-names which define the control- and guide-symbols
to draw the tree. Here is the list of the allowed image-names and the
related corresponding ascii-symbols:

@itemize @minus
@item open (``[-]''):
The control-symbol displayed for an opened tree-node which has several
subnodes. Clicking onto this control closes the node.

@item close (``[+]''):
The control-symbol displayed for a closed tree-node, i.e. an
expandable node with subnodes but all subnodes are hidden. Clicking
onto this control opened the node and displays its subnodes - if
there are any. If it has no subnodes the empty-symbol will be
displayed.

@item empty (``[x]''):
The symbol displayed for an empty node. An empty node is a
node which could have subnodes but has currently none.

@item leaf (``*''):
The symbol displayed for a node which can not have any subnodes so it
is a ``leaf'' in the tree.

@item guide (`` |''):
The symbol used for drawing vertical ``guide-lines'' for opened nodes.
See the example below.

@item no-guide (``  ''):
Sometimes invisible guide-lines are needed to draw the tree.

@item end-guide (`` `''):
The symbol used for the guide-line of the last subnode of an opened
node.

@item handle (``-''):
The symbol displayed before every subnode. Each handle is connected to
a guide-line - either a normal guide or an end-guide.

@item no-handle (`` ''):
An invisible handle.
@end itemize

A tree will be build-up with these elements like follows:

@example
@group
[-] node-with-subnodes      (open)
 |-[+] not-empty-subnode1   (guide+handle+close)
 |-[X] empty-subnode        (guide+handle+empty)
 `-[-] not-empty-subnode2   (end-guide+handle+open)
    |-* leaf-1              (no-guide+no-handle+guide+handle+leaf)
    `-* leaf-2              (no-guide+no-handle+end-guide+handle+leaf)
@end group
@end example

@node Ascii-based styles, Tree-buffers with images, Style basics, Tree-buffer styles
@subsection How to customize the ascii-styles

The ECB-option @code{ecb-tree-buffer-style} offers two different
styles completely drawn with ascii-controls and -guides.

Ascii-style with guide-lines (value @code{ascii-guides})@footnote{For
a better look&feel of such a tree-buffer ECB displays only the last
subnode of an opened node with a handle!}:

@example
@group
[-] ECB
 |  [+] code-save
 `- [-] ecb-images
     |  [-] directories
     |   |  [-] height-15
     |   |   |  * close.xpm
     |   |   |  * empty.xpm
     |   |   |  * leaf.xpm
     |   |   `- * open.xpm
     |   |  [+] height-17
     |   |  [+] height-19
     |   `- [+] height-21
     |  [x] history
     |  [x] methods
     `- [x] sources
@end group
@end example

Ascii-style without guide-lines (value @code{ascii-no-guides}) - this
is the style used by ECB <= 1.96:

@example
@group
[-] ECB
    [+] code-save
    [-] ecb-images
        [-] directories
            [-] height-15
                * close.xpm
                * empty.xpm
                * leaf.xpm
                * open.xpm
            [+] height-17
            [+] height-19
            [+] height-21
        [x] history
        [x] methods
        [x] sources
@end group
@end example

The tree-layout of both ascii-styles can be affected with the options
@code{ecb-tree-indent} and @code{ecb-tree-expand-symbol-before} (the
examples above have set 4 for the former and true for the latter one).
For the guide-style the face and color of the guide- and
handle-symbols can be customized with the option
@code{ecb-tree-guide-line-face} (default is the equal-named face).

@node Tree-buffers with images, ,Ascii-based styles, Tree-buffer styles
@subsection Which images are used for the tree

Depending on the value of @code{ecb-tree-buffer-style} and the
image-support of (X)Emacs, the tree-buffer try to use images instead
of strings to draw a nice-looking tree. If images can and should be
used then the option @code{ecb-tree-image-icons-directories} tells ECB
where to search for suitable image-icons for each of the nine
image-names (see above). An image is used for displaying a control
with name ``XXX'' if one of the directories of
@code{ecb-tree-image-icons-directories} contains an image-file with
basename ``ecb-XXX'' and an extension which is supported by (X)Emacs.
Currently supported extensions are ``.xpm'', ``.png'', ``.gif'',
``.jpeg'', .''jpg'' and ``.xbm''.

Example: To display the control with name ``open'' with a suitable
image then one of the directories of
@code{ecb-tree-image-icons-directories} must contain a file with name
``ecb-open.xpm'' or ``ecb-open.png'' etc. See the description of this
option to get all important details how and in which sequence ECB
searches the directories of @code{ecb-tree-image-icons-directories}.

ECB comes with predefined default-images usable for every tree-buffer
and special images for the Directories-tree-buffer. They are defined
in several different heights - so for the most senseful font-heights
of a tree-buffer a fitting image-size should be available. The shipped
images reside either in the subdirectory "ecb-images" of the
ECB-installation or - if ECB is installed as regular XEmacs-package -
in the ECB-etc data-directory (the directory returned by evaluating
(locate-data-directory "ecb"). If you do not want to change the images
then you normally have nothing to do because the default value of
@code{ecb-tree-image-icons-directories} points already to the correct
image-directories.

@subsubsection A special note for XEmacs

At least XEmacs 21.14 (but probably previous versions too) has a bug
in its display-engine which prevents adjacent images to be displayed
correctly. The effect is, that in a row of two or more adjacent images
(e.g. end-guide+handle+open - see the tree-example above) always all
images are masked by the last one, means only the last one is visible.
If at least one normal character (e.g. a space) is placed between two
images then the images are displayed correctly. Therefore ECB has
implemented the following work-around to get best possible results
with XEmacs: open-, close-, empty-, leaf-, guide-, end-guide- and
no-guide-images are displayed with images and the handle- and the
no-handle-images are displayed with the corresponding ascii-symbols
(which is ``-'' rsp. `` ''). The face (the color) of the handle-symbol
is customizable via the option @code{ecb-tree-guide-line-face}.

This bug is already reported to the XEmacs-team. If your XEmacs has
fixed this bug then add the following to your @file{.emacs}-file (or
whereever your emacs-setup is located):

@lisp
(setq tree-buffer-enable-xemacs-image-bug-hack nil)
@end lisp

Then ECB uses images without any special work-around with XEmacs too.
Just try it - if the tree-buffers look ugly then the XEmacs-bug is
probably not fixed correctly.

@node Using semanticdb, , Tree-buffer styles, Tips and tricks
@section Using semanticdb to jump to type-tags defined in other files

In OO-languages like CLOS, eieio and C++ there can be type-tags in the
method-buffer which are somehow virtual because there is no definition
in the current source-file. But such a virtual type collects all its
outside defined members like methods in C++ which are defined in the
@file{*.cc} file whereas the class-definition is defined in the
associated header-file. ECB uses semanticdb to open the definition-file
of such a tag and to jump to the definition of this tag. Same for
parent-tags in the methods-buffer. This feature can only work
correctly if semanticdb is well configured!

Here is a C++-example:

This class is defined in a file @file{ParentClass.h}:

@example
@group
class ParentClass
@{
protected:
  int p;
@};  
@end group
@end example

This class is defined in a file @file{ClassWithExternals.h}

@example
@group
#include "ParentClass.h"

class ClassWithExternals : public ParentClass
@{
private:
  int i;

public:
  ClassWithExternals();
  ~ClassWithExternals();
@};
@end group
@end example

Both the constructor and the desctructor of the class
``ClassWithExternals'' are defined in a file
@file{ClassWithExternals.cc}:

@example
@group
#include "test.h"

ClassWithExternals::ClassWithExternals(int i,
                                       boolean b,
                                       char c)
@{
  return;
@}

void
ClassWithExternals::~ClassWithExternals()
@{
  return;
@}
@end group
@end example

ECB displays the contents of @file{ClassWithExternals.cc} in its methods-buffer like
follows:

@example
@group
[-] [Includes]
 `- test.h
[-] ClassWithExternals
 |  +ClassWithExternals (+i:int, +b:class boolean, +c:char):ClassWithExternals
 `- +~ClassWithExternals ():void
@end group
@end example

Both the constructor and the desctructor of the class
``ClassWithExternals'' are grouped under their class-type. ECB now
uses semanticdb to jump to the definition of class
``ClassWithExternals'' when you click onto the type-node
``ClassWithExternals'' in the methods-buffer.

The contents of @file{ClassWithExternals.h} are displayed like
follows:

@example
@group
[-] [Includes]
 `- ParentClass.h
[-] ClassWithExternals:class
 |  [-] [Parents]
 |   `- ParentClass
 |  [-] [Variables]
 |   `- -i:int
 |  +ClassWithExternals ():ClassWithExternals
 |  +~ClassWithExternals ():void
 `- [+] [Misc]
@end group
@end example

ECB uses semanticdb to jump to the definition of the class
``ParentClass'' when you click onto the node ``ParentClass''.

To enable this feature @code{global-semanticdb-minor-mode} must be
enabled and semanticdb must be correctly configured. This means
mainly that the option @code{semanticdb-project-roots} must be setup
well. See the manual of semanticdb for further informations about
this.

@node Elisp programming, Conflicts and bugs, Tips and tricks, Top
@chapter Entry points for Elisp programmers

This chapter describes how ECB can be used/programmed/driven by an
Elisp-program. This contains:

@menu
* List of variables::           Which variables an Elisp-program can use
* List of hooks::               All available hooks
* tree-buffer::                 Some words to the tree-buffer-library
* Adviced functions::           How to deal with the adviced functions
* The layout-engine::           Programming new layouts and special windows
@end menu

@node List of variables, List of hooks, Elisp programming, Elisp programming
@section Variables for Elisp-programs

Variables an Elisp-program can use beyond those ones mentioned in
@ref{The layout-engine}:

@itemize @bullet
@item @code{ecb-source-path-functions}
@end itemize

Look at the documentation of these variables to get a description.

@node List of hooks, tree-buffer, List of variables, Elisp programming
@section Available hooks of ECB

The following hooks are available:

@cindex Hooks
@itemize @bullet
@item @code{ecb-activate-before-new-frame-created-hook}
@item @code{ecb-activate-before-layout-draw-hook}
@item @code{ecb-activate-hook}
@item @code{ecb-before-activate-hook}
@item @code{ecb-before-deactivate-hook}
@item @code{ecb-common-tree-buffer-after-create-hook}
@item @code{ecb-current-buffer-sync-hook}
@item @code{ecb-deactivate-hook}
@item @code{ecb-directories-buffer-after-create-hook}
@item @code{ecb-hide-ecb-windows-after-hook}
@item @code{ecb-hide-ecb-windows-before-hook}
@item @code{ecb-history-buffer-after-create-hook}
@item @code{ecb-methods-buffer-after-create-hook}
@item @code{ecb-redraw-layout-after-hook}
@item @code{ecb-redraw-layout-before-hook}
@item @code{ecb-show-ecb-windows-after-hook}
@item @code{ecb-show-ecb-windows-before-hook}
@item @code{ecb-sources-buffer-after-create-hook}
@end itemize

Look at the documentation of these hooks to get a detailed description.

@node tree-buffer, Adviced functions, List of hooks, Elisp programming
@section The library tree-buffer.el

The library tree-buffer.el is ECB independent and can be used for
other applications too. But such an application is not allowed to use
any of the variables of tree-buffer.el especially not the variable
@strong{tree-buffers}!

@code{tree-buffers}: Only for internal use. It contains all
tree-buffers of current Emacs-instance, means @strong{all}
tree-buffers of @strong{all} applications which uses currently
tree-buffers. Every application must store its own collection of
tree-buffers in an own variable! For example: ECB stores its
tree-buffer set in @code{ecb-tree-buffers}!

An application may only use the methods tree-buffer.el provides but no
internal variables!

@node Adviced functions, The layout-engine, tree-buffer, Elisp programming
@section How to deal with the adviced window-functions

ECB offers for packages which work during activated ECB three macros
for easy temporally@footnote{I.e. regardless of the settings in
@code{ecb-advice-window-functions}!} using all original-functions, all
adviced functions or only some adviced functions:

@itemize @minus
@item @code{ecb-with-original-functions}
@item @code{ecb-with-adviced-functions}
@item @code{ecb-with-some-adviced-functions}
@end itemize

For a detailed explanation of each macro read the documentation with
@code{describe-function}!

@node The layout-engine, , Adviced functions, Elisp programming
@section How to program new layouts and new special windows

There are two aspects concerning this topic:

@enumerate
@item
Programming a new layout which contains several special ECB-windows
like directories, sources, methods, history or other special windows
and arranging them in a new outline.

@item
Creating complete new special windows (e.g. a local-variable window
for a graphical debugger like JDEbug of JDEE), adding them to a layout
and synchronizing them with the current active edit-window.
@end enumerate

The former one covers merely the layout-programming aspect which is
explained in the first subsection of this chapter whereas the latter
one covers all aspects of creating new special windows and what is
necessary to synchronize it with the current active edit-window of
ECB. This is explained in the second subsection which will refers to
the first subsection.

@menu
* Programming a new layout::    How to program a new layout
* Programming special windows:: Aspects of programming special windows
* Possible layout-outlines::    The wide range of possible layouts
* The layout-engine API::       The complete layout-engine API
@end menu

@node Programming a new layout, Programming special windows, The layout-engine, The layout-engine
@subsection How to program a new layout

If you just want creating a new layout with the standard ECB-windows
like directories, sources, methods, history and speedbar it's is
strongly recommended to define the new layout interactively with the
command @code{ecb-create-new-layout} (@pxref{Creating a new
ECB-layout}).

If you want creating a new layout and if this layout should contain
other special windows than the standard ECB-windows then it's still
recommended to define this layout interactively with
@code{ecb-create-new-layout} and using the option to give the created
windows user-defined types. For every user defined type you have then
just to program the necessary buffer-set function. For all the details
see @ref{Creating a new ECB-layout}.

But if you do not like the interactive way (because you are tough and
brave) but you want programming the new layout with Elisp then use the
macro @code{ecb-layout-define} (the following definition has stripped
the prefix ``ecb-'' for better indexing this manual):

@defmac layout-define name type &rest create-code
Creates a new ECB-layout with name @var{NAME}. @var{TYPE} is the type
of the new layout and is literal, i.e. not evaluated. It can be left,
right, top or left-right. @var{DOC} is the docstring for the new
layout-function ``ecb-layout-function-<name>''. @var{CREATE-CODE} is
all the lisp code which is necessary to define the
ECB-windows/buffers. This macro adds the layout with @var{NAME} and
@var{TYPE}to the internal variable @code{ecb-available-layouts}.

Preconditions for @var{CREATE-CODE}:
@enumerate
@item
Current frame is splitted at least in one edit-window and the
``column'' (for layout types left, right and left-right) rsp. ``row''
(for a top layout) for the special ECB-windows/buffers. The width of
the ``column'' rsp. the height of the ``row'' is always defined with
the option @code{ecb-windows-width} rsp. @code{ecb-windows-height}.
Depending on the value of the option @code{ecb-compile-window-height}
there is also a compile window at the bottom of the frame which is
stored in @code{ecb-compile-window}.

@item
All windows are not dedicated.

@item
Neither the edit-window nor the compile-window (if there is one) are
selected for types left, right and top. For type left-right the left
column-window is selected

@item
All ECB-advices for the functions in
@code{ecb-advice-window-functions} are disabled!
@end enumerate

Things @var{CREATE-CODE} has to do:
@enumerate
@item
Splitting the ECB-tree-windows-column(s)/row (s.a.) in all the
ECB-windows the layout should contain (directories, sources, methods
and history). The split must not be done with other functions than
@code{ecb-split-hor} and @code{ecb-split-ver}! It is recommended not to
to use a ``hard'' number of split-lines or -rows but using fractions
between -0.9 and +0.9! Tip: It is recommended to spilt from right to
left and from bottom to top or with other words: First create the
right-most and bottom-most special windows!

@item
Making each special ECB-window a dedicated window. This can be done with
one of the following functions:
@itemize @minus
@item @code{ecb-set-directories-buffer}
@item @code{ecb-set-sources-buffer}
@item @code{ecb-set-methods-buffer}
@item @code{ecb-set-history-buffer}
@item @code{ecb-set-speedbar-buffer}
@end itemize
Each layout can only contain one of each tree-buffer-type!

In addition to these functions there is a general macro
@code{ecb-with-dedicated-window}. This macro performs any arbitrary
code in current window and makes the window autom. dedicated at the
end. This can be used by third party packages like JDEE to create
arbitrary ECB-windows besides the standard tree-windows.

To make a special ECB-window a dedicated window either one of the five
functions above must be used or a function(!) which calls in turn the
macro @code{ecb-with-dedicated-window}. See the documentation of this
macro how to use it!

Such a function is called a ``dedicated setter'' and must(!) use
@code{ecb-with-dedicated-window} to make the window dedicated!

@item
Every(!) special ECB-window must be dedicated as described in 2.

@item
@var{CREATE-CODE} must work correctly regardless if there is already a
compile-window (stored in @code{ecb-compile-window}) or not
(@code{ecb-compile-window} is nil).
@end enumerate

Things @var{CREATE-CODE} can do or can use:
@enumerate
@item
The value of @code{ecb-compile-window} which contains the compile-window (if
there is one). Using the values of @code{ecb-compile-window-height},
@code{ecb-windows-width}, @code{ecb-windows-height}.
@end enumerate

Things @var{CREATE-CODE} must NOT do:
@enumerate
@item Splitting the edit-window
@item Creating a compile-window
@item
Deleting the edit-window, the compile-window (if there is any) or the
ECB-windows-column(s)/row (see Precondition 1.)
@item
Referring to the value of @code{ecb-edit-window} because this is always nil
during @var{CREATE-CODE}.
@end enumerate

Postconditions for @var{CREATE-CODE}:
@enumerate
@item
The edit-window must be the selected window and must not be dedicated
and not be splitted.

@item
Every window besides the edit-window \(and the compile-window) must be
a dedicated window \(e.g. a ECB-tree-window).
@end enumerate
@end defmac

Use this macro to program new layouts within your @file{.emacs} or any
other file which is loaded into your Emacs. After loading the file(s)
with all the new layout-definitions you can use it by customizing the
option @code{ecb-layout-name} to the appropriate name or with the
command @code{ecb-change-layout}.

With the function @code{ecb-layout-undefine} you can remove a layout
from the list of available layouts:

@defun layout-undefine name
Unbind ecb-layout-function-<NAME> and
ecb-delete-window-ecb-windows-<NAME> and remove @code{NAME} from
@code{ecb-available-layouts}.
@end defun

Here is an example for a new layout programmed with
@code{ecb-layout-define}:

@example
@group
(ecb-layout-define "my-own-layout" left nil
  ;; The frame is already splitted side-by-side and point stays in the
  ;; left window (= the ECB-tree-window-column)

  ;; Here is the creation code for the new layout
  
  ;; 1. Defining the current window/buffer as ECB-methods buffer
  (ecb-set-methods-buffer)
  ;; 2. Splitting the ECB-tree-windows-column in two windows
  (ecb-split-ver 0.75 t)
  ;; 3. Go to the second window
  (other-window 1)
  ;; 4. Defining the current window/buffer as ECB-history buffer
  (ecb-set-history-buffer)
  ;; 5. Make the ECB-edit-window current (see Postcondition above)
  (select-window (next-window)))
@end group
@end example

This layout definition defines a layout with name ``my-own-layout''
which looks like:

@example
@group
-------------------------------------------------------
|              |                                      |
|              |                                      |
|              |                                      |
|  Methods     |                                      |
|              |                                      |
|              |                                      |
|              |               Edit                   |
|              |                                      |
|              |                                      |
|--------------|                                      |
|              |                                      |
|  History     |                                      |
|              |                                      |
-------------------------------------------------------
|                                                     |
|                    Compilation                      |
|                                                     |
-------------------------------------------------------
@end group
@end example

@node Programming special windows, Possible layout-outlines, Programming a new layout, The layout-engine
@subsection All aspects of programming special windows

ECB offers a flexible programmable layout-engine for other packages to
display their own contents and informations in special ECB-windows. An
example could be a graphical debugger which offers a special window for
displaying local variables and another special window for messages
from the debugger-process (like JDEbug of JDEE@footnote{JDEE is
available at
@ifhtml
@uref{http://jdee.sunsite.dk/}
@end ifhtml
@ifnothtml
@url{http://jdee.sunsite.dk/}
@end ifnothtml
}).

This section explains all aspects of programming new special windows,
adding them to a new layout and synchronizing them with edit-window of
ECB. This can be done best with an easy example which nevertheless
covers all necessary aspects to be a good example and skeleton for
complex tools (like a graphical debugger) which want to use the
layout-engine of ECB do display their own information.

Here comes the example:

@subsubsection The outline of the example layout:

@example
@group
-------------------------------------------------------
|Bufferinfo for <filename>:            |[prior]       |
|Type: file                            |[next]        |
|Size: 23456                           |              |
|Modes: rw-rw-rw-                      |              |
|-----------------------------------------------------|
|                                                     |
|                                                     |
|                                                     |
|                                                     |
|                 edit-window                         |
|                                                     |
|                                                     |
|                                                     |
|                                                     |
-------------------------------------------------------
|                                                     |
|                 compilation-window                  |
|                                                     |
-------------------------------------------------------
@end group
@end example

@subsubsection The description of the layout-contents

The top-left window always displays informations about the current
buffer in the selected edit-window. This window demonstrates how
autom. synchronizing a special window/buffer of a layout with current
edit-window.

The top-right window contains an read-only ``action-buffer'' and
offers two buttons which can be used with the middle mouse-button to
scroll the edit-window. This is not very senseful but it demonstrates
how to control the edit-window with actions performed in a special
window/buffer of a layout.

(If you have not set a compilation-window in
@code{ecb-compile-window-height} then the layout contains no durable
compilation window and the other windows get a little more place).

@subsubsection The example code

Now let have us a look at the several parts of the Elisp-program
needed to program this new example layout. ECB contains a library
@file{ecb-examples.el} which contains the full working code of this
example. To test this example and to play with it you can load this
library into Emacs (with @code{load-library} for example) and then
calling @code{ecb-change-layout} (bound to @kbd{C-c . lc}) and
inserting ``example-layout1'' as layout-name. An alternative is
calling @code{ecb-examples-activate} and
@code{ecb-examples-deactivate}. For details see file
@file{ecb-examples.el}.

The following steps only contain code-skeletons to demonstrate the
principle. The full working code is available in
@file{ecb-examples.el}.

@subsubsection The bufferinfo buffer of the example

The name of the bufferinfo buffer:

@lisp
(defconst ecb-examples-bufferinfo-buffer-name " *ECB buffer info*")
@end lisp

Two helper functions for displaying infos in a special buffer:


@lisp
@group
(defun ecb-examples-print-file-attributes (buffer filename)
  (ecb-with-readonly-buffer buffer
    (erase-buffer)
    (insert (format "Bufferinfo for %s:\n\n" filename))
    ;; insert with the function `file-attributes' some 
    ;; informations about FILENAME.
    ))

(defun ecb-examples-print-non-filebuffer (buffer buffer-name)
  (ecb-with-readonly-buffer buffer
    (erase-buffer)
    ;; analogous to `ecb-examples-print-file-attributes'
    ))
@end group
@end lisp

The main synchronizing function added to
@code{ecb-current-buffer-sync-hook} for autom. evaluation by
@code{ecb-current-buffer-sync} which runs dependent on the values of
@code{ecb-window-sync} and @code{ecb-window-sync-delay}. This function
synchronizes the bufferinfo buffer with the current buffer of the
edit-window if that buffer has changed.

@lisp
@group
(defun ecb-examples-bufferinfo-sync ()
  (ecb-do-if-buffer-visible-in-ecb-frame
      'ecb-examples-bufferinfo-buffer-name

    ;; here we can be sure that the buffer with name
    ;; `ecb-examples-bufferinfo-buffer-name' is displayed in a 
    ;; window of `ecb-frame'

    ;; The macro `ecb-do-if-buffer-visible-in-ecb-frame' locally 
    ;; binds the variables visible-buffer and visible-window!! See
    ;; documentation of this macro!

    (let ((filename (buffer-file-name (current-buffer))))
     
      (if (and filename (file-readable-p filename))
            
          ;; real filebuffers
          ;; here we could add a smarter mechanism;
          ;; see ecb-examples.el
          (ecb-examples-print-file-attributes visible-buffer
                                              filename)
        
        ;; non file buffers like help-buffers etc...
        (setq ecb-examples-bufferinfo-last-file nil)
        (ecb-examples-print-non-filebuffer visible-buffer
                                           (buffer-name
                                             (current-buffer)))
        ))))
@end group
@end lisp

The function which makes the bufferinfo-buffer dedicated to a window.

@lisp
@group
(defun ecb-examples-set-bufferinfo-buffer ()
  (ecb-with-dedicated-window
      ecb-examples-bufferinfo-buffer-name
      'ecb-examples-set-bufferinfo-buffer
    (switch-to-buffer (get-buffer-create
                       ecb-examples-bufferinfo-buffer-name))
    (setq buffer-read-only t)))
@end group
@end lisp


This is all what we need for the special bufferinfo buffer. We have
demonstrated already three of the important functions/macros of the
layout-engine API of ECB: @code{ecb-with-readonly-buffer},
@code{ecb-do-if-buffer-visible-in-ecb-frame} and
@code{ecb-with-dedicated-window} (@pxref{The layout-engine
API}. Especially the second macro is strongly recommended for
programming good synchronizing functions which do not waste CPU!

@subsubsection The action buffer of the example

The name of the action-buffer:

@lisp
(defconst ecb-examples-action-buffer-name " *ECB action buffer*")
@end lisp

Two helper functions for creating a readonly action-buffer with a
special local key-map for the middle-mouse-button and two buttons
[prior] and [next]:

@lisp
@group
(defun ecb-examples-insert-text-in-action-buffer (text)
  (let ((p (point)))
    (insert text)
    (put-text-property p (+ p (length text)) 'mouse-face
                                             'highlight)))

(defun ecb-examples-action-buffer-create ()
  (save-excursion
    (if (get-buffer ecb-examples-action-buffer-name)
        (get-buffer ecb-examples-action-buffer-name)

      (set-buffer (get-buffer-create
                    ecb-examples-action-buffer-name))

      ;; we setup a local key-map and bind middle-mouse-button
      ;; see ecb-examples.el for the full code        

      ;; insert the action buttons [prior] and [next] and
      ;; make it read-only
      
      (ecb-with-readonly-buffer (current-buffer)
        (erase-buffer)
        (ecb-examples-insert-text-in-action-buffer "[prior]")
        ;; analogous for the [next] button
        )
      
      (current-buffer))))
@end group
@end lisp

The function which performs the actions in the action-buffer if
clicked with the middle-mouse button onto a button [next] or [prior].

@lisp
@group
(defun ecb-examples-action-buffer-clicked (e)
  (interactive "e")
  (mouse-set-point e)
  (let ((line (buffer-substring (ecb-line-beginning-pos)
                                (ecb-line-end-pos))))
    (cond ((string-match "prior" line)
           (ecb-select-edit-window)
           (call-interactively 'scroll-down))
          ((string-match "next" line)
           ;; analogous for [next]
           ))))
@end group
@end lisp

The function which makes the action-buffer dedicated to a window.

@lisp
@group
(defun ecb-examples-set-action-buffer ()
  (let ((buf-name (buffer-name (ecb-examples-action-buffer-create))))
    (ecb-with-dedicated-window buf-name 'ecb-examples-set-action-buffer
      (switch-to-buffer (buffer-name
                         (ecb-examples-action-buffer-create))))))
@end group
@end lisp

We do not need more code for the action buffer. All of the code is
standard emacs-lisp which would also needed if used without ECB.

@subsubsection Adding the bufferinfo- and action-buffer to a new layout

Now we add the bufferinfo- and the action-buffer to a new layout of
type top with name ``example-layout1'':

@lisp
@group
(ecb-layout-define "example-layout1" top
  
  ;; dedicating the bufferinfo window to the bufferinfo-buffer
  (ecb-examples-set-bufferinfo-buffer)

  ;; creating the action-window
  (ecb-split-hor 0.75)
  
  ;; dedicate the action window to the action-buffer
  (ecb-examples-set-action-buffer)

  ;; select the edit-window
  (select-window (next-window)))
@end group
@end lisp

This all what we need to define the new layout. See @ref{Programming a
new layout} for more details of the pure layout-programming task.

@subsubsection Synchronizing the bufferinfo-buffer automatically

The last thing we have to do is to synchronize the bufferinfo-buffer
with current edit-window. We do this by adding
@code{ecb-examples-bufferinfo-sync} to the hook
@code{ecb-current-buffer-sync-hook'} (The file @file{ecb-examples.el}
shows a smarter mechanism for (de)activating the new layout and the
synchronization but this works also very well).

@lisp
(add-hook 'ecb-current-buffer-sync-hook 'ecb-examples-bufferinfo-sync)
@end lisp

@subsubsection Activating and deactivating new layouts

Because a set of new special windows integrated in a new layout is
often just the GUI of a complete tool (like a graphical debugger) we
demonstrate here the complete activation and deactivation of such a
tool or at least of the tool-GUI. We decide that the GUI of our
example ``tool'' needs a compile-window with height 5 lines and the
height of the special windows ``row'' on top should be exactly 6 lines
(normally width and height of the special windows should be a fraction
of the frame, but here we use 6 lines@footnote{You can change the code
in the file @file{ecb-examples.el} to use a frame-fraction of 0.2
instead of 6 hard lines, just try it!}

Here comes the (de)activation code.

The code for saving and restoring the state before activation (the
full code is available in @file{ecb-examples.el}:

@lisp
@group
(defun ecb-examples-preactivation-state(action)
  (cond ((equal action 'save)
         ;; code for saving the state
         )
        ((equal action 'restore)
        ;; code for restoring the state
        )))
@end group
@end lisp

The following function activates the GUI of our example tool:

@lisp
@group
(defun ecb-examples-activate ()
  (interactive)
  
  ;; activating the synchronization of the bufferinfo-window
  (add-hook 'ecb-current-buffer-sync-hook
            'ecb-examples-bufferinfo-sync)
  
  ;; saving the state
  (ecb-examples-preactivation-state 'save)

  ;; switch to our preferred layout
  (setq ecb-windows-height 6)
  (setq ecb-compile-window-height 5)
  (ecb-layout-switch "example-layout1"))
@end group
@end lisp

This function deactivates the GUI of our example-tool and restores the
state as before activation:

@lisp
@group
(defun ecb-examples-deactivate ()
  (interactive)
  
  (remove-hook 'ecb-current-buffer-sync-hook
               'ecb-examples-bufferinfo-sync)
  (ecb-examples-preactivation-state 'restore)
  (ecb-layout-switch ecb-layout-name))
@end group
@end lisp


Now we have all code for the new layout and the new layout-buffers.
The example is ready for use; just load @file{ecb-examples.el} (s.a.).

@node Possible layout-outlines, The layout-engine API, Programming special windows, The layout-engine
@subsection The wide range of possible layout-outlines

In the two previous sections @ref{Programming a new layout} and
@ref{Programming special windows} we have explained in detail how to
program new layouts and how to program new special windows/buffers and
adding them to a new layout.

The intention of this section is to be a summary what are the real
restrictions for a new layout-outline programmed with
@code{ecb-layout-define}. This is necessary because until now we just
programmed ``obvious'' layouts, means layout which are in principle
very similar to the standard ones which means one big edit-window and
some special windows ``around'' this edit-window. This section will
show you that a layout can have also very different outlines.

OK, here are the real restrictions and conditions for a layout
programmed with @code{ecb-layout-define}:
@enumerate
@item
It must have exactly one edit-window regardless of its size. The user
of this layout can later split this edit-window in as many
edit-windows as he like.

@item
All other windows created within the @var{CREATE-CODE} body of
@code{ecb-layout-define} (@pxref{Programming a new layout}) must be
dedicated to their buffers.

@item
All the dedicated windows must (exclusive!) either reside on the left,
right, top or left-and-right side of the edit-window. This will be
defined with the @var{TYPE}-argument of @code{ecb-layout-define}
(@pxref{Programming a new layout}).
@end enumerate

You see, there are only three restrictions/conditions. These and only
these must be fulfilled at layout-programming.

Demonstrating what this really means and how flexible the
layout-engine of ECB really is, can be done best with some
``pathological'' layout-outlines. All the following are correct
layouts (working code is added below each layout):

The following is a top layout with three vertical layered special
windows.

@example
@group
------------------------------------------------------------------
|                                                                |
|                 Upper special window                           |
|                                                                |
|----------------------------------------------------------------|
|                                                                |
|                 Middle special window                          |
|                                                                |
|----------------------------------------------------------------|
|                                                                |
|                 Lower special window                           |
|                                                                |
|================================================================|
|                                                                |
|                         Edit-area                              |
|      (can be splitted by the user in several edit-windows)     |
------------------------------------------------------------------
|                                                                |
|                 Compilation-window (optional)                  |
|                                                                |
------------------------------------------------------------------
@end group
@end example

Here is the code for that top layout (all buffers are dummy-buffers):

@lisp
@group

;; The "dedicated setter" functions:

(defun ecb-set-usw-buffer ()
  (ecb-with-dedicated-window
    "Upper special window"
    'ecb-set-usw-buffer
      (switch-to-buffer (get-buffer-create "Upper special window"))))

(defun ecb-set-msw-buffer ()
  (ecb-with-dedicated-window
    "Middle special window"
    'ecb-set-msw-buffer
      (switch-to-buffer (get-buffer-create "Middle special window"))))

(defun ecb-set-lsw-buffer ()
  (ecb-with-dedicated-window
    "Lower special window"
    'ecb-set-lsw-buffer
      (switch-to-buffer (get-buffer-create "Lower special window"))))

;; The layout itself:

(ecb-layout-define "example-layout3" top
  nil

  ;; here we have an edit-window and above one top window which we can
  ;; now split in several other windows. Dependent on the value of
  ;; `ecb-compile-window-height' we have also a compile-window at the
  ;; bottom.

  (ecb-set-usw-buffer)
  (ecb-split-ver 0.33)
  (ecb-set-msw-buffer)
  (ecb-split-ver 0.5)
  (ecb-set-lsw-buffer)

  ;; select the edit-window.
  (select-window (next-window)))
@end group
@end lisp


The following is a left-right layout which has six special windows in
the left-''column'' and one big special window in the
right-''column''. For left-right layouts the left-''column'' and the
right-''column'' have always the same width.

@example
@group
------------------------------------------------------------------
|             |       |                   |                      |
| Left1       | Left5 |                   |                      |
|             |       |                   |                      |
|-------------|       |                   |                      |
|      |      |       |                   |                      |
|      |      |       |                   |                      |
|      |      |       |                   |                      |
| Left2| Left3|-------|     Edit-area     |   Right1             |
|      |      |       | (can be splitted  |                      |
|      |      |       |  in several edit- |                      |
|      |      |       |      windows)     |                      |
|-------------|       |                   |                      |
|             |       |                   |                      |
| Left4       | Left6 |                   |                      |
|             |       |                   |                      |
------------------------------------------------------------------
|                                                                |
|                 Compilation-window (optional)                  |
|                                                                |
------------------------------------------------------------------
@end group
@end example

Here is the code for that left-right layout, again with dummy-buffers
(depending to your screen-resolution you will need a quite big value
for @code{ecb-windows-width}, e.g. 0.4):

Here is one of the ``dedicated setter'' functions@footnote{The
``dedicated setter functions'' for all these ecb-windows/buffers are
not explicitly described - they look all like
@code{ecb-set-left1-buffer}
- of course with different buffer-names!}:

@lisp
@group
(defun ecb-set-left1-buffer ()
  (ecb-with-dedicated-window
    "Left1"
    'ecb-set-left1-buffer
      (switch-to-buffer (get-buffer-create "Left1"))))
@end group
@end lisp

Here is the layout-definition itself:

@lisp
@group
(ecb-layout-define "example-layout2" left-right
  nil

  ;; here we have an edit-window and left and right two windows each
  ;; with width `ecb-windows-width'. Dependent to the value of
  ;; `ecb-compile-window-height' we have also a compile-window at the
  ;; bottom.

  (ecb-set-left1-buffer)
  (ecb-split-hor 0.66 t)
  (ecb-split-ver 0.75)
  (ecb-set-left4-buffer)
  (select-window (previous-window (selected-window) 0))
  (ecb-split-ver 0.25 nil t)
  (ecb-set-left2-buffer)
  (ecb-split-hor 0.5)
  (ecb-set-left3-buffer)
  (select-window (next-window (next-window)))
  (ecb-set-left5-buffer)
  (ecb-split-ver 0.5)
  (ecb-set-left6-buffer)
  (select-window (next-window (next-window)))
  (ecb-set-right1-buffer))

  ;; select the edit-window
  (select-window (previous-window (selected-window) 0)))
@end group
@end lisp

Especially the last example should demonstrate that even very
complicated layouts are easy to program with @code{ecb-layout-define}.
If such layouts are senseful is another topic ;-)

@node The layout-engine API, , Possible layout-outlines, The layout-engine
@subsection The complete layout-engine API of ECB

This section lists all functions, macros, variables and user-options
the layout-engine API of ECB offers foreign packages. Call
@code{describe-function} rsp. @code{describe-variable} to get a
detailed description.

Functions for programming with layouts and special ecb-windows:
@itemize @minus
@item ecb-available-layouts-member-p
@item ecb-canonical-ecb-windows-list
@item ecb-compile-window-live-p
@item ecb-do-if-buffer-visible-in-ecb-frame
@item ecb-get-current-visible-ecb-buffers
@item ecb-layout-define
@item ecb-layout-switch
@item ecb-layout-undefine
@item ecb-point-in-compile-window
@item ecb-point-in-ecb-window
@item ecb-point-in-edit-window
@item ecb-select-edit-window
@item ecb-split-hor
@item ecb-split-ver
@item ecb-where-is-point
@item ecb-with-dedicated-window
@end itemize

Utility functions/macros:
@itemize @minus
@item ecb-enlarge-window
@item ecb-fix-filename
@item ecb-window-live-p
@item ecb-with-readonly-buffer
@end itemize

Some other maybe useful functions/macros:
@itemize @minus
@item ecb-with-adviced-functions
@item ecb-with-original-functions
@item ecb-with-some-adviced-functions
@end itemize

Some useful @strong{READONLY} variables:
@itemize @minus
@item ecb-compile-window
@item ecb-last-edit-window-with-point
@item ecb-last-source-buffer
@end itemize

@strong{Caution}: DO NOT USE THE VARIABLE @code{ecb-edit-window} IN
YOUR PROGRAMS!

User-options and hooks related to the layout-engine API:
@itemize @minus
@item ecb-current-buffer-sync-hook
@item ecb-hide-ecb-windows-after-hook
@item ecb-hide-ecb-windows-before-hook
@item ecb-redraw-layout-after-hook
@item ecb-redraw-layout-before-hook
@item ecb-show-ecb-windows-after-hook
@item ecb-show-ecb-windows-before-hook
@item ecb-windows-height
@item ecb-windows-width
@item ecb-compile-window-height
@end itemize

@node Conflicts and bugs, FAQ, Elisp programming, Top
@chapter Conflicts and bugs of ECB

This chapter describes what to do when there are conflicts with other
packages and also the known (and currently unfixed) bugs of ECB. If
possible (and in most cases it is possible ;-) then a practicable
solution or workaround is described.

@menu
* Conflicts::                   Conflicts with other packages
* Bugs::                        Known bugs
@end menu

@node Conflicts, Bugs, Conflicts and bugs, Conflicts and bugs
@section Conflicts with other packages

This chapter contains a list of already known conflict between ECB and
other packages and how to solve them - in most cases ECB already
contains a suitable workaround.

But in front of this ``know-conflicts-and-solutions-list'' a general
recipe is given what you can do when you have detected a conflict
between ECB and a package not listed in the know-conflicts-section.

@subsection What to do for unknown conflicts with other packages

As of version 2.20 the layout-engine of ECB is so flexible that
normally there should be no conflicts with other packages unless these
packages have their own complete window-layout-management (e.g. Gnus,
BBDM, Xrefactory). But these packages can and should be handled very
well with the window-manager-support of ECB (@pxref{Window-managers
and ECB}).

So if you detect an unknown (i.e. not listed in the conflicts-list in
the next subsection) conflict with a small package and some of its
commands and you have installed an ECB-version < 2.20 the first task
you have to do is to upgrade to a version >= 2.20!

If this doesn't solve the problem a very probable reason for the
conflict is that the command fails if called from another window than
an edit-window of the ecb-frame. So please check if the problem
disappears if you call the failing command from an edit-window of ECB.
If this is true then you you can add the following code to your
.emacs (and of course replace the XXX with the failing command):

@example
@group
(defadvice XXX (before ecb activate)
  "Ensures `XXX' works well when called from another window
as an edit-window. Does nothing if called in another frame
as the `ecb-frame'."
  (when (equal (selected-frame) ecb-frame)
    (unless (ecb-point-in-edit-window)
      (ecb-select-edit-window))))
@end group
@end example

This before-advice runs before the command XXX and ensures that the
XXX is called from within an edit-window if the current selected
window is not an edit-window. It does nothing if called for another
frame as the ecb-frame.

If such an advice solves the problem then please send a not with the
solution to the ECB-mailing-list or direct to the ECB-maintainer so
the solution can be integrated in the next ECB-release

If calling from an edit-window fails too then please file a complete
bug-report to the ECB-mailing-list (@pxref{Submitting problem
report}). This report should contain a detailed description which
command of which package fails under which circumstances!

@subsection Known conflicts and proper solutions/work-arounds

Here is a list of known conflicts of ECB with other packages and
helpful solutions/hints/workarounds:

@subsubsection Package avoid.el

@cindex avoid package
With GNU Emacs 20.X ECB must deactivate @code{mouse-avoidance-mode} if the
option @code{ecb-show-node-info-in-minibuffer} activates for at least one
ECB tree-buffer 'if-too-long or 'always. This is done automatically
but only as long ECB is activated.

@subsubsection Package bs.el

@cindex bs package
@cindex bs-show
The package bs.el offers a nifty buffer-selection buffer. The main
command of this package is @code{bs-show}. With ECB < 2.20 this
command does not really working well within activated ECB. But as of
version 2.20 of ECB there should be no problems using this package.

If you add ``*buffer-selection*'' as buffer-name to the option
@code{ecb-compilation-buffer-names} then ECB will always display the
buffer-selection buffer of bs in the compile-window (if there is one).
Otherwise bs will use the edit-area to do its job.

@subsubsection Package BBDB

@cindex BBDB
With ECB-version < 1.96 it is not recommended to use BBDB and ECB
simultaneously in one frame because each of them has its own
window-management and probably there will be conflicts. Use different
frames for ECB and BBDB!

But beginning with ECB 1.96 you can use one of the window-managers
escreen.el or winring.el (@pxref{Window-managers and ECB}). With such
a window-manager ECB and BBDB should work very well together - even in
the same frame!

@subsubsection Package calculator.el

@cindex calculator package
The following is only for ECB-versions < 2.20. From beginning with
version 2.20 there are no conflicts with the package calculator.el!

If the edit-window is already splitted then calling @code{calculator} uses
the whole ``other'' edit-window for the calculator. With an unsplitted
edit-window the calculator window has it�s normal size of about 2
lines. Therefore it�s recommended to set @code{calculator-electric-mode}
during ECB activation to not nil so calculator uses always the
echo-area instead of creating a new small window!

@subsubsection Package calendar.el

@cindex calendar package
With activated ECB @code{calendar} does not shrink it�s window to the small
size but splits the window equally. But if you add this to your
@file{.emacs} it works:

@example
@group
(add-hook 'initial-calendar-window-hook
          (function (lambda ()
                      (when (and ecb-minor-mode
                                 (ecb-point-in-edit-window))
                        ;; if no horizontal split then nothing
                        ;; special to do
                        (or (= (frame-width) (window-width))
                            (shrink-window (- (window-height) 9))))
                     )))
@end group
@end example

@subsubsection Package cygwin-mount.el

@cindex cygwin-mount package
There can be a conflict between ECB and cygwin-mount.el if the
following conditions are true:

@itemize @minus
@item You are working with cygwin-mount.el (sounds clear :-)
@item You have set @code{cygwin-mount-build-mount-table-asynch} to not
nil
@item ECB is automatically started after starting Emacs (e.g. with
@code{ecb-auto-activate} or calling @code{ecb-activate} in
@code{window-setup-hook})
@item Your Emacs-setup contains a call of @code{cygwin-mount-activate}.
@end itemize

Under these circumstances Emacs 21.X sometimes eats up the whole CPU (at
least with Windows XP) and the cygwin-mount-table is never build.

But there is an easy work-around: Call @code{cygwin-mount-activate}
first *AFTER* ECB is activated. This can be done with the hook
@code{ecb-activate-hook}:

@example
@group
(add-hook 'ecb-activate-hook
          (function (lambda ()
                      (require 'cygwin-mount)
                      (setq cygwin-mount-build-mount-table-asynch t)
                      (cygwin-mount-activate))))

@end group
@end example


@subsubsection Package ediff.el

@cindex ediff
In most cases ECB works very well with ediff (see option
@code{ecb-run-ediff-in-ecb-frame}). But currently suspending ediff
with @code{ediff-suspend} and restoring the ediff-session (e.g. with
command @code{eregistry}) does confuse the window-management of ECB.

If you often use ediff in a scenario where you suspend ediff and
reactivate it later then it is recommended to exit ECB first
(@code{ecb-deactivate} or @code{ecb-minor-mode})!

@subsubsection Package escreen.el

Beginning with version 1.96 ECB supports the window-manager
escreen.el. See @ref{Window-managers and ECB}.

@subsubsection Package follow-mouse.el

@noindent
The following is only relevant for Emacs 20.X!

@cindex follow-mouse package
ECB works very well with follow-mouse if follow-mouse is turned on
@strong{BEFORE} ECB is activated (e.g. within the
@code{ecb-activate-hook}). But if you activate follow-mouse first
after ECB is already activated, then the follow-mouse stuff prevents
the complete node-name to be displayed in the echo-area if mouse moves
over it. Because ECB has a much more intelligent mouse tracking
mechanism than follow-mouse the follow-mouse stuff profit from ECB and
works even better and saver as without activated ECB!

@subsubsection Package Gnus (Newsreader)

@cindex Gnus
With ECB-version < 1.96 it is not recommended to use Gnus and ECB
simultaneously in one frame because each of them has its own
window-management and probably there will be conflicts. Use different
frames for ECB and Gnus!

But beginning with ECB 1.96 you can use one of the window-managers
escreen.el or winring.el (@pxref{Window-managers and ECB}). With such
a window-manager ECB and Gnus should work very well together - even in
the same frame!

@subsubsection Package JDEE (Java Development Environment)

@cindex JDEE
JDEE has a lot of ``dialogs'' where the user can select among several
choices. An example is importing classes via the command
@code{jde-import-find-and-import}. These dialogs are strongly designed
to work in an environment where a new temporary window is created, the
contents of the dialog are displayed in the new window, the user
select his choice and hits [OK]. After that the new window is deleted
and the selection is performed (for example the chosen import
statement are inserted in the source-buffer.

@strong{Caution}: ECB can work very well with this dialogs but only if
the buffer-name of these dialog-buffers (normally ``Dialog'') is not
contained in the option @code{ecb-compilation-buffer-names}. So do not
add the string ``Dialog'' to this option!

@strong{Please Note}: Regardless if a durable compile-window is used
(i.e. @code{ecb-compile-window-height} is not nil) or not, these
JDEE-dialogs will always being displayed by splitting the edit-window
of ECB and not within the compile-window.

@subsubsection Package scroll-all.el (scroll-all-mode)

@cindex scroll-all-mode
@cindex scroll-all
ECB advices @code{scroll-all-mode} so it is working correct during
running ECB. This means if point stays in an edit-window and the
edit-window is splitted then all edit-windows are scrolled by
@code{scroll-all-mode} and no other window! If point stays in any
other window just this selected window is scrolled. This is the only
senseful behavior of @code{scroll-all-mode} with ECB.

@subsubsection Package tmm.el (Text mode menu)

@cindex tmm-menubar
@cindex tmm
In general this library does not work perfectly with ECB. Beginning
with version 1.95.2 ECB autom. ensures that every code which uses
@code{tmm-prompt} (e.g. @code{tmm-menubar}) works.

@subsubsection Package VC (Version Control)

@cindex VC package
@cindex Version control
The variable @code{vc-delete-logbuf-window} must be set to nil during
active ECB. This can be done with the hooks mentioned in @ref{Elisp
programming}.

@subsubsection Package winner.el (winner-mode)

@cindex winner-mode
@cindex winner
@code{winner-mode} is autom. disabled as long as ECB is running. ECB
has its own window-management which is completely incompatible with
@code{winner-mode}! But @code{winner-mode} makes also not really sense
with ECB.

@subsubsection Package winring.el

Beginning with version 1.96 ECB supports the window-manager
winring.el. See @ref{Window-managers and ECB}.

@subsubsection Application xrefactory

@cindex xrefactory
Xrefactory (also known as Xref, X-ref and Xref-Speller), the
refactoring browser for (X)Emacs@footnote{Xrefactory is available at
@ifhtml
@uref{http://www.xref-tech.com}
@end ifhtml
@ifnothtml
@url{http://www.xref-tech.com}
@end ifnothtml
}, can be used during running ECB so long as
not the Xrefactory-browser is used (e.g. via
@code{xref-show-browser}). using the Xrefactory-broswer confuses the
ECB-layout-engine as well as the Xrefactory window-layouter because
the latter one does some wild window splitting and resizing of its
own. The symbol completion window plays nice with ECB, but the source
code browsers 3 window layout won't work with ECB enabled. It is so
deeply confused by ECB that it drops a window. Normally hiding the ECB
windows before starting the Xref-brwoser should help because with
hidden ECB-windows there are no restrictions on the part of ECB
concering window-layout. But to get sure ECB can also be deactivated
;-)

This can be achieved with the following advice which should be put in
the @file{.emacs}:

@example
@group
(defadvice xref-create-browser-windows 
     (before hide-or-deactivate-ecb-for-xref first nil compile)
   "deactivate ecb when invoking the xrefactory browser"
   (when ecb-minor-mode
     (ecb-toggle-ecb-windows -1)
     ;; or if you want completely deactivating ECB uncomment this
     ;; (ecb-deactivate)
     )
@end group
@end example

But the most recommended way is to use a window-manager as
escreen.el or winring.el (and then use different escreens or
window-configurations for ECB and Xrefactory-browsing -
@ref{Window-managers and ECB}).

@node Bugs, , Conflicts, Conflicts and bugs
@section Known bugs

This section describes all currently known bugs of ECB. The
maintainers of ECB try to fix these bugs as soon as possible.

@subsection Following the source-file link in a help-buffer

The following bug occurs only in ECB-versions < 1.96 and is fixed
since ECB 1.96!!

This bug only occurs if a compile-window is used and visible!

If you call functions like @code{describe-function} which displays a
help-buffer in the compile-window, then you will often get an output
like this in the compile-window:

@example
ecb-activate is an interactive compiled Lisp function in `ecb'.
(ecb-activate)

Activates the ECB...
@end example

The link to `ecb' is normally a click-able link, means if you click
with the middle-mouse button onto it the file is opened (in our
example @file{ecb.el} would be opened.

If you click onto it when the help-buffer is already the current
buffer (i.e. the compile-window is already selected before the click!)
then all is working fine (i.e. the file is opened in the edit-window),
but if you click onto the link without selecting the compile-window
before (i.e. the edit-window is the current selected window) then the
file is opened in the compile-window which is probably not what you
want. Not a big problem but annoying.

The only available workaround is, first selecting the compile-window
and then clicking onto the link!

@subsection Extra history-entries for JDEE source-buffers

ECB on occasions creates an extra edit buffer for entries in the
history window. For example, let say there are three entries in the
history window:

@example
@group
Test1
Test2
Test3
@end group
@end example

In the edit window Test1 file is edited. When clicked on Test2 entry
in history, on occasion instead of switching to the existing buffer for
Test2, a new edit buffer is opened for Test2 file. At this point, there
are four entries in the history as follows:

@example
@group
Test2
Test2<2>
Test1
Test3
@end group
@end example

@node FAQ, Command Index, Conflicts and bugs, Top
@chapter Frequently asked questions

This is the Emacs Code Browser FAQ.

@c To produce prettier output we make a small empty column between the
@c question- and the answer-column. Therefore every Q/A-item must look
@c like:
@c
@c    @c an empty line between every Q/A-item
@c    @item @tab @tab
@c
@c    @c The Q/A-item
@c    @item
@c    <The text of the question?>
@c    @tab @tab
@c    <The text of the answer>

@multitable @columnfractions 0.40 0.01 0.59

@item
@ifnotinfo
@strong{Question}
@end ifnotinfo
@ifinfo
QUESTION
@end ifinfo
@tab @tab
@ifnotinfo
@strong{Answer}
@end ifnotinfo
@ifinfo
ANSWER
@end ifinfo

@c an empty line between every Q/A-item
@item @tab @tab

@c The Q/A-item
@item
What is the first step i should do if i have problems with ECB?
@tab @tab
Read carefully the related sections of the online-help of ECB.

@item @tab @tab

@item
What should i do, if a have a problem which can not be solved even
after reading the online-help?
@tab @tab
Send a problem-report to the ECB-mailing-list with the command
@code{ecb-submit-problem-report}.
@ifinfo
@*
@end ifinfo
See @ref{Submitting problem report}.

@item @tab @tab

@item
What should i do, if another package seems not to work correct with
ECB?
@tab @tab
Take a look into @ref{Conflicts}. If your package is not listed there
then submit a problem-report.

@item @tab @tab

@item
Can ECB parse and display source-contents not supported by semantic?
@tab @tab
Yes, in all version >= 1.94. ECB can now parse and display all
source-contents supported by semantic, imenu or etags - same as
speedbar. See @ref{Non-semantic sources}.

@item @tab @tab

@item
Why are the lines in the ECB-, temp- and compilation-buffers not
wrapped but truncated?
@tab @tab
Check the variable @code{truncate-partial-width-windows} and set it to
nil.

@item @tab @tab

@item
Why doesn't ECB work correct with VC?
@tab @tab
The variable @code{vc-delete-logbuf-window} must be set to nil during
active ECB. This can be done with the hooks of ECB.

@item @tab @tab

@item
Does ECB support C++ as well as Java?
@tab @tab
This depends strongly on the used semantic-version, but all
semantic-versions >= semantic-1.4.3 support C++ really well.

@item @tab @tab

@item
Does ECB support Perl?
@tab @tab
If perl can be parsed either by imenu, etags or semantic then ECB
supports perl. Of course ECB would support perl best if perl is
supported by semantic.

@item @tab @tab

@item
Does ECB support language XYZ?
@tab @tab
See question ``Does ECB support Perl?'' and replace ``Perl'' with
``XYZ'' in the answer.

@item @tab @tab

@item
How to add new languages to ECB?
@tab @tab
Add the language XYZ to semantic (perform all necessary steps described in
the semantic-manual) and ECB will automatically support language XYZ!
There is nothing to do in ECB itself! Same when you write an imenu- or
etags-support for language XYZ.

@item @tab @tab

@item
Why does ECB not recognize my source-files for C++?
@tab @tab
Your C++-files have probably an extension which is not mapped to
c++-mode in @code{auto-mode-alist} and/or your own Emacs-setup has
``destroyed'' the correct value of the hook-variable
@code{c++-mode-hook}.
@ifinfo
@*
@end ifinfo
See @ref{Setting up Emacs}.

@item @tab @tab

@item
Why doesn't ECB display the node name in the echo area if mouse moves
over it?
@tab @tab
There can be several reasons: First the value of the option
@code{ecb-show-node-name-in-minibuffer} must be either @code{always} or
@code{if-too-long}. If this is OK, then maybe you have turned on
follow-mouse AFTER activating ECB; follow-mouse must be turned on
BEFORE ECB is activated, e.g. in the @code{ecb-activate-hook}! But with
Emacs 21.X and XEmacs there are no problems with this feature, just
activate it.

@item @tab @tab

@item
What is the reason for poor scrolling performance with GNU Emacs 20.X
in the edit-windows and what can i do?
@tab @tab
Set @code{scroll-conservatively} to 0 and @code{scroll-step} to a
value > 1. For the exact reason look at
@ifinfo
@*
@end ifinfo
@ref{Optimize scrolling}.

@item @tab @tab

@item
Is it possible to make the history of ECB persistent?
@tab @tab
You can use the library ``desktop.el'' which works very well with ECB.
Then all files of your recent Emacs-session will be opened
automatically after next Emacs-start and will be added automatically
to the ECB-history after ECB-start.

@item @tab @tab

@item
Is there an ``Intellisense''-mechanism like with other IDEs?
@tab @tab
For Java the JDEE@footnote{
@ifhtml
@uref{http://jdee.sunsite.dk/}
@end ifhtml
@ifnothtml
@url{http://jdee.sunsite.dk/}
@end ifnothtml
} has this feature and for all other languages
semantic offer something similar, see
@ifhtml
@uref{http://cedet.sourceforge.net/intellisense.shtml}
@end ifhtml
@ifnothtml
@url{http://cedet.sourceforge.net/intellisense.shtml}
@end ifnothtml

@item @tab @tab

@item
Can i use ECB in combination with Gnus within one frame?
@tab @tab
You can, but for ECB-versions < 1.96 it is not recommended because
each of them has it's own window-management and probably there will be
conflicts, so use different frames for ECB and Gnus! But beginning
with ECB 1.96 you can use either escreen.el or winring.el as
``window-manager'' which allows you in consequence to use ECB and
applications like Gnus in one frame!
@ifinfo
@*
@end ifinfo
@xref{Window-managers and ECB}.

@item @tab @tab

@item
Can i speed up displaying the contents of big-size directories?
@tab @tab
Yes, see the option @code{ecb-cache-directory-contents}. Read the
section
@ifinfo
@*
@end ifinfo
@ref{Large directories}.

@item @tab @tab

@item
Is it possible to create/use other layouts than the built-in ones?
@tab @tab
Yes. @ref{Creating a new ECB-layout} and
@ifinfo
@*
@end ifinfo
@ref{The layout-engine} are the relevant sections. The former one
describes how to create interactively new layouts where the latter
one is for Elisp-programmers.

@item @tab @tab

@item
Can i use speedbar as directory-browser within ECB?
@tab @tab
Yes, see @ref{Integrating speedbar}.

@item @tab @tab

@item
Can i exclude subdirectories from the recursive grep in the directories buffer?
@tab @tab
Yes, see @ref{Grepping directories}.

@item @tab @tab

@item
How can i prevent contaminating each directory with a file @file{semantic-cache}?
@tab @tab
Set @code{semanticdb-default-save-directory} to a directory.

@item @tab @tab

@item
Why ECB displays large portions of current source-file with dark background?
@tab @tab
This comes from semantic;
@ifinfo
@*
@end ifinfo
see @ref{Setting up Emacs}.

@item @tab @tab

@item
Why ECB underlines some parts of current source-file?
@tab @tab
This comes from semantic;
@ifinfo
@*
@end ifinfo
see @ref{Setting up Emacs}.

@item @tab @tab

@item
Can i add my own commands to the popup-menus of tree-buffers?
@tab @tab
Yes, see @ref{Using the mouse}.

@item @tab @tab

@item
Can ECB display the compile-window ``on demand''?
@tab @tab
Yes, see @ref{Tips and tricks}.

@item @tab @tab

@item
Which buffers are treated as compilation-buffers by ECB?
@tab @tab
See the docstring of the function @code{ecb-compilation-buffer-p}.

@item @tab @tab

@item
How can i change the modeline of an ECB-tree-buffer?
@tab @tab
You can change it with the options @code{ecb-mode-line-prefixes},
@code{ecb-mode-line-data} and
@code{ecb-mode-line-display-window-number}.

@item @tab @tab

@item
Can the tree-buffers being selected faster than with the
standard-keybindings of ECB? 
@tab @tab
Yes, see option @code{ecb-mode-line-display-window-number}.

@item @tab @tab

@item
Can ECB display the window-number in the modeline of the special windows?
@tab @tab
Yes, see option @code{ecb-mode-line-display-window-number}.

@item @tab @tab

@item
How can i change the keybindings of ECB?
@tab @tab
You can do this with option @code{ecb-key-map} (@pxref{ecb-general}).

@item @tab @tab

@item
What can i do if hiding/showing from the methods-buffer does not work?
@tab @tab
Either the current @code{major-modes} is not supported by hideshow or
you have to add an entry to @code{hs-special-modes-alist}
@ifinfo
@*
@end ifinfo
(@pxref{Hide-show}).

@item @tab @tab

@item
Can i maximize one of the ECB-windows for better overlook?
@tab @tab
Yes, see @ref{Maximizing the ECB windows}.

@item @tab @tab

@item
Can i hide the ECB-windows for getting more editing-space?
@tab @tab
Yes, see @ref{Hiding the ECB windows}.

@item @tab @tab

@item
Can i define the actions ECB performs after visiting a tag?
@tab @tab
Yes, see @ref{Visiting tags}.

@item @tab @tab

@item
Buffers are not displayed correctly in the compile-window?
@tab @tab
See @ref{Problems with the compile window}.

@item @tab @tab

@item
Can ECB work together with window-managers like escreen.el?
@tab @tab
Yes, see @ref{Window-managers and ECB}.

@item @tab @tab

@item
Can i remove these ``ugly'' vertical lines from a tree-buffer?
@tab @tab
Yes, see option @code{ecb-tree-buffer-style}.

@item @tab @tab

@item
ECB does not display images in the tree-buffers - what can i do?
@tab @tab
Customize @code{ecb-tree-buffer-style} and restart ECB. But note: GNU
Emacs <= 21.3.X for Windows does not support image-display so ECB uses
always ascii-guide-lines even when here the image-style is set in
@code{ecb-tree-buffer-style}.

@item @tab @tab

@item
Do @code{special-display-function} et. al. work with ECB.
@tab @tab
Yes, see
@ifinfo
@*
@end ifinfo
@ref{Using special-display with ECB}.

@item @tab @tab

@item
Can i activate the popup-menu of a tree-buffer from keyboard?
@tab @tab
Yes, see @ref{Using popup-menus}.

@item @tab @tab

@item
Can i display the popup-menu of a tree-buffer with tmm?
@tab @tab
Yes, see @ref{Using popup-menus}.

@item @tab @tab

@item
Does ECB disable all advices after deactivation?
@tab @tab
``Nes''@footnote{Nes is a combination of No and Yes :-)}, see remarks
in the documentation of the option
@code{ecb-split-edit-window-after-start}.

@item @tab @tab

@item
Can ECB preserve the full state of ECB between deactivation and next
activation?
@tab @tab
Yes, see the option @code{ecb-split-edit-window-after-start}.

@item @tab @tab

@item
Can i change the behavior how ECB chooses another window for selecting
it or scrolling it.
@tab @tab
Yes, see @ref{The other window}.

@end multitable


@node Command Index, Option Index, FAQ, Top
@unnumbered Command Index

@noindent
This index contains all user commands of ECB.

@strong{Please note}: The commands in this index are listed without
the prefix ``ecb-'' (e.g. the command @code{ecb-activate} is listed
with name ``activate'').

@printindex fn

@node Option Index, Concept Index, Command Index, Top
@unnumbered Option Index

@noindent
This index contains all customizable options of ECB.

@strong{Please note}: All options in this index are listed without the
prefix ``ecb-'' (e.g. the option @code{ecb-layout-name} is listed with
name ``layout-name'').

@printindex vr

@node Concept Index, , Option Index, Top
@unnumbered Concept Index

@printindex cp

@contents


@bye

@c  LocalWords:  texinfo Berndl java ECB ecb texi berndl Exp setfilename vr cp
@c  LocalWords:  settitle syncodeindex fn ifinfo paragraphindent exampleindent
@c  LocalWords:  footnotestyle frobbed ecbver dircategory direntry titlepage sp
@c  LocalWords:  titlefont vskip pt Jesper Nordenberg dir ifnottex Elisp imenu
@c  LocalWords:  etags perl iftex ref tex url ifhtml uref detailmenu eshell API
@c  LocalWords:  keybindings speedbar Grepping JDEE website eieio xref subdirs
@c  LocalWords:  loadtime autoloads Bytecompiling bytecompile EMACSINFOPATH hxx
@c  LocalWords:  pxref alist multitable columnfractions ifnotinfo hh HH cxx cpp
@c  LocalWords:  CC jde setq RET kbd Alt minibuffer cindex dfn grep ascii popup
@c  LocalWords:  screenshot splitted sourcecode noindent de itemx rsp CTRL hor
@c  LocalWords:  senseful modeline subnode uml const gm Ctrl docstring autom lc
@c  LocalWords:  subsubsection fontify defun asis Hist leftright lr nav dired
@c  LocalWords:  deffn var CLEARALL cedet sourcepath classpath arg html regexp
@c  LocalWords:  backtrace def incl defopt cdr keysequence SPC DEL LFD ESC NUL
@c  LocalWords:  alt abc horiz filenumber rexexp bigdir iff cvsignore lib ini
@c  LocalWords:  elc obj dll rexexps assoc taglist bovinate toplevel oo CLOS
@c  LocalWords:  defclass colorized XYZ XYC structs colorizing struct enum adv
@c  LocalWords:  func comint proc min subdir wget gzip cygwin ifnothtml env iso
@c  LocalWords:  http defcustom upgradable defconst lw doc ls grepping tempor
@c  LocalWords:  igrep CVS gen maxout FF hs hideshow JDEbug defmac ver undefine
@c  LocalWords:  Bufferinfo rw bufferinfo readonly filebuffer filebuffers pos
@c  LocalWords:  cond buf preactivation usw msw lsw asynch XP Newsreader BBDB
@c  LocalWords:  VC vc logbuf BNF Intellisense IDEs semanticdb printindex