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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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 2
* of the License, or (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "glk/adrift/adrift.h"
#include "glk/adrift/scprotos.h"
#include "glk/adrift/scgamest.h"
namespace Glk {
namespace Adrift {
/* Assorted definitions and constants. */
static const sc_uint DEBUG_MAGIC = 0xc4584d2e;
enum { DEBUG_BUFFER_SIZE = 256 };
/* Debugging command and command argument type. */
typedef enum
{ DEBUG_NONE = 0, DEBUG_CONTINUE, DEBUG_STEP, DEBUG_BUFFER, DEBUG_RESOURCES,
DEBUG_HELP, DEBUG_GAME,
DEBUG_PLAYER, DEBUG_ROOMS, DEBUG_OBJECTS, DEBUG_NPCS, DEBUG_EVENTS,
DEBUG_TASKS, DEBUG_VARIABLES,
DEBUG_OLDPLAYER, DEBUG_OLDROOMS, DEBUG_OLDOBJECTS, DEBUG_OLDNPCS,
DEBUG_OLDEVENTS, DEBUG_OLDTASKS, DEBUG_OLDVARIABLES,
DEBUG_WATCHPLAYER, DEBUG_WATCHOBJECTS, DEBUG_WATCHNPCS, DEBUG_WATCHEVENTS,
DEBUG_WATCHTASKS, DEBUG_WATCHVARIABLES,
DEBUG_CLEARPLAYER, DEBUG_CLEAROBJECTS, DEBUG_CLEARNPCS, DEBUG_CLEAREVENTS,
DEBUG_CLEARTASKS, DEBUG_CLEARVARIABLES,
DEBUG_WATCHALL, DEBUG_CLEARALL, DEBUG_RANDOM,
DEBUG_QUIT
}
sc_command_t;
typedef enum
{ COMMAND_QUERY = 0, COMMAND_RANGE, COMMAND_ONE, COMMAND_ALL }
sc_command_type_t;
/* Table connecting debugging command strings to commands. */
typedef struct
{
const sc_char *const command_string;
const sc_command_t command;
} sc_strings_t;
static const sc_strings_t DEBUG_COMMANDS[] = {
{"continue", DEBUG_CONTINUE}, {"step", DEBUG_STEP}, {"buffer", DEBUG_BUFFER},
{"resources", DEBUG_RESOURCES}, {"help", DEBUG_HELP}, {"game", DEBUG_GAME},
{"player", DEBUG_PLAYER}, {"rooms", DEBUG_ROOMS}, {"objects", DEBUG_OBJECTS},
{"npcs", DEBUG_NPCS}, {"events", DEBUG_EVENTS}, {"tasks", DEBUG_TASKS},
{"variables", DEBUG_VARIABLES},
{"oldplayer", DEBUG_OLDPLAYER}, {"oldrooms", DEBUG_OLDROOMS},
{"oldobjects", DEBUG_OLDOBJECTS}, {"oldnpcs", DEBUG_OLDNPCS},
{"oldevents", DEBUG_OLDEVENTS}, {"oldtasks", DEBUG_OLDTASKS},
{"oldvariables", DEBUG_OLDVARIABLES},
{"watchplayer", DEBUG_WATCHPLAYER}, {"clearplayer", DEBUG_CLEARPLAYER},
{"watchobjects", DEBUG_WATCHOBJECTS}, {"watchnpcs", DEBUG_WATCHNPCS},
{"watchevents", DEBUG_WATCHEVENTS}, {"watchtasks", DEBUG_WATCHTASKS},
{"watchvariables", DEBUG_WATCHVARIABLES},
{"clearobjects", DEBUG_CLEAROBJECTS}, {"clearnpcs", DEBUG_CLEARNPCS},
{"clearevents", DEBUG_CLEAREVENTS}, {"cleartasks", DEBUG_CLEARTASKS},
{"clearvariables", DEBUG_CLEARVARIABLES}, {"watchall", DEBUG_WATCHALL},
{"clearall", DEBUG_CLEARALL}, {"random", DEBUG_RANDOM}, {"quit", DEBUG_QUIT},
{NULL, DEBUG_NONE}
};
/*
* Debugging control information structure. The structure is created and
* added to the game on enabling debug, and removed and destroyed on
* disabling debugging.
*/
typedef struct sc_debugger_s
{
sc_uint magic;
sc_bool *watch_objects;
sc_bool *watch_npcs;
sc_bool *watch_events;
sc_bool *watch_tasks;
sc_bool *watch_variables;
sc_bool watch_player;
sc_bool single_step;
sc_bool quit_pending;
sc_uint elapsed_seconds;
} sc_debugger_t;
/*
* debug_is_valid()
*
* Return TRUE if pointer is a valid debugger, FALSE otherwise.
*/
static sc_bool
debug_is_valid (sc_debuggerref_t debug)
{
return debug && debug->magic == DEBUG_MAGIC;
}
/*
* debug_get_debugger()
*
* Return the debugger reference from a game, or NULL if none.
*/
static sc_debuggerref_t
debug_get_debugger (sc_gameref_t game)
{
assert (gs_is_game_valid (game));
return game->debugger;
}
/*
* debug_variable_count()
*
* Common helper to return the count of variables defined in a game.
*/
static sc_int
debug_variable_count (sc_gameref_t game)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key;
sc_int variable_count;
/* Find and return the variables count. */
vt_key.string = "Variables";
variable_count = prop_get_child_count (bundle, "I<-s", &vt_key);
return variable_count;
}
/*
* debug_initialize()
*
* Create a new set of debug control information, and append it to the
* game passed in.
*/
static void
debug_initialize (sc_gameref_t game)
{
sc_debuggerref_t debug;
/* Create the easy bits of the new debugging set. */
debug = (sc_debuggerref_t)sc_malloc (sizeof (*debug));
debug->magic = DEBUG_MAGIC;
debug->watch_player = FALSE;
debug->single_step = FALSE;
debug->quit_pending = FALSE;
debug->elapsed_seconds = 0;
/* Allocate watchpoints for everything we can watch. */
debug->watch_objects = (sc_bool *)sc_malloc (gs_object_count (game)
* sizeof (*debug->watch_objects));
debug->watch_npcs = (sc_bool *)sc_malloc (gs_npc_count (game)
* sizeof (*debug->watch_npcs));
debug->watch_events = (sc_bool *)sc_malloc (gs_event_count (game)
* sizeof (*debug->watch_events));
debug->watch_tasks = (sc_bool *)sc_malloc (gs_task_count (game)
* sizeof (*debug->watch_tasks));
debug->watch_variables = (sc_bool *)sc_malloc (debug_variable_count (game)
* sizeof (*debug->watch_variables));
/* Clear all watchpoint arrays. */
memset (debug->watch_objects, FALSE,
gs_object_count (game) * sizeof (*debug->watch_objects));
memset (debug->watch_npcs, FALSE,
gs_npc_count (game) * sizeof (*debug->watch_npcs));
memset (debug->watch_events, FALSE,
gs_event_count (game) * sizeof (*debug->watch_events));
memset (debug->watch_tasks, FALSE,
gs_task_count (game) * sizeof (*debug->watch_tasks));
memset (debug->watch_variables, FALSE,
debug_variable_count (game) * sizeof (*debug->watch_variables));
/* Append the new debugger set to the game. */
assert (!game->debugger);
game->debugger = debug;
}
/*
* debug_finalize()
*
* Destroy a debug data set, free its heap memory, and remove its reference
* from the game.
*/
static void
debug_finalize (sc_gameref_t game)
{
sc_debuggerref_t debug = debug_get_debugger (game);
assert (debug_is_valid (debug));
/* Free all allocated watchpoint arrays. */
sc_free (debug->watch_objects);
sc_free (debug->watch_npcs);
sc_free (debug->watch_events);
sc_free (debug->watch_tasks);
sc_free (debug->watch_variables);
/* Poison and free the debugger itself. */
memset (debug, 0xaa, sizeof (*debug));
sc_free (debug);
/* Remove the debug reference from the game. */
game->debugger = NULL;
}
/*
* debug_help()
*
* Print debugging help.
*/
static void
debug_help (sc_command_t topic)
{
/* Is help general, or specific? */
if (topic == DEBUG_NONE)
{
if_print_debug (
"The following debugging commands examine game state:\n\n");
if_print_debug (
" game -- Print general game information,"
" and class counts\n"
" player -- Show the player location and position\n"
" rooms [Range] -- Print information on game rooms\n"
" objects [Range] -- Print information on objects in the game\n"
" npcs [Range] -- Print information on game NPCs\n"
" events [Range] -- Print information on the game's events\n"
" tasks [Range] -- Print information on the game's tasks\n"
" variables [Range] -- Show variables defined by the game\n\n");
if_print_debug (
"Most commands take range inputs. This can be a single number, to"
" apply the command to just that item, a range such as '0 to 10' (or"
" '0 - 10', '0 .. 10', or simply '0 10') to apply to that range of"
" items, or '*' to apply the command to all items of the class. If"
" omitted, the command is applied only to the items of the class"
" 'relevant' to the current game state; see the help for specific"
" commands for more on what is 'relevant'.\n\n");
if_print_debug (
"The 'player', 'objects', 'npcs', 'events', 'tasks', and 'variables'"
" commands may be prefixed with 'old', in which case the values"
" printed will be those for the previous game turn, rather than the"
" current values.\n\n");
if_print_debug (
"These debugging commands manage watchpoints:\n\n");
if_print_debug (
"The 'player', 'objects', 'npcs', 'events', 'tasks', and 'variables'"
" commands may be prefixed with 'watch', to set watchpoints."
" Watchpoints automatically enter the debugger when the item changes"
" state during a game turn. For example 'watchobject 10' monitors"
" object 10 for changes, and 'watchnpc *' monitors all NPCs. A"
" 'watch' command with no range prints out all watchpoints set for"
" that class.\n\n");
if_print_debug (
"Prefix commands with 'clear' to clear watchpoints, for example"
" 'clearnpcs *'. Use 'watchall' to obtain a complete list of every"
" watchpoint set, and 'clearall' to clear all watchpoints in one go."
" A 'clear' command with no range behaves the same as a 'watch'"
" command with no range.\n\n");
if_print_debug (
"These debugging commands print details of game output and control the"
" debugger and interpreter:\n\n");
if_print_debug (
" buffer -- Show the current buffered game text\n"
" resources -- Show current and requested game resources\n"
" random [Seed] -- Control the random number generator\n"
" step -- Run one game turn, then re-enter the debugger\n"
" continue -- Leave the debugger and resume the game\n"
" quit -- Exit the interpreter main loop\n"
" help [Command] -- Print help specific to Command\n\n");
if_print_debug (
"Debugging commands may be abbreviated to their shortest unambiguous"
" form.\n\n");
if_print_debug (
"Use the 'debug' or '#debug' command in a game, typed at the usual"
" game prompt, to return to the debugger.\n");
return;
}
/* Command-specific help. */
switch (topic)
{
case DEBUG_HELP:
if_print_debug (
"Give the name of the command you want help on, for example 'help"
" continue'.\n");
break;
case DEBUG_CONTINUE:
if_print_debug (
"Leave the debugger and resume the game. Use the 'debug' or '#debug'"
" command in a game, typed at the usual game prompt, to return to the"
" debugger.\n");
break;
case DEBUG_STEP:
if_print_debug (
"Run one game turn, then re-enter the debugger. Useful for games that"
" intercept empty input lines, which otherwise catch the 'debug'"
" command before SCARE can get to it.\n");
break;
case DEBUG_QUIT:
if_print_debug (
"Exit the interpreter main loop. Equivalent to a confirmed 'quit'"
" from within the game itself, this ends the interpreter session.\n");
break;
case DEBUG_BUFFER:
if_print_debug (
"Print the current text that the game has buffered for output. The"
" debugger catches games before they have printed their turn output"
" -- this is the text that will be filtered and printed on exiting the"
" debugger.\n");
break;
case DEBUG_RESOURCES:
if_print_debug (
"Print any resources currently active, and any requested by the game"
" on the current turn. The requested resources will become the active"
" ones on exiting the debugger.\n");
break;
case DEBUG_RANDOM:
if_print_debug (
"If no seed is given, report the current random number generator"
" setting. Otherwise, seed the random number generator with the value"
" given. This is useful for persuading games with random sections to"
" behave predictably. A new seed value of zero is invalid.\n");
break;
case DEBUG_GAME:
if_print_debug (
"Print general game information, including the number of rooms,"
" objects, events, tasks, and variables that the game defines\n");
break;
case DEBUG_PLAYER:
if_print_debug (
"Print out the current player room and position, and any parent object"
" of the player character.\n");
break;
case DEBUG_OLDPLAYER:
if_print_debug (
"Print out the player room and position from the previous turn, and"
" any parent object of the player character.\n");
break;
case DEBUG_ROOMS:
if_print_debug (
"Print out the name and contents of rooms in the range. If no range,"
" print details of the room containing the player.\n");
break;
case DEBUG_OLDROOMS:
if_print_debug (
"Print out the name and contents of rooms in the range for the"
" previous turn. If no range, print details of the room that"
" contained the player on the previous turn.\n");
break;
case DEBUG_OBJECTS:
if_print_debug (
"Print out details of all objects in the range. If no range, print"
" details of objects in the room containing the player, and visible to"
" the player.\n");
break;
case DEBUG_OLDOBJECTS:
if_print_debug (
"Print out details of all objects in the range for the previous turn."
" If no range, print details of objects in the room that contained"
" the player, and were visible to the player.\n");
break;
case DEBUG_NPCS:
if_print_debug (
"Print out details of all NPCs in the range. If no range, print"
" details of only NPCs in the room containing the player.\n");
break;
case DEBUG_OLDNPCS:
if_print_debug (
"Print out details of all NPCs in the range for the previous turn."
" If no range, print details of only NPCs in the room that contained"
" the player.\n");
break;
case DEBUG_EVENTS:
if_print_debug (
"Print out details of all events in the range. If no range, print"
" details of only events currently running.\n");
break;
case DEBUG_OLDEVENTS:
if_print_debug (
"Print out details of all events in the range for the previous turn."
" If no range, print details of only events running on the previous"
" turn.\n");
break;
case DEBUG_TASKS:
if_print_debug (
"Print out details of all tasks in the range. If no range, print"
" details of only tasks that are runnable, for the current state of"
" the game.\n");
break;
case DEBUG_OLDTASKS:
if_print_debug (
"Print out details of all tasks in the range for the previous turn."
" If no range, print details of only tasks that were runnable, for"
" the previous state of the game.\n");
break;
case DEBUG_VARIABLES:
if_print_debug (
"Print out the names, types, and values of all game variables in the"
" range. If no range, print details of all variables (equivalent to"
" 'variables *').\n");
break;
case DEBUG_OLDVARIABLES:
if_print_debug (
"Print out the names, types, and values at the previous turn of all"
" game variables in the range. If no range, print details of all"
" variables (equivalent to 'variables *').\n");
break;
case DEBUG_WATCHPLAYER:
if_print_debug (
"If no range is given, list any watchpoint on player movement. If"
" range '0' is given, set a watchpoint on player movement. Other"
" usages of 'watchplayer' behave as if no range is given.\n");
break;
case DEBUG_WATCHOBJECTS:
if_print_debug (
"Set watchpoints on all objects in the range. If no range, list out"
" object watchpoints currently set.\n");
break;
case DEBUG_WATCHNPCS:
if_print_debug (
"Set watchpoints on all NPCs in the range. If no range, list out NPC"
" watchpoints currently set.\n");
break;
case DEBUG_WATCHEVENTS:
if_print_debug (
"Set watchpoints on all events in the range. If no range, list out"
" event watchpoints currently set.\n");
break;
case DEBUG_WATCHTASKS:
if_print_debug (
"Set watchpoints on all tasks in the range. If no range, list out"
" task watchpoints currently set.\n");
break;
case DEBUG_WATCHVARIABLES:
if_print_debug (
"Set watchpoints on all game variables in the range. If no range,"
" list variable watchpoints currently set.\n");
break;
case DEBUG_CLEARPLAYER:
if_print_debug (
"Clear any watchpoint set on player movements.\n");
break;
case DEBUG_CLEAROBJECTS:
if_print_debug (
"Clear watchpoints on all objects in the range. If no range, list"
" out object watchpoints currently set.\n");
break;
case DEBUG_CLEARNPCS:
if_print_debug (
"Clear watchpoints on all NPCs in the range. If no range, list out"
" NPC watchpoints currently set.\n");
break;
case DEBUG_CLEAREVENTS:
if_print_debug (
"Clear watchpoints on all events in the range. If no range, list out"
" event watchpoints currently set.\n");
break;
case DEBUG_CLEARTASKS:
if_print_debug (
"Clear watchpoints on all tasks in the range. If no range, list out"
" task watchpoints currently set.\n");
break;
case DEBUG_CLEARVARIABLES:
if_print_debug (
"Clear watchpoints on all game variables in the range. If no range,"
" list variable watchpoints currently set.\n");
break;
case DEBUG_WATCHALL:
if_print_debug (
"Print out a list of all all watchpoints set for all the classes of"
" item on which watchpoints can be used.\n");
break;
case DEBUG_CLEARALL:
if_print_debug (
"Clear all watchpoints set, on all classes of item on which"
" watchpoints can be used.\n");
break;
default:
if_print_debug (
"Sorry, there is no help available on that at the moment.\n");
break;
}
}
/*
* debug_print_quoted()
* debug_print_player()
* debug_print_room()
* debug_print_object()
* debug_print_npc()
* debug_print_event()
* debug_print_task()
* debug_print_variable()
*
* Low level output helpers.
*/
static void
debug_print_quoted (const sc_char *string)
{
if_print_debug_character ('"');
if_print_debug (string);
if_print_debug_character ('"');
}
static void
debug_print_player (sc_gameref_t game)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[2];
const sc_char *playername;
vt_key[0].string = "Globals";
vt_key[1].string = "PlayerName";
playername = prop_get_string (bundle, "S<-ss", vt_key);
if_print_debug ("Player ");
debug_print_quoted (playername);
}
static void
debug_print_room (sc_gameref_t game, sc_int room)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[3];
sc_char buffer[32];
const sc_char *name;
if_print_debug ("Room ");
if (room < 0 || room >= gs_room_count (game))
{
sprintf (buffer, "%ld ", room);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "Rooms";
vt_key[1].integer = room;
vt_key[2].string = "Short";
name = prop_get_string (bundle, "S<-sis", vt_key);
sprintf (buffer, "%ld ", room);
if_print_debug (buffer);
debug_print_quoted (name);
}
static void
debug_print_object (sc_gameref_t game, sc_int object)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[3];
sc_bool bstatic;
sc_char buffer[32];
const sc_char *prefix, *name;
if (object < 0 || object >= gs_object_count (game))
{
if_print_debug ("Object ");
sprintf (buffer, "%ld ", object);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "Objects";
vt_key[1].integer = object;
vt_key[2].string = "Static";
bstatic = prop_get_boolean (bundle, "B<-sis", vt_key);
vt_key[2].string = "Prefix";
prefix = prop_get_string (bundle, "S<-sis", vt_key);
vt_key[2].string = "Short";
name = prop_get_string (bundle, "S<-sis", vt_key);
if (bstatic)
if_print_debug ("Static ");
else
if_print_debug ("Dynamic ");
sprintf (buffer, "%ld ", object);
if_print_debug (buffer);
debug_print_quoted (prefix);
if_print_debug_character (' ');
debug_print_quoted (name);
}
static void
debug_print_npc (sc_gameref_t game, sc_int npc)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[3];
sc_char buffer[32];
const sc_char *prefix, *name;
if_print_debug ("NPC ");
if (npc < 0 || npc >= gs_npc_count (game))
{
sprintf (buffer, "%ld ", npc);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "NPCs";
vt_key[1].integer = npc;
vt_key[2].string = "Prefix";
prefix = prop_get_string (bundle, "S<-sis", vt_key);
vt_key[2].string = "Name";
name = prop_get_string (bundle, "S<-sis", vt_key);
sprintf (buffer, "%ld ", npc);
if_print_debug (buffer);
debug_print_quoted (prefix);
if_print_debug_character (' ');
debug_print_quoted (name);
}
static void
debug_print_event (sc_gameref_t game, sc_int event)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[3];
sc_char buffer[32];
const sc_char *name;
if_print_debug ("Event ");
if (event < 0 || event >= gs_event_count (game))
{
sprintf (buffer, "%ld ", event);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "Events";
vt_key[1].integer = event;
vt_key[2].string = "Short";
name = prop_get_string (bundle, "S<-sis", vt_key);
sprintf (buffer, "%ld ", event);
if_print_debug (buffer);
debug_print_quoted (name);
}
static void
debug_print_task (sc_gameref_t game, sc_int task)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_vartype_t vt_key[4];
sc_char buffer[32];
const sc_char *command;
if_print_debug ("Task ");
if (task < 0 || task >= gs_task_count (game))
{
sprintf (buffer, "%ld ", task);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "Tasks";
vt_key[1].integer = task;
vt_key[2].string = "Command";
vt_key[3].integer = 0;
command = prop_get_string (bundle, "S<-sisi", vt_key);
sprintf (buffer, "%ld ", task);
if_print_debug (buffer);
debug_print_quoted (command);
}
static void
debug_print_variable (sc_gameref_t game, sc_int variable)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
const sc_var_setref_t vars = gs_get_vars (game);
sc_vartype_t vt_key[3], vt_rvalue;
sc_char buffer[32];
sc_int var_type;
const sc_char *name;
if (variable < 0 || variable >= debug_variable_count (game))
{
if_print_debug ("Variable ");
sprintf (buffer, "%ld ", variable);
if_print_debug (buffer);
if_print_debug ("[Out of range]");
return;
}
vt_key[0].string = "Variables";
vt_key[1].integer = variable;
vt_key[2].string = "Name";
name = prop_get_string (bundle, "S<-sis", vt_key);
if (var_get (vars, name, &var_type, &vt_rvalue))
{
switch (var_type)
{
case VAR_INTEGER:
if_print_debug ("Integer ");
break;
case VAR_STRING:
if_print_debug ("String ");
break;
default:
if_print_debug ("[Invalid type] ");
break;
}
}
else
if_print_debug ("[Invalid variable] ");
sprintf (buffer, "%ld ", variable);
if_print_debug (buffer);
debug_print_quoted (name);
}
/*
* debug_game()
*
* Display overall game details.
*/
static void
debug_game (sc_gameref_t game, sc_command_type_t type)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
const sc_debuggerref_t debug = debug_get_debugger (game);
sc_vartype_t vt_key[2];
const sc_char *version, *gamename, *compiledate, *gameauthor;
sc_int perspective, waitturns;
sc_bool has_sound, has_graphics, has_battle;
sc_char buffer[32];
assert (debug_is_valid (debug));
if (type != COMMAND_QUERY)
{
if_print_debug ("The Game command takes no arguments.\n");
return;
}
if_print_debug ("Game ");
vt_key[0].string = "Globals";
vt_key[1].string = "GameName";
gamename = prop_get_string (bundle, "S<-ss", vt_key);
debug_print_quoted (gamename);
if_print_debug_character ('\n');
if_print_debug (" Compiled ");
vt_key[0].string = "CompileDate";
compiledate = prop_get_string (bundle, "S<-s", vt_key);
debug_print_quoted (compiledate);
if_print_debug (", Author ");
vt_key[0].string = "Globals";
vt_key[1].string = "GameAuthor";
gameauthor = prop_get_string (bundle, "S<-ss", vt_key);
debug_print_quoted (gameauthor);
if_print_debug_character ('\n');
vt_key[0].string = "VersionString";
version = prop_get_string (bundle, "S<-s", vt_key);
if_print_debug (" Version ");
if_print_debug (version);
vt_key[0].string = "Globals";
vt_key[1].string = "Perspective";
perspective = prop_get_integer (bundle, "I<-ss", vt_key);
switch (perspective)
{
case 0:
if_print_debug (", First person");
break;
case 1:
if_print_debug (", Second person");
break;
case 2:
if_print_debug (", Third person");
break;
default:
if_print_debug (", [Unknown perspective]");
break;
}
vt_key[0].string = "Globals";
vt_key[1].string = "WaitTurns";
waitturns = prop_get_integer (bundle, "I<-ss", vt_key);
if_print_debug (", Waitturns ");
sprintf (buffer, "%ld", waitturns);
if_print_debug (buffer);
vt_key[0].string = "Globals";
vt_key[1].string = "Sound";
has_sound = prop_get_boolean (bundle, "B<-ss", vt_key);
vt_key[1].string = "Graphics";
has_graphics = prop_get_boolean (bundle, "B<-ss", vt_key);
if (has_sound)
if_print_debug (", Sound");
if (has_graphics)
if_print_debug (", Graphics");
if_print_debug_character ('\n');
vt_key[0].string = "Globals";
vt_key[1].string = "BattleSystem";
has_battle = prop_get_boolean (bundle, "B<-ss", vt_key);
if (has_battle)
if_print_debug (" Battle system\n");
if_print_debug (" Room count ");
sprintf (buffer, "%ld", gs_room_count (game));
if_print_debug (buffer);
if_print_debug (", Object count ");
sprintf (buffer, "%ld", gs_object_count (game));
if_print_debug (buffer);
if_print_debug (", NPC count ");
sprintf (buffer, "%ld", gs_npc_count (game));
if_print_debug (buffer);
if_print_debug_character ('\n');
if_print_debug (" Event count ");
sprintf (buffer, "%ld", gs_event_count (game));
if_print_debug (buffer);
if_print_debug (", Task count ");
sprintf (buffer, "%ld", gs_task_count (game));
if_print_debug (buffer);
if_print_debug (", Variable count ");
sprintf (buffer, "%ld", debug_variable_count (game));
if_print_debug (buffer);
if_print_debug_character ('\n');
if (game->is_running)
if_print_debug (" Running");
else
if_print_debug (" Not running");
if (game->has_completed)
if_print_debug (", Completed");
else
if_print_debug (", Not completed");
if (game->verbose)
if_print_debug (", Verbose");
else
if_print_debug (", Not verbose");
if (game->bold_room_names)
if_print_debug (", Bold");
else
if_print_debug (", Not bold");
if (game->undo_available)
if_print_debug (", Undo");
else
if_print_debug (", No undo");
if_print_debug_character ('\n');
if_print_debug (" Score ");
sprintf (buffer, "%ld", game->score);
if_print_debug (buffer);
if_print_debug (", Turns ");
sprintf (buffer, "%ld", game->turns);
if_print_debug (buffer);
if_print_debug (", Seconds ");
sprintf (buffer, "%lu", debug->elapsed_seconds);
if_print_debug (buffer);
if_print_debug_character ('\n');
}
/*
* debug_player()
*
* Print a few brief details about the player status.
*/
static void
debug_player (sc_gameref_t game,
sc_command_t command, sc_command_type_t type)
{
if (type != COMMAND_QUERY)
{
if_print_debug ("The Player command takes no arguments.\n");
return;
}
if (command == DEBUG_OLDPLAYER)
{
if (!game->undo_available)
{
if_print_debug ("There is no previous game state to examine.\n");
return;
}
game = game->undo;
assert (gs_is_game_valid (game));
}
debug_print_player (game);
if_print_debug_character ('\n');
if (gs_playerroom (game) == -1)
if_print_debug (" Hidden!\n");
else
{
if_print_debug (" In ");
debug_print_room (game, gs_playerroom (game));
if_print_debug_character ('\n');
}
switch (gs_playerposition (game))
{
case 0:
if_print_debug (" Standing\n");
break;
case 1:
if_print_debug (" Sitting\n");
break;
case 2:
if_print_debug (" Lying\n");
break;
default:
if_print_debug (" [Invalid position]\n");
break;
}
if (gs_playerparent (game) != -1)
{
if_print_debug (" Parent is ");
debug_print_object (game, gs_playerparent (game));
if_print_debug_character ('\n');
}
}
/*
* debug_normalize_arguments()
*
* Normalize a set of arguments parsed from a debugger command line, for
* debug commands that take ranges.
*/
static sc_bool
debug_normalize_arguments (sc_command_type_t type,
sc_int *arg1, sc_int *arg2, sc_int limit)
{
sc_int low = 0, high = 0;
/* Set range low and high depending on the command type. */
switch (type)
{
case COMMAND_QUERY:
case COMMAND_ALL:
low = 0;
high = limit - 1;
break;
case COMMAND_ONE:
low = *arg1;
high = *arg1;
break;
case COMMAND_RANGE:
low = *arg1;
high = *arg2;
break;
default:
sc_fatal ("debug_normalize_arguments: bad command type\n");
}
/* If range is valid, copy out and return TRUE. */
if (low >= 0 && low < limit && high >= 0 && high < limit && high >= low)
{
*arg1 = low;
*arg2 = high;
return TRUE;
}
/* Input range is invalid. */
return FALSE;
}
/*
* debug_filter_room()
* debug_dump_room()
*
* Print details of rooms and their direct contents.
*/
static sc_bool
debug_filter_room (sc_gameref_t game, sc_int room)
{
return room == gs_playerroom (game);
}
static void
debug_dump_room (sc_gameref_t game, sc_int room)
{
sc_int object, npc;
debug_print_room (game, room);
if_print_debug_character ('\n');
if (gs_room_seen (game, room))
if_print_debug (" Visited\n");
else
if_print_debug (" Not visited\n");
if (gs_playerroom (game) == room)
{
if_print_debug (" ");
debug_print_player (game);
if_print_debug_character ('\n');
}
for (object = 0; object < gs_object_count (game); object++)
{
if (obj_indirectly_in_room (game, object, room))
{
if_print_debug (" ");
debug_print_object (game, object);
if_print_debug_character ('\n');
}
}
for (npc = 0; npc < gs_npc_count (game); npc++)
{
if (npc_in_room (game, npc, room))
{
if_print_debug (" ");
debug_print_npc (game, npc);
if_print_debug_character ('\n');
}
}
}
/*
* debug_filter_object()
* debug_dump_object()
*
* Print the changeable details of game objects.
*/
static sc_bool
debug_filter_object (sc_gameref_t game, sc_int object)
{
return obj_indirectly_in_room (game, object, gs_playerroom (game));
}
static void
debug_dump_object (sc_gameref_t game, sc_int object)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
sc_int openness;
sc_vartype_t vt_key[3];
sc_bool bstatic, is_statussed;
sc_int position, parent;
debug_print_object (game, object);
if_print_debug_character ('\n');
vt_key[0].string = "Objects";
vt_key[1].integer = object;
vt_key[2].string = "Static";
bstatic = prop_get_boolean (bundle, "B<-sis", vt_key);
if (gs_object_seen (game, object))
if_print_debug (" Seen");
else
if_print_debug (" Not seen");
if (bstatic)
{
if (gs_object_static_unmoved (game, object))
if_print_debug (", Not relocated");
else
if_print_debug (", Relocated");
}
else
{
vt_key[2].string = "OnlyWhenNotMoved";
if (prop_get_integer (bundle, "I<-sis", vt_key) == 1)
{
if (gs_object_unmoved (game, object))
if_print_debug (", Not moved");
else
if_print_debug (", Moved");
}
}
openness = gs_object_openness (game, object);
switch (openness)
{
case OBJ_OPEN:
if_print_debug (", Open");
break;
case OBJ_CLOSED:
if_print_debug (", Closed");
break;
case OBJ_LOCKED:
if_print_debug (", Locked");
break;
}
if_print_debug_character ('\n');
position = gs_object_position (game, object);
parent = gs_object_parent (game, object);
switch (position)
{
case OBJ_HIDDEN:
if (bstatic)
if_print_debug (" Static default\n");
else
if_print_debug (" Hidden\n");
break;
case OBJ_HELD_PLAYER:
if_print_debug (" Held by ");
debug_print_player (game);
if_print_debug_character ('\n');
break;
case OBJ_HELD_NPC:
if_print_debug (" Held by ");
debug_print_npc (game, parent);
if_print_debug_character ('\n');
break;
case OBJ_WORN_PLAYER:
if_print_debug (" Worn by ");
debug_print_player (game);
if_print_debug_character ('\n');
break;
case OBJ_WORN_NPC:
if_print_debug (" Worn by ");
debug_print_npc (game, parent);
if_print_debug_character ('\n');
break;
case OBJ_PART_NPC:
if_print_debug (" Part of ");
if (parent == -1)
debug_print_player (game);
else
debug_print_npc (game, parent);
if_print_debug_character ('\n');
break;
case OBJ_ON_OBJECT:
if_print_debug (" On ");
debug_print_object (game, parent);
if_print_debug_character ('\n');
break;
case OBJ_IN_OBJECT:
if_print_debug (" Inside ");
debug_print_object (game, parent);
if_print_debug_character ('\n');
break;
default:
if_print_debug (" In ");
debug_print_room (game, position - 1);
if_print_debug_character ('\n');
break;
}
vt_key[0].string = "Objects";
vt_key[1].integer = object;
vt_key[2].string = "CurrentState";
is_statussed = prop_get_integer (bundle, "I<-sis", vt_key) != 0;
if (is_statussed)
{
sc_char buffer[32];
const sc_char *states;
if_print_debug (" State ");
sprintf (buffer, "%ld", gs_object_state (game, object));
if_print_debug (buffer);
vt_key[2].string = "States";
states = prop_get_string (bundle, "S<-sis", vt_key);
if_print_debug (" of ");
debug_print_quoted (states);
if_print_debug_character ('\n');
}
}
/*
* debug_filter_npc()
* debug_dump_npc()
*
* Print stuff about NPCs.
*/
static sc_bool
debug_filter_npc (sc_gameref_t game, sc_int npc)
{
return npc_in_room (game, npc, gs_playerroom (game));
}
static void
debug_dump_npc (sc_gameref_t game, sc_int npc)
{
debug_print_npc (game, npc);
if_print_debug_character ('\n');
if (gs_npc_seen (game, npc))
if_print_debug (" Seen\n");
else
if_print_debug (" Not seen\n");
if (gs_npc_location (game, npc) - 1 == -1)
if_print_debug (" Hidden\n");
else
{
if_print_debug (" In ");
debug_print_room (game, gs_npc_location (game, npc) - 1);
if_print_debug_character ('\n');
}
switch (gs_npc_position (game, npc))
{
case 0:
if_print_debug (" Standing\n");
break;
case 1:
if_print_debug (" Sitting\n");
break;
case 2:
if_print_debug (" Lying\n");
break;
default:
if_print_debug (" [Invalid position]\n");
break;
}
if (gs_npc_parent (game, npc) != -1)
{
if_print_debug (" Parent is ");
debug_print_object (game, gs_npc_parent (game, npc));
if_print_debug_character ('\n');
}
if (gs_npc_walkstep_count (game, npc) > 0)
{
sc_char buffer[32];
sc_int walk;
if_print_debug (" Walkstep count ");
sprintf (buffer, "%ld", gs_npc_walkstep_count (game, npc));
if_print_debug (buffer);
if_print_debug (", Walks { ");
for (walk = 0; walk < gs_npc_walkstep_count (game, npc); walk++)
{
sprintf (buffer, "%ld", gs_npc_walkstep (game, npc, walk));
if_print_debug (buffer);
if_print_debug_character (' ');
}
if_print_debug ("}.\n");
}
}
/*
* debug_filter_event()
* debug_dump_event()
*
* Print stuff about events.
*/
static sc_bool
debug_filter_event (sc_gameref_t game, sc_int event)
{
return gs_event_state (game, event) == ES_RUNNING;
}
static void
debug_dump_event (sc_gameref_t game, sc_int event)
{
sc_char buffer[32];
debug_print_event (game, event);
if_print_debug_character ('\n');
switch (gs_event_state (game, event))
{
case ES_WAITING:
if_print_debug (" Waiting\n");
break;
case ES_RUNNING:
if_print_debug (" Running\n");
break;
case ES_AWAITING:
if_print_debug (" Awaiting\n");
break;
case ES_FINISHED:
if_print_debug (" Finished\n");
break;
case ES_PAUSED:
if_print_debug (" Paused\n");
break;
default:
if_print_debug (" [Invalid state]\n");
break;
}
if_print_debug (" Time ");
sprintf (buffer, "%ld\n", gs_event_time (game, event));
if_print_debug (buffer);
}
/*
* debug_filter_task()
* debug_dump_task()
*
* Print stuff about tasks.
*/
static sc_bool
debug_filter_task (sc_gameref_t game, sc_int task)
{
return task_can_run_task (game, task);
}
static void
debug_dump_task (sc_gameref_t game, sc_int task)
{
debug_print_task (game, task);
if_print_debug_character ('\n');
if (task_can_run_task (game, task))
if_print_debug (" Runnable");
else
if_print_debug (" Not runnable");
if (gs_task_done (game, task))
if_print_debug (", Done");
else
if_print_debug (", Not done");
if (gs_task_scored (game, task))
if_print_debug (", Scored\n");
else
if_print_debug (", Not scored\n");
}
/*
* debug_dump_variable()
*
* Print stuff about variables.
*/
static void
debug_dump_variable (sc_gameref_t game, sc_int variable)
{
const sc_prop_setref_t bundle = gs_get_bundle (game);
const sc_var_setref_t vars = gs_get_vars (game);
sc_vartype_t vt_key[3], vt_rvalue;
const sc_char *name;
sc_int var_type;
debug_print_variable (game, variable);
if_print_debug_character ('\n');
vt_key[0].string = "Variables";
vt_key[1].integer = variable;
vt_key[2].string = "Name";
name = prop_get_string (bundle, "S<-sis", vt_key);
if_print_debug (" Value = ");
if (var_get (vars, name, &var_type, &vt_rvalue))
{
switch (var_type)
{
case VAR_INTEGER:
{
sc_char buffer[32];
sprintf (buffer, "%ld", vt_rvalue.integer);
if_print_debug (buffer);
break;
}
case VAR_STRING:
debug_print_quoted (vt_rvalue.string);
break;
default:
if_print_debug ("[Unknown]");
break;
}
}
else
if_print_debug ("[Unknown]");
if_print_debug_character ('\n');
}
/*
* debug_dump_common()
*
* Common handler for iterating dumps of classes.
*/
static void
debug_dump_common (sc_gameref_t game, sc_command_t command,
sc_command_type_t type, sc_int arg1, sc_int arg2)
{
sc_int low = arg1, high = arg2;
sc_int limit, index_;
const sc_char *class_;
sc_bool (*filter_function) (sc_gameref_t, sc_int);
void (*dumper_function) (sc_gameref_t, sc_int);
sc_bool printed = FALSE;
/* Initialize variables to avoid gcc warnings. */
limit = 0;
class_ = NULL;
filter_function = NULL;
dumper_function = NULL;
/* Switch to undo game on relevant commands. */
switch (command)
{
case DEBUG_OLDROOMS:
case DEBUG_OLDOBJECTS:
case DEBUG_OLDNPCS:
case DEBUG_OLDEVENTS:
case DEBUG_OLDTASKS:
case DEBUG_OLDVARIABLES:
if (!game->undo_available)
{
if_print_debug ("There is no previous game state to examine.\n");
return;
}
game = game->undo;
assert (gs_is_game_valid (game));
break;
default:
break;
}
/* Demultiplex dump command. */
switch (command)
{
case DEBUG_ROOMS:
case DEBUG_OLDROOMS:
class_ = "Room";
filter_function = debug_filter_room;
dumper_function = debug_dump_room;
limit = gs_room_count (game);
break;
case DEBUG_OBJECTS:
case DEBUG_OLDOBJECTS:
class_ = "Object";
filter_function = debug_filter_object;
dumper_function = debug_dump_object;
limit = gs_object_count (game);
break;
case DEBUG_NPCS:
case DEBUG_OLDNPCS:
class_ = "NPC";
filter_function = debug_filter_npc;
dumper_function = debug_dump_npc;
limit = gs_npc_count (game);
break;
case DEBUG_EVENTS:
case DEBUG_OLDEVENTS:
class_ = "Event";
filter_function = debug_filter_event;
dumper_function = debug_dump_event;
limit = gs_event_count (game);
break;
case DEBUG_TASKS:
case DEBUG_OLDTASKS:
class_ = "Task";
filter_function = debug_filter_task;
dumper_function = debug_dump_task;
limit = gs_task_count (game);
break;
case DEBUG_VARIABLES:
case DEBUG_OLDVARIABLES:
class_ = "Variable";
filter_function = NULL;
dumper_function = debug_dump_variable;
limit = debug_variable_count (game);
break;
default:
sc_fatal ("debug_dump_common: invalid command\n");
}
/* Normalize to this limit. */
if (!debug_normalize_arguments (type, &low, &high, limit))
{
if (limit == 0)
{
if_print_debug ("There is nothing of type ");
debug_print_quoted (class_);
if_print_debug (" to print.\n");
}
else
{
if_print_debug ("Invalid item or range for ");
debug_print_quoted (class_);
if (limit == 1)
if_print_debug ("; only 0 is valid.\n");
else
{
sc_char buffer[32];
if_print_debug ("; valid values are 0 to ");
sprintf (buffer, "%ld", limit - 1);
if_print_debug (buffer);
if_print_debug (".\n");
}
}
return;
}
/* Print each item of the class, filtering on query commands. */
for (index_ = low; index_ <= high; index_++)
{
if (type == COMMAND_QUERY
&& filter_function && !filter_function (game, index_))
continue;
if (printed)
if_print_debug_character ('\n');
dumper_function (game, index_);
printed = TRUE;
}
if (!printed)
{
if_print_debug ("Nothing of type ");
debug_print_quoted (class_);
if_print_debug (" is relevant.\nTry \"");
if_print_debug (class_);
if_print_debug (" *\" to show all items of this type.\n");
}
}
/*
* debug_buffer()
*
* Print the current raw printfilter contents.
*/
static void
debug_buffer (sc_gameref_t game, sc_command_type_t type)
{
const sc_filterref_t filter = gs_get_filter (game);
const sc_char *buffer;
if (type != COMMAND_QUERY)
{
if_print_debug ("The Buffer command takes no arguments.\n");
return;
}
buffer = pf_get_buffer (filter);
if (buffer)
if_print_debug (buffer);
else
if_print_debug ("There is no game text buffered.\n");
}
/*
* debug_print_resource()
*
* Helper for debug_resources().
*/
static void
debug_print_resource (const sc_resource_t *resource)
{
sc_char buffer[32];
debug_print_quoted (resource->name);
if_print_debug (", offset ");
sprintf (buffer, "%ld", resource->offset);
if_print_debug (buffer);
if_print_debug (", length ");
sprintf (buffer, "%ld", resource->length);
if_print_debug (buffer);
}
/*
* debug_resources()
*
* Print any active and requested resources.
*/
static void
debug_resources (sc_gameref_t game, sc_command_type_t type)
{
sc_bool printed = FALSE;
if (type != COMMAND_QUERY)
{
if_print_debug ("The Resources command takes no arguments.\n");
return;
}
if (game->stop_sound)
{
if_print_debug ("Sound stop");
if (strlen (game->requested_sound.name) > 0)
if_print_debug (" before new sound");
if_print_debug (" requested");
if (game->sound_active)
if_print_debug (", sound active");
if_print_debug (".\n");
printed = TRUE;
}
if (!res_compare_resource (&game->requested_sound,
&game->playing_sound))
{
if_print_debug ("Requested Sound ");
debug_print_resource (&game->requested_sound);
if_print_debug (".\n");
printed = TRUE;
}
if (!res_compare_resource (&game->requested_graphic,
&game->displayed_graphic))
{
if_print_debug ("Requested Graphic ");
debug_print_resource (&game->requested_graphic);
if_print_debug (".\n");
printed = TRUE;
}
if (strlen (game->playing_sound.name) > 0)
{
if_print_debug ("Playing Sound ");
debug_print_resource (&game->playing_sound);
if_print_debug (".\n");
printed = TRUE;
}
if (strlen (game->displayed_graphic.name) > 0)
{
if_print_debug ("Displaying Graphic ");
debug_print_resource (&game->displayed_graphic);
if_print_debug (".\n");
printed = TRUE;
}
if (!printed)
if_print_debug ("There is no game resource activity.\n");
}
/*
* debug_random()
*
* Report the PRNG in use, and seed the random number generator to the
* given value.
*/
static void
debug_random (sc_command_type_t type, sc_int new_seed)
{
const sc_char *random_type;
sc_char buffer[32];
if (type != COMMAND_ONE && type != COMMAND_QUERY)
{
if_print_debug ("The Random command takes either one argument or"
" no arguments.\n");
return;
}
random_type = sc_is_congruential_random () ? "congruential" : "platform";
if (type == COMMAND_QUERY)
{
if_print_debug ("The ");
if_print_debug (random_type);
if_print_debug (" random number generator is selected.\n");
return;
}
if (new_seed == 0)
{
if_print_debug ("The seed value may not be zero.\n");
return;
}
sc_seed_random (new_seed);
if_print_debug ("Set seed ");
sprintf (buffer, "%ld", new_seed);
if_print_debug (buffer);
if_print_debug (" for the ");
if_print_debug (random_type);
if_print_debug (" random number generator.\n");
}
/*
* debug_watchpoint_common()
*
* Common handler for setting and clearing watchpoints.
*/
static void
debug_watchpoint_common (sc_gameref_t game, sc_command_t command,
sc_command_type_t type, sc_int arg1, sc_int arg2)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
sc_int low = arg1, high = arg2;
sc_int limit, index_;
const sc_char *class_;
sc_bool *watchpoints, action;
sc_char buffer[32];
assert (debug_is_valid (debug));
/* Initialize variables to avoid gcc warnings. */
limit = 0;
class_ = NULL;
watchpoints = NULL;
action = FALSE;
/* Set action to TRUE or FALSE, for setting/clearing watchpoints. */
switch (command)
{
case DEBUG_WATCHPLAYER:
case DEBUG_WATCHOBJECTS:
case DEBUG_WATCHNPCS:
case DEBUG_WATCHEVENTS:
case DEBUG_WATCHTASKS:
case DEBUG_WATCHVARIABLES:
action = TRUE;
break;
case DEBUG_CLEARPLAYER:
case DEBUG_CLEAROBJECTS:
case DEBUG_CLEARNPCS:
case DEBUG_CLEAREVENTS:
case DEBUG_CLEARTASKS:
case DEBUG_CLEARVARIABLES:
action = FALSE;
break;
default:
sc_fatal ("debug_watchpoint_common: invalid command\n");
}
/* Handle player watchpoint setting. */
if (command == DEBUG_WATCHPLAYER || command == DEBUG_CLEARPLAYER)
{
if (command == DEBUG_CLEARPLAYER)
{
debug->watch_player = action;
if_print_debug ("Cleared Player watchpoint.\n");
}
else if (type == COMMAND_ONE && arg1 == 0)
{
debug->watch_player = action;
if_print_debug ("Set Player watchpoint.\n");
}
else
{
if (debug->watch_player)
if_print_debug ("Player watchpoint is set.\n");
else
if_print_debug ("No Player watchpoint is set; to set one, use"
" \"Watchplayer 0\".\n");
}
return;
}
/* Demultiplex watchpoint command. */
switch (command)
{
case DEBUG_WATCHOBJECTS:
case DEBUG_CLEAROBJECTS:
class_ = "Object";
watchpoints = debug->watch_objects;
limit = gs_object_count (game);
break;
case DEBUG_WATCHNPCS:
case DEBUG_CLEARNPCS:
class_ = "NPC";
watchpoints = debug->watch_npcs;
limit = gs_npc_count (game);
break;
case DEBUG_WATCHEVENTS:
case DEBUG_CLEAREVENTS:
class_ = "Event";
watchpoints = debug->watch_events;
limit = gs_event_count (game);
break;
case DEBUG_WATCHTASKS:
case DEBUG_CLEARTASKS:
class_ = "Task";
watchpoints = debug->watch_tasks;
limit = gs_task_count (game);
break;
case DEBUG_WATCHVARIABLES:
case DEBUG_CLEARVARIABLES:
class_ = "Variable";
watchpoints = debug->watch_variables;
limit = debug_variable_count (game);
break;
default:
sc_fatal ("debug_watchpoint_common: invalid command\n");
}
/* Normalize to this limit. */
if (!debug_normalize_arguments (type, &low, &high, limit))
{
if (limit == 0)
{
if_print_debug ("There is nothing of type ");
debug_print_quoted (class_);
if_print_debug (" to watch.\n");
}
else
{
if_print_debug ("Invalid item or range for ");
debug_print_quoted (class_);
if (limit == 1)
if_print_debug ("; only 0 is valid.\n");
else
{
if_print_debug ("; valid values are 0 to ");
sprintf (buffer, "%ld", limit - 1);
if_print_debug (buffer);
if_print_debug (".\n");
}
}
return;
}
/* On query, search the array for set flags, and print out. */
if (type == COMMAND_QUERY)
{
sc_bool printed = FALSE;
/* Scan for set watchpoints, and list each found. */
for (index_ = low; index_ <= high; index_++)
{
if (watchpoints[index_])
{
if (!printed)
{
if_print_debug ("Watchpoints are set for ");
if_print_debug (class_);
if_print_debug (" { ");
}
sprintf (buffer, "%ld", index_);
if_print_debug (buffer);
if_print_debug_character (' ');
printed = TRUE;
}
}
if (printed)
if_print_debug ("}.\n");
else
{
if_print_debug ("No ");
if_print_debug (class_);
if_print_debug (" watchpoints are set.\n");
}
return;
}
/*
* For non-queries, set watchpoint flags as defined in action for
* the range determined, and print confirmation.
*/
for (index_ = low; index_ <= high; index_++)
watchpoints[index_] = action;
if (action)
if_print_debug ("Set ");
else
if_print_debug ("Cleared ");
sprintf (buffer, "%ld ", high - low + 1);
if_print_debug (buffer);
if_print_debug (class_);
if (high == low)
if_print_debug (" watchpoint.\n");
else
if_print_debug (" watchpoints.\n");
}
/*
* debug_watchall_common()
*
* Common handler to list out and clear all set watchpoints at a stroke.
*/
static void
debug_watchall_common (sc_gameref_t game,
sc_command_t command, sc_command_type_t type)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
assert (debug_is_valid (debug));
if (type != COMMAND_QUERY)
{
if (command == DEBUG_WATCHALL)
if_print_debug ("The Watchall command takes no arguments.\n");
else
if_print_debug ("The Clearall command takes no arguments.\n");
return;
}
/* Query all set watchpoints using common watchpoint handler... */
if (command == DEBUG_WATCHALL)
{
debug_watchpoint_common (game,
DEBUG_WATCHPLAYER, COMMAND_QUERY, 0, 0);
debug_watchpoint_common (game,
DEBUG_WATCHOBJECTS, COMMAND_QUERY, 0, 0);
debug_watchpoint_common (game,
DEBUG_WATCHNPCS, COMMAND_QUERY, 0, 0);
debug_watchpoint_common (game,
DEBUG_WATCHEVENTS, COMMAND_QUERY, 0, 0);
debug_watchpoint_common (game,
DEBUG_WATCHTASKS, COMMAND_QUERY, 0, 0);
debug_watchpoint_common (game,
DEBUG_WATCHVARIABLES, COMMAND_QUERY, 0, 0);
return;
}
/* ...but reset all the fast way, with memset(). */
assert (command == DEBUG_CLEARALL);
debug->watch_player = FALSE;
memset (debug->watch_objects, FALSE,
gs_object_count (game) * sizeof (*debug->watch_objects));
memset (debug->watch_npcs, FALSE,
gs_npc_count (game) * sizeof (*debug->watch_npcs));
memset (debug->watch_events, FALSE,
gs_event_count (game) * sizeof (*debug->watch_events));
memset (debug->watch_tasks, FALSE,
gs_task_count (game) * sizeof (*debug->watch_tasks));
memset (debug->watch_variables, FALSE,
debug_variable_count (game) * sizeof (*debug->watch_variables));
if_print_debug ("Cleared all watchpoints.\n");
}
/*
* debug_compare_object()
*
* Compare two objects, and return TRUE if the same.
*/
static sc_bool
debug_compare_object (sc_gameref_t from, sc_gameref_t with, sc_int object)
{
const sc_objectstate_t *from_object = from->objects + object;
const sc_objectstate_t *with_object = with->objects + object;
return from_object->unmoved == with_object->unmoved
&& from_object->static_unmoved == with_object->static_unmoved
&& from_object->position == with_object->position
&& from_object->parent == with_object->parent
&& from_object->openness == with_object->openness
&& from_object->state == with_object->state
&& from_object->seen == with_object->seen;
}
/*
* debug_compare_npc()
*
* Compare two NPCs, and return TRUE if the same.
*/
static sc_bool
debug_compare_npc (sc_gameref_t from, sc_gameref_t with, sc_int npc)
{
const sc_npcstate_t *from_npc = from->npcs + npc;
const sc_npcstate_t *with_npc = with->npcs + npc;
if (from_npc->walkstep_count != with_npc->walkstep_count)
sc_fatal ("debug_compare_npc: walkstep count error\n");
return from_npc->location == with_npc->location
&& from_npc->position == with_npc->position
&& from_npc->parent == with_npc->parent
&& from_npc->seen == with_npc->seen
&& memcmp (from_npc->walksteps, with_npc->walksteps,
from_npc->walkstep_count
* sizeof (*from_npc->walksteps)) == 0;
}
/*
* debug_compare_event()
*
* Compare two events, and return TRUE if the same.
*/
static sc_bool
debug_compare_event (sc_gameref_t from, sc_gameref_t with, sc_int event)
{
const sc_eventstate_t *from_event = from->events + event;
const sc_eventstate_t *with_event = with->events + event;
return from_event->state == with_event->state
&& from_event->time == with_event->time;
}
/*
* debug_compare_task()
*
* Compare two tasks, and return TRUE if the same.
*/
static sc_bool
debug_compare_task (sc_gameref_t from, sc_gameref_t with, sc_int task)
{
const sc_taskstate_t *from_task = from->tasks + task;
const sc_taskstate_t *with_task = with->tasks + task;
return from_task->done == with_task->done
&& from_task->scored == with_task->scored;
}
/*
* debug_compare_variable()
*
* Compare two variables, and return TRUE if the same.
*/
static sc_bool
debug_compare_variable (sc_gameref_t from, sc_gameref_t with, sc_int variable)
{
const sc_prop_setref_t bundle = from->bundle;
const sc_var_setref_t from_var = from->vars;
const sc_var_setref_t with_var = with->vars;
sc_vartype_t vt_key[3], vt_rvalue, vt_rvalue2;
const sc_char *name;
sc_int var_type, var_type2;
sc_bool equal = FALSE;
if (from->bundle != with->bundle)
sc_fatal ("debug_compare_variable: property sharing malfunction\n");
vt_key[0].string = "Variables";
vt_key[1].integer = variable;
vt_key[2].string = "Name";
name = prop_get_string (bundle, "S<-sis", vt_key);
if (!var_get (from_var, name, &var_type, &vt_rvalue)
|| !var_get (with_var, name, &var_type2, &vt_rvalue2))
sc_fatal ("debug_compare_variable: can't find variable %s\n", name);
else if (var_type != var_type2)
sc_fatal ("debug_compare_variable: variable type mismatch %s\n", name);
switch (var_type)
{
case VAR_INTEGER:
equal = (vt_rvalue.integer == vt_rvalue2.integer);
break;
case VAR_STRING:
equal = !strcmp (vt_rvalue.string, vt_rvalue2.string);
break;
default:
sc_fatal ("debug_compare_variable:"
" invalid variable type, %ld\n", var_type);
}
return equal;
}
/*
* debug_check_class()
*
* Central handler for checking watchpoints. Compares a number of items
* of a class using the comparison function given, where indicated by a
* watchpoints flags array. Prints entries that differ, and returns TRUE
* if any differed.
*/
static sc_bool
debug_check_class (sc_gameref_t from, sc_gameref_t with,
const sc_char *class_, sc_int class_count,
const sc_bool *watchpoints,
sc_bool (*const compare_function)
(sc_gameref_t, sc_gameref_t, sc_int))
{
sc_int index_;
sc_bool triggered = FALSE;
/*
* Scan the watchpoints array for set watchpoints, comparing classes
* where the watchpoint flag is set.
*/
for (index_ = 0; index_ < class_count; index_++)
{
if (!watchpoints[index_])
continue;
if (!compare_function (from, with, index_))
{
sc_char buffer[32];
if (!triggered)
{
if_print_debug ("--- ");
if_print_debug (class_);
if_print_debug (" watchpoint triggered { ");
}
sprintf (buffer, "%ld ", index_);
if_print_debug (buffer);
triggered = TRUE;
}
}
if (triggered)
if_print_debug ("}.\n");
/* Return TRUE if anything differed. */
return triggered;
}
/*
* debug_check_watchpoints()
*
* Checks the game against the undo game for all set watchpoints. Returns
* TRUE if any triggered, FALSE if none (or if the undo game isn't available,
* in which case no check is possible).
*/
static sc_bool
debug_check_watchpoints (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
const sc_gameref_t undo = game->undo;
sc_bool triggered;
assert (debug_is_valid (debug) && gs_is_game_valid (undo));
/* If no undo is present, no check is possible. */
if (!game->undo_available)
return FALSE;
/* Check first for player watchpoint. */
triggered = FALSE;
if (debug->watch_player)
{
if (gs_playerroom (game) != gs_playerroom (undo)
|| gs_playerposition (game) != gs_playerposition (undo)
|| gs_playerparent (game) != gs_playerparent (undo))
{
if_print_debug ("--- Player watchpoint triggered.\n");
triggered |= TRUE;
}
}
/* Now check other classes of watchpoint. */
triggered |= debug_check_class (game, undo,
"Object", gs_object_count (game),
debug->watch_objects, debug_compare_object);
triggered |= debug_check_class (game, undo,
"NPC", gs_npc_count (game),
debug->watch_npcs, debug_compare_npc);
triggered |= debug_check_class (game, undo,
"Event", gs_event_count (game),
debug->watch_events, debug_compare_event);
triggered |= debug_check_class (game, undo,
"Task", gs_task_count (game),
debug->watch_tasks, debug_compare_task);
triggered |= debug_check_class (game, undo,
"Variable", debug_variable_count (game),
debug->watch_variables,
debug_compare_variable);
return triggered;
}
/*
* debug_parse_command()
*
* Given a debugging command string, try to parse it and return the
* appropriate command and its arguments. Returns DEBUG_NONE if the parse
* fails.
*/
static sc_command_t
debug_parse_command (const sc_char *command_string,
sc_command_type_t *type,
sc_int *arg1, sc_int *arg2, sc_command_t *help_topic)
{
sc_command_t return_command;
sc_command_type_t return_type;
sc_int val1, val2, converted, matches;
sc_char *help, *string, junk, wildcard;
sc_bool is_help, is_parsed, is_wildcard;
const sc_strings_t *entry;
/* Allocate temporary strings long enough to take a copy of the input. */
string = (sc_char *)sc_malloc (strlen (command_string) + 1);
help = (sc_char *)sc_malloc (strlen (command_string) + 1);
/*
* Parse the input line, in a very simplistic fashion. The argument count
* is one less than sscanf converts.
*/
is_parsed = is_wildcard = is_help = FALSE;
val1 = val2 = 0;
converted = sscanf (command_string, " %s %s %c", help, string, &junk);
if (converted == 2 && sc_strcasecmp (help, "help") == 0)
{
is_help = TRUE;
is_parsed = TRUE;
}
sc_free (help);
if (!is_parsed)
{
converted = sscanf (command_string,
" %s %ld to %ld %c", string, &val1, &val2, &junk);
if (converted != 3)
converted = sscanf (command_string,
" %s %ld - %ld %c", string, &val1, &val2, &junk);
if (converted != 3)
converted = sscanf (command_string,
" %s %ld .. %ld %c", string, &val1, &val2, &junk);
if (converted != 3)
converted = sscanf (command_string,
" %s %ld %ld %c", string, &val1, &val2, &junk);
is_parsed |= converted == 3;
}
if (!is_parsed)
{
converted = sscanf (command_string,
" %s %ld %c", string, &val1, &junk);
is_parsed |= converted == 2;
}
if (!is_parsed)
{
converted = sscanf (command_string,
" %s %c %c", string, &wildcard, &junk);
if (converted == 2 && wildcard == '*')
{
is_wildcard = TRUE;
is_parsed = TRUE;
}
else
is_parsed |= converted == 1;
}
if (!is_parsed)
{
if_print_debug ("Invalid debug command.");
if_print_debug (" Type 'help' for a list of valid commands.\n");
sc_free (string);
return DEBUG_NONE;
}
/* Decide on a command type based on the parse. */
if (is_wildcard)
return_type = COMMAND_ALL;
else if (converted == 3)
return_type = COMMAND_RANGE;
else if (converted == 2)
return_type = COMMAND_ONE;
else
return_type = COMMAND_QUERY;
/*
* Find the first unambiguous command matching the string. If none,
* return DEBUG_NONE.
*/
matches = 0;
return_command = DEBUG_NONE;
for (entry = DEBUG_COMMANDS; entry->command_string; entry++)
{
if (sc_strncasecmp (string, entry->command_string, strlen (string)) == 0)
{
matches++;
return_command = entry->command;
}
}
if (matches != 1)
{
if (matches > 1)
if_print_debug ("Ambiguous debug command.");
else
if_print_debug ("Unrecognized debug command.");
if_print_debug (" Type 'help' for a list of valid commands.\n");
sc_free (string);
return DEBUG_NONE;
}
/* Done with temporary command parse area. */
sc_free (string);
/*
* Return the command type, arguments, and the debugging command. For help
* <topic>, the command is help, with the command on which help requested
* in *help_topic. All clear, then?
*/
*type = return_type;
*arg1 = val1;
*arg2 = val2;
*help_topic = is_help ? return_command : DEBUG_NONE;
return is_help ? DEBUG_HELP : return_command;
}
/*
* debug_dispatch()
*
* Dispatch a debugging command to the appropriate handler.
*/
static void
debug_dispatch (sc_gameref_t game,
sc_command_t command, sc_command_type_t type,
sc_int arg1, sc_int arg2, sc_command_t help_topic)
{
/* Demultiplex debugging command, and call handlers. */
switch (command)
{
case DEBUG_HELP:
debug_help (help_topic);
break;
case DEBUG_BUFFER:
debug_buffer (game, type);
break;
case DEBUG_RESOURCES:
debug_resources (game, type);
break;
case DEBUG_RANDOM:
debug_random (type, arg1);
break;
case DEBUG_GAME:
debug_game (game, type);
break;
case DEBUG_PLAYER:
case DEBUG_OLDPLAYER:
debug_player (game, command, type);
break;
case DEBUG_ROOMS:
case DEBUG_OBJECTS:
case DEBUG_NPCS:
case DEBUG_EVENTS:
case DEBUG_TASKS:
case DEBUG_VARIABLES:
case DEBUG_OLDROOMS:
case DEBUG_OLDOBJECTS:
case DEBUG_OLDNPCS:
case DEBUG_OLDEVENTS:
case DEBUG_OLDTASKS:
case DEBUG_OLDVARIABLES:
debug_dump_common (game, command, type, arg1, arg2);
break;
case DEBUG_WATCHPLAYER:
case DEBUG_WATCHOBJECTS:
case DEBUG_WATCHNPCS:
case DEBUG_WATCHEVENTS:
case DEBUG_WATCHTASKS:
case DEBUG_WATCHVARIABLES:
case DEBUG_CLEARPLAYER:
case DEBUG_CLEAROBJECTS:
case DEBUG_CLEARNPCS:
case DEBUG_CLEAREVENTS:
case DEBUG_CLEARTASKS:
case DEBUG_CLEARVARIABLES:
debug_watchpoint_common (game, command, type, arg1, arg2);
break;
case DEBUG_WATCHALL:
case DEBUG_CLEARALL:
debug_watchall_common (game, command, type);
break;
case DEBUG_NONE:
break;
default:
sc_fatal ("debug_dispatch: invalid debug command\n");
}
}
/*
* debug_dialog()
*
* Create a small debugging dialog with the user.
*/
static void
debug_dialog (sc_gameref_t game)
{
const sc_filterref_t filter = gs_get_filter (game);
const sc_debuggerref_t debug = debug_get_debugger (game);
const sc_var_setref_t vars = gs_get_vars (game);
assert (debug_is_valid (debug));
/*
* Note elapsed seconds, so time stands still while debugging, and clear
* any pending game quit left over from prior dialogs (just in case).
*/
debug->elapsed_seconds = var_get_elapsed_seconds (vars);
debug->quit_pending = FALSE;
/* Handle debug commands until debugger quit or game quit. */
while (TRUE)
{
sc_char buffer[DEBUG_BUFFER_SIZE];
sc_command_t command, help_topic;
sc_command_type_t type;
sc_int arg1, arg2;
/* Get a debugging command string from the user. */
do
{
if_read_debug (buffer, sizeof (buffer));
if (g_vm->shouldQuit())
return;
}
while (sc_strempty (buffer));
/* Parse the command read, and handle dialog exit commands. */
command = debug_parse_command (buffer,
&type, &arg1, &arg2, &help_topic);
if (command == DEBUG_CONTINUE || command == DEBUG_STEP)
{
if (!game->is_running)
{
if_print_debug ("The game is no longer running.\n");
continue;
}
debug->single_step = (command == DEBUG_STEP);
break;
}
else if (command == DEBUG_QUIT)
{
/*
* If the game is not running, we can't halt it, and we don't need
* to confirm the quit (either the player "quit" or the game
* completed), so leave the dialog loop.
*/
if (!game->is_running)
break;
/*
* The game is still running, so confirm quit by requiring a repeat,
* or if this is the confirmation, force the game to a halt.
*/
if (!debug->quit_pending)
{
if_print_debug ("Use 'quit' again to confirm, or another"
" debugger command to cancel.\n");
debug->quit_pending = TRUE;
continue;
}
/* Drop printfilter contents and quit the game. */
pf_empty (filter);
run_quit (game);
/* Just in case... */
if_print_debug ("Unable to quit from the game. Sorry.\n");
continue;
}
/* Dispatch the remaining debugging commands, and clear quit flag. */
debug_dispatch (game, command, type, arg1, arg2, help_topic);
debug->quit_pending = FALSE;
}
/* Restart time, and clear any pending game quit. */
var_set_elapsed_seconds (vars, debug->elapsed_seconds);
debug->quit_pending = FALSE;
}
/*
* debug_run_command()
*
* Handle a single debugging command line from the outside world. Returns
* TRUE if valid, FALSE if invalid (parse failed, not understood).
*/
sc_bool
debug_run_command (sc_gameref_t game, const sc_char *debug_command)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
sc_command_t command, help_topic;
sc_command_type_t type;
sc_int arg1, arg2;
/* If debugging disallowed (not initialized), refuse the call. */
if (debug)
{
/*
* Parse the command string passed in, and return FALSE if the parse
* fails, or if it returns DEBUG_CONTINUE, DEBUG_STEP, or DEBUG_QUIT,
* none of which make any sense in this context.
*/
command = debug_parse_command (debug_command,
&type, &arg1, &arg2, &help_topic);
if (command == DEBUG_NONE
|| command == DEBUG_CONTINUE || command == DEBUG_STEP
|| command == DEBUG_QUIT)
return FALSE;
/* Dispatch the remaining debugging commands, return successfully. */
debug_dispatch (game, command, type, arg1, arg2, help_topic);
return TRUE;
}
return FALSE;
}
/*
* debug_cmd_debugger()
*
* Called by the run main loop on user "debug" command request. Prints
* a polite refusal if debugging is not enabled, otherwise runs a debugging
* dialog. Uses if_print_string() as this isn't debug output.
*/
sc_bool
debug_cmd_debugger (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
/* If debugging disallowed (not initialized), ignore the call. */
if (debug)
debug_dialog (game);
else
if_print_string ("SCARE's game debugger is not enabled. Sorry.\n");
/*
* Set as administrative command, so as not to consume a game turn, and
* return successfully.
*/
game->is_admin = TRUE;
return TRUE;
}
/*
* debug_game_started()
* debug_game_ended()
*
* The first is called on entry to the game main loop, and gives us a chance
* to look at things before any turns are run, and to set watchpoints to
* catch things in games that use catch-all command tasks on startup (The PK
* Girl, for example).
*
* The second is called on exit from the game, and may make a final sweep for
* watchpoints and offer the debug dialog one last time.
*/
void
debug_game_started (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
/* If debugging disallowed (not initialized), ignore the call. */
if (debug)
{
/* Starting a new game, or a restore or undo of an old one? */
if (!gs_room_seen (game, gs_playerroom (game)))
{
/*
* It's a new game starting or restarting. Print a banner, and
* run the debugger dialog.
*/
if_print_debug ("\n--- SCARE " SCARE_VERSION SCARE_PATCH_LEVEL
" Game Debugger\n"
"--- Type 'help' for a list of commands.\n");
debug_dialog (game);
}
else
{
/*
* It's a restore or undo through memos, so run the dialog only if
* single-stepping; no need to check watchpoints for this case as
* none can be set -- no undo.
*/
if (debug->single_step)
debug_dialog (game);
}
}
}
void
debug_game_ended (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
/* If debugging disallowed (not initialized), ignore the call. */
if (debug)
{
/*
* Using our carnal knowledge of the run main loop, we know here that
* if the loop exited with do_restart or do_restore, we'll get a call to
* debug_game_start() when the loop restarts. So in this case, ignore
* the call (even if single stepping).
*/
if (game->do_restart || game->do_restore)
return;
/*
* Check for any final watchpoints, and print a message describing why
* we're here. Suppress the check for watchpoints if the user exited
* the game, as it'll only be a repeat of any found last turn update.
*/
if (!game->is_running)
{
if (game->has_completed)
{
debug_check_watchpoints (game);
if_print_debug ("\n--- The game has completed.\n");
}
else
if_print_debug ("\n--- The game has exited.\n");
}
else
{
debug_check_watchpoints (game);
if_print_debug ("\n--- The game is still running!\n");
}
/* Run a final dialog. */
debug_dialog (game);
}
}
/*
* debug_turn_update()
*
* Called after each turn by the main game loop. Checks for any set
* watchpoints, and triggers a debug dialog when any fire.
*/
void
debug_turn_update (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
/* If debugging disallowed (not initialized), ignore the call. */
if (debug)
{
/*
* Again using carnal knowledge of the run main loop, if we're in
* mid-wait, ignore the call. Also, ignore the call if the game is
* no longer running, as we'll see a debug_game_ended() call come
* along to handle that.
*/
if (game->waitcounter > 0 || !game->is_running)
return;
/*
* Run debugger dialog if any watchpoints triggered, or if single
* stepping (even if none triggered).
*/
if (debug_check_watchpoints (game) || debug->single_step)
debug_dialog (game);
}
}
/*
* debug_set_enabled()
* debug_get_enabled()
*
* Enable/disable debugging, and return debugging status. Debugging is
* enabled when there is a debugger reference in the game, and disabled
* when it's NULL -- that's the flag. To avoid lugging about all the
* watchpoint memory with a game, debugger data is allocated on enabling,
* and free'd on disabling; as a result, any set watchpoints are lost on
* disabling.
*/
void
debug_set_enabled (sc_gameref_t game, sc_bool enable)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
/*
* If enabling and not already enabled, or disabling and not already
* disabled, either initialize or finalize..
*/
if ((enable && !debug) || (!enable && debug))
{
/* Initialize or finalize debugging, as appropriate. */
if (enable)
debug_initialize (game);
else
debug_finalize (game);
}
}
sc_bool
debug_get_enabled (sc_gameref_t game)
{
const sc_debuggerref_t debug = debug_get_debugger (game);
return debug != NULL;
}
} // End of namespace Adrift
} // End of namespace Glk
|