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
| | ;;; gdb-mi.el --- User Interface for running GDB -*- lexical-binding: t -*-
;; Copyright (C) 2007-2019 Free Software Foundation, Inc.
;; Author: Nick Roberts <nickrob@gnu.org>
;; Maintainer: emacs-devel@gnu.org
;; Keywords: unix, tools
;; This file is part of GNU Emacs.
;; Homepage: http://www.emacswiki.org/emacs/GDB-MI
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Credits:
;; This file was written by Nick Roberts following the general design
;; used in gdb-ui.el for Emacs 22.1 - 23.1. It was further developed
;; by Dmitry Dzhus <dima@sphinx.net.ru> as part of the Google Summer
;; of Code 2009 Project "Emacs GDB/MI migration".
;;; Commentary:
;; This mode acts as a graphical user interface to GDB. You can interact with
;; GDB through the GUD buffer in the usual way, but there are also further
;; buffers which control the execution and describe the state of your program.
;; It separates the input/output of your program from that of GDB and displays
;; expressions and their current values in their own buffers. It also uses
;; features of Emacs 21 such as the fringe/display margin for breakpoints, and
;; the toolbar (see the GDB Graphical Interface section in the Emacs info
;; manual).
;; M-x gdb will start the debugger.
;; This file uses GDB/MI as the primary interface to GDB. It runs gdb with
;; GDB/MI (-interp=mi) and access CLI using "-interpreter-exec console
;; cli-command". This code replaces gdb-ui.el and uses MI tokens instead
;; of queues. Eventually MI should be asynchronous.
;; Windows Platforms:
;; If you are using Emacs and GDB on Windows you will need to flush the buffer
;; explicitly in your program if you want timely display of I/O in Emacs.
;; Alternatively you can make the output stream unbuffered, for example, by
;; using a macro:
;; #ifdef UNBUFFERED
;; setvbuf (stdout, (char *) NULL, _IONBF, 0);
;; #endif
;; and compiling with -DUNBUFFERED while debugging.
;; If you are using Cygwin GDB and find that the source is not being displayed
;; in Emacs when you step through it, possible solutions are to:
;; 1) Use Cygwin X Windows and Cygwin Emacs.
;; (Since 22.1 Emacs builds under Cygwin.)
;; 2) Use MinGW GDB instead.
;; 3) Use cygwin-mount.el
;;; macOS:
;; GDB in Emacs on macOS works best with FSF GDB as Apple have made
;; some changes to the version that they include as part of macOS.
;; This requires GDB version 7.0 or later as earlier versions do not
;; compile on macOS.
;;; Known Bugs:
;; 1) Stack buffer doesn't parse MI output if you stop in a routine without
;; line information, e.g., a routine in libc (just a TODO item).
;; TODO:
;; 2) Watch windows to work with threads.
;; 3) Use treebuffer.el instead of the speedbar for watch-expressions?
;; 4) Mark breakpoint locations on scroll-bar of source buffer?
;;; Code:
(require 'gud)
(require 'json)
(require 'bindat)
(require 'cl-lib)
(declare-function speedbar-change-initial-expansion-list
"speedbar" (new-default))
(declare-function speedbar-timer-fn "speedbar" ())
(declare-function speedbar-line-text "speedbar" (&optional p))
(declare-function speedbar-change-expand-button-char "speedbar" (char))
(declare-function speedbar-delete-subblock "speedbar" (indent))
(declare-function speedbar-center-buffer-smartly "speedbar" ())
(defvar tool-bar-map)
(defvar speedbar-initial-expansion-list-name)
(defvar speedbar-frame)
(defvar gdb-memory-address "main")
(defvar gdb-memory-last-address nil
"Last successfully accessed memory address.")
(defvar gdb-memory-next-page nil
"Address of next memory page for program memory buffer.")
(defvar gdb-memory-prev-page nil
"Address of previous memory page for program memory buffer.")
(defvar gdb-thread-number nil
"Main current thread.
Invalidation triggers use this variable to query GDB for
information on the specified thread by wrapping GDB/MI commands
in `gdb-current-context-command'.
This variable may be updated implicitly by GDB via `gdb-stopped'
or explicitly by `gdb-select-thread'.
Only `gdb-setq-thread-number' should be used to change this
value.")
(defvar gdb-frame-number nil
"Selected frame level for main current thread.
Updated according to the following rules:
When a thread is selected or current thread stops, set to \"0\".
When current thread goes running (and possibly exits eventually),
set to nil.
May be manually changed by user with `gdb-select-frame'.")
(defvar gdb-frame-address nil "Identity of frame for watch expression.")
;; Used to show overlay arrow in source buffer. All set in
;; gdb-get-main-selected-frame. Disassembly buffer should not use
;; these but rely on buffer-local thread information instead.
(defvar gdb-selected-frame nil
"Name of selected function for main current thread.")
(defvar gdb-selected-file nil
"Name of selected file for main current thread.")
(defvar gdb-selected-line nil
"Number of selected line for main current thread.")
(defvar gdb-threads-list nil
"Associative list of threads provided by \"-thread-info\" MI command.
Keys are thread numbers (in strings) and values are structures as
returned from -thread-info by `gdb-json-partial-output'. Updated in
`gdb-thread-list-handler-custom'.")
(defvar gdb-running-threads-count nil
"Number of currently running threads.
If nil, no information is available.
Updated in `gdb-thread-list-handler-custom'.")
(defvar gdb-stopped-threads-count nil
"Number of currently stopped threads.
See also `gdb-running-threads-count'.")
(defvar gdb-breakpoints-list nil
"Associative list of breakpoints provided by \"-break-list\" MI command.
Keys are breakpoint numbers (in string) and values are structures
as returned from \"-break-list\" by `gdb-json-partial-output'
\(\"body\" field is used). Updated in
`gdb-breakpoints-list-handler-custom'.")
(defvar gdb-current-language nil)
(defvar gdb-var-list nil
"List of variables in watch window.
Each element has the form
(VARNUM EXPRESSION NUMCHILD TYPE VALUE STATUS HAS_MORE FP)
where STATUS is nil (`unchanged'), `changed' or `out-of-scope', FP the frame
address for root variables.")
(defvar gdb-main-file nil "Source file from which program execution begins.")
;; Overlay arrow markers
(defvar gdb-stack-position nil)
(defvar gdb-thread-position nil)
(defvar gdb-disassembly-position nil)
(defvar gdb-location-alist nil
"Alist of breakpoint numbers and full filenames.
Only used for files that Emacs can't find.")
(defvar gdb-active-process nil
"GUD tooltips display variable values when t, and macro definitions otherwise.")
(defvar gdb-error "Non-nil when GDB is reporting an error.")
(defvar gdb-macro-info nil
"Non-nil if GDB knows that the inferior includes preprocessor macro info.")
(defvar gdb-register-names nil "List of register names.")
(defvar gdb-changed-registers nil
"List of changed register numbers (strings).")
(defvar gdb-buffer-fringe-width nil)
(defvar gdb-last-command nil)
(defvar gdb-prompt-name nil)
(defvar gdb-token-number 0)
(defvar gdb-handler-list '()
"List of gdb-handler keeping track of all pending GDB commands.")
(defvar gdb-source-file-list nil
"List of source files for the current executable.")
(defvar gdb-first-done-or-error t)
(defvar gdb-source-window nil)
(defvar gdb-inferior-status nil)
(defvar gdb-continuation nil)
(defvar gdb-supports-non-stop nil)
(defvar gdb-filter-output nil
"Message to be shown in GUD console.
This variable is updated in `gdb-done-or-error' and returned by
`gud-gdbmi-marker-filter'.")
(defvar gdb-non-stop nil
"Indicates whether current GDB session is using non-stop mode.
It is initialized to `gdb-non-stop-setting' at the beginning of
every GDB session.")
(defvar-local gdb-buffer-type nil
"One of the symbols bound in `gdb-buffer-rules'.")
(defvar gdb-output-sink 'nil
"The disposition of the output of the current gdb command.
Possible values are these symbols:
`user' -- gdb output should be copied to the GUD buffer
for the user to see.
`emacs' -- output should be collected in the partial-output-buffer
for subsequent processing by a command. This is the
disposition of output generated by commands that
gdb mode sends to gdb on its own behalf.")
(defcustom gdb-discard-unordered-replies t
"Non-nil means discard any out-of-order GDB replies.
This protects against lost GDB replies, assuming that GDB always
replies in the same order as Emacs sends commands. When receiving a
reply with a given token-number, assume any pending messages with a
lower token-number are out-of-order."
:type 'boolean
:group 'gud
:version "24.4")
(cl-defstruct gdb-handler
"Data required to handle the reply of a command sent to GDB."
;; Prefix of the command sent to GDB. The GDB reply for this command
;; will be prefixed with this same TOKEN-NUMBER
(token-number nil :read-only t)
;; Callback to invoke when the reply is received from GDB
(function nil :read-only t)
;; PENDING-TRIGGER is used to prevent congestion: Emacs won't send
;; two requests with the same PENDING-TRIGGER until a reply is received
;; for the first one."
(pending-trigger nil))
(defun gdb-add-handler (token-number handler-function &optional pending-trigger)
"Insert a new GDB command handler in `gdb-handler-list'.
Handlers are used to keep track of the commands sent to GDB
and to handle the replies received.
Upon reception of a reply prefixed with TOKEN-NUMBER,
invoke the callback HANDLER-FUNCTION.
If PENDING-TRIGGER is specified, no new GDB commands will be
sent with this same PENDING-TRIGGER until a reply is received
for this handler."
(push (make-gdb-handler :token-number token-number
:function handler-function
:pending-trigger pending-trigger)
gdb-handler-list))
(defun gdb-delete-handler (token-number)
"Remove the handler TOKEN-NUMBER from `gdb-handler-list'.
Additionally, if `gdb-discard-unordered-replies' is non-nil,
discard all handlers having a token number less than TOKEN-NUMBER."
(if gdb-discard-unordered-replies
(setq gdb-handler-list
(cl-delete-if
(lambda (handler)
"Discard any HANDLER with a token number `<=' than TOKEN-NUMBER."
(when (< (gdb-handler-token-number handler) token-number)
(message "WARNING! Discarding GDB handler with token #%d\n"
(gdb-handler-token-number handler)))
(<= (gdb-handler-token-number handler) token-number))
gdb-handler-list))
(setq gdb-handler-list
(cl-delete-if
(lambda (handler)
"Discard any HANDLER with a token number `eq' to TOKEN-NUMBER."
(eq (gdb-handler-token-number handler) token-number))
gdb-handler-list))))
(defun gdb-get-handler-function (token-number)
"Return the function callback registered with the handler TOKEN-NUMBER."
(gdb-handler-function
(cl-find-if (lambda (handler) (eq (gdb-handler-token-number handler)
token-number))
gdb-handler-list)))
(defun gdb-pending-handler-p (pending-trigger)
"Return non-nil if a command handler is pending with trigger PENDING-TRIGGER."
(cl-find-if (lambda (handler) (eq (gdb-handler-pending-trigger handler)
pending-trigger))
gdb-handler-list))
(defun gdb-handle-reply (token-number)
"Handle the GDB reply TOKEN-NUMBER.
This invokes the handler registered with this token number
in `gdb-handler-list' and clears all pending handlers invalidated
by the reception of this reply."
(let ((handler-function (gdb-get-handler-function token-number)))
(when handler-function
(funcall handler-function)
(gdb-delete-handler token-number))))
(defun gdb-remove-all-pending-triggers ()
"Remove all pending triggers from gdb-handler-list.
The handlers are left in gdb-handler-list so that replies received
from GDB could still be handled. However, removing the pending triggers
allows Emacs to send new commands even if replies of previous commands
were not yet received."
(dolist (handler gdb-handler-list)
(setf (gdb-handler-pending-trigger handler) nil)))
(defmacro gdb-wait-for-pending (&rest body)
"Wait for all pending GDB commands to finish and evaluate BODY.
This function checks every 0.5 seconds if there are any pending
triggers in `gdb-handler-list'."
`(run-with-timer
0.5 nil
'(lambda ()
(if (not (cl-find-if (lambda (handler)
(gdb-handler-pending-trigger handler))
gdb-handler-list))
(progn ,@body)
(gdb-wait-for-pending ,@body)))))
;; Publish-subscribe
(defmacro gdb-add-subscriber (publisher subscriber)
"Register new PUBLISHER's SUBSCRIBER.
SUBSCRIBER must be a pair, where cdr is a function of one
argument (see `gdb-emit-signal')."
`(add-to-list ',publisher ,subscriber t))
(defmacro gdb-delete-subscriber (publisher subscriber)
"Unregister SUBSCRIBER from PUBLISHER."
`(setq ,publisher (delete ,subscriber
,publisher)))
(defun gdb-get-subscribers (publisher)
publisher)
(defun gdb-emit-signal (publisher &optional signal)
"Call cdr for each subscriber of PUBLISHER with SIGNAL as argument."
(dolist (subscriber (gdb-get-subscribers publisher))
(funcall (cdr subscriber) signal)))
(defvar gdb-buf-publisher '()
"Used to invalidate GDB buffers by emitting a signal in `gdb-update'.
Must be a list of pairs with cars being buffers and cdr's being
valid signal handlers.")
(defgroup gdb nil
"GDB graphical interface"
:group 'tools
:link '(info-link "(emacs)GDB Graphical Interface")
:version "23.2")
(defgroup gdb-non-stop nil
"GDB non-stop debugging settings"
:group 'gdb
:version "23.2")
(defgroup gdb-buffers nil
"GDB buffers"
:group 'gdb
:version "23.2")
(defcustom gdb-debug-log-max 128
"Maximum size of `gdb-debug-log'. If nil, size is unlimited."
:group 'gdb
:type '(choice (integer :tag "Number of elements")
(const :tag "Unlimited" nil))
:version "22.1")
(defcustom gdb-non-stop-setting (not (eq system-type 'windows-nt))
"If non-nil, GDB sessions are expected to support the non-stop mode.
When in the non-stop mode, stopped threads can be examined while
other threads continue to execute.
If this is non-nil, GDB will be sent the \"set non-stop 1\" command,
and if that results in an error, the non-stop setting will be
turned off automatically.
On MS-Windows, this is off by default, because MS-Windows targets
don't support the non-stop mode.
GDB session needs to be restarted for this setting to take effect."
:type 'boolean
:group 'gdb-non-stop
:version "26.1")
;; TODO Some commands can't be called with --all (give a notice about
;; it in setting doc)
(defcustom gdb-gud-control-all-threads t
"When non-nil, GUD execution commands affect all threads when
in non-stop mode. Otherwise, only current thread is affected."
:type 'boolean
:group 'gdb-non-stop
:version "23.2")
(defcustom gdb-switch-reasons t
"List of stop reasons for which Emacs should switch thread.
When t, switch to stopped thread no matter what the reason was.
When nil, never switch to stopped thread automatically.
This setting is used in non-stop mode only. In all-stop mode,
Emacs always switches to the thread which caused the stop."
;; exited, exited-normally and exited-signaled are not
;; thread-specific stop reasons and therefore are not included in
;; this list
:type '(choice
(const :tag "All reasons" t)
(set :tag "Selection of reasons..."
(const :tag "A breakpoint was reached." "breakpoint-hit")
(const :tag "A watchpoint was triggered." "watchpoint-trigger")
(const :tag "A read watchpoint was triggered."
"read-watchpoint-trigger")
(const :tag "An access watchpoint was triggered."
"access-watchpoint-trigger")
(const :tag "Function finished execution." "function-finished")
(const :tag "Location reached." "location-reached")
(const :tag "Watchpoint has gone out of scope"
"watchpoint-scope")
(const :tag "End of stepping range reached."
"end-stepping-range")
(const :tag "Signal received (like interruption)."
"signal-received"))
(const :tag "None" nil))
:group 'gdb-non-stop
:version "23.2"
:link '(info-link "(gdb)GDB/MI Async Records"))
(defcustom gdb-stopped-functions nil
"List of functions called whenever GDB stops.
Each function takes one argument, a parsed MI response, which
contains fields of corresponding MI *stopped async record:
((stopped-threads . \"all\")
(thread-id . \"1\")
(frame (line . \"38\")
(fullname . \"/home/sphinx/projects/gsoc/server.c\")
(file . \"server.c\")
(args ((value . \"0x804b038\")
(name . \"arg\")))
(func . \"hello\")
(addr . \"0x0804869e\"))
(reason . \"end-stepping-range\"))
Note that \"reason\" is only present in non-stop debugging mode.
`bindat-get-field' may be used to access the fields of response.
Each function is called after the new current thread was selected
and GDB buffers were updated in `gdb-stopped'."
:type '(repeat function)
:group 'gdb
:version "23.2"
:link '(info-link "(gdb)GDB/MI Async Records"))
(defcustom gdb-switch-when-another-stopped t
"When nil, don't switch to stopped thread if some other
stopped thread is already selected."
:type 'boolean
:group 'gdb-non-stop
:version "23.2")
(defcustom gdb-stack-buffer-locations t
"Show file information or library names in stack buffers."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-stack-buffer-addresses nil
"Show frame addresses in stack buffers."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-thread-buffer-verbose-names t
"Show long thread names in threads buffer."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-thread-buffer-arguments t
"Show function arguments in threads buffer."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-thread-buffer-locations t
"Show file information or library names in threads buffer."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-thread-buffer-addresses nil
"Show addresses for thread frames in threads buffer."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defcustom gdb-show-threads-by-default nil
"Show threads list buffer instead of breakpoints list by default."
:type 'boolean
:group 'gdb-buffers
:version "23.2")
(defvar gdb-debug-log nil
"List of commands sent to and replies received from GDB.
Most recent commands are listed first. This list stores only the last
`gdb-debug-log-max' values. This variable is used to debug GDB-MI.")
;;;###autoload
(define-minor-mode gdb-enable-debug
"Toggle logging of transaction between Emacs and Gdb.
The log is stored in `gdb-debug-log' as an alist with elements
whose cons is send, send-item or recv and whose cdr is the string
being transferred. This list may grow up to a size of
`gdb-debug-log-max' after which the oldest element (at the end of
the list) is deleted every time a new one is added (at the front)."
:global t
:group 'gdb
:version "22.1")
(defcustom gdb-cpp-define-alist-program "gcc -E -dM -"
"Shell command for generating a list of defined macros in a source file.
This list is used to display the #define directive associated
with an identifier as a tooltip. It works in a debug session with
GDB, when `gud-tooltip-mode' is t.
Set `gdb-cpp-define-alist-flags' for any include paths or
predefined macros."
:type 'string
:group 'gdb
:version "22.1")
(defcustom gdb-cpp-define-alist-flags ""
"Preprocessor flags for `gdb-cpp-define-alist-program'."
:type 'string
:group 'gdb
:version "22.1")
(defcustom gdb-create-source-file-list t
"Non-nil means create a list of files from which the executable was built.
Set this to nil if the GUD buffer displays \"initializing...\" in the mode
line for a long time when starting, possibly because your executable was
built from a large number of files. This allows quicker initialization
but means that these files are not automatically enabled for debugging,
e.g., you won't be able to click in the fringe to set a breakpoint until
execution has already stopped there."
:type 'boolean
:group 'gdb
:version "23.1")
(defcustom gdb-show-main nil
"Non-nil means display source file containing the main routine at startup.
Also display the main routine in the disassembly buffer if present."
:type 'boolean
:group 'gdb
:version "22.1")
(defvar gdbmi-debug-mode nil
"When non-nil, print the messages sent/received from GDB/MI in *Messages*.")
(defun gdb-force-mode-line-update (status)
(let ((buffer gud-comint-buffer))
(if (and buffer (buffer-name buffer))
(with-current-buffer buffer
(setq mode-line-process
(format ":%s [%s]"
(process-status (get-buffer-process buffer)) status))
;; Force mode line redisplay soon.
(force-mode-line-update)))))
;; These two are used for menu and toolbar
(defun gdb-control-all-threads ()
"Switch to non-stop/A mode."
(interactive)
(setq gdb-gud-control-all-threads t)
;; Actually forcing the tool-bar to update.
(force-mode-line-update)
(message "Now in non-stop/A mode."))
(defun gdb-control-current-thread ()
"Switch to non-stop/T mode."
(interactive)
(setq gdb-gud-control-all-threads nil)
;; Actually forcing the tool-bar to update.
(force-mode-line-update)
(message "Now in non-stop/T mode."))
(defun gdb-find-watch-expression ()
(let* ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list))
(varnum (car var)) expr)
(string-match "\\(var[0-9]+\\)\\.\\(.*\\)" varnum)
(let ((var1 (assoc (match-string 1 varnum) gdb-var-list)) var2 varnumlet
(component-list (split-string (match-string 2 varnum) "\\." t)))
(setq expr (nth 1 var1))
(setq varnumlet (car var1))
(dolist (component component-list)
(setq var2 (assoc varnumlet gdb-var-list))
(setq expr (concat expr
(if (string-match ".*\\[[0-9]+\\]$" (nth 3 var2))
(concat "[" component "]")
(concat "." component))))
(setq varnumlet (concat varnumlet "." component)))
expr)))
;; noall is used for commands which don't take --all, but only
;; --thread.
(defun gdb-gud-context-command (command &optional noall)
"When `gdb-non-stop' is t, add --thread option to COMMAND if
`gdb-gud-control-all-threads' is nil and --all option otherwise.
If NOALL is t, always add --thread option no matter what
`gdb-gud-control-all-threads' value is.
When `gdb-non-stop' is nil, return COMMAND unchanged."
(if gdb-non-stop
(if (and gdb-gud-control-all-threads
(not noall)
gdb-supports-non-stop)
(concat command " --all ")
(gdb-current-context-command command))
command))
(defmacro gdb-gud-context-call (cmd1 &optional cmd2 noall noarg)
"`gud-call' wrapper which adds --thread/--all options between
CMD1 and CMD2. NOALL is the same as in `gdb-gud-context-command'.
NOARG must be t when this macro is used outside `gud-def'"
`(gud-call
(concat (gdb-gud-context-command ,cmd1 ,noall) " " ,cmd2)
,(when (not noarg) 'arg)))
(defun gdb--check-interpreter (filter proc string)
(unless (zerop (length string))
(remove-function (process-filter proc) #'gdb--check-interpreter)
(unless (memq (aref string 0) '(?^ ?~ ?@ ?& ?* ?=))
;; Apparently we're not running with -i=mi.
(let ((msg "Error: you did not specify -i=mi on GDB's command line!"))
(message msg)
(setq string (concat (propertize msg 'font-lock-face 'error)
"\n" string)))
;; Use the old gud-gbd filter, not because it works, but because it
;; will properly display GDB's answers rather than hanging waiting for
;; answers that aren't coming.
(set (make-local-variable 'gud-marker-filter) #'gud-gdb-marker-filter))
(funcall filter proc string)))
(defvar gdb-control-level 0)
;;;###autoload
(defun gdb (command-line)
"Run gdb passing it COMMAND-LINE as arguments.
If COMMAND-LINE names a program FILE to debug, gdb will run in
a buffer named *gud-FILE*, and the directory containing FILE
becomes the initial working directory and source-file directory
for your debugger.
If COMMAND-LINE requests that gdb attaches to a process PID, gdb
will run in *gud-PID*, otherwise it will run in *gud*; in these
cases the initial working directory is the default-directory of
the buffer in which this command was invoked.
COMMAND-LINE should include \"-i=mi\" to use gdb's MI text interface.
Note that the old \"--annotate\" option is no longer supported.
If option `gdb-many-windows' is nil (the default value) then gdb just
pops up the GUD buffer unless `gdb-show-main' is t. In this case
it starts with two windows: one displaying the GUD buffer and the
other with the source file with the main routine of the inferior.
If option `gdb-many-windows' is t, regardless of the value of
`gdb-show-main', the layout below will appear. Keybindings are
shown in some of the buffers.
Watch expressions appear in the speedbar/slowbar.
The following commands help control operation :
`gdb-many-windows' - Toggle the number of windows gdb uses.
`gdb-restore-windows' - To restore the window layout.
See Info node `(emacs)GDB Graphical Interface' for a more
detailed description of this mode.
+----------------------------------------------------------------------+
| GDB Toolbar |
+-----------------------------------+----------------------------------+
| GUD buffer (I/O of GDB) | Locals buffer |
| | |
| | |
| | |
+-----------------------------------+----------------------------------+
| Source buffer | I/O buffer (of debugged program) |
| | (comint-mode) |
| | |
| | |
| | |
| | |
| | |
| | |
+-----------------------------------+----------------------------------+
| Stack buffer | Breakpoints buffer |
| RET gdb-select-frame | SPC gdb-toggle-breakpoint |
| | RET gdb-goto-breakpoint |
| | D gdb-delete-breakpoint |
+-----------------------------------+----------------------------------+"
;;
(interactive (list (gud-query-cmdline 'gdb)))
(when (and gud-comint-buffer
(buffer-name gud-comint-buffer)
(get-buffer-process gud-comint-buffer)
(with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
(gdb-restore-windows)
(error
"Multiple debugging requires restarting in text command mode"))
;;
(gud-common-init command-line nil 'gud-gdbmi-marker-filter)
;; Setup a temporary process filter to warn when GDB was not started
;; with -i=mi.
(let ((proc (get-buffer-process gud-comint-buffer)))
(add-function :around (process-filter proc) #'gdb--check-interpreter))
(set (make-local-variable 'gud-minor-mode) 'gdbmi)
(set (make-local-variable 'gdb-control-level) 0)
(setq comint-input-sender 'gdb-send)
(when (ring-empty-p comint-input-ring) ; cf shell-mode
(let ((hfile (expand-file-name (or (getenv "GDBHISTFILE")
(if (eq system-type 'ms-dos)
"_gdb_history"
".gdb_history"))))
;; gdb defaults to 256, but we'll default to comint-input-ring-size.
(hsize (getenv "HISTSIZE")))
(dolist (file (append '("~/.gdbinit")
(unless (string-equal (expand-file-name ".")
(expand-file-name "~"))
'(".gdbinit"))))
(if (file-readable-p (setq file (expand-file-name file)))
(with-temp-buffer
(insert-file-contents file)
;; TODO? check for "set history save\\( *on\\)?" and do
;; not use history otherwise?
(while (re-search-forward
"^ *set history \\(filename\\|size\\) *\\(.*\\)" nil t)
(cond ((string-equal (match-string 1) "filename")
(setq hfile (expand-file-name
(match-string 2)
(file-name-directory file))))
((string-equal (match-string 1) "size")
(setq hsize (match-string 2))))))))
(and (stringp hsize)
(integerp (setq hsize (string-to-number hsize)))
(> hsize 0)
(set (make-local-variable 'comint-input-ring-size) hsize))
(if (stringp hfile)
(set (make-local-variable 'comint-input-ring-file-name) hfile))
(comint-read-input-ring t)))
(gud-def gud-tbreak "tbreak %f:%l" "\C-t"
"Set temporary breakpoint at current line.")
(gud-def gud-jump
(progn (gud-call "tbreak %f:%l" arg) (gud-call "jump %f:%l"))
"\C-j" "Set execution address to current line.")
(gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
(gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
(gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
(gud-def gud-pstar "print* %e" nil
"Evaluate C dereferenced pointer expression at point.")
(gud-def gud-step (gdb-gud-context-call "-exec-step" "%p" t)
"\C-s"
"Step one source line with display.")
(gud-def gud-stepi (gdb-gud-context-call "-exec-step-instruction" "%p" t)
"\C-i"
"Step one instruction with display.")
(gud-def gud-next (gdb-gud-context-call "-exec-next" "%p" t)
"\C-n"
"Step one line (skip functions).")
(gud-def gud-nexti (gdb-gud-context-call "-exec-next-instruction" "%p" t)
nil
"Step one instruction (skip functions).")
(gud-def gud-cont (gdb-gud-context-call "-exec-continue")
"\C-r"
"Continue with display.")
(gud-def gud-finish (gdb-gud-context-call "-exec-finish" nil t)
"\C-f"
"Finish executing current function.")
(gud-def gud-run "-exec-run"
nil
"Run the program.")
(gud-def gud-break (if (not (string-match "Disassembly" mode-name))
(gud-call "break %f:%l" arg)
(save-excursion
(beginning-of-line)
(forward-char 2)
(gud-call "break *%a" arg)))
"\C-b" "Set breakpoint at current line or address.")
(gud-def gud-remove (if (not (string-match "Disassembly" mode-name))
(gud-call "clear %f:%l" arg)
(save-excursion
(beginning-of-line)
(forward-char 2)
(gud-call "clear *%a" arg)))
"\C-d" "Remove breakpoint at current line or address.")
;; -exec-until doesn't support --all yet
(gud-def gud-until (if (not (string-match "Disassembly" mode-name))
(gud-call "-exec-until %f:%l" arg)
(save-excursion
(beginning-of-line)
(forward-char 2)
(gud-call "-exec-until *%a" arg)))
"\C-u" "Continue to current line or address.")
;; TODO Why arg here?
(gud-def
gud-go (gud-call (if gdb-active-process
(gdb-gud-context-command "-exec-continue")
"-exec-run") arg)
nil "Start or continue execution.")
;; For debugging Emacs only.
(gud-def gud-pp
(gud-call
(concat
"pp " (if (eq (buffer-local-value
'major-mode (window-buffer)) 'speedbar-mode)
(gdb-find-watch-expression) "%e")) arg)
nil "Print the Emacs s-expression.")
(define-key gud-minor-mode-map [left-margin mouse-1]
'gdb-mouse-set-clear-breakpoint)
(define-key gud-minor-mode-map [left-fringe mouse-1]
'gdb-mouse-set-clear-breakpoint)
(define-key gud-minor-mode-map [left-margin C-mouse-1]
'gdb-mouse-toggle-breakpoint-margin)
(define-key gud-minor-mode-map [left-fringe C-mouse-1]
'gdb-mouse-toggle-breakpoint-fringe)
(define-key gud-minor-mode-map [left-margin drag-mouse-1]
'gdb-mouse-until)
(define-key gud-minor-mode-map [left-fringe drag-mouse-1]
'gdb-mouse-until)
(define-key gud-minor-mode-map [left-margin mouse-3]
'gdb-mouse-until)
(define-key gud-minor-mode-map [left-fringe mouse-3]
'gdb-mouse-until)
(define-key gud-minor-mode-map [left-margin C-drag-mouse-1]
'gdb-mouse-jump)
(define-key gud-minor-mode-map [left-fringe C-drag-mouse-1]
'gdb-mouse-jump)
(define-key gud-minor-mode-map [left-fringe C-mouse-3]
'gdb-mouse-jump)
(define-key gud-minor-mode-map [left-margin C-mouse-3]
'gdb-mouse-jump)
(set (make-local-variable 'gud-gdb-completion-function)
'gud-gdbmi-completions)
(add-hook 'completion-at-point-functions #'gud-gdb-completion-at-point
nil 'local)
(local-set-key "\C-i" 'completion-at-point)
(local-set-key [remap comint-delchar-or-maybe-eof] 'gdb-delchar-or-quit)
(setq gdb-first-prompt t)
(setq gud-running nil)
(gdb-update)
(run-hooks 'gdb-mode-hook))
(defun gdb-init-1 ()
;; (Re-)initialize.
(setq gdb-selected-frame nil
gdb-frame-number nil
gdb-thread-number nil
gdb-var-list nil
gdb-output-sink 'user
gdb-location-alist nil
gdb-source-file-list nil
gdb-last-command nil
gdb-token-number 0
gdb-handler-list '()
gdb-prompt-name nil
gdb-first-done-or-error t
gdb-buffer-fringe-width (car (window-fringes))
gdb-debug-log nil
gdb-source-window nil
gdb-inferior-status nil
gdb-continuation nil
gdb-buf-publisher '()
gdb-threads-list '()
gdb-breakpoints-list '()
gdb-register-names '()
gdb-non-stop gdb-non-stop-setting)
;;
(gdbmi-bnf-init)
;;
(setq gdb-buffer-type 'gdbmi)
;;
(gdb-force-mode-line-update
(propertize "initializing..." 'face font-lock-variable-name-face))
(gdb-get-buffer-create 'gdb-inferior-io)
(gdb-clear-inferior-io)
(gdb-inferior-io--init-proc (get-process "gdb-inferior"))
(when (eq system-type 'windows-nt)
;; Don't create a separate console window for the debuggee.
(gdb-input "-gdb-set new-console off" 'ignore)
;; Force GDB to behave as if its input and output stream were
;; connected to a TTY device (since on Windows we use pipes for
;; communicating with GDB).
(gdb-input "-gdb-set interactive-mode on" 'ignore))
(gdb-input "-gdb-set height 0" 'ignore)
(when gdb-non-stop
(gdb-input "-gdb-set non-stop 1" 'gdb-non-stop-handler))
(gdb-input "-enable-pretty-printing" 'ignore)
;; Find source file and compilation directory here.
(if gdb-create-source-file-list
;; Needs GDB 6.2 onwards.
(gdb-input "-file-list-exec-source-files" 'gdb-get-source-file-list))
;; Needs GDB 6.0 onwards.
(gdb-input "-file-list-exec-source-file" 'gdb-get-source-file)
(gdb-input "-gdb-show prompt" 'gdb-get-prompt))
(defun gdb-non-stop-handler ()
(goto-char (point-min))
(if (re-search-forward "No symbol" nil t)
(progn
(message
"This version of GDB doesn't support non-stop mode. Turning it off.")
(setq gdb-non-stop nil)
(setq gdb-supports-non-stop nil))
(setq gdb-supports-non-stop t)
(gdb-input "-gdb-set target-async 1" 'ignore)
(gdb-input "-list-target-features" 'gdb-check-target-async)))
(defun gdb-check-target-async ()
(goto-char (point-min))
(unless (re-search-forward "async" nil t)
(message
"Target doesn't support non-stop mode. Turning it off.")
(setq gdb-non-stop nil)
(gdb-input "-gdb-set non-stop 0" 'ignore)))
(defun gdb-delchar-or-quit (arg)
"Delete ARG characters or send a quit command to GDB.
Send a quit only if point is at the end of the buffer, there is
no input, and GDB is waiting for input."
(interactive "p")
(unless (and (eq (current-buffer) gud-comint-buffer)
(eq gud-minor-mode 'gdbmi))
(error "Not in a GDB-MI buffer"))
(let ((proc (get-buffer-process gud-comint-buffer)))
(if (and (eobp)
(process-live-p proc)
(not gud-running)
(= (point) (marker-position (process-mark proc))))
;; Sending an EOF does not work with GDB-MI; submit an
;; explicit quit command.
(progn
(insert "quit")
(comint-send-input t t))
(delete-char arg))))
(defvar gdb-define-alist nil "Alist of #define directives for GUD tooltips.")
(defun gdb-create-define-alist ()
"Create an alist of #define directives for GUD tooltips."
(let* ((file (buffer-file-name))
(output
(with-output-to-string
(with-current-buffer standard-output
(and file
(file-exists-p file)
;; call-process doesn't work with remote file names.
(not (file-remote-p default-directory))
(call-process shell-file-name file
(list t nil) nil "-c"
(concat gdb-cpp-define-alist-program " "
gdb-cpp-define-alist-flags))))))
(define-list (split-string output "\n" t))
(name))
(setq gdb-define-alist nil)
(dolist (define define-list)
(setq name (nth 1 (split-string define "[( ]")))
(push (cons name define) gdb-define-alist))))
(declare-function tooltip-show "tooltip" (text &optional use-echo-area))
(defconst gdb--string-regexp "\"\\(?:[^\\\"]\\|\\\\.\\)*\"")
(defun gdb-tooltip-print (expr)
(with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
(goto-char (point-min))
(cond
((re-search-forward (concat ".*value=\\(" gdb--string-regexp
"\\)")
nil t)
(tooltip-show
(concat expr " = " (read (match-string 1)))
(or gud-tooltip-echo-area
(not (display-graphic-p)))))
((re-search-forward "msg=\\(\".+\"\\)$" nil t)
(tooltip-show (read (match-string 1))
(or gud-tooltip-echo-area
(not (display-graphic-p))))))))
;; If expr is a macro for a function don't print because of possible dangerous
;; side-effects. Also printing a function within a tooltip generates an
;; unexpected starting annotation (phase error).
(defun gdb-tooltip-print-1 (expr)
(with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
(goto-char (point-min))
(if (search-forward "expands to: " nil t)
(unless (looking-at "\\S-+.*(.*).*")
(gdb-input (concat "-data-evaluate-expression \"" expr "\"")
`(lambda () (gdb-tooltip-print ,expr)))))))
(defun gdb-init-buffer ()
(set (make-local-variable 'gud-minor-mode) 'gdbmi)
(set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
(when gud-tooltip-mode
(make-local-variable 'gdb-define-alist)
(gdb-create-define-alist)
(add-hook 'after-save-hook 'gdb-create-define-alist nil t)))
(defmacro gdb--if-arrow (arrow-position start-posn end-posn &rest body)
(declare (indent 3))
(let ((buffer (make-symbol "buffer")))
`(if ,arrow-position
(let ((,buffer (marker-buffer ,arrow-position)))
(if (equal ,buffer (window-buffer (posn-window ,end-posn)))
(with-current-buffer ,buffer
(when (or (equal ,start-posn ,end-posn)
(equal (posn-point ,start-posn)
(marker-position ,arrow-position)))
,@body)))))))
(defun gdb-mouse-until (event)
"Continue running until a source line past the current line.
The destination source line can be selected either by clicking
with mouse-3 on the fringe/margin or dragging the arrow
with mouse-1 (default bindings)."
(interactive "e")
(let ((start (event-start event))
(end (event-end event)))
(gdb--if-arrow gud-overlay-arrow-position start end
(let ((line (line-number-at-pos (posn-point end))))
(gud-call (concat "until " (number-to-string line)))))
(gdb--if-arrow gdb-disassembly-position start end
(save-excursion
(goto-char (point-min))
(forward-line (1- (line-number-at-pos (posn-point end))))
(forward-char 2)
(gud-call (concat "until *%a"))))))
(defun gdb-mouse-jump (event)
"Set execution address/line.
The destination source line can be selected either by clicking with C-mouse-3
on the fringe/margin or dragging the arrow with C-mouse-1 (default bindings).
Unlike `gdb-mouse-until' the destination address can be before the current
line, and no execution takes place."
(interactive "e")
(let ((start (event-start event))
(end (event-end event)))
(gdb--if-arrow gud-overlay-arrow-position start end
(let ((line (line-number-at-pos (posn-point end))))
(gud-call (concat "tbreak " (number-to-string line)))
(gud-call (concat "jump " (number-to-string line)))))
(gdb--if-arrow gdb-disassembly-position start end
(save-excursion
(goto-char (point-min))
(forward-line (1- (line-number-at-pos (posn-point end))))
(forward-char 2)
(gud-call (concat "tbreak *%a"))
(gud-call (concat "jump *%a"))))))
(defcustom gdb-show-changed-values t
"If non-nil change the face of out of scope variables and changed values.
Out of scope variables are suppressed with `shadow' face.
Changed values are highlighted with the face `font-lock-warning-face'.
Used by Speedbar."
:type 'boolean
:group 'gdb
:version "22.1")
(defcustom gdb-max-children 40
"Maximum number of children before expansion requires confirmation.
Used by Speedbar."
:type 'integer
:group 'gdb
:version "22.1")
(defcustom gdb-delete-out-of-scope t
"If non-nil delete watch expressions automatically when they go out of scope."
:type 'boolean
:group 'gdb
:version "22.2")
(define-minor-mode gdb-speedbar-auto-raise
"Minor mode to automatically raise the speedbar for watch expressions."
:global t
:group 'gdb
:version "22.1")
(defcustom gdb-use-colon-colon-notation nil
"If non-nil use FUN::VAR format to display variables in the speedbar."
:type 'boolean
:group 'gdb
:version "22.1")
(define-key gud-minor-mode-map "\C-c\C-w" 'gud-watch)
(define-key global-map (vconcat gud-key-prefix "\C-w") 'gud-watch)
(declare-function tooltip-identifier-from-point "tooltip" (point))
(defun gud-watch (&optional arg event)
"Watch expression at point.
With arg, enter name of variable to be watched in the minibuffer."
(interactive (list current-prefix-arg last-input-event))
(let ((minor-mode (buffer-local-value 'gud-minor-mode gud-comint-buffer)))
(if (eq minor-mode 'gdbmi)
(progn
(if event (posn-set-point (event-end event)))
(require 'tooltip)
(save-selected-window
(let ((expr
(if arg
(completing-read "Name of variable: "
'gud-gdb-complete-command)
(if (and transient-mark-mode mark-active)
(buffer-substring (region-beginning) (region-end))
(concat (if (derived-mode-p 'gdb-registers-mode) "$")
(tooltip-identifier-from-point (point)))))))
(set-text-properties 0 (length expr) nil expr)
(gdb-input (concat "-var-create - * " expr "")
`(lambda () (gdb-var-create-handler ,expr))))))
(message "gud-watch is a no-op in this mode."))))
(defun gdb-var-create-handler (expr)
(let* ((result (gdb-json-partial-output)))
(if (not (bindat-get-field result 'msg))
(let ((var
(list (bindat-get-field result 'name)
(if (and (string-equal gdb-current-language "c")
gdb-use-colon-colon-notation gdb-selected-frame)
(setq expr (concat gdb-selected-frame "::" expr))
expr)
(bindat-get-field result 'numchild)
(bindat-get-field result 'type)
(bindat-get-field result 'value)
nil
(bindat-get-field result 'has_more)
gdb-frame-address)))
(push var gdb-var-list)
(speedbar 1)
(unless (string-equal
speedbar-initial-expansion-list-name "GUD")
(speedbar-change-initial-expansion-list "GUD")))
(message-box "No symbol \"%s\" in current context." expr))))
(defun gdb-speedbar-update ()
(when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame))
;; Dummy command to update speedbar even when idle.
(gdb-input "-environment-pwd"
'gdb-speedbar-timer-fn
'gdb-speedbar-update)))
(defun gdb-speedbar-timer-fn ()
(if gdb-speedbar-auto-raise
(raise-frame speedbar-frame))
(speedbar-timer-fn))
(defun gdb-var-evaluate-expression-handler (varnum changed)
(goto-char (point-min))
(re-search-forward (concat ".*value=\\(" gdb--string-regexp "\\)")
nil t)
(let ((var (assoc varnum gdb-var-list)))
(when var
(if changed (setcar (nthcdr 5 var) 'changed))
(setcar (nthcdr 4 var) (read (match-string 1)))))
(gdb-speedbar-update))
; Uses "-var-list-children --all-values". Needs GDB 6.1 onwards.
(defun gdb-var-list-children (varnum)
(gdb-input (concat "-var-update " varnum) 'ignore)
(gdb-input (concat "-var-list-children --all-values " varnum)
`(lambda () (gdb-var-list-children-handler ,varnum))))
(defun gdb-var-list-children-handler (varnum)
(let* ((var-list nil)
(output (bindat-get-field (gdb-json-partial-output "child")))
(children (bindat-get-field output 'children)))
(catch 'child-already-watched
(dolist (var gdb-var-list)
(if (string-equal varnum (car var))
(progn
;; With dynamic varobjs numchild may have increased.
(setcar (nthcdr 2 var) (bindat-get-field output 'numchild))
(push var var-list)
(dolist (child children)
(let ((varchild (list (bindat-get-field child 'name)
(bindat-get-field child 'exp)
(bindat-get-field child 'numchild)
(bindat-get-field child 'type)
(bindat-get-field child 'value)
nil
(bindat-get-field child 'has_more))))
(if (assoc (car varchild) gdb-var-list)
(throw 'child-already-watched nil))
(push varchild var-list))))
(push var var-list)))
(setq gdb-var-list (nreverse var-list))))
(gdb-speedbar-update))
(defun gdb-var-set-format (format)
"Set the output format for a variable displayed in the speedbar."
(let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
(varnum (car var)))
(gdb-input (concat "-var-set-format " varnum " " format) 'ignore)
(gdb-var-update)))
(defun gdb-var-delete-1 (var varnum)
(gdb-input (concat "-var-delete " varnum) 'ignore)
(setq gdb-var-list (delq var gdb-var-list))
(dolist (varchild gdb-var-list)
(if (string-match (concat (car var) "\\.") (car varchild))
(setq gdb-var-list (delq varchild gdb-var-list)))))
(defun gdb-var-delete ()
"Delete watch expression at point from the speedbar."
(interactive)
(let ((text (speedbar-line-text)))
(string-match "\\(\\S-+\\)" text)
(let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
(varnum (car var)))
(if (string-match "\\." (car var))
(message-box "Can only delete a root expression")
(gdb-var-delete-1 var varnum)))))
(defun gdb-var-delete-children (varnum)
"Delete children of variable object at point from the speedbar."
(gdb-input (concat "-var-delete -c " varnum) 'ignore))
(defun gdb-edit-value (_text _token _indent)
"Assign a value to a variable displayed in the speedbar."
(let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
(varnum (car var))
(value (read-string "New value: ")))
(gdb-input (concat "-var-assign " varnum " " value)
`(lambda () (gdb-edit-value-handler ,value)))))
(defconst gdb-error-regexp "\\^error,msg=\\(\".+\"\\)")
(defun gdb-edit-value-handler (value)
(goto-char (point-min))
(if (re-search-forward gdb-error-regexp nil t)
(message-box "Invalid number or expression (%s)" value)))
; Uses "-var-update --all-values". Needs GDB 6.4 onwards.
(defun gdb-var-update ()
(gdb-input "-var-update --all-values *"
'gdb-var-update-handler
'gdb-var-update))
(defun gdb-var-update-handler ()
(let ((changelist (bindat-get-field (gdb-json-partial-output) 'changelist)))
(dolist (var gdb-var-list)
(setcar (nthcdr 5 var) nil))
(let ((temp-var-list gdb-var-list))
(dolist (change changelist)
(let* ((varnum (bindat-get-field change 'name))
(var (assoc varnum gdb-var-list))
(new-num (bindat-get-field change 'new_num_children)))
(when var
(let ((scope (bindat-get-field change 'in_scope))
(has-more (bindat-get-field change 'has_more)))
(cond ((string-equal scope "false")
(if gdb-delete-out-of-scope
(gdb-var-delete-1 var varnum)
(setcar (nthcdr 5 var) 'out-of-scope)))
((string-equal scope "true")
(setcar (nthcdr 6 var) has-more)
(when (and (or (not has-more)
(string-equal has-more "0"))
(not new-num)
(string-equal (nth 2 var) "0"))
(setcar (nthcdr 4 var)
(bindat-get-field change 'value))
(setcar (nthcdr 5 var) 'changed)))
((string-equal scope "invalid")
(gdb-var-delete-1 var varnum)))))
(let ((var-list nil) var1
(children (bindat-get-field change 'new_children)))
(when new-num
(setq var1 (pop temp-var-list))
(while var1
(if (string-equal varnum (car var1))
(let ((new (string-to-number new-num))
(previous (string-to-number (nth 2 var1))))
(setcar (nthcdr 2 var1) new-num)
(push var1 var-list)
(cond
((> new previous)
;; Add new children to list.
(dotimes (_ previous)
(push (pop temp-var-list) var-list))
(dolist (child children)
(let ((varchild
(list (bindat-get-field child 'name)
(bindat-get-field child 'exp)
(bindat-get-field child 'numchild)
(bindat-get-field child 'type)
(bindat-get-field child 'value)
'changed
(bindat-get-field child 'has_more))))
(push varchild var-list))))
;; Remove deleted children from list.
((< new previous)
(dotimes (_ new)
(push (pop temp-var-list) var-list))
(dotimes (_ (- previous new))
(pop temp-var-list)))))
(push var1 var-list))
(setq var1 (pop temp-var-list)))
(setq gdb-var-list (nreverse var-list))))))))
(gdb-speedbar-update))
(defun gdb-speedbar-expand-node (text token indent)
"Expand the node the user clicked on.
TEXT is the text of the button we clicked on, a + or - item.
TOKEN is data related to this node.
INDENT is the current indentation depth."
(cond ((string-match "\\+" text) ;expand this node
(let* ((var (assoc token gdb-var-list))
(expr (nth 1 var)) (children (nth 2 var)))
(if (or (<= (string-to-number children) gdb-max-children)
(y-or-n-p
(format "%s has %s children. Continue? " expr children)))
(gdb-var-list-children token))))
((string-match "-" text) ;contract this node
(dolist (var gdb-var-list)
(if (string-match (concat token "\\.") (car var))
(setq gdb-var-list (delq var gdb-var-list))))
(gdb-var-delete-children token)
(speedbar-change-expand-button-char ?+)
(speedbar-delete-subblock indent))
(t (error "Ooops... not sure what to do")))
(speedbar-center-buffer-smartly))
(defun gdb-get-target-string ()
(with-current-buffer gud-comint-buffer
gud-target-name))
\f
;;
;; gdb buffers.
;;
;; Each buffer has a TYPE -- a symbol that identifies the function
;; of that particular buffer.
;;
;; The usual gdb interaction buffer is given the type `gdbmi' and
;; is constructed specially.
;;
;; Others are constructed by gdb-get-buffer-create and
;; named according to the rules set forth in the gdb-buffer-rules
(defvar gdb-buffer-rules '())
(defun gdb-rules-name-maker (rules-entry)
(cadr rules-entry))
(defun gdb-rules-buffer-mode (rules-entry)
(nth 2 rules-entry))
(defun gdb-rules-update-trigger (rules-entry)
(nth 3 rules-entry))
(defun gdb-update-buffer-name ()
"Rename current buffer according to name-maker associated with
it in `gdb-buffer-rules'."
(let ((f (gdb-rules-name-maker (assoc gdb-buffer-type
gdb-buffer-rules))))
(when f (rename-buffer (funcall f)))))
(defun gdb-current-buffer-rules ()
"Get `gdb-buffer-rules' entry for current buffer type."
(assoc gdb-buffer-type gdb-buffer-rules))
(defun gdb-current-buffer-thread ()
"Get thread object of current buffer from `gdb-threads-list'.
When current buffer is not bound to any thread, return main
thread."
(cdr (assoc gdb-thread-number gdb-threads-list)))
(defun gdb-current-buffer-frame ()
"Get current stack frame object for thread of current buffer."
(bindat-get-field (gdb-current-buffer-thread) 'frame))
(defun gdb-buffer-type (buffer)
"Get value of `gdb-buffer-type' for BUFFER."
(with-current-buffer buffer
gdb-buffer-type))
(defun gdb-buffer-shows-main-thread-p ()
"Return t if current GDB buffer shows main selected thread and
is not bound to it."
(current-buffer)
(not (local-variable-p 'gdb-thread-number)))
(defun gdb-get-buffer (buffer-type &optional thread)
"Get a specific GDB buffer.
In that buffer, `gdb-buffer-type' must be equal to BUFFER-TYPE
and `gdb-thread-number' (if provided) must be equal to THREAD."
(catch 'found
(dolist (buffer (buffer-list) nil)
(with-current-buffer buffer
(when (and (eq gdb-buffer-type buffer-type)
(or (not thread)
(equal gdb-thread-number thread)))
(throw 'found buffer))))))
(defun gdb-get-buffer-create (buffer-type &optional thread)
"Create a new GDB buffer of the type specified by BUFFER-TYPE.
The buffer-type should be one of the cars in `gdb-buffer-rules'.
If THREAD is non-nil, it is assigned to `gdb-thread-number'
buffer-local variable of the new buffer.
Buffer mode and name are selected according to buffer type.
If buffer has trigger associated with it in `gdb-buffer-rules',
this trigger is subscribed to `gdb-buf-publisher' and called with
'update argument."
(or (gdb-get-buffer buffer-type thread)
(let ((rules (assoc buffer-type gdb-buffer-rules))
(new (generate-new-buffer "limbo")))
(with-current-buffer new
(let ((mode (gdb-rules-buffer-mode rules))
(trigger (gdb-rules-update-trigger rules)))
(when mode (funcall mode))
(setq gdb-buffer-type buffer-type)
(when thread
(set (make-local-variable 'gdb-thread-number) thread))
(set (make-local-variable 'gud-minor-mode)
(buffer-local-value 'gud-minor-mode gud-comint-buffer))
(set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
(rename-buffer (funcall (gdb-rules-name-maker rules)))
(when trigger
(gdb-add-subscriber gdb-buf-publisher
(cons (current-buffer)
(gdb-bind-function-to-buffer
trigger (current-buffer))))
(funcall trigger 'start))
(current-buffer))))))
(defun gdb-bind-function-to-buffer (expr buffer)
"Return a function which will evaluate EXPR in BUFFER."
`(lambda (&rest args)
(with-current-buffer ,buffer
(apply ',expr args))))
;; Used to display windows with thread-bound buffers
(defmacro def-gdb-preempt-display-buffer (name buffer &optional doc
split-horizontal)
`(defun ,name (&optional thread)
,(when doc doc)
(message "%s" thread)
(gdb-preempt-existing-or-display-buffer
(gdb-get-buffer-create ,buffer thread)
,split-horizontal)))
;; This assoc maps buffer type symbols to rules. Each rule is a list of
;; at least one and possible more functions. The functions have these
;; roles in defining a buffer type:
;;
;; NAME - Return a name for this buffer type.
;;
;; The remaining function(s) are optional:
;;
;; MODE - called in a new buffer with no arguments, should establish
;; the proper mode for the buffer.
;;
(defun gdb-set-buffer-rules (buffer-type &rest rules)
(let ((binding (assoc buffer-type gdb-buffer-rules)))
(if binding
(setcdr binding rules)
(push (cons buffer-type rules)
gdb-buffer-rules))))
(defun gdb-parent-mode ()
"Generic mode to derive all other GDB buffer modes from."
(kill-all-local-variables)
(setq buffer-read-only t)
(buffer-disable-undo)
;; Delete buffer from gdb-buf-publisher when it's killed
;; (if it has an associated update trigger)
(add-hook
'kill-buffer-hook
(function
(lambda ()
(let ((trigger (gdb-rules-update-trigger
(gdb-current-buffer-rules))))
(when trigger
(gdb-delete-subscriber
gdb-buf-publisher
;; This should match gdb-add-subscriber done in
;; gdb-get-buffer-create
(cons (current-buffer)
(gdb-bind-function-to-buffer trigger (current-buffer))))))))
nil t))
;; Partial-output buffer : This accumulates output from a command executed on
;; behalf of emacs (rather than the user).
;;
(gdb-set-buffer-rules 'gdb-partial-output-buffer
'gdb-partial-output-name)
(defun gdb-partial-output-name ()
(concat " *partial-output-"
(gdb-get-target-string)
"*"))
\f
(gdb-set-buffer-rules 'gdb-inferior-io
'gdb-inferior-io-name
'gdb-inferior-io-mode)
(defun gdb-inferior-io-name ()
(concat "*input/output of "
(gdb-get-target-string)
"*"))
(defun gdb-display-io-buffer ()
"Display IO of debugged program in a separate window."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-inferior-io)))
(defun gdb-inferior-io--init-proc (proc)
;; Set up inferior I/O. Needs GDB 6.4 onwards.
(set-process-filter proc 'gdb-inferior-filter)
(set-process-sentinel proc 'gdb-inferior-io-sentinel)
;; The process can run on a remote host.
(let ((tty (or (process-get proc 'remote-tty)
(process-tty-name proc))))
(unless (or (null tty)
(string= tty ""))
(gdb-input
(concat "-inferior-tty-set " tty) 'ignore))))
(defun gdb-inferior-io-sentinel (proc _str)
(when (eq (process-status proc) 'failed)
;; When the debugged process exits, Emacs gets an EIO error on
;; read from the pty, and stops listening to it. If the gdb
;; process is still running, remove the pty, make a new one, and
;; pass it to gdb.
(let ((io-buffer (process-buffer proc)))
(when (and (process-live-p (get-buffer-process gud-comint-buffer))
(buffer-live-p io-buffer))
;; `comint-exec' deletes the original process as a side effect.
(comint-exec io-buffer "gdb-inferior" nil nil nil)
(gdb-inferior-io--init-proc (get-buffer-process io-buffer))))))
(defcustom gdb-display-buffer-other-frame-action
'((display-buffer-reuse-window display-buffer-pop-up-frame)
(reusable-frames . visible)
(inhibit-same-window . t)
(pop-up-frame-parameters (height . 14)
(width . 80)
(unsplittable . t)
(tool-bar-lines . nil)
(menu-bar-lines . nil)
(minibuffer . nil)))
"`display-buffer' action for displaying GDB utility frames."
:group 'gdb
:type display-buffer--action-custom-type
:risky t
:version "24.3")
(defun gdb-frame-io-buffer ()
"Display IO of debugged program in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-inferior-io)
gdb-display-buffer-other-frame-action))
(defvar gdb-inferior-io-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-c\C-c" 'gdb-io-interrupt)
(define-key map "\C-c\C-z" 'gdb-io-stop)
(define-key map "\C-c\C-\\" 'gdb-io-quit)
(define-key map "\C-c\C-d" 'gdb-io-eof)
(define-key map "\C-d" 'gdb-io-eof)
map))
;; We want to use comint because it has various nifty and familiar features.
(define-derived-mode gdb-inferior-io-mode comint-mode "Inferior I/O"
"Major mode for gdb inferior-io."
:syntax-table nil :abbrev-table nil
(make-comint-in-buffer "gdb-inferior" (current-buffer) nil))
(defcustom gdb-display-io-nopopup nil
"When non-nil, and the `gdb-inferior-io' buffer is buried, don't pop it up."
:type 'boolean
:group 'gdb
:version "25.1")
(defun gdb-inferior-filter (proc string)
(unless (string-equal string "")
(let (buf)
(unless (and gdb-display-io-nopopup
(setq buf (gdb-get-buffer 'gdb-inferior-io))
(null (get-buffer-window buf)))
(gdb-display-buffer (gdb-get-buffer-create 'gdb-inferior-io)))))
(with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
(comint-output-filter proc string)))
(defun gdb-io-interrupt ()
"Interrupt the program being debugged."
(interactive)
(interrupt-process
(get-buffer-process gud-comint-buffer) comint-ptyp))
(defun gdb-io-quit ()
"Send quit signal to the program being debugged."
(interactive)
(quit-process
(get-buffer-process gud-comint-buffer) comint-ptyp))
(defun gdb-io-stop ()
"Stop the program being debugged."
(interactive)
(stop-process
(get-buffer-process gud-comint-buffer) comint-ptyp))
(defun gdb-io-eof ()
"Send end-of-file to the program being debugged."
(interactive)
(process-send-eof
(get-buffer-process gud-comint-buffer)))
(defun gdb-clear-inferior-io ()
(with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
(erase-buffer)))
\f
(defconst breakpoint-xpm-data
"/* XPM */
static char *magick[] = {
/* columns rows colors chars-per-pixel */
\"10 10 2 1\",
\" c red\",
\"+ c None\",
/* pixels */
\"+++ +++\",
\"++ ++\",
\"+ +\",
\" \",
\" \",
\" \",
\" \",
\"+ +\",
\"++ ++\",
\"+++ +++\",
};"
"XPM data used for breakpoint icon.")
(defconst breakpoint-enabled-pbm-data
"P1
10 10\",
0 0 0 0 1 1 1 1 0 0 0 0
0 0 0 1 1 1 1 1 1 0 0 0
0 0 1 1 1 1 1 1 1 1 0 0
0 1 1 1 1 1 1 1 1 1 1 0
0 1 1 1 1 1 1 1 1 1 1 0
0 1 1 1 1 1 1 1 1 1 1 0
0 1 1 1 1 1 1 1 1 1 1 0
0 0 1 1 1 1 1 1 1 1 0 0
0 0 0 1 1 1 1 1 1 0 0 0
0 0 0 0 1 1 1 1 0 0 0 0"
"PBM data used for enabled breakpoint icon.")
(defconst breakpoint-disabled-pbm-data
"P1
10 10\",
0 0 1 0 1 0 1 0 0 0
0 1 0 1 0 1 0 1 0 0
1 0 1 0 1 0 1 0 1 0
0 1 0 1 0 1 0 1 0 1
1 0 1 0 1 0 1 0 1 0
0 1 0 1 0 1 0 1 0 1
1 0 1 0 1 0 1 0 1 0
0 1 0 1 0 1 0 1 0 1
0 0 1 0 1 0 1 0 1 0
0 0 0 1 0 1 0 1 0 0"
"PBM data used for disabled breakpoint icon.")
(defvar breakpoint-enabled-icon nil
"Icon for enabled breakpoint in display margin.")
(defvar breakpoint-disabled-icon nil
"Icon for disabled breakpoint in display margin.")
;; Bitmap for breakpoint in fringe
(define-fringe-bitmap 'breakpoint
"\x3c\x7e\xff\xff\xff\xff\x7e\x3c")
;; Bitmap for gud-overlay-arrow in fringe
(define-fringe-bitmap 'hollow-right-triangle
"\xe0\x90\x88\x84\x84\x88\x90\xe0")
(defface breakpoint-enabled
'((t
:foreground "red1"
:weight bold))
"Face for enabled breakpoint icon in fringe."
:group 'gdb)
(defface breakpoint-disabled
'((((class color) (min-colors 88)) :foreground "grey70")
;; Ensure that on low-color displays that we end up something visible.
(((class color) (min-colors 8) (background light))
:foreground "black")
(((class color) (min-colors 8) (background dark))
:foreground "white")
(((type tty) (class mono))
:inverse-video t)
(t :background "gray"))
"Face for disabled breakpoint icon in fringe."
:group 'gdb)
\f
(defvar gdb-python-guile-commands-regexp
"python\\|python-interactive\\|pi\\|guile\\|guile-repl\\|gr"
"Regexp that matches Python and Guile commands supported by GDB.")
(defvar gdb-control-commands-regexp
(concat
"^\\("
"comm\\(a\\(n\\(ds?\\)?\\)?\\)?\\|if\\|while"
"\\|def\\(i\\(ne?\\)?\\)?\\|doc\\(u\\(m\\(e\\(nt?\\)?\\)?\\)?\\)?\\|"
gdb-python-guile-commands-regexp
"\\|while-stepping\\|stepp\\(i\\(ng?\\)?\\)?\\|ws\\|actions"
"\\)\\([[:blank:]]+\\([^[:blank:]]*\\)\\)?$")
"Regexp matching GDB commands that enter a recursive reading loop.
As long as GDB is in the recursive reading loop, it does not expect
commands to be prefixed by \"-interpreter-exec console\".")
(defun gdb-strip-string-backslash (string)
(replace-regexp-in-string "\\\\$" "" string))
(defun gdb-send (proc string)
"A comint send filter for gdb."
(with-current-buffer gud-comint-buffer
(let ((inhibit-read-only t))
(remove-text-properties (point-min) (point-max) '(face nil))))
;; mimic <RET> key to repeat previous command in GDB
(when (= gdb-control-level 0)
(if (not (string= "" string))
(if gdb-continuation
(setq gdb-last-command (concat gdb-continuation
(gdb-strip-string-backslash string)
" "))
(setq gdb-last-command (gdb-strip-string-backslash string)))
(if gdb-last-command (setq string gdb-last-command))
(setq gdb-continuation nil)))
(if (and (not gdb-continuation)
(or (string-match "^-" string)
(> gdb-control-level 0)))
;; Either MI command or we are feeding GDB's recursive reading loop.
(progn
(setq gdb-first-done-or-error t)
(process-send-string proc (concat string "\n"))
(if (and (string-match
(concat "^\\("
(if (eq system-type 'windows-nt) "\026" "\004")
"\\|,q\\|,quit\\|end\\)$")
string)
(> gdb-control-level 0))
(setq gdb-control-level (1- gdb-control-level))))
;; CLI command
(if (string-match "\\\\$" string)
(setq gdb-continuation
(concat gdb-continuation (gdb-strip-string-backslash
string)
" "))
(setq gdb-first-done-or-error t)
(let ((to-send (concat "-interpreter-exec console "
(gdb-mi-quote (concat gdb-continuation string))
"\n")))
(if gdb-enable-debug
(push (cons 'mi-send to-send) gdb-debug-log))
(process-send-string proc to-send))
(if (and (string-match
(concat "^\\("
(if (eq system-type 'windows-nt) "\026" "\004")
"\\|,q\\|,quit\\|end\\)$")
string)
(> gdb-control-level 0))
(setq gdb-control-level (1- gdb-control-level)))
(setq gdb-continuation nil)))
;; Python and Guile commands that have an argument don't enter the
;; recursive reading loop.
(let* ((control-command-p (string-match gdb-control-commands-regexp string))
(command-arg (and control-command-p (match-string 3 string)))
(python-or-guile-p (string-match gdb-python-guile-commands-regexp
string)))
(if (and control-command-p
(or (not python-or-guile-p)
(null command-arg)
(zerop (length command-arg))))
(setq gdb-control-level (1+ gdb-control-level)))))
(defun gdb-mi-quote (string)
"Return STRING quoted properly as an MI argument.
The string is enclosed in double quotes.
All embedded quotes, newlines, and backslashes are preceded with a backslash."
(setq string (replace-regexp-in-string "\\([\"\\]\\)" "\\\\\\&" string))
(setq string (replace-regexp-in-string "\n" "\\n" string t t))
(concat "\"" string "\""))
(defun gdb-input (command handler-function &optional trigger-name)
"Send COMMAND to GDB via the MI interface.
Run the function HANDLER-FUNCTION, with no arguments, once the command is
complete. Do not send COMMAND to GDB if TRIGGER-NAME is non-nil and
Emacs is still waiting for a reply from another command previously
sent with the same TRIGGER-NAME."
(when (or (not trigger-name)
(not (gdb-pending-handler-p trigger-name)))
(setq gdb-token-number (1+ gdb-token-number))
(setq command (concat (number-to-string gdb-token-number) command))
(if gdb-enable-debug (push (list 'send-item command handler-function)
gdb-debug-log))
(gdb-add-handler gdb-token-number handler-function trigger-name)
(if gdbmi-debug-mode (message "gdb-input: %s" command))
(process-send-string (get-buffer-process gud-comint-buffer)
(concat command "\n"))))
;; NOFRAME is used for gud execution control commands
(defun gdb-current-context-command (command)
"Add --thread to gdb COMMAND when needed."
(if (and gdb-thread-number
gdb-supports-non-stop)
(concat command " --thread " gdb-thread-number)
command))
(defun gdb-current-context-buffer-name (name)
"Add thread information and asterisks to string NAME.
If `gdb-thread-number' is nil, just wrap NAME in asterisks."
(concat "*" name
(if (local-variable-p 'gdb-thread-number)
(format " (bound to thread %s)" gdb-thread-number)
"")
"*"))
(defun gdb-current-context-mode-name (mode)
"Add thread information to MODE which is to be used as `mode-name'."
(concat mode
(if gdb-thread-number
(format " [thread %s]" gdb-thread-number)
"")))
\f
(defcustom gud-gdb-command-name "gdb -i=mi"
"Default command to execute an executable under the GDB debugger."
:type 'string
:group 'gdb)
(defun gdb-resync()
(setq gud-running nil)
(setq gdb-output-sink 'user)
(gdb-remove-all-pending-triggers))
(defun gdb-update (&optional no-proc)
"Update buffers showing status of debug session.
If NO-PROC is non-nil, do not try to contact the GDB process."
(when gdb-first-prompt
(gdb-force-mode-line-update
(propertize "initializing..." 'face font-lock-variable-name-face))
(gdb-init-1)
(setq gdb-first-prompt nil))
(unless no-proc
(gdb-get-main-selected-frame))
;; We may need to update gdb-threads-list so we can use
(gdb-get-buffer-create 'gdb-threads-buffer)
;; gdb-break-list is maintained in breakpoints handler
(gdb-get-buffer-create 'gdb-breakpoints-buffer)
(gdb-get-changed-registers)
(unless no-proc
(gdb-emit-signal gdb-buf-publisher 'update))
(when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame))
(dolist (var gdb-var-list)
(setcar (nthcdr 5 var) nil))
(gdb-var-update)))
;; gdb-setq-thread-number and gdb-update-gud-running are decoupled
;; because we may need to update current gud-running value without
;; changing current thread (see gdb-running)
(defun gdb-setq-thread-number (number)
"Set `gdb-thread-number' to NUMBER.
Only this function must be used to change `gdb-thread-number'
value to NUMBER, because `gud-running' and `gdb-frame-number'
need to be updated appropriately when current thread changes."
;; GDB 6.8 and earlier always output thread-id="0" when stopping.
(unless (string-equal number "0") (setq gdb-thread-number number))
(setq gdb-frame-number "0")
(gdb-update-gud-running))
(defun gdb-update-gud-running ()
"Set `gud-running' according to the state of current thread.
`gdb-frame-number' is set to 0 if current thread is now stopped.
Note that when `gdb-gud-control-all-threads' is t, `gud-running'
cannot be reliably used to determine whether or not execution
control buttons should be shown in menu or toolbar. Use
`gdb-running-threads-count' and `gdb-stopped-threads-count'
instead.
For all-stop mode, thread information is unavailable while target
is running."
(let ((old-value gud-running))
(setq gud-running
(string= (bindat-get-field (gdb-current-buffer-thread) 'state)
"running"))
;; Set frame number to "0" when _current_ threads stops.
(when (and (gdb-current-buffer-thread)
(not (eq gud-running old-value)))
(setq gdb-frame-number "0"))))
(defun gdb-show-run-p ()
"Return t if \"Run/continue\" should be shown on the toolbar."
(or (not gdb-active-process)
(and (or
(not gdb-gud-control-all-threads)
(not gdb-non-stop))
(not gud-running))
(and gdb-gud-control-all-threads
(> gdb-stopped-threads-count 0))))
(defun gdb-show-stop-p ()
"Return t if \"Stop\" should be shown on the toolbar."
(or (and (or
(not gdb-gud-control-all-threads)
(not gdb-non-stop))
gud-running)
(and gdb-gud-control-all-threads
(not (null gdb-running-threads-count))
(> gdb-running-threads-count 0))))
;; GUD displays the selected GDB frame. This might might not be the current
;; GDB frame (after up, down etc). If no GDB frame is visible but the last
;; visited breakpoint is, use that window.
(defun gdb-display-source-buffer (buffer)
(let* ((last-window (if gud-last-last-frame
(get-buffer-window
(gud-find-file (car gud-last-last-frame)))))
(source-window (or last-window
(if (and gdb-source-window
(window-live-p gdb-source-window))
gdb-source-window))))
(when source-window
(setq gdb-source-window source-window)
(set-window-buffer source-window buffer))
source-window))
(defun gdbmi-start-with (str offset match)
"Return non-nil if string STR starts with MATCH, else returns nil.
OFFSET is the position in STR at which the comparison takes place."
(let ((match-length (length match))
(str-length (- (length str) offset)))
(when (>= str-length match-length)
(string-equal match (substring str offset (+ offset match-length))))))
(defun gdbmi-same-start (str offset match)
"Return non-nil if STR and MATCH are equal up to the end of either strings.
OFFSET is the position in STR at which the comparison takes place."
(let* ((str-length (- (length str) offset))
(match-length (length match))
(compare-length (min str-length match-length)))
(when (> compare-length 0)
(string-equal (substring str offset (+ offset compare-length))
(substring match 0 compare-length)))))
(defun gdbmi-is-number (character)
"Return non-nil if CHARACTER is a numerical character between 0 and 9."
(and (>= character ?0)
(<= character ?9)))
(defvar-local gdbmi-bnf-state 'gdbmi-bnf-output
"Current GDB/MI output parser state.
The parser is placed in a different state when an incomplete data steam is
received from GDB.
This variable will preserve the state required to resume the parsing
when more data arrives.")
(defvar-local gdbmi-bnf-offset 0
"Offset in `gud-marker-acc' at which the parser is reading.
This offset is used to be able to parse the GDB/MI message
in-place, without the need of copying the string in a temporary buffer
or discarding parsed tokens by substringing the message.")
(defun gdbmi-bnf-init ()
"Initialize the GDB/MI message parser."
(setq gdbmi-bnf-state 'gdbmi-bnf-output)
(setq gdbmi-bnf-offset 0)
(setq gud-marker-acc ""))
(defun gdbmi-bnf-output ()
"Implementation of the following GDB/MI output grammar rule:
output ==>
( out-of-band-record )* [ result-record ] gdb-prompt"
(gdbmi-bnf-skip-unrecognized)
(while (gdbmi-bnf-out-of-band-record))
(gdbmi-bnf-result-record)
(gdbmi-bnf-gdb-prompt))
(defun gdbmi-bnf-skip-unrecognized ()
"Skip characters until is encounters the beginning of a valid record.
Used as a protection mechanism in case something goes wrong when parsing
a GDB/MI reply message."
(let ((acc-length (length gud-marker-acc))
(prefix-offset gdbmi-bnf-offset)
(prompt "(gdb) \n"))
(while (and (< prefix-offset acc-length)
(gdbmi-is-number (aref gud-marker-acc prefix-offset)))
(setq prefix-offset (1+ prefix-offset)))
(if (and (< prefix-offset acc-length)
(not (memq (aref gud-marker-acc prefix-offset)
'(?^ ?* ?+ ?= ?~ ?@ ?&)))
(not (gdbmi-same-start gud-marker-acc gdbmi-bnf-offset prompt))
(string-match "\\([^^*+=~@&]+\\)" gud-marker-acc
gdbmi-bnf-offset))
(let ((unrecognized-str (match-string 0 gud-marker-acc)))
(setq gdbmi-bnf-offset (match-end 0))
(if gdbmi-debug-mode
(message "gdbmi-bnf-skip-unrecognized: %s" unrecognized-str))
(gdb-shell unrecognized-str)
t))))
(defun gdbmi-bnf-gdb-prompt ()
"Implementation of the following GDB/MI output grammar rule:
gdb-prompt ==>
`(gdb)' nl
nl ==>
CR | CR-LF"
(let ((prompt "(gdb) \n"))
(when (gdbmi-start-with gud-marker-acc gdbmi-bnf-offset prompt)
(if gdbmi-debug-mode (message "gdbmi-bnf-gdb-prompt: %s" prompt))
(gdb-gdb prompt)
(setq gdbmi-bnf-offset (+ gdbmi-bnf-offset (length prompt)))
;; Returns non-nil to tell gud-gdbmi-marker-filter we've reached
;; the end of a GDB reply message.
t)))
(defun gdbmi-bnf-result-record ()
"Implementation of the following GDB/MI output grammar rule:
result-record ==>
[ token ] `^' result-class ( `,' result )* nl
token ==>
any sequence of digits."
(gdbmi-bnf-result-and-async-record-impl))
(defun gdbmi-bnf-out-of-band-record ()
"Implementation of the following GDB/MI output grammar rule:
out-of-band-record ==>
async-record | stream-record"
(or (gdbmi-bnf-async-record)
(gdbmi-bnf-stream-record)))
(defun gdbmi-bnf-async-record ()
"Implementation of the following GDB/MI output grammar rules:
async-record ==>
exec-async-output | status-async-output | notify-async-output
exec-async-output ==>
[ token ] `*' async-output
status-async-output ==>
[ token ] `+' async-output
notify-async-output ==>
[ token ] `=' async-output
async-output ==>
async-class ( `,' result )* nl"
(gdbmi-bnf-result-and-async-record-impl))
(defun gdbmi-bnf-stream-record ()
"Implement the following GDB/MI output grammar rule:
stream-record ==>
console-stream-output | target-stream-output | log-stream-output
console-stream-output ==>
`~' c-string
target-stream-output ==>
`@' c-string
log-stream-output ==>
`&' c-string"
(when (< gdbmi-bnf-offset (length gud-marker-acc))
(if (and (member (aref gud-marker-acc gdbmi-bnf-offset) '(?~ ?@ ?&))
(string-match (concat "\\([~@&]\\)\\(" gdb--string-regexp "\\)\n")
gud-marker-acc
gdbmi-bnf-offset))
(let ((prefix (match-string 1 gud-marker-acc))
(c-string (match-string 2 gud-marker-acc)))
(setq gdbmi-bnf-offset (match-end 0))
(if gdbmi-debug-mode (message "gdbmi-bnf-stream-record: %s"
(match-string 0 gud-marker-acc)))
(cond ((string-equal prefix "~")
(gdbmi-bnf-console-stream-output c-string))
((string-equal prefix "@")
(gdbmi-bnf-target-stream-output c-string))
((string-equal prefix "&")
(gdbmi-bnf-log-stream-output c-string)))
t))))
(defun gdbmi-bnf-console-stream-output (c-string)
"Handler for the console-stream-output GDB/MI output grammar rule."
(gdb-console c-string)
;; We've written to the GUD console, so we should print the prompt
;; after the next result-class or async-class.
(setq gdb-first-done-or-error t))
(defun gdbmi-bnf-target-stream-output (_c-string)
"Handler for the target-stream-output GDB/MI output grammar rule."
;; Not currently used.
)
(defun gdbmi-bnf-log-stream-output (c-string)
"Handler for the log-stream-output GDB/MI output grammar rule."
;; Suppress "No registers." GDB 6.8 and earlier
;; duplicates MI error message on internal stream.
;; Don't print to GUD buffer.
(if (not (string-equal (read c-string) "No registers.\n"))
(gdb-internals c-string)))
(defconst gdbmi-bnf-result-state-configs
'(("^" . (("done" . (gdb-done . progressive))
("error" . (gdb-error . progressive))
("running" . (gdb-starting . atomic))))
("*" . (("stopped" . (gdb-stopped . atomic))
("running" . (gdb-running . atomic))))
("+" . ())
("=" . (("thread-created" . (gdb-thread-created . atomic))
("thread-selected" . (gdb-thread-selected . atomic))
("thread-existed" . (gdb-ignored-notification . atomic))
('default . (gdb-ignored-notification . atomic)))))
"Alist of alists, mapping the type and class of message to a handler function.
Handler functions are all flagged as either `progressive' or `atomic'.
`progressive' handlers are capable of parsing incomplete messages.
They can be called several time with new data chunk as they arrive from GDB.
`progressive' handlers must have an extra argument that is set to a non-nil
value when the message is complete.
Implement the following GDB/MI output grammar rule:
result-class ==>
`done' | `running' | `connected' | `error' | `exit'
async-class ==>
`stopped' | others (where others will be added depending on the needs
--this is still in development).")
(defun gdbmi-bnf-result-and-async-record-impl ()
"Common implementation of the result-record and async-record rule.
Both rules share the same syntax. Those records may be very large in size.
For that reason, the \"result\" part of the record is parsed by
`gdbmi-bnf-incomplete-record-result', which will keep
receiving characters as they arrive from GDB until the record is complete."
(let ((acc-length (length gud-marker-acc))
(prefix-offset gdbmi-bnf-offset))
(while (and (< prefix-offset acc-length)
(gdbmi-is-number (aref gud-marker-acc prefix-offset)))
(setq prefix-offset (1+ prefix-offset)))
(if (and (< prefix-offset acc-length)
(member (aref gud-marker-acc prefix-offset) '(?* ?+ ?= ?^))
(string-match "\\([0-9]*\\)\\([*+=^]\\)\\(.+?\\)\\([,\n]\\)"
gud-marker-acc gdbmi-bnf-offset))
(let ((token (match-string 1 gud-marker-acc))
(prefix (match-string 2 gud-marker-acc))
(class (match-string 3 gud-marker-acc))
(complete (string-equal (match-string 4 gud-marker-acc) "\n"))
class-alist
class-command)
(setq gdbmi-bnf-offset (match-end 0))
(if gdbmi-debug-mode (message "gdbmi-bnf-result-record: %s"
(match-string 0 gud-marker-acc)))
(setq class-alist
(cdr (assoc prefix gdbmi-bnf-result-state-configs)))
(setq class-command (cdr (assoc class class-alist)))
(if (null class-command)
(setq class-command (cdr (assoc 'default class-alist))))
(if complete
(if class-command
(if (equal (cdr class-command) 'progressive)
(funcall (car class-command) token "" complete)
(funcall (car class-command) token "")))
(setq gdbmi-bnf-state
(lambda ()
(gdbmi-bnf-incomplete-record-result token class-command)))
(funcall gdbmi-bnf-state))
t))))
(defun gdbmi-bnf-incomplete-record-result (token class-command)
"State of the parser used to progressively parse a result-record or async-record
rule from an incomplete data stream. The parser will stay in this state until
the end of the current result or async record is reached."
(when (< gdbmi-bnf-offset (length gud-marker-acc))
;; Search the data stream for the end of the current record:
(let* ((newline-pos (string-match "\n" gud-marker-acc gdbmi-bnf-offset))
(is-progressive (equal (cdr class-command) 'progressive))
(is-complete (not (null newline-pos)))
result-str)
(when gdbmi-debug-mode
(message "gdbmi-bnf-incomplete-record-result: %s"
(substring gud-marker-acc gdbmi-bnf-offset newline-pos)))
;; Update the gdbmi-bnf-offset only if the current chunk of data can
;; be processed by the class-command handler:
(when (or is-complete is-progressive)
(setq result-str
(substring gud-marker-acc gdbmi-bnf-offset newline-pos))
;; Move gdbmi-bnf-offset past the end of the chunk.
(setq gdbmi-bnf-offset (+ gdbmi-bnf-offset (length result-str)))
(when newline-pos
(setq gdbmi-bnf-offset (1+ gdbmi-bnf-offset))))
;; Update the parsing state before invoking the handler in class-command
;; to make sure it's not left in an invalid state if the handler was
;; to generate an error.
(if is-complete
(setq gdbmi-bnf-state 'gdbmi-bnf-output))
(if class-command
(if is-progressive
(funcall (car class-command) token result-str is-complete)
(if is-complete
(funcall (car class-command) token result-str))))
(unless is-complete
;; Incomplete gdb response: abort parsing until we receive more data.
(if gdbmi-debug-mode (message "gdbmi-bnf-incomplete-record-result, aborting: incomplete stream"))
(throw 'gdbmi-incomplete-stream nil))
is-complete)))
; The following grammar rules are not yet implemented by this GDBMI-BNF parser.
; The handling of those rules is currently done by the handlers registered
; in gdbmi-bnf-result-state-configs
;
; result ==>
; variable "=" value
;
; variable ==>
; string
;
; value ==>
; const | tuple | list
;
; const ==>
; c-string
;
; tuple ==>
; "{}" | "{" result ( "," result )* "}"
;
; list ==>
; "[]" | "[" value ( "," value )* "]" | "[" result ( "," result )* "]"
(defcustom gdb-mi-decode-strings nil
"When non-nil, decode octal escapes in GDB output into non-ASCII text.
If the value is a coding-system, use that coding-system to decode
the bytes reconstructed from octal escapes. Any other non-nil value
means to decode using the coding-system set for the GDB process.
Warning: setting this non-nil might mangle strings reported by GDB
that have literal substrings which match the \\nnn octal escape
patterns, where nnn is an octal number between 200 and 377. So
we only recommend to set this variable non-nil if the program you
are debugging really reports non-ASCII text, or some of its source
file names include non-ASCII characters."
:type '(choice
(const :tag "Don't decode" nil)
(const :tag "Decode using default coding-system" t)
(coding-system :tag "Decode using this coding-system"))
:group 'gdb
:version "25.1")
;; The idea of the following function was suggested
;; by Kenichi Handa <handa@gnu.org>.
;;
;; FIXME: This is fragile: it relies on the assumption that all the
;; non-ASCII strings output by GDB, including names of the source
;; files, values of string variables in the inferior, etc., are all
;; encoded in the same encoding. It also assumes that the \nnn
;; sequences are not split between chunks of output of the GDB process
;; due to buffering, and arrive together. Finally, if some string
;; included literal \nnn strings (as opposed to non-ASCII characters
;; converted by GDB/MI to octal escapes), this decoding will mangle
;; those strings. When/if GDB acquires the ability to not
;; escape-protect non-ASCII characters in its MI output, this kludge
;; should be removed.
(defun gdb-mi-decode (string)
"Decode octal escapes in MI output STRING into multibyte text."
(let ((coding
(if (coding-system-p gdb-mi-decode-strings)
gdb-mi-decode-strings
(with-current-buffer
(gdb-get-buffer-create 'gdb-partial-output-buffer)
buffer-file-coding-system))))
(with-temp-buffer
(set-buffer-multibyte nil)
(prin1 string (current-buffer))
(goto-char (point-min))
;; prin1 quotes the octal escapes as well, which interferes with
;; their interpretation by 'read' below. Remove the extra
;; backslashes to countermand that.
(while (re-search-forward "\\\\\\(\\\\[2-3][0-7][0-7]\\)" nil t)
(replace-match "\\1" nil nil))
(goto-char (point-min))
(decode-coding-string (read (current-buffer)) coding))))
(defun gud-gdbmi-marker-filter (string)
"Filter GDB/MI output."
;; If required, decode non-ASCII text encoded with octal escapes.
(or (null gdb-mi-decode-strings)
(setq string (gdb-mi-decode string)))
;; Record transactions if logging is enabled.
(when gdb-enable-debug
(push (cons 'recv string) gdb-debug-log)
(if (and gdb-debug-log-max
(> (length gdb-debug-log) gdb-debug-log-max))
(setcdr (nthcdr (1- gdb-debug-log-max) gdb-debug-log) nil)))
;; Recall the left over gud-marker-acc from last time.
(setq gud-marker-acc (concat gud-marker-acc string))
;; Start accumulating output for the GUD buffer.
(setq gdb-filter-output "")
(let ((acc-length (length gud-marker-acc)))
(catch 'gdbmi-incomplete-stream
(while (and (< gdbmi-bnf-offset acc-length)
(funcall gdbmi-bnf-state)))))
(when (/= gdbmi-bnf-offset 0)
(setq gud-marker-acc (substring gud-marker-acc gdbmi-bnf-offset))
(setq gdbmi-bnf-offset 0))
(when (and gdbmi-debug-mode (> (length gud-marker-acc) 0))
(message "gud-gdbmi-marker-filter, unparsed string: %s" gud-marker-acc))
gdb-filter-output)
(defun gdb-gdb (_output-field))
(defun gdb-shell (output-field)
(setq gdb-filter-output
(concat output-field gdb-filter-output)))
(defun gdb-ignored-notification (_token _output-field))
;; gdb-invalidate-threads is defined to accept 'update-threads signal
(defun gdb-thread-created (_token _output-field))
(defun gdb-thread-exited (_token output-field)
"Handle =thread-exited async record.
Unset `gdb-thread-number' if current thread exited and update threads list."
(let* ((thread-id (bindat-get-field (gdb-json-string output-field) 'id)))
(if (string= gdb-thread-number thread-id)
(gdb-setq-thread-number nil))
;; When we continue current thread and it quickly exits,
;; the pending triggers in gdb-handler-list left after gdb-running
;; disallow us to properly call -thread-info without --thread option.
;; Thus we need to use gdb-wait-for-pending.
(gdb-wait-for-pending
(gdb-emit-signal gdb-buf-publisher 'update-threads))))
(defun gdb-thread-selected (_token output-field)
"Handler for =thread-selected MI output record.
Sets `gdb-thread-number' to new id."
(let* ((result (gdb-json-string output-field))
(thread-id (bindat-get-field result 'id)))
(gdb-setq-thread-number thread-id)
;; Typing `thread N' in GUD buffer makes GDB emit `^done' followed
;; by `=thread-selected' notification. `^done' causes `gdb-update'
;; as usually. Things happen too fast and second call (from
;; gdb-thread-selected handler) gets cut off by our beloved
;; pending triggers.
;; Solution is `gdb-wait-for-pending' macro: it guarantees that its
;; body will get executed when `gdb-handler-list' if free of
;; pending triggers.
(gdb-wait-for-pending
(gdb-update))))
(defun gdb-running (_token output-field)
(let* ((thread-id
(bindat-get-field (gdb-json-string output-field) 'thread-id)))
;; We reset gdb-frame-number to nil if current thread has gone
;; running. This can't be done in gdb-thread-list-handler-custom
;; because we need correct gdb-frame-number by the time
;; -thread-info command is sent.
(when (or (string-equal thread-id "all")
(string-equal thread-id gdb-thread-number))
(setq gdb-frame-number nil)))
(setq gdb-inferior-status "running")
(gdb-force-mode-line-update
(propertize gdb-inferior-status 'face font-lock-type-face))
(when (not gdb-non-stop)
(setq gud-running t))
(setq gdb-active-process t))
(defun gdb-starting (_output-field _result)
;; CLI commands don't emit ^running at the moment so use gdb-running too.
(setq gdb-inferior-status "running")
(gdb-force-mode-line-update
(propertize gdb-inferior-status 'face font-lock-type-face))
(setq gdb-active-process t)
(setq gud-running t))
;; -break-insert -t didn't give a reason before gdb 6.9
(defun gdb-stopped (_token output-field)
"Given the contents of *stopped MI async record, select new
current thread and update GDB buffers."
;; Reason is available with target-async only
(let* ((result (gdb-json-string output-field))
(reason (bindat-get-field result 'reason))
(thread-id (bindat-get-field result 'thread-id))
(retval (bindat-get-field result 'return-value))
(varnum (bindat-get-field result 'gdb-result-var)))
;; -data-list-register-names needs to be issued for any stopped
;; thread
(when (not gdb-register-names)
(gdb-input (concat "-data-list-register-names"
(if gdb-supports-non-stop
(concat " --thread " thread-id)))
'gdb-register-names-handler))
;; Don't set gud-last-frame here as it's currently done in
;; gdb-frame-handler because synchronous GDB doesn't give these fields
;; with CLI.
;;(when file
;; (setq
;; ;; Extract the frame position from the marker.
;; gud-last-frame (cons file
;; (string-to-number
;; (match-string 6 gud-marker-acc)))))
(setq gdb-inferior-status (or reason "unknown"))
(gdb-force-mode-line-update
(propertize gdb-inferior-status 'face font-lock-warning-face))
(if (string-equal reason "exited-normally")
(setq gdb-active-process nil))
(when (and retval varnum
;; When the user typed CLI commands, GDB/MI helpfully
;; includes the "Value returned" response in the "~"
;; record; here we avoid displaying it twice.
(not (string-match "^Value returned is " gdb-filter-output)))
(setq gdb-filter-output
(concat gdb-filter-output
(format "Value returned is %s = %s\n" varnum retval))))
;; Select new current thread.
;; Don't switch if we have no reasons selected
(when gdb-switch-reasons
;; Switch from another stopped thread only if we have
;; gdb-switch-when-another-stopped:
(when (or gdb-switch-when-another-stopped
(not (string= "stopped"
(bindat-get-field (gdb-current-buffer-thread) 'state))))
;; Switch if current reason has been selected or we have no
;; reasons
(if (or (eq gdb-switch-reasons t)
(member reason gdb-switch-reasons))
(when (not (string-equal gdb-thread-number thread-id))
(message "Switched to thread %s" thread-id)
(gdb-setq-thread-number thread-id))
(message "Thread %s stopped" thread-id))))
;; Print "(gdb)" to GUD console
(when gdb-first-done-or-error
(setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
;; In non-stop, we update information as soon as another thread gets
;; stopped
(when (or gdb-first-done-or-error
gdb-non-stop)
;; In all-stop this updates gud-running properly as well.
(gdb-update)
(setq gdb-first-done-or-error nil))
(run-hook-with-args 'gdb-stopped-functions result)))
;; Remove the trimmings from log stream containing debugging messages
;; being produced by GDB's internals, use warning face and send to GUD
;; buffer.
(defun gdb-internals (output-field)
(setq gdb-filter-output
(gdb-concat-output
gdb-filter-output
(if (string= output-field "\"\\n\"")
""
(let ((error-message
(read output-field)))
(put-text-property
0 (length error-message)
'face font-lock-warning-face
error-message)
error-message)))))
;; Remove the trimmings from the console stream and send to GUD buffer
;; (frontend MI commands should not print to this stream)
(defun gdb-console (output-field)
(setq gdb-filter-output
(gdb-concat-output gdb-filter-output (read output-field))))
(defun gdb-done (token-number output-field is-complete)
(gdb-done-or-error token-number 'done output-field is-complete))
(defun gdb-error (token-number output-field is-complete)
(gdb-done-or-error token-number 'error output-field is-complete))
(defun gdb-done-or-error (token-number type output-field is-complete)
(if (string-equal token-number "")
;; Output from command entered by user
(progn
(setq gdb-output-sink 'user)
(setq token-number nil)
;; MI error - send to minibuffer
(when (eq type 'error)
;; Skip "msg=" from `output-field'
(message "%s" (read (substring output-field 4)))
;; Don't send to the console twice. (If it is a console error
;; it is also in the console stream.)
(setq output-field nil)))
;; Output from command from frontend.
(setq gdb-output-sink 'emacs))
;; The process may already be dead (e.g. C-d at the gdb prompt).
(let* ((proc (get-buffer-process gud-comint-buffer))
(no-proc (or (null proc)
(memq (process-status proc) '(exit signal)))))
(when (and is-complete gdb-first-done-or-error)
(unless (or token-number gud-running no-proc)
(setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
(gdb-update no-proc)
(setq gdb-first-done-or-error nil))
(setq gdb-filter-output
(gdb-concat-output gdb-filter-output output-field))
;; We are done concatenating to the output sink. Restore it to user sink:
(setq gdb-output-sink 'user)
(when (and token-number is-complete)
(with-current-buffer
(gdb-get-buffer-create 'gdb-partial-output-buffer)
(gdb-handle-reply (string-to-number token-number))))
(when is-complete
(gdb-clear-partial-output))))
(defun gdb-concat-output (so-far new)
(cond
((eq gdb-output-sink 'user) (concat so-far new))
((eq gdb-output-sink 'emacs)
(gdb-append-to-partial-output new)
so-far)))
(defun gdb-append-to-partial-output (string)
(with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
(goto-char (point-max))
(insert string)))
(defun gdb-clear-partial-output ()
(with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
(erase-buffer)))
(defun gdb-jsonify-buffer (&optional fix-key fix-list)
"Prepare GDB/MI output in current buffer for parsing with `json-read'.
Field names are wrapped in double quotes and equal signs are
replaced with semicolons.
If FIX-KEY is non-nil, strip all \"FIX-KEY=\" occurrences from
partial output. This is used to get rid of useless keys in lists
in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and
-break-info are examples of MI commands which issue such
responses.
If FIX-LIST is non-nil, \"FIX-LIST={..}\" is replaced with
\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken
-break-info output when it contains breakpoint script field
incompatible with GDB/MI output syntax.
If `default-directory' is remote, full file names are adapted accordingly."
(save-excursion
(let ((remote (file-remote-p default-directory)))
(when remote
(goto-char (point-min))
(while (re-search-forward "[\\[,]fullname=\"\\(.+\\)\"" nil t)
(replace-match (concat remote "\\1") nil nil nil 1))))
(goto-char (point-min))
(when fix-key
(save-excursion
(while (re-search-forward (concat "[\\[,]\\(" fix-key "=\\)") nil t)
(replace-match "" nil nil nil 1))))
(when fix-list
(save-excursion
;; Find positions of braces which enclose broken list
(while (re-search-forward (concat fix-list "={\"") nil t)
(let ((p1 (goto-char (- (point) 2)))
(p2 (progn (forward-sexp)
(1- (point)))))
;; Replace braces with brackets
(save-excursion
(goto-char p1)
(delete-char 1)
(insert "[")
(goto-char p2)
(delete-char 1)
(insert "]"))))))
(goto-char (point-min))
(insert "{")
(let ((re (concat "\\([[:alnum:]_-]+\\)=")))
(while (re-search-forward re nil t)
(replace-match "\"\\1\":" nil nil)
(if (eq (char-after) ?\") (forward-sexp) (forward-char))))
(goto-char (point-max))
(insert "}")))
(defun gdb-json-read-buffer (&optional fix-key fix-list)
"Prepare and parse GDB/MI output in current buffer with `json-read'.
FIX-KEY and FIX-LIST work as in `gdb-jsonify-buffer'."
(gdb-jsonify-buffer fix-key fix-list)
(save-excursion
(goto-char (point-min))
(let ((json-array-type 'list))
(json-read))))
(defun gdb-json-string (string &optional fix-key fix-list)
"Prepare and parse STRING containing GDB/MI output with `json-read'.
FIX-KEY and FIX-LIST work as in `gdb-jsonify-buffer'."
(with-temp-buffer
(insert string)
(gdb-json-read-buffer fix-key fix-list)))
(defun gdb-json-partial-output (&optional fix-key fix-list)
"Prepare and parse gdb-partial-output-buffer with `json-read'.
FIX-KEY and FIX-KEY work as in `gdb-jsonify-buffer'."
(with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
(gdb-json-read-buffer fix-key fix-list)))
(defun gdb-line-posns (line)
"Return a pair of LINE beginning and end positions."
(let ((offset (1+ (- line (line-number-at-pos)))))
(cons
(line-beginning-position offset)
(line-end-position offset))))
(defmacro gdb-mark-line (line variable)
"Set VARIABLE marker to point at beginning of LINE.
If current window has no fringes, inverse colors on LINE.
Return position where LINE begins."
`(save-excursion
(let* ((posns (gdb-line-posns ,line))
(start-posn (car posns))
(end-posn (cdr posns)))
(set-marker ,variable (copy-marker start-posn))
(when (not (> (car (window-fringes)) 0))
(put-text-property start-posn end-posn
'font-lock-face '(:inverse-video t)))
start-posn)))
(defun gdb-pad-string (string padding)
(format (concat "%" (number-to-string padding) "s") string))
;; gdb-table struct is a way to programmatically construct simple
;; tables. It help to reliably align columns of data in GDB buffers
;; and provides
(cl-defstruct gdb-table
(column-sizes nil)
(rows nil)
(row-properties nil)
(right-align nil))
(defun gdb-table-add-row (table row &optional properties)
"Add ROW of string to TABLE and recalculate column sizes.
When non-nil, PROPERTIES will be added to the whole row when
calling `gdb-table-string'."
(let ((rows (gdb-table-rows table))
(row-properties (gdb-table-row-properties table))
(column-sizes (gdb-table-column-sizes table))
(right-align (gdb-table-right-align table)))
(when (not column-sizes)
(setf (gdb-table-column-sizes table)
(make-list (length row) 0)))
(setf (gdb-table-rows table)
(append rows (list row)))
(setf (gdb-table-row-properties table)
(append row-properties (list properties)))
(setf (gdb-table-column-sizes table)
(cl-mapcar (lambda (x s)
(let ((new-x
(max (abs x) (string-width (or s "")))))
(if right-align new-x (- new-x))))
(gdb-table-column-sizes table)
row))
;; Avoid trailing whitespace at eol
(if (not (gdb-table-right-align table))
(setcar (last (gdb-table-column-sizes table)) 0))))
(defun gdb-table-string (table &optional sep)
"Return TABLE as a string with columns separated with SEP."
(let ((column-sizes (gdb-table-column-sizes table)))
(mapconcat
'identity
(cl-mapcar
(lambda (row properties)
(apply 'propertize
(mapconcat 'identity
(cl-mapcar (lambda (s x) (gdb-pad-string s x))
row column-sizes)
sep)
properties))
(gdb-table-rows table)
(gdb-table-row-properties table))
"\n")))
;; bindat-get-field goes deep, gdb-get-many-fields goes wide
(defun gdb-get-many-fields (struct &rest fields)
"Return a list of FIELDS values from STRUCT."
(let ((values))
(dolist (field fields)
(push (bindat-get-field struct field) values))
(nreverse values)))
(defmacro def-gdb-auto-update-trigger (trigger-name gdb-command
handler-name
&optional signal-list)
"Define a trigger TRIGGER-NAME which sends GDB-COMMAND and sets
HANDLER-NAME as its handler. HANDLER-NAME is bound to current
buffer with `gdb-bind-function-to-buffer'.
If SIGNAL-LIST is non-nil, GDB-COMMAND is sent only when the
defined trigger is called with an argument from SIGNAL-LIST. It's
not recommended to define triggers with empty SIGNAL-LIST.
Normally triggers should respond at least to the `update' signal.
Normally the trigger defined by this command must be called from
the buffer where HANDLER-NAME must work. This should be done so
that buffer-local thread number may be used in GDB-COMMAND (by
calling `gdb-current-context-command').
`gdb-bind-function-to-buffer' is used to achieve this, see
`gdb-get-buffer-create'.
Triggers defined by this command are meant to be used as a
trigger argument when describing buffer types with
`gdb-set-buffer-rules'."
`(defun ,trigger-name (&optional signal)
(when
(or (not ,signal-list)
(memq signal ,signal-list))
(gdb-input ,gdb-command
(gdb-bind-function-to-buffer ',handler-name (current-buffer))
(cons (current-buffer) ',trigger-name)))))
;; Used by disassembly buffer only, the rest use
;; def-gdb-trigger-and-handler
(defmacro def-gdb-auto-update-handler (handler-name custom-defun
&optional nopreserve)
"Define a handler HANDLER-NAME calling CUSTOM-DEFUN.
Handlers are normally called from the buffers they put output in.
Erase current buffer and evaluate CUSTOM-DEFUN.
Then call `gdb-update-buffer-name'.
If NOPRESERVE is non-nil, window point is not restored after CUSTOM-DEFUN."
`(defun ,handler-name ()
(let* ((inhibit-read-only t)
,@(unless nopreserve
'((window (get-buffer-window (current-buffer) 0))
(start (window-start window))
(p (window-point window)))))
(erase-buffer)
(,custom-defun)
(gdb-update-buffer-name)
,@(when (not nopreserve)
'((set-window-start window start)
(set-window-point window p))))))
(defmacro def-gdb-trigger-and-handler (trigger-name gdb-command
handler-name custom-defun
&optional signal-list)
"Define trigger and handler.
TRIGGER-NAME trigger is defined to send GDB-COMMAND.
See `def-gdb-auto-update-trigger'.
HANDLER-NAME handler uses customization of CUSTOM-DEFUN.
See `def-gdb-auto-update-handler'."
`(progn
(def-gdb-auto-update-trigger ,trigger-name
,gdb-command
,handler-name ,signal-list)
(def-gdb-auto-update-handler ,handler-name
,custom-defun)))
\f
;; Breakpoint buffer : This displays the output of `-break-list'.
(def-gdb-trigger-and-handler
gdb-invalidate-breakpoints "-break-list"
gdb-breakpoints-list-handler gdb-breakpoints-list-handler-custom
'(start update))
(gdb-set-buffer-rules
'gdb-breakpoints-buffer
'gdb-breakpoints-buffer-name
'gdb-breakpoints-mode
'gdb-invalidate-breakpoints)
(defun gdb-breakpoints-list-handler-custom ()
(let ((breakpoints-list (bindat-get-field
(gdb-json-partial-output "bkpt" "script")
'BreakpointTable 'body))
(table (make-gdb-table)))
(setq gdb-breakpoints-list nil)
(gdb-table-add-row table '("Num" "Type" "Disp" "Enb" "Addr" "Hits" "What"))
(dolist (breakpoint breakpoints-list)
(add-to-list 'gdb-breakpoints-list
(cons (bindat-get-field breakpoint 'number)
breakpoint))
(let ((at (bindat-get-field breakpoint 'at))
(pending (bindat-get-field breakpoint 'pending))
(func (bindat-get-field breakpoint 'func))
(type (bindat-get-field breakpoint 'type)))
(gdb-table-add-row table
(list
(bindat-get-field breakpoint 'number)
(or type "")
(or (bindat-get-field breakpoint 'disp) "")
(let ((flag (bindat-get-field breakpoint 'enabled)))
(if (string-equal flag "y")
(eval-when-compile
(propertize "y" 'font-lock-face
font-lock-warning-face))
(eval-when-compile
(propertize "n" 'font-lock-face
font-lock-comment-face))))
(bindat-get-field breakpoint 'addr)
(or (bindat-get-field breakpoint 'times) "")
(if (and type (string-match ".*watchpoint" type))
(bindat-get-field breakpoint 'what)
(or pending at
(concat "in "
(propertize (or func "unknown")
'font-lock-face font-lock-function-name-face)
(gdb-frame-location breakpoint)))))
;; Add clickable properties only for breakpoints with file:line
;; information
(append (list 'gdb-breakpoint breakpoint)
(when func '(help-echo "mouse-2, RET: visit breakpoint"
mouse-face highlight))))))
(insert (gdb-table-string table " "))
(gdb-place-breakpoints)))
;; Put breakpoint icons in relevant margins (even those set in the GUD buffer).
(defun gdb-place-breakpoints ()
;; Remove all breakpoint-icons in source buffers but not assembler buffer.
(dolist (buffer (buffer-list))
(with-current-buffer buffer
(if (and (eq gud-minor-mode 'gdbmi)
(not (string-match "\\` ?\\*.+\\*\\'" (buffer-name))))
(gdb-remove-breakpoint-icons (point-min) (point-max)))))
(dolist (breakpoint gdb-breakpoints-list)
(let* ((breakpoint (cdr breakpoint)) ; gdb-breakpoints-list is
; an associative list
(line (bindat-get-field breakpoint 'line)))
(when line
(let ((file (bindat-get-field breakpoint 'fullname))
(flag (bindat-get-field breakpoint 'enabled))
(bptno (bindat-get-field breakpoint 'number)))
(unless (and file (file-exists-p file))
(setq file (cdr (assoc bptno gdb-location-alist))))
(if (or (null file)
(string-equal file "File not found"))
;; If the full filename is not recorded in the
;; breakpoint structure or in `gdb-location-alist', use
;; -file-list-exec-source-file to extract it.
(when (setq file (bindat-get-field breakpoint 'file))
(gdb-input (concat "list " file ":1") 'ignore)
(gdb-input "-file-list-exec-source-file"
`(lambda () (gdb-get-location
,bptno ,line ,flag))))
(with-current-buffer (find-file-noselect file 'nowarn)
(gdb-init-buffer)
;; Only want one breakpoint icon at each location.
(gdb-put-breakpoint-icon (string-equal flag "y") bptno
(string-to-number line)))))))))
(defconst gdb-source-file-regexp
(concat "fullname=\\(" gdb--string-regexp "\\)"))
(defun gdb-get-location (bptno line flag)
"Find the directory containing the relevant source file.
Put in buffer and place breakpoint icon."
(goto-char (point-min))
(catch 'file-not-found
(if (re-search-forward gdb-source-file-regexp nil t)
(delete (cons bptno "File not found") gdb-location-alist)
;; FIXME: Why/how do we use (match-string 1) when the search failed?
(push (cons bptno (match-string 1)) gdb-location-alist)
(gdb-resync)
(unless (assoc bptno gdb-location-alist)
(push (cons bptno "File not found") gdb-location-alist)
(message-box "Cannot find source file for breakpoint location.
Add directory to search path for source files using the GDB command, dir."))
(throw 'file-not-found nil))
(with-current-buffer (find-file-noselect (match-string 1))
(gdb-init-buffer)
;; only want one breakpoint icon at each location
(gdb-put-breakpoint-icon (eq flag ?y) bptno (string-to-number line)))))
(add-hook 'find-file-hook 'gdb-find-file-hook)
(defun gdb-find-file-hook ()
"Set up buffer for debugging if file is part of the source code
of the current session."
(if (and (buffer-name gud-comint-buffer)
;; in case gud or gdb-ui is just loaded
gud-comint-buffer
(eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
'gdbmi))
(if (member buffer-file-name gdb-source-file-list)
(with-current-buffer (find-buffer-visiting buffer-file-name)
(gdb-init-buffer)))))
(declare-function gud-remove "gdb-mi" t t) ; gud-def
(declare-function gud-break "gdb-mi" t t) ; gud-def
(declare-function fringe-bitmaps-at-pos "fringe.c" (&optional pos window))
(defun gdb-mouse-set-clear-breakpoint (event)
"Set/clear breakpoint in left fringe/margin at mouse click.
If not in a source or disassembly buffer just set point."
(interactive "e")
(mouse-minibuffer-check event)
(let ((posn (event-end event)))
(with-selected-window (posn-window posn)
(if (or (buffer-file-name) (derived-mode-p 'gdb-disassembly-mode))
(if (numberp (posn-point posn))
(save-excursion
(goto-char (posn-point posn))
(if (or (posn-object posn)
(eq (car (fringe-bitmaps-at-pos (posn-point posn)))
'breakpoint))
(gud-remove nil)
(gud-break nil)))))
(posn-set-point posn))))
(defun gdb-mouse-toggle-breakpoint-margin (event)
"Enable/disable breakpoint in left margin with mouse click."
(interactive "e")
(mouse-minibuffer-check event)
(let ((posn (event-end event)))
(if (numberp (posn-point posn))
(with-selected-window (posn-window posn)
(save-excursion
(goto-char (posn-point posn))
(if (posn-object posn)
(gud-basic-call
(let ((bptno (get-text-property
0 'gdb-bptno (car (posn-string posn)))))
(concat
(if (get-text-property
0 'gdb-enabled (car (posn-string posn)))
"-break-disable "
"-break-enable ")
bptno)))))))))
(defun gdb-mouse-toggle-breakpoint-fringe (event)
"Enable/disable breakpoint in left fringe with mouse click."
(interactive "e")
(mouse-minibuffer-check event)
(let* ((posn (event-end event))
(pos (posn-point posn))
obj)
(when (numberp pos)
(with-selected-window (posn-window posn)
(with-current-buffer (window-buffer)
(goto-char pos)
(dolist (overlay (overlays-in pos pos))
(when (overlay-get overlay 'put-break)
(setq obj (overlay-get overlay 'before-string))))
(when (stringp obj)
(gud-basic-call
(concat
(if (get-text-property 0 'gdb-enabled obj)
"-break-disable "
"-break-enable ")
(get-text-property 0 'gdb-bptno obj)))))))))
(defun gdb-breakpoints-buffer-name ()
(concat "*breakpoints of " (gdb-get-target-string) "*"))
(defun gdb-display-breakpoints-buffer (&optional thread)
"Display GDB breakpoints."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-breakpoints-buffer thread)))
(defun gdb-frame-breakpoints-buffer (&optional thread)
"Display GDB breakpoints in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-breakpoints-buffer thread)
gdb-display-buffer-other-frame-action))
(defvar gdb-breakpoints-mode-map
(let ((map (make-sparse-keymap))
(menu (make-sparse-keymap "Breakpoints")))
(define-key menu [quit] '("Quit" . gdb-delete-frame-or-window))
(define-key menu [goto] '("Goto" . gdb-goto-breakpoint))
(define-key menu [delete] '("Delete" . gdb-delete-breakpoint))
(define-key menu [toggle] '("Toggle" . gdb-toggle-breakpoint))
(suppress-keymap map)
(define-key map [menu-bar breakpoints] (cons "Breakpoints" menu))
(define-key map " " 'gdb-toggle-breakpoint)
(define-key map "D" 'gdb-delete-breakpoint)
;; Don't bind "q" to kill-this-buffer as we need it for breakpoint icons.
(define-key map "q" 'gdb-delete-frame-or-window)
(define-key map "\r" 'gdb-goto-breakpoint)
(define-key map "\t" (lambda ()
(interactive)
(gdb-set-window-buffer
(gdb-get-buffer-create 'gdb-threads-buffer) t)))
(define-key map [mouse-2] 'gdb-goto-breakpoint)
(define-key map [follow-link] 'mouse-face)
map))
(defun gdb-delete-frame-or-window ()
"Delete frame if there is only one window. Otherwise delete the window."
(interactive)
(if (one-window-p) (delete-frame)
(delete-window)))
;;from make-mode-line-mouse-map
(defun gdb-make-header-line-mouse-map (mouse function) "\
Return a keymap with single entry for mouse key MOUSE on the header line.
MOUSE is defined to run function FUNCTION with no args in the buffer
corresponding to the mode line clicked."
(let ((map (make-sparse-keymap)))
(define-key map (vector 'header-line mouse) function)
(define-key map (vector 'header-line 'down-mouse-1) 'ignore)
map))
(defmacro gdb-propertize-header (name buffer help-echo mouse-face face)
`(propertize ,name
'help-echo ,help-echo
'mouse-face ',mouse-face
'face ',face
'local-map
(gdb-make-header-line-mouse-map
'mouse-1
(lambda (event) (interactive "e")
(save-selected-window
(select-window (posn-window (event-start event)))
(gdb-set-window-buffer
(gdb-get-buffer-create ',buffer) t) )))))
\f
;; uses "-thread-info". Needs GDB 7.0 onwards.
;;; Threads view
(defun gdb-threads-buffer-name ()
(concat "*threads of " (gdb-get-target-string) "*"))
(defun gdb-display-threads-buffer (&optional thread)
"Display GDB threads."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-threads-buffer thread)))
(defun gdb-frame-threads-buffer (&optional thread)
"Display GDB threads in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-threads-buffer thread)
gdb-display-buffer-other-frame-action))
(def-gdb-trigger-and-handler
gdb-invalidate-threads (gdb-current-context-command "-thread-info")
gdb-thread-list-handler gdb-thread-list-handler-custom
'(start update update-threads))
(gdb-set-buffer-rules
'gdb-threads-buffer
'gdb-threads-buffer-name
'gdb-threads-mode
'gdb-invalidate-threads)
(defvar gdb-threads-font-lock-keywords
'(("in \\([^ ]+\\)" (1 font-lock-function-name-face))
(" \\(stopped\\)" (1 font-lock-warning-face))
(" \\(running\\)" (1 font-lock-string-face))
("\\(\\(\\sw\\|[_.]\\)+\\)=" (1 font-lock-variable-name-face)))
"Font lock keywords used in `gdb-threads-mode'.")
(defvar gdb-threads-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\r" 'gdb-select-thread)
(define-key map "f" 'gdb-display-stack-for-thread)
(define-key map "F" 'gdb-frame-stack-for-thread)
(define-key map "l" 'gdb-display-locals-for-thread)
(define-key map "L" 'gdb-frame-locals-for-thread)
(define-key map "r" 'gdb-display-registers-for-thread)
(define-key map "R" 'gdb-frame-registers-for-thread)
(define-key map "d" 'gdb-display-disassembly-for-thread)
(define-key map "D" 'gdb-frame-disassembly-for-thread)
(define-key map "i" 'gdb-interrupt-thread)
(define-key map "c" 'gdb-continue-thread)
(define-key map "s" 'gdb-step-thread)
(define-key map "\t"
(lambda ()
(interactive)
(gdb-set-window-buffer
(gdb-get-buffer-create 'gdb-breakpoints-buffer) t)))
(define-key map [mouse-2] 'gdb-select-thread)
(define-key map [follow-link] 'mouse-face)
map))
(defvar gdb-threads-header
(list
(gdb-propertize-header
"Breakpoints" gdb-breakpoints-buffer
"mouse-1: select" mode-line-highlight mode-line-inactive)
" "
(gdb-propertize-header "Threads" gdb-threads-buffer
nil nil mode-line)))
(define-derived-mode gdb-threads-mode gdb-parent-mode "Threads"
"Major mode for GDB threads."
(setq gdb-thread-position (make-marker))
(add-to-list 'overlay-arrow-variable-list 'gdb-thread-position)
(setq header-line-format gdb-threads-header)
(set (make-local-variable 'font-lock-defaults)
'(gdb-threads-font-lock-keywords))
'gdb-invalidate-threads)
(defun gdb-thread-list-handler-custom ()
(let ((threads-list (bindat-get-field (gdb-json-partial-output) 'threads))
(table (make-gdb-table))
(marked-line nil))
(setq gdb-threads-list nil)
(setq gdb-running-threads-count 0)
(setq gdb-stopped-threads-count 0)
(set-marker gdb-thread-position nil)
(dolist (thread (reverse threads-list))
(let ((running (equal (bindat-get-field thread 'state) "running")))
(add-to-list 'gdb-threads-list
(cons (bindat-get-field thread 'id)
thread))
(cl-incf (if running
gdb-running-threads-count
gdb-stopped-threads-count))
(gdb-table-add-row
table
(list
(bindat-get-field thread 'id)
(concat
(if gdb-thread-buffer-verbose-names
(concat (bindat-get-field thread 'target-id) " ") "")
(bindat-get-field thread 'state)
;; Include frame information for stopped threads
(if (not running)
(concat
" in " (bindat-get-field thread 'frame 'func)
(if gdb-thread-buffer-arguments
(concat
" ("
(let ((args (bindat-get-field thread 'frame 'args)))
(mapconcat
(lambda (arg)
(apply #'format "%s=%s"
(gdb-get-many-fields arg 'name 'value)))
args ","))
")")
"")
(if gdb-thread-buffer-locations
(gdb-frame-location (bindat-get-field thread 'frame)) "")
(if gdb-thread-buffer-addresses
(concat " at " (bindat-get-field thread 'frame 'addr)) ""))
"")))
(list
'gdb-thread thread
'mouse-face 'highlight
'help-echo "mouse-2, RET: select thread")))
(when (string-equal gdb-thread-number
(bindat-get-field thread 'id))
(setq marked-line (length gdb-threads-list))))
(insert (gdb-table-string table " "))
(when marked-line
(gdb-mark-line marked-line gdb-thread-position)))
;; We update gud-running here because we need to make sure that
;; gdb-threads-list is up-to-date
(gdb-update-gud-running)
(gdb-emit-signal gdb-buf-publisher 'update-disassembly))
(defmacro def-gdb-thread-buffer-command (name custom-defun &optional doc)
"Define a NAME command which will act upon thread on the current line.
CUSTOM-DEFUN may use locally bound `thread' variable, which will
be the value of `gdb-thread' property of the current line.
If `gdb-thread' is nil, error is signaled."
`(defun ,name (&optional event)
,(when doc doc)
(interactive (list last-input-event))
(if event (posn-set-point (event-end event)))
(save-excursion
(beginning-of-line)
(let ((thread (get-text-property (point) 'gdb-thread)))
(if thread
,custom-defun
(error "Not recognized as thread line"))))))
(defmacro def-gdb-thread-buffer-simple-command (name buffer-command
&optional doc)
"Define a NAME which will call BUFFER-COMMAND with id of thread
on the current line."
`(def-gdb-thread-buffer-command ,name
(,buffer-command (bindat-get-field thread 'id))
,doc))
(def-gdb-thread-buffer-command gdb-select-thread
(let ((new-id (bindat-get-field thread 'id)))
(gdb-setq-thread-number new-id)
(gdb-input (concat "-thread-select " new-id) 'ignore)
(gdb-update))
"Select the thread at current line of threads buffer.")
(def-gdb-thread-buffer-simple-command
gdb-display-stack-for-thread
gdb-preemptively-display-stack-buffer
"Display stack buffer for the thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-display-locals-for-thread
gdb-preemptively-display-locals-buffer
"Display locals buffer for the thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-display-registers-for-thread
gdb-preemptively-display-registers-buffer
"Display registers buffer for the thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-display-disassembly-for-thread
gdb-preemptively-display-disassembly-buffer
"Display disassembly buffer for the thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-frame-stack-for-thread
gdb-frame-stack-buffer
"Display another frame with stack buffer for thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-frame-locals-for-thread
gdb-frame-locals-buffer
"Display another frame with locals buffer for thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-frame-registers-for-thread
gdb-frame-registers-buffer
"Display another frame with registers buffer for the thread at current line.")
(def-gdb-thread-buffer-simple-command
gdb-frame-disassembly-for-thread
gdb-frame-disassembly-buffer
"Display another frame with disassembly buffer for the thread at current line.")
(defmacro def-gdb-thread-buffer-gud-command (name gud-command &optional doc)
"Define a NAME which will execute GUD-COMMAND with
`gdb-thread-number' locally bound to id of thread on the current
line."
`(def-gdb-thread-buffer-command ,name
(if gdb-non-stop
(let ((gdb-thread-number (bindat-get-field thread 'id))
(gdb-gud-control-all-threads nil))
(call-interactively #',gud-command))
(error "Available in non-stop mode only, customize `gdb-non-stop-setting'"))
,doc))
(def-gdb-thread-buffer-gud-command
gdb-interrupt-thread
gud-stop-subjob
"Interrupt thread at current line.")
;; Defined opaquely in M-x gdb via gud-def.
(declare-function gud-cont "gdb-mi" (arg) t)
(def-gdb-thread-buffer-gud-command
gdb-continue-thread
gud-cont
"Continue thread at current line.")
(declare-function gud-step "gdb-mi" (arg) t)
(def-gdb-thread-buffer-gud-command
gdb-step-thread
gud-step
"Step thread at current line.")
\f
;;; Memory view
(defcustom gdb-memory-rows 8
"Number of data rows in memory window."
:type 'integer
:group 'gud
:version "23.2")
(defcustom gdb-memory-columns 4
"Number of data columns in memory window."
:type 'integer
:group 'gud
:version "23.2")
(defcustom gdb-memory-format "x"
"Display format of data items in memory window."
:type '(choice (const :tag "Hexadecimal" "x")
(const :tag "Signed decimal" "d")
(const :tag "Unsigned decimal" "u")
(const :tag "Octal" "o")
(const :tag "Binary" "t"))
:group 'gud
:version "22.1")
(defcustom gdb-memory-unit 4
"Unit size of data items in memory window."
:type '(choice (const :tag "Byte" 1)
(const :tag "Halfword" 2)
(const :tag "Word" 4)
(const :tag "Giant word" 8))
:group 'gud
:version "23.2")
(def-gdb-trigger-and-handler
gdb-invalidate-memory
(format "-data-read-memory %s %s %d %d %d"
gdb-memory-address
gdb-memory-format
gdb-memory-unit
gdb-memory-rows
gdb-memory-columns)
gdb-read-memory-handler
gdb-read-memory-custom
'(start update))
(gdb-set-buffer-rules
'gdb-memory-buffer
'gdb-memory-buffer-name
'gdb-memory-mode
'gdb-invalidate-memory)
(defun gdb-memory-column-width (size format)
"Return length of string with memory unit of SIZE in FORMAT.
SIZE is in bytes, as in `gdb-memory-unit'. FORMAT is a string as
in `gdb-memory-format'."
(let ((format-base (cdr (assoc format
'(("x" . 16)
("d" . 10) ("u" . 10)
("o" . 8)
("t" . 2))))))
(if format-base
(let ((res (ceiling (log (expt 2.0 (* size 8)) format-base))))
(cond ((string-equal format "x")
(+ 2 res)) ; hexadecimal numbers have 0x in front
((or (string-equal format "d")
(string-equal format "o"))
(1+ res))
(t res)))
(error "Unknown format"))))
(defun gdb-read-memory-custom ()
(let* ((res (gdb-json-partial-output))
(err-msg (bindat-get-field res 'msg)))
(if (not err-msg)
(let ((memory (bindat-get-field res 'memory)))
(setq gdb-memory-address (bindat-get-field res 'addr))
(setq gdb-memory-next-page (bindat-get-field res 'next-page))
(setq gdb-memory-prev-page (bindat-get-field res 'prev-page))
(setq gdb-memory-last-address gdb-memory-address)
(dolist (row memory)
(insert (concat (bindat-get-field row 'addr) ":"))
(dolist (column (bindat-get-field row 'data))
(insert (gdb-pad-string column
(+ 2 (gdb-memory-column-width
gdb-memory-unit
gdb-memory-format)))))
(newline)))
;; Show last page instead of empty buffer when out of bounds
(progn
(let ((gdb-memory-address gdb-memory-last-address))
(gdb-invalidate-memory 'update)
(error err-msg))))))
(defvar gdb-memory-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map t)
(define-key map "q" 'kill-current-buffer)
(define-key map "n" 'gdb-memory-show-next-page)
(define-key map "p" 'gdb-memory-show-previous-page)
(define-key map "a" 'gdb-memory-set-address)
(define-key map "t" 'gdb-memory-format-binary)
(define-key map "o" 'gdb-memory-format-octal)
(define-key map "u" 'gdb-memory-format-unsigned)
(define-key map "d" 'gdb-memory-format-signed)
(define-key map "x" 'gdb-memory-format-hexadecimal)
(define-key map "b" 'gdb-memory-unit-byte)
(define-key map "h" 'gdb-memory-unit-halfword)
(define-key map "w" 'gdb-memory-unit-word)
(define-key map "g" 'gdb-memory-unit-giant)
(define-key map "R" 'gdb-memory-set-rows)
(define-key map "C" 'gdb-memory-set-columns)
map))
(defun gdb-memory-set-address-event (event)
"Handle a click on address field in memory buffer header."
(interactive "e")
(save-selected-window
(select-window (posn-window (event-start event)))
(gdb-memory-set-address)))
;; Non-event version for use within keymap
(defun gdb-memory-set-address ()
"Set the start memory address."
(interactive)
(let ((arg (read-from-minibuffer "Memory address: ")))
(setq gdb-memory-address arg))
(gdb-invalidate-memory 'update))
(defmacro def-gdb-set-positive-number (name variable echo-string &optional doc)
"Define a function NAME which reads new VAR value from minibuffer."
`(defun ,name (event)
,(when doc doc)
(interactive "e")
(save-selected-window
(select-window (posn-window (event-start event)))
(let* ((arg (read-from-minibuffer ,echo-string))
(count (string-to-number arg)))
(if (<= count 0)
(error "Positive number only")
(customize-set-variable ',variable count)
(gdb-invalidate-memory 'update))))))
(def-gdb-set-positive-number
gdb-memory-set-rows
gdb-memory-rows
"Rows: "
"Set the number of data rows in memory window.")
(def-gdb-set-positive-number
gdb-memory-set-columns
gdb-memory-columns
"Columns: "
"Set the number of data columns in memory window.")
(defmacro def-gdb-memory-format (name format doc)
"Define a function NAME to switch memory buffer to use FORMAT.
DOC is an optional documentation string."
`(defun ,name () ,(when doc doc)
(interactive)
(customize-set-variable 'gdb-memory-format ,format)
(gdb-invalidate-memory 'update)))
(def-gdb-memory-format
gdb-memory-format-binary "t"
"Set the display format to binary.")
(def-gdb-memory-format
gdb-memory-format-octal "o"
"Set the display format to octal.")
(def-gdb-memory-format
gdb-memory-format-unsigned "u"
"Set the display format to unsigned decimal.")
(def-gdb-memory-format
gdb-memory-format-signed "d"
"Set the display format to decimal.")
(def-gdb-memory-format
gdb-memory-format-hexadecimal "x"
"Set the display format to hexadecimal.")
(defvar gdb-memory-format-map
(let ((map (make-sparse-keymap)))
(define-key map [header-line down-mouse-3] 'gdb-memory-format-menu-1)
map)
"Keymap to select format in the header line.")
(defvar gdb-memory-format-menu
(let ((map (make-sparse-keymap "Format")))
(define-key map [binary]
'(menu-item "Binary" gdb-memory-format-binary
:button (:radio . (equal gdb-memory-format "t"))))
(define-key map [octal]
'(menu-item "Octal" gdb-memory-format-octal
:button (:radio . (equal gdb-memory-format "o"))))
(define-key map [unsigned]
'(menu-item "Unsigned Decimal" gdb-memory-format-unsigned
:button (:radio . (equal gdb-memory-format "u"))))
(define-key map [signed]
'(menu-item "Signed Decimal" gdb-memory-format-signed
:button (:radio . (equal gdb-memory-format "d"))))
(define-key map [hexadecimal]
'(menu-item "Hexadecimal" gdb-memory-format-hexadecimal
:button (:radio . (equal gdb-memory-format "x"))))
map)
"Menu of display formats in the header line.")
(defun gdb-memory-format-menu (event)
(interactive "@e")
(x-popup-menu event gdb-memory-format-menu))
(defun gdb-memory-format-menu-1 (event)
(interactive "e")
(save-selected-window
(select-window (posn-window (event-start event)))
(let* ((selection (gdb-memory-format-menu event))
(binding (and selection (lookup-key gdb-memory-format-menu
(vector (car selection))))))
(if binding (call-interactively binding)))))
(defmacro def-gdb-memory-unit (name unit-size doc)
"Define a function NAME to switch memory unit size to UNIT-SIZE.
DOC is an optional documentation string."
`(defun ,name () ,(when doc doc)
(interactive)
(customize-set-variable 'gdb-memory-unit ,unit-size)
(gdb-invalidate-memory 'update)))
(def-gdb-memory-unit gdb-memory-unit-giant 8
"Set the unit size to giant words (eight bytes).")
(def-gdb-memory-unit gdb-memory-unit-word 4
"Set the unit size to words (four bytes).")
(def-gdb-memory-unit gdb-memory-unit-halfword 2
"Set the unit size to halfwords (two bytes).")
(def-gdb-memory-unit gdb-memory-unit-byte 1
"Set the unit size to bytes.")
(defmacro def-gdb-memory-show-page (name address-var &optional doc)
"Define a function NAME which show new address in memory buffer.
The defined function switches Memory buffer to show address
stored in ADDRESS-VAR variable.
DOC is an optional documentation string."
`(defun ,name
,(when doc doc)
(interactive)
(let ((gdb-memory-address ,address-var))
(gdb-invalidate-memory))))
(def-gdb-memory-show-page gdb-memory-show-previous-page
gdb-memory-prev-page)
(def-gdb-memory-show-page gdb-memory-show-next-page
gdb-memory-next-page)
(defvar gdb-memory-unit-map
(let ((map (make-sparse-keymap)))
(define-key map [header-line down-mouse-3] 'gdb-memory-unit-menu-1)
map)
"Keymap to select units in the header line.")
(defvar gdb-memory-unit-menu
(let ((map (make-sparse-keymap "Unit")))
(define-key map [giantwords]
'(menu-item "Giant words" gdb-memory-unit-giant
:button (:radio . (equal gdb-memory-unit 8))))
(define-key map [words]
'(menu-item "Words" gdb-memory-unit-word
:button (:radio . (equal gdb-memory-unit 4))))
(define-key map [halfwords]
'(menu-item "Halfwords" gdb-memory-unit-halfword
:button (:radio . (equal gdb-memory-unit 2))))
(define-key map [bytes]
'(menu-item "Bytes" gdb-memory-unit-byte
:button (:radio . (equal gdb-memory-unit 1))))
map)
"Menu of units in the header line.")
(defun gdb-memory-unit-menu (event)
(interactive "@e")
(x-popup-menu event gdb-memory-unit-menu))
(defun gdb-memory-unit-menu-1 (event)
(interactive "e")
(save-selected-window
(select-window (posn-window (event-start event)))
(let* ((selection (gdb-memory-unit-menu event))
(binding (and selection (lookup-key gdb-memory-unit-menu
(vector (car selection))))))
(if binding (call-interactively binding)))))
(defvar gdb-memory-font-lock-keywords
'(;; <__function.name+n>
("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>"
(1 font-lock-function-name-face)))
"Font lock keywords used in `gdb-memory-mode'.")
(defvar gdb-memory-header
'(:eval
(concat
"Start address["
(propertize "-"
'face font-lock-warning-face
'help-echo "mouse-1: decrement address"
'mouse-face 'mode-line-highlight
'local-map (gdb-make-header-line-mouse-map
'mouse-1
#'gdb-memory-show-previous-page))
"|"
(propertize "+"
'face font-lock-warning-face
'help-echo "mouse-1: increment address"
'mouse-face 'mode-line-highlight
'local-map (gdb-make-header-line-mouse-map
'mouse-1
#'gdb-memory-show-next-page))
"]: "
(propertize gdb-memory-address
'face font-lock-warning-face
'help-echo "mouse-1: set start address"
'mouse-face 'mode-line-highlight
'local-map (gdb-make-header-line-mouse-map
'mouse-1
#'gdb-memory-set-address-event))
" Rows: "
(propertize (number-to-string gdb-memory-rows)
'face font-lock-warning-face
'help-echo "mouse-1: set number of columns"
'mouse-face 'mode-line-highlight
'local-map (gdb-make-header-line-mouse-map
'mouse-1
#'gdb-memory-set-rows))
" Columns: "
(propertize (number-to-string gdb-memory-columns)
'face font-lock-warning-face
'help-echo "mouse-1: set number of columns"
'mouse-face 'mode-line-highlight
'local-map (gdb-make-header-line-mouse-map
'mouse-1
#'gdb-memory-set-columns))
" Display Format: "
(propertize gdb-memory-format
'face font-lock-warning-face
'help-echo "mouse-3: select display format"
'mouse-face 'mode-line-highlight
'local-map gdb-memory-format-map)
" Unit Size: "
(propertize (number-to-string gdb-memory-unit)
'face font-lock-warning-face
'help-echo "mouse-3: select unit size"
'mouse-face 'mode-line-highlight
'local-map gdb-memory-unit-map)))
"Header line used in `gdb-memory-mode'.")
(define-derived-mode gdb-memory-mode gdb-parent-mode "Memory"
"Major mode for examining memory."
(setq header-line-format gdb-memory-header)
(set (make-local-variable 'font-lock-defaults)
'(gdb-memory-font-lock-keywords))
'gdb-invalidate-memory)
(defun gdb-memory-buffer-name ()
(concat "*memory of " (gdb-get-target-string) "*"))
(defun gdb-display-memory-buffer (&optional thread)
"Display GDB memory contents."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-memory-buffer thread)))
(defun gdb-frame-memory-buffer ()
"Display memory contents in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-memory-buffer)
gdb-display-buffer-other-frame-action))
\f
;;; Disassembly view
(defun gdb-disassembly-buffer-name ()
(gdb-current-context-buffer-name
(concat "disassembly of " (gdb-get-target-string))))
(defun gdb-display-disassembly-buffer (&optional thread)
"Display GDB disassembly information."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-disassembly-buffer thread)))
(def-gdb-preempt-display-buffer
gdb-preemptively-display-disassembly-buffer
'gdb-disassembly-buffer)
(defun gdb-frame-disassembly-buffer (&optional thread)
"Display GDB disassembly information in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-disassembly-buffer thread)
gdb-display-buffer-other-frame-action))
(def-gdb-auto-update-trigger gdb-invalidate-disassembly
(let* ((frame (gdb-current-buffer-frame))
(file (bindat-get-field frame 'fullname))
(line (bindat-get-field frame 'line)))
(if file
(format "-data-disassemble -f %s -l %s -n -1 -- 0" file line)
;; If we're unable to get a file name / line for $PC, simply
;; follow $PC, disassembling the next 10 (x ~15 (on IA) ==
;; 150 bytes) instructions.
"-data-disassemble -s $pc -e \"$pc + 150\" -- 0"))
gdb-disassembly-handler
;; We update disassembly only after we have actual frame information
;; about all threads, so no there's `update' signal in this list
'(start update-disassembly))
(def-gdb-auto-update-handler
gdb-disassembly-handler
gdb-disassembly-handler-custom
t)
(gdb-set-buffer-rules
'gdb-disassembly-buffer
'gdb-disassembly-buffer-name
'gdb-disassembly-mode
'gdb-invalidate-disassembly)
(defvar gdb-disassembly-font-lock-keywords
'(;; <__function.name+n>
("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>"
(1 font-lock-function-name-face))
;; 0xNNNNNNNN <__function.name+n>: opcode
("^0x[0-9a-f]+ \\(<\\(\\(\\sw\\|[_.]\\)+\\)\\+[0-9]+>\\)?:[ \t]+\\(\\sw+\\)"
(4 font-lock-keyword-face))
;; %register(at least i386)
("%\\sw+" . font-lock-variable-name-face)
("^\\(Dump of assembler code for function\\) \\(.+\\):"
(1 font-lock-comment-face)
(2 font-lock-function-name-face))
("^\\(End of assembler dump\\.\\)" . font-lock-comment-face))
"Font lock keywords used in `gdb-disassembly-mode'.")
(defvar gdb-disassembly-mode-map
;; TODO
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "q" 'kill-current-buffer)
map))
(define-derived-mode gdb-disassembly-mode gdb-parent-mode "Disassembly"
"Major mode for GDB disassembly information."
;; TODO Rename overlay variable for disassembly mode
(add-to-list 'overlay-arrow-variable-list 'gdb-disassembly-position)
(setq fringes-outside-margins t)
(set (make-local-variable 'gdb-disassembly-position) (make-marker))
(set (make-local-variable 'font-lock-defaults)
'(gdb-disassembly-font-lock-keywords))
'gdb-invalidate-disassembly)
(defun gdb-disassembly-handler-custom ()
(let* ((instructions (bindat-get-field (gdb-json-partial-output) 'asm_insns))
(address (bindat-get-field (gdb-current-buffer-frame) 'addr))
(table (make-gdb-table))
(marked-line nil))
(dolist (instr instructions)
(gdb-table-add-row table
(list
(bindat-get-field instr 'address)
(let
((func-name (bindat-get-field instr 'func-name))
(offset (bindat-get-field instr 'offset)))
(if func-name
(format "<%s+%s>:" func-name offset)
""))
(bindat-get-field instr 'inst)))
(when (string-equal (bindat-get-field instr 'address)
address)
(progn
(setq marked-line (length (gdb-table-rows table)))
(setq fringe-indicator-alist
(if (string-equal gdb-frame-number "0")
nil
'((overlay-arrow . hollow-right-triangle)))))))
(insert (gdb-table-string table " "))
(gdb-disassembly-place-breakpoints)
;; Mark current position with overlay arrow and scroll window to
;; that point
(when marked-line
(let ((window (get-buffer-window (current-buffer) 0)))
(set-window-point window (gdb-mark-line marked-line
gdb-disassembly-position))))
(setq mode-name
(gdb-current-context-mode-name
(concat "Disassembly: "
(bindat-get-field (gdb-current-buffer-frame) 'func))))))
(defun gdb-disassembly-place-breakpoints ()
(gdb-remove-breakpoint-icons (point-min) (point-max))
(dolist (breakpoint gdb-breakpoints-list)
(let* ((breakpoint (cdr breakpoint))
(bptno (bindat-get-field breakpoint 'number))
(flag (bindat-get-field breakpoint 'enabled))
(address (bindat-get-field breakpoint 'addr)))
(save-excursion
(goto-char (point-min))
(if (re-search-forward (concat "^" address) nil t)
(gdb-put-breakpoint-icon (string-equal flag "y") bptno))))))
\f
(defvar gdb-breakpoints-header
(list
(gdb-propertize-header "Breakpoints" gdb-breakpoints-buffer
nil nil mode-line)
" "
(gdb-propertize-header "Threads" gdb-threads-buffer
"mouse-1: select" mode-line-highlight
mode-line-inactive)))
;;; Breakpoints view
(define-derived-mode gdb-breakpoints-mode gdb-parent-mode "Breakpoints"
"Major mode for gdb breakpoints."
(setq header-line-format gdb-breakpoints-header)
'gdb-invalidate-breakpoints)
(defun gdb-toggle-breakpoint ()
"Enable/disable breakpoint at current line of breakpoints buffer."
(interactive)
(save-excursion
(beginning-of-line)
(let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
(if breakpoint
(gud-basic-call
(concat (if (equal "y" (bindat-get-field breakpoint 'enabled))
"-break-disable "
"-break-enable ")
(bindat-get-field breakpoint 'number)))
(error "Not recognized as break/watchpoint line")))))
(defun gdb-delete-breakpoint ()
"Delete the breakpoint at current line of breakpoints buffer."
(interactive)
(save-excursion
(beginning-of-line)
(let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
(if breakpoint
(gud-basic-call (concat "-break-delete "
(bindat-get-field breakpoint 'number)))
(error "Not recognized as break/watchpoint line")))))
(defun gdb-goto-breakpoint (&optional event)
"Go to the location of breakpoint at current line of breakpoints buffer."
(interactive (list last-input-event))
(if event (posn-set-point (event-end event)))
;; Hack to stop gdb-goto-breakpoint displaying in GUD buffer.
(let ((window (get-buffer-window gud-comint-buffer)))
(if window (save-selected-window (select-window window))))
(save-excursion
(beginning-of-line)
(let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
(if breakpoint
(let ((bptno (bindat-get-field breakpoint 'number))
(file (bindat-get-field breakpoint 'fullname))
(line (bindat-get-field breakpoint 'line)))
(save-selected-window
(let* ((buffer (find-file-noselect
(if (file-exists-p file) file
(cdr (assoc bptno gdb-location-alist)))))
(window (or (gdb-display-source-buffer buffer)
(display-buffer buffer))))
(setq gdb-source-window window)
(with-current-buffer buffer
(goto-char (point-min))
(forward-line (1- (string-to-number line)))
(set-window-point window (point))))))
(error "Not recognized as break/watchpoint line")))))
\f
;; Frames buffer. This displays a perpetually correct backtrack trace.
;;
(def-gdb-trigger-and-handler
gdb-invalidate-frames (gdb-current-context-command "-stack-list-frames")
gdb-stack-list-frames-handler gdb-stack-list-frames-custom
'(start update))
(gdb-set-buffer-rules
'gdb-stack-buffer
'gdb-stack-buffer-name
'gdb-frames-mode
'gdb-invalidate-frames)
(defun gdb-frame-location (frame)
"Return \" of file:line\" or \" of library\" for structure FRAME.
FRAME must have either \"file\" and \"line\" members or \"from\"
member."
(let ((file (bindat-get-field frame 'file))
(line (bindat-get-field frame 'line))
(from (bindat-get-field frame 'from)))
(let ((res (or (and file line (concat file ":" line))
from)))
(if res (concat " of " res) ""))))
(defun gdb-stack-list-frames-custom ()
(let ((stack (bindat-get-field (gdb-json-partial-output "frame") 'stack))
(table (make-gdb-table)))
(set-marker gdb-stack-position nil)
(dolist (frame stack)
(gdb-table-add-row table
(list
(bindat-get-field frame 'level)
"in"
(concat
(bindat-get-field frame 'func)
(if gdb-stack-buffer-locations
(gdb-frame-location frame) "")
(if gdb-stack-buffer-addresses
(concat " at " (bindat-get-field frame 'addr)) "")))
`(mouse-face highlight
help-echo "mouse-2, RET: Select frame"
gdb-frame ,frame)))
(insert (gdb-table-string table " ")))
(when (and gdb-frame-number
(gdb-buffer-shows-main-thread-p))
(gdb-mark-line (1+ (string-to-number gdb-frame-number))
gdb-stack-position))
(setq mode-name
(gdb-current-context-mode-name "Frames")))
(defun gdb-stack-buffer-name ()
(gdb-current-context-buffer-name
(concat "stack frames of " (gdb-get-target-string))))
(defun gdb-display-stack-buffer (&optional thread)
"Display GDB backtrace for current stack."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-stack-buffer thread)))
(def-gdb-preempt-display-buffer
gdb-preemptively-display-stack-buffer
'gdb-stack-buffer nil t)
(defun gdb-frame-stack-buffer (&optional thread)
"Display GDB backtrace for current stack in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-stack-buffer thread)
gdb-display-buffer-other-frame-action))
(defvar gdb-frames-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "q" 'kill-current-buffer)
(define-key map "\r" 'gdb-select-frame)
(define-key map [mouse-2] 'gdb-select-frame)
(define-key map [follow-link] 'mouse-face)
map))
(defvar gdb-frames-font-lock-keywords
'(("in \\([^ ]+\\)" (1 font-lock-function-name-face)))
"Font lock keywords used in `gdb-frames-mode'.")
(define-derived-mode gdb-frames-mode gdb-parent-mode "Frames"
"Major mode for gdb call stack."
(setq gdb-stack-position (make-marker))
(add-to-list 'overlay-arrow-variable-list 'gdb-stack-position)
(setq truncate-lines t) ;; Make it easier to see overlay arrow.
(set (make-local-variable 'font-lock-defaults)
'(gdb-frames-font-lock-keywords))
'gdb-invalidate-frames)
(defun gdb-select-frame (&optional event)
"Select the frame and display the relevant source."
(interactive (list last-input-event))
(if event (posn-set-point (event-end event)))
(let ((frame (get-text-property (point) 'gdb-frame)))
(if frame
(if (gdb-buffer-shows-main-thread-p)
(let ((new-level (bindat-get-field frame 'level)))
(setq gdb-frame-number new-level)
(gdb-input (concat "-stack-select-frame " new-level)
'ignore)
(gdb-update))
(error "Could not select frame for non-current thread"))
(error "Not recognized as frame line"))))
\f
;; Locals buffer.
;; uses "-stack-list-locals --simple-values". Needs GDB 6.1 onwards.
(def-gdb-trigger-and-handler
gdb-invalidate-locals
(concat (gdb-current-context-command "-stack-list-locals")
" --simple-values")
gdb-locals-handler gdb-locals-handler-custom
'(start update))
(gdb-set-buffer-rules
'gdb-locals-buffer
'gdb-locals-buffer-name
'gdb-locals-mode
'gdb-invalidate-locals)
(defvar gdb-locals-watch-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "\r" 'gud-watch)
(define-key map [mouse-2] 'gud-watch)
map)
"Keymap to create watch expression of a complex data type local variable.")
(defvar gdb-edit-locals-map-1
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "\r" 'gdb-edit-locals-value)
(define-key map [mouse-2] 'gdb-edit-locals-value)
map)
"Keymap to edit value of a simple data type local variable.")
(defun gdb-edit-locals-value (&optional event)
"Assign a value to a variable displayed in the locals buffer."
(interactive (list last-input-event))
(save-excursion
(if event (posn-set-point (event-end event)))
(beginning-of-line)
(let* ((var (bindat-get-field
(get-text-property (point) 'gdb-local-variable) 'name))
(value (read-string (format "New value (%s): " var))))
(gud-basic-call
(concat "-gdb-set variable " var " = " value)))))
;; Don't display values of arrays or structures.
;; These can be expanded using gud-watch.
(defun gdb-locals-handler-custom ()
(let ((locals-list (bindat-get-field (gdb-json-partial-output) 'locals))
(table (make-gdb-table)))
(dolist (local locals-list)
(let ((name (bindat-get-field local 'name))
(value (bindat-get-field local 'value))
(type (bindat-get-field local 'type)))
(when (not value)
(setq value "<complex data type>"))
(if (or (not value)
(string-match "0x" value))
(add-text-properties 0 (length name)
`(mouse-face highlight
help-echo "mouse-2: create watch expression"
local-map ,gdb-locals-watch-map)
name)
(add-text-properties 0 (length value)
`(mouse-face highlight
help-echo "mouse-2: edit value"
local-map ,gdb-edit-locals-map-1)
value))
(gdb-table-add-row
table
(list
(propertize type 'font-lock-face font-lock-type-face)
(propertize name 'font-lock-face font-lock-variable-name-face)
value)
`(gdb-local-variable ,local))))
(insert (gdb-table-string table " "))
(setq mode-name
(gdb-current-context-mode-name
(concat "Locals: "
(bindat-get-field (gdb-current-buffer-frame) 'func))))))
(defvar gdb-locals-header
(list
(gdb-propertize-header "Locals" gdb-locals-buffer
nil nil mode-line)
" "
(gdb-propertize-header "Registers" gdb-registers-buffer
"mouse-1: select" mode-line-highlight
mode-line-inactive)))
(defvar gdb-locals-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "q" 'kill-current-buffer)
(define-key map "\t" (lambda ()
(interactive)
(gdb-set-window-buffer
(gdb-get-buffer-create
'gdb-registers-buffer
gdb-thread-number) t)))
map))
(define-derived-mode gdb-locals-mode gdb-parent-mode "Locals"
"Major mode for gdb locals."
(setq header-line-format gdb-locals-header)
'gdb-invalidate-locals)
(defun gdb-locals-buffer-name ()
(gdb-current-context-buffer-name
(concat "locals of " (gdb-get-target-string))))
(defun gdb-display-locals-buffer (&optional thread)
"Display the local variables of current GDB stack."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-locals-buffer thread)))
(def-gdb-preempt-display-buffer
gdb-preemptively-display-locals-buffer
'gdb-locals-buffer nil t)
(defun gdb-frame-locals-buffer (&optional thread)
"Display the local variables of the current GDB stack in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-locals-buffer thread)
gdb-display-buffer-other-frame-action))
\f
;; Registers buffer.
(def-gdb-trigger-and-handler
gdb-invalidate-registers
(concat (gdb-current-context-command "-data-list-register-values") " x")
gdb-registers-handler
gdb-registers-handler-custom
'(start update))
(gdb-set-buffer-rules
'gdb-registers-buffer
'gdb-registers-buffer-name
'gdb-registers-mode
'gdb-invalidate-registers)
(defun gdb-registers-handler-custom ()
(when gdb-register-names
(let ((register-values
(bindat-get-field (gdb-json-partial-output) 'register-values))
(table (make-gdb-table)))
(dolist (register register-values)
(let* ((register-number (bindat-get-field register 'number))
(value (bindat-get-field register 'value))
(register-name (nth (string-to-number register-number)
gdb-register-names)))
(gdb-table-add-row
table
(list
(propertize register-name
'font-lock-face font-lock-variable-name-face)
(if (member register-number gdb-changed-registers)
(propertize value 'font-lock-face font-lock-warning-face)
value))
`(mouse-face highlight
help-echo "mouse-2: edit value"
gdb-register-name ,register-name))))
(insert (gdb-table-string table " ")))
(setq mode-name
(gdb-current-context-mode-name "Registers"))))
(defun gdb-edit-register-value (&optional event)
"Assign a value to a register displayed in the registers buffer."
(interactive (list last-input-event))
(save-excursion
(if event (posn-set-point (event-end event)))
(beginning-of-line)
(let* ((var (bindat-get-field
(get-text-property (point) 'gdb-register-name)))
(value (read-string (format "New value (%s): " var))))
(gud-basic-call
(concat "-gdb-set variable $" var " = " value)))))
(defvar gdb-registers-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(define-key map "\r" 'gdb-edit-register-value)
(define-key map [mouse-2] 'gdb-edit-register-value)
(define-key map "q" 'kill-current-buffer)
(define-key map "\t" (lambda ()
(interactive)
(gdb-set-window-buffer
(gdb-get-buffer-create
'gdb-locals-buffer
gdb-thread-number) t)))
map))
(defvar gdb-registers-header
(list
(gdb-propertize-header "Locals" gdb-locals-buffer
"mouse-1: select" mode-line-highlight
mode-line-inactive)
" "
(gdb-propertize-header "Registers" gdb-registers-buffer
nil nil mode-line)))
(define-derived-mode gdb-registers-mode gdb-parent-mode "Registers"
"Major mode for gdb registers."
(setq header-line-format gdb-registers-header)
'gdb-invalidate-registers)
(defun gdb-registers-buffer-name ()
(gdb-current-context-buffer-name
(concat "registers of " (gdb-get-target-string))))
(defun gdb-display-registers-buffer (&optional thread)
"Display GDB register contents."
(interactive)
(gdb-display-buffer (gdb-get-buffer-create 'gdb-registers-buffer thread)))
(def-gdb-preempt-display-buffer
gdb-preemptively-display-registers-buffer
'gdb-registers-buffer nil t)
(defun gdb-frame-registers-buffer (&optional thread)
"Display GDB register contents in another frame."
(interactive)
(display-buffer (gdb-get-buffer-create 'gdb-registers-buffer thread)
gdb-display-buffer-other-frame-action))
;; Needs GDB 6.4 onwards (used to fail with no stack).
(defun gdb-get-changed-registers ()
(when (gdb-get-buffer 'gdb-registers-buffer)
(gdb-input "-data-list-changed-registers"
'gdb-changed-registers-handler
'gdb-get-changed-registers)))
(defun gdb-changed-registers-handler ()
(setq gdb-changed-registers nil)
(dolist (register-number
(bindat-get-field (gdb-json-partial-output) 'changed-registers))
(push register-number gdb-changed-registers)))
(defun gdb-register-names-handler ()
;; Don't use pending triggers because this handler is called
;; only once (in gdb-init-1)
(setq gdb-register-names nil)
(dolist (register-name
(bindat-get-field (gdb-json-partial-output) 'register-names))
(push register-name gdb-register-names))
(setq gdb-register-names (reverse gdb-register-names)))
\f
(defun gdb-get-source-file-list ()
"Create list of source files for current GDB session.
If buffers already exist for any of these files, `gud-minor-mode'
is set in them."
(goto-char (point-min))
(while (re-search-forward gdb-source-file-regexp nil t)
(push (read (match-string 1)) gdb-source-file-list))
(dolist (buffer (buffer-list))
(with-current-buffer buffer
(when (member buffer-file-name gdb-source-file-list)
(gdb-init-buffer)))))
(defun gdb-get-main-selected-frame ()
"Trigger for `gdb-frame-handler' which uses main current thread.
Called from `gdb-update'."
(gdb-input (gdb-current-context-command "-stack-info-frame")
'gdb-frame-handler
'gdb-get-main-selected-frame))
(defun gdb-frame-handler ()
"Set `gdb-selected-frame' and `gdb-selected-file' to show
overlay arrow in source buffer."
(let ((frame (bindat-get-field (gdb-json-partial-output) 'frame)))
(when frame
(setq gdb-selected-frame (bindat-get-field frame 'func))
(setq gdb-selected-file (bindat-get-field frame 'fullname))
(setq gdb-frame-number (bindat-get-field frame 'level))
(setq gdb-frame-address (bindat-get-field frame 'addr))
(let ((line (bindat-get-field frame 'line)))
(setq gdb-selected-line (and line (string-to-number line)))
(when (and gdb-selected-file gdb-selected-line)
(setq gud-last-frame (cons gdb-selected-file gdb-selected-line))
(gud-display-frame)))
(if gud-overlay-arrow-position
(let ((buffer (marker-buffer gud-overlay-arrow-position))
(position (marker-position gud-overlay-arrow-position)))
(when buffer
(with-current-buffer buffer
(setq fringe-indicator-alist
(if (string-equal gdb-frame-number "0")
nil
'((overlay-arrow . hollow-right-triangle))))
(setq gud-overlay-arrow-position (make-marker))
(set-marker gud-overlay-arrow-position position))))))))
(defconst gdb-prompt-name-regexp
(concat "value=\\(" gdb--string-regexp "\\)"))
(defun gdb-get-prompt ()
"Find prompt for GDB session."
(goto-char (point-min))
(setq gdb-prompt-name nil)
(re-search-forward gdb-prompt-name-regexp nil t)
(setq gdb-prompt-name (read (match-string 1)))
;; Insert first prompt.
(setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
;;;; Window management
(defun gdb-display-buffer (buf)
"Show buffer BUF, and make that window dedicated."
(let ((window (display-buffer buf)))
(set-window-dedicated-p window t)
window))
;; (let ((answer (get-buffer-window buf 0)))
;; (if answer
;; (display-buffer buf nil 0) ;Deiconify frame if necessary.
;; (let ((window (get-lru-window)))
;; (if (eq (buffer-local-value 'gud-minor-mode (window-buffer window))
;; 'gdbmi)
;; (let ((largest (get-largest-window)))
;; (setq answer (split-window largest))
;; (set-window-buffer answer buf)
;; (set-window-dedicated-p answer t)
;; answer)
;; (set-window-buffer window buf)
;; window)))))
(defun gdb-preempt-existing-or-display-buffer (buf &optional split-horizontal)
"Find window displaying a buffer with the same
`gdb-buffer-type' as BUF and show BUF there. If no such window
exists, just call `gdb-display-buffer' for BUF. If the window
found is already dedicated, split window according to
SPLIT-HORIZONTAL and show BUF in the new window."
(if buf
(when (not (get-buffer-window buf))
(let* ((buf-type (gdb-buffer-type buf))
(existing-window
(get-window-with-predicate
#'(lambda (w)
(and (eq buf-type
(gdb-buffer-type (window-buffer w)))
(not (window-dedicated-p w)))))))
(if existing-window
(set-window-buffer existing-window buf)
(let ((dedicated-window
(get-window-with-predicate
#'(lambda (w)
(eq buf-type
(gdb-buffer-type (window-buffer w)))))))
(if dedicated-window
(set-window-buffer
(split-window dedicated-window nil split-horizontal) buf)
(gdb-display-buffer buf))))))
(error "Null buffer")))
\f
;;; Shared keymap initialization:
(let ((menu (make-sparse-keymap "GDB-Windows")))
(define-key gud-menu-map [displays]
`(menu-item "GDB-Windows" ,menu
:visible (eq gud-minor-mode 'gdbmi)))
(define-key menu [gdb] '("Gdb" . gdb-display-gdb-buffer))
(define-key menu [threads] '("Threads" . gdb-display-threads-buffer))
(define-key menu [memory] '("Memory" . gdb-display-memory-buffer))
(define-key menu [disassembly]
'("Disassembly" . gdb-display-disassembly-buffer))
(define-key menu [registers] '("Registers" . gdb-display-registers-buffer))
(define-key menu [inferior]
'("IO" . gdb-display-io-buffer))
(define-key menu [locals] '("Locals" . gdb-display-locals-buffer))
(define-key menu [frames] '("Stack" . gdb-display-stack-buffer))
(define-key menu [breakpoints]
'("Breakpoints" . gdb-display-breakpoints-buffer)))
(let ((menu (make-sparse-keymap "GDB-Frames")))
(define-key gud-menu-map [frames]
`(menu-item "GDB-Frames" ,menu
:visible (eq gud-minor-mode 'gdbmi)))
(define-key menu [gdb] '("Gdb" . gdb-frame-gdb-buffer))
(define-key menu [threads] '("Threads" . gdb-frame-threads-buffer))
(define-key menu [memory] '("Memory" . gdb-frame-memory-buffer))
(define-key menu [disassembly]
'("Disassembly" . gdb-frame-disassembly-buffer))
(define-key menu [registers] '("Registers" . gdb-frame-registers-buffer))
(define-key menu [inferior]
'("IO" . gdb-frame-io-buffer))
(define-key menu [locals] '("Locals" . gdb-frame-locals-buffer))
(define-key menu [frames] '("Stack" . gdb-frame-stack-buffer))
(define-key menu [breakpoints]
'("Breakpoints" . gdb-frame-breakpoints-buffer)))
(let ((menu (make-sparse-keymap "GDB-MI")))
(define-key menu [gdb-customize]
'(menu-item "Customize" (lambda () (interactive) (customize-group 'gdb))
:help "Customize Gdb Graphical Mode options."))
(define-key menu [gdb-many-windows]
'(menu-item "Display Other Windows" gdb-many-windows
:help "Toggle display of locals, stack and breakpoint information"
:button (:toggle . gdb-many-windows)))
(define-key menu [gdb-restore-windows]
'(menu-item "Restore Window Layout" gdb-restore-windows
:help "Restore standard layout for debug session."))
(define-key menu [sep1]
'(menu-item "--"))
(define-key menu [all-threads]
'(menu-item "GUD controls all threads"
(lambda ()
(interactive)
(setq gdb-gud-control-all-threads t))
:help "GUD start/stop commands apply to all threads"
:button (:radio . gdb-gud-control-all-threads)))
(define-key menu [current-thread]
'(menu-item "GUD controls current thread"
(lambda ()
(interactive)
(setq gdb-gud-control-all-threads nil))
:help "GUD start/stop commands apply to current thread only"
:button (:radio . (not gdb-gud-control-all-threads))))
(define-key menu [sep2]
'(menu-item "--"))
(define-key menu [gdb-customize-reasons]
'(menu-item "Customize switching..."
(lambda ()
(interactive)
(customize-option 'gdb-switch-reasons))))
(define-key menu [gdb-switch-when-another-stopped]
(menu-bar-make-toggle gdb-toggle-switch-when-another-stopped
gdb-switch-when-another-stopped
"Automatically switch to stopped thread"
"GDB thread switching %s"
"Switch to stopped thread"))
(define-key gud-menu-map [mi]
`(menu-item "GDB-MI" ,menu :visible (eq gud-minor-mode 'gdbmi))))
;; TODO Fit these into tool-bar-local-item-from-menu call in gud.el.
;; GDB-MI menu will need to be moved to gud.el. We can't use
;; tool-bar-local-item-from-menu here because it appends new buttons
;; to toolbar from right to left while we want our A/T throttle to
;; show up right before Run button.
(define-key-after gud-tool-bar-map [all-threads]
'(menu-item "Switch to non-stop/A mode" gdb-control-all-threads
:image (find-image '((:type xpm :file "gud/thread.xpm")))
:visible (and (eq gud-minor-mode 'gdbmi)
gdb-non-stop
(not gdb-gud-control-all-threads)))
'run)
(define-key-after gud-tool-bar-map [current-thread]
'(menu-item "Switch to non-stop/T mode" gdb-control-current-thread
:image (find-image '((:type xpm :file "gud/all.xpm")))
:visible (and (eq gud-minor-mode 'gdbmi)
gdb-non-stop
gdb-gud-control-all-threads))
'all-threads)
(defun gdb-frame-gdb-buffer ()
"Display GUD buffer in another frame."
(interactive)
(display-buffer-other-frame gud-comint-buffer))
(defun gdb-display-gdb-buffer ()
"Display GUD buffer."
(interactive)
(pop-to-buffer gud-comint-buffer nil 0))
(defun gdb-set-window-buffer (name &optional ignore-dedicated window)
"Set buffer of selected window to NAME and dedicate window.
When IGNORE-DEDICATED is non-nil, buffer is set even if selected
window is dedicated."
(unless window (setq window (selected-window)))
(when ignore-dedicated
(set-window-dedicated-p window nil))
(set-window-buffer window (get-buffer name))
(set-window-dedicated-p window t))
(defun gdb-setup-windows ()
"Layout the window pattern for option `gdb-many-windows'."
(gdb-get-buffer-create 'gdb-locals-buffer)
(gdb-get-buffer-create 'gdb-stack-buffer)
(gdb-get-buffer-create 'gdb-breakpoints-buffer)
(set-window-dedicated-p (selected-window) nil)
(switch-to-buffer gud-comint-buffer)
(delete-other-windows)
(let ((win0 (selected-window))
(win1 (split-window nil ( / ( * (window-height) 3) 4)))
(win2 (split-window nil ( / (window-height) 3)))
(win3 (split-window-right)))
(gdb-set-window-buffer (gdb-locals-buffer-name) nil win3)
(select-window win2)
(set-window-buffer
win2
(if gud-last-last-frame
(gud-find-file (car gud-last-last-frame))
(if gdb-main-file
(gud-find-file gdb-main-file)
;; Put buffer list in window if we
;; can't find a source file.
(list-buffers-noselect))))
(setq gdb-source-window (selected-window))
(let ((win4 (split-window-right)))
(gdb-set-window-buffer
(gdb-get-buffer-create 'gdb-inferior-io) nil win4))
(select-window win1)
(gdb-set-window-buffer (gdb-stack-buffer-name))
(let ((win5 (split-window-right)))
(gdb-set-window-buffer (if gdb-show-threads-by-default
(gdb-threads-buffer-name)
(gdb-breakpoints-buffer-name))
nil win5))
(select-window win0)))
(define-minor-mode gdb-many-windows
"If nil just pop up the GUD buffer unless `gdb-show-main' is t.
In this case it starts with two windows: one displaying the GUD
buffer and the other with the source file with the main routine
of the debugged program. Non-nil means display the layout shown for
`gdb'."
:global t
:group 'gdb
:version "22.1"
(if (and gud-comint-buffer
(buffer-name gud-comint-buffer))
(ignore-errors
(gdb-restore-windows))))
(defun gdb-restore-windows ()
"Restore the basic arrangement of windows used by gdb.
This arrangement depends on the value of option `gdb-many-windows'."
(interactive)
(switch-to-buffer gud-comint-buffer) ;Select the right window and frame.
(delete-other-windows)
(if gdb-many-windows
(gdb-setup-windows)
(when (or gud-last-last-frame gdb-show-main)
(let ((win (split-window)))
(set-window-buffer
win
(if gud-last-last-frame
(gud-find-file (car gud-last-last-frame))
(gud-find-file gdb-main-file)))
(setq gdb-source-window win)))))
;; Called from `gud-sentinel' in gud.el:
(defun gdb-reset ()
"Exit a debugging session cleanly.
Kills the gdb buffers, and resets variables and the source buffers."
;; The gdb-inferior buffer has a pty hooked up to the main gdb
;; process. This pty must be deleted explicitly.
(let ((pty (get-process "gdb-inferior")))
(if pty (delete-process pty)))
;; Find gdb-mi buffers and kill them.
(dolist (buffer (buffer-list))
(unless (eq buffer gud-comint-buffer)
(with-current-buffer buffer
(if (eq gud-minor-mode 'gdbmi)
(if (string-match "\\` ?\\*.+\\*\\'" (buffer-name))
(kill-buffer nil)
(gdb-remove-breakpoint-icons (point-min) (point-max) t)
(setq gud-minor-mode nil)
(kill-local-variable 'tool-bar-map)
(kill-local-variable 'gdb-define-alist))))))
(setq gdb-disassembly-position nil)
(setq overlay-arrow-variable-list
(delq 'gdb-disassembly-position overlay-arrow-variable-list))
(setq fringe-indicator-alist '((overlay-arrow . right-triangle)))
(setq gdb-stack-position nil)
(setq overlay-arrow-variable-list
(delq 'gdb-stack-position overlay-arrow-variable-list))
(setq gdb-thread-position nil)
(setq overlay-arrow-variable-list
(delq 'gdb-thread-position overlay-arrow-variable-list))
(if (boundp 'speedbar-frame) (speedbar-timer-fn))
(setq gud-running nil)
(setq gdb-active-process nil)
(remove-hook 'after-save-hook 'gdb-create-define-alist t))
(defun gdb-get-source-file ()
"Find the source file where the program starts and display it with related
buffers, if required."
(goto-char (point-min))
(if (re-search-forward gdb-source-file-regexp nil t)
(setq gdb-main-file (read (match-string 1))))
(if gdb-many-windows
(gdb-setup-windows)
(gdb-get-buffer-create 'gdb-breakpoints-buffer)
(and gdb-show-main
gdb-main-file
(display-buffer (gud-find-file gdb-main-file))))
(gdb-force-mode-line-update
(propertize "ready" 'face font-lock-variable-name-face)))
;;from put-image
(defun gdb-put-string (putstring pos &optional dprop &rest sprops)
"Put string PUTSTRING in front of POS in the current buffer.
PUTSTRING is displayed by putting an overlay into the current buffer with a
`before-string' string that has a `display' property whose value is
PUTSTRING."
(let ((string (make-string 1 ?x))
(buffer (current-buffer)))
(setq putstring (copy-sequence putstring))
(let ((overlay (make-overlay pos pos buffer))
(prop (or dprop
(list (list 'margin 'left-margin) putstring))))
(put-text-property 0 1 'display prop string)
(if sprops
(add-text-properties 0 1 sprops string))
(overlay-put overlay 'put-break t)
(overlay-put overlay 'before-string string))))
;;from remove-images
(defun gdb-remove-strings (start end &optional buffer)
"Remove strings between START and END in BUFFER.
Remove only strings that were put in BUFFER with calls to `gdb-put-string'.
BUFFER nil or omitted means use the current buffer."
(unless buffer
(setq buffer (current-buffer)))
(dolist (overlay (overlays-in start end))
(when (overlay-get overlay 'put-break)
(delete-overlay overlay))))
(defun gdb-put-breakpoint-icon (enabled bptno &optional line)
(let* ((posns (gdb-line-posns (or line (line-number-at-pos))))
(start (- (car posns) 1))
(end (+ (cdr posns) 1))
(putstring (if enabled "B" "b"))
(source-window (get-buffer-window (current-buffer) 0)))
(add-text-properties
0 1 '(help-echo "mouse-1: clear bkpt, mouse-3: enable/disable bkpt")
putstring)
(if enabled
(add-text-properties
0 1 `(gdb-bptno ,bptno gdb-enabled t) putstring)
(add-text-properties
0 1 `(gdb-bptno ,bptno gdb-enabled nil) putstring))
(gdb-remove-breakpoint-icons start end)
(if (display-images-p)
(if (>= (or left-fringe-width
(if source-window (car (window-fringes source-window)))
gdb-buffer-fringe-width) 8)
(gdb-put-string
nil (1+ start)
`(left-fringe breakpoint
,(if enabled
'breakpoint-enabled
'breakpoint-disabled))
'gdb-bptno bptno
'gdb-enabled enabled)
(when (< left-margin-width 2)
(save-current-buffer
(setq left-margin-width 2)
(if source-window
(set-window-margins
source-window
left-margin-width right-margin-width))))
(put-image
(if enabled
(or breakpoint-enabled-icon
(setq breakpoint-enabled-icon
(find-image `((:type xpm :data
,breakpoint-xpm-data
:ascent 100 :pointer hand)
(:type pbm :data
,breakpoint-enabled-pbm-data
:ascent 100 :pointer hand)))))
(or breakpoint-disabled-icon
(setq breakpoint-disabled-icon
(find-image `((:type xpm :data
,breakpoint-xpm-data
:conversion disabled
:ascent 100 :pointer hand)
(:type pbm :data
,breakpoint-disabled-pbm-data
:ascent 100 :pointer hand))))))
(+ start 1)
putstring
'left-margin))
(when (< left-margin-width 2)
(save-current-buffer
(setq left-margin-width 2)
(let ((window (get-buffer-window (current-buffer) 0)))
(if window
(set-window-margins
window left-margin-width right-margin-width)))))
(gdb-put-string
(propertize putstring
'face (if enabled
'breakpoint-enabled 'breakpoint-disabled))
(1+ start)))))
(defun gdb-remove-breakpoint-icons (start end &optional remove-margin)
(gdb-remove-strings start end)
(if (display-images-p)
(remove-images start end))
(when remove-margin
(setq left-margin-width 0)
(let ((window (get-buffer-window (current-buffer) 0)))
(if window
(set-window-margins
window left-margin-width right-margin-width)))))
\f
;;; Functions for inline completion.
(defvar gud-gdb-fetch-lines-in-progress)
(defvar gud-gdb-fetch-lines-string)
(defvar gud-gdb-fetch-lines-break)
(defvar gud-gdb-fetched-lines)
(defun gud-gdbmi-completions (context command)
"Completion table for GDB/MI commands.
COMMAND is the prefix for which we seek completion.
CONTEXT is the text before COMMAND on the line."
(let ((gud-gdb-fetch-lines-in-progress t)
(gud-gdb-fetch-lines-string nil)
(gud-gdb-fetch-lines-break (length context))
(gud-gdb-fetched-lines nil)
;; This filter dumps output lines to `gud-gdb-fetched-lines'.
(gud-marker-filter #'gud-gdbmi-fetch-lines-filter))
(with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
(gdb-input (concat "complete " context command)
(lambda () (setq gud-gdb-fetch-lines-in-progress nil)))
(while gud-gdb-fetch-lines-in-progress
(accept-process-output (get-buffer-process gud-comint-buffer))))
(gud-gdb-completions-1 gud-gdb-fetched-lines)))
(defun gud-gdbmi-fetch-lines-filter (string)
"Custom filter function for `gud-gdbmi-completions'."
(setq string (concat gud-gdb-fetch-lines-string
(gud-gdbmi-marker-filter string)))
(while (string-match "\n" string)
(push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
gud-gdb-fetched-lines)
(setq string (substring string (match-end 0))))
"")
(provide 'gdb-mi)
;;; gdb-mi.el ends here
|