1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231
|
/* 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.
*
*/
// Console module
#include "common/md5.h"
#include "sci/sci.h"
#include "sci/console.h"
#include "sci/debug.h"
#include "sci/event.h"
#include "sci/resource.h"
#include "sci/engine/state.h"
#include "sci/engine/kernel.h"
#include "sci/engine/selector.h"
#include "sci/engine/savegame.h"
#include "sci/engine/gc.h"
#include "sci/engine/features.h"
#include "sci/engine/scriptdebug.h"
#include "sci/sound/midiparser_sci.h"
#include "sci/sound/music.h"
#include "sci/sound/drivers/mididriver.h"
#include "sci/sound/drivers/map-mt32-to-gm.h"
#include "sci/graphics/animate.h"
#include "sci/graphics/cache.h"
#include "sci/graphics/cursor.h"
#include "sci/graphics/screen.h"
#include "sci/graphics/paint16.h"
#include "sci/graphics/palette.h"
#include "sci/graphics/ports.h"
#include "sci/graphics/view.h"
#include "sci/parser/vocabulary.h"
#include "video/avi_decoder.h"
#include "sci/video/seq_decoder.h"
#ifdef ENABLE_SCI32
#include "common/memstream.h"
#include "sci/graphics/frameout.h"
#include "sci/graphics/paint32.h"
#include "sci/graphics/palette32.h"
#include "sci/sound/decoders/sol.h"
#include "video/coktel_decoder.h"
#endif
#include "common/file.h"
#include "common/savefile.h"
#include "engines/util.h"
namespace Sci {
int g_debug_sleeptime_factor = 1;
int g_debug_simulated_key = 0;
bool g_debug_track_mouse_clicks = false;
// Refer to the "addresses" command on how to pass address parameters
static int parse_reg_t(EngineState *s, const char *str, reg_t *dest);
Console::Console(SciEngine *engine) : GUI::Debugger(),
_engine(engine), _debugState(engine->_debugState) {
assert(_engine);
assert(_engine->_gamestate);
// Variables
registerVar("sleeptime_factor", &g_debug_sleeptime_factor);
registerVar("gc_interval", &engine->_gamestate->scriptGCInterval);
registerVar("simulated_key", &g_debug_simulated_key);
registerVar("track_mouse_clicks", &g_debug_track_mouse_clicks);
// FIXME: This actually passes an enum type instead of an integer but no
// precaution is taken to assure that all assigned values are in the range
// of the enum type. We should handle this more carefully...
registerVar("script_abort_flag", (int *)&_engine->_gamestate->abortScriptProcessing);
// General
registerCmd("help", WRAP_METHOD(Console, cmdHelp));
// Kernel
// registerCmd("classes", WRAP_METHOD(Console, cmdClasses)); // TODO
registerCmd("opcodes", WRAP_METHOD(Console, cmdOpcodes));
registerCmd("selector", WRAP_METHOD(Console, cmdSelector));
registerCmd("selectors", WRAP_METHOD(Console, cmdSelectors));
registerCmd("functions", WRAP_METHOD(Console, cmdKernelFunctions));
registerCmd("class_table", WRAP_METHOD(Console, cmdClassTable));
// Parser
registerCmd("suffixes", WRAP_METHOD(Console, cmdSuffixes));
registerCmd("parse_grammar", WRAP_METHOD(Console, cmdParseGrammar));
registerCmd("parser_nodes", WRAP_METHOD(Console, cmdParserNodes));
registerCmd("parser_words", WRAP_METHOD(Console, cmdParserWords));
registerCmd("sentence_fragments", WRAP_METHOD(Console, cmdSentenceFragments));
registerCmd("parse", WRAP_METHOD(Console, cmdParse));
registerCmd("set_parse_nodes", WRAP_METHOD(Console, cmdSetParseNodes));
registerCmd("said", WRAP_METHOD(Console, cmdSaid));
// Resources
registerCmd("diskdump", WRAP_METHOD(Console, cmdDiskDump));
registerCmd("hexdump", WRAP_METHOD(Console, cmdHexDump));
registerCmd("resource_id", WRAP_METHOD(Console, cmdResourceId));
registerCmd("resource_info", WRAP_METHOD(Console, cmdResourceInfo));
registerCmd("resource_types", WRAP_METHOD(Console, cmdResourceTypes));
registerCmd("list", WRAP_METHOD(Console, cmdList));
registerCmd("alloc_list", WRAP_METHOD(Console, cmdAllocList));
registerCmd("hexgrep", WRAP_METHOD(Console, cmdHexgrep));
registerCmd("verify_scripts", WRAP_METHOD(Console, cmdVerifyScripts));
registerCmd("integrity_dump", WRAP_METHOD(Console, cmdResourceIntegrityDump));
// Game
registerCmd("save_game", WRAP_METHOD(Console, cmdSaveGame));
registerCmd("restore_game", WRAP_METHOD(Console, cmdRestoreGame));
registerCmd("restart_game", WRAP_METHOD(Console, cmdRestartGame));
registerCmd("version", WRAP_METHOD(Console, cmdGetVersion));
registerCmd("room", WRAP_METHOD(Console, cmdRoomNumber));
registerCmd("quit", WRAP_METHOD(Console, cmdQuit));
registerCmd("list_saves", WRAP_METHOD(Console, cmdListSaves));
// Graphics
registerCmd("show_map", WRAP_METHOD(Console, cmdShowMap));
registerCmd("set_palette", WRAP_METHOD(Console, cmdSetPalette));
registerCmd("draw_pic", WRAP_METHOD(Console, cmdDrawPic));
registerCmd("draw_cel", WRAP_METHOD(Console, cmdDrawCel));
registerCmd("undither", WRAP_METHOD(Console, cmdUndither));
registerCmd("pic_visualize", WRAP_METHOD(Console, cmdPicVisualize));
registerCmd("play_video", WRAP_METHOD(Console, cmdPlayVideo));
registerCmd("animate_list", WRAP_METHOD(Console, cmdAnimateList));
registerCmd("al", WRAP_METHOD(Console, cmdAnimateList)); // alias
registerCmd("window_list", WRAP_METHOD(Console, cmdWindowList));
registerCmd("wl", WRAP_METHOD(Console, cmdWindowList)); // alias
registerCmd("plane_list", WRAP_METHOD(Console, cmdPlaneList));
registerCmd("pl", WRAP_METHOD(Console, cmdPlaneList)); // alias
registerCmd("visible_plane_list", WRAP_METHOD(Console, cmdVisiblePlaneList));
registerCmd("vpl", WRAP_METHOD(Console, cmdVisiblePlaneList)); // alias
registerCmd("plane_items", WRAP_METHOD(Console, cmdPlaneItemList));
registerCmd("pi", WRAP_METHOD(Console, cmdPlaneItemList)); // alias
registerCmd("visible_plane_items", WRAP_METHOD(Console, cmdVisiblePlaneItemList));
registerCmd("vpi", WRAP_METHOD(Console, cmdVisiblePlaneItemList)); // alias
registerCmd("saved_bits", WRAP_METHOD(Console, cmdSavedBits));
registerCmd("show_saved_bits", WRAP_METHOD(Console, cmdShowSavedBits));
// Segments
registerCmd("segment_table", WRAP_METHOD(Console, cmdPrintSegmentTable));
registerCmd("segtable", WRAP_METHOD(Console, cmdPrintSegmentTable)); // alias
registerCmd("segment_info", WRAP_METHOD(Console, cmdSegmentInfo));
registerCmd("seginfo", WRAP_METHOD(Console, cmdSegmentInfo)); // alias
registerCmd("segment_kill", WRAP_METHOD(Console, cmdKillSegment));
registerCmd("segkill", WRAP_METHOD(Console, cmdKillSegment)); // alias
// Garbage collection
registerCmd("gc", WRAP_METHOD(Console, cmdGCInvoke));
registerCmd("gc_objects", WRAP_METHOD(Console, cmdGCObjects));
registerCmd("gc_reachable", WRAP_METHOD(Console, cmdGCShowReachable));
registerCmd("gc_freeable", WRAP_METHOD(Console, cmdGCShowFreeable));
registerCmd("gc_normalize", WRAP_METHOD(Console, cmdGCNormalize));
// Music/SFX
registerCmd("songlib", WRAP_METHOD(Console, cmdSongLib));
registerCmd("songinfo", WRAP_METHOD(Console, cmdSongInfo));
registerCmd("is_sample", WRAP_METHOD(Console, cmdIsSample));
registerCmd("startsound", WRAP_METHOD(Console, cmdStartSound));
registerCmd("togglesound", WRAP_METHOD(Console, cmdToggleSound));
registerCmd("stopallsounds", WRAP_METHOD(Console, cmdStopAllSounds));
registerCmd("sfx01_header", WRAP_METHOD(Console, cmdSfx01Header));
registerCmd("sfx01_track", WRAP_METHOD(Console, cmdSfx01Track));
registerCmd("show_instruments", WRAP_METHOD(Console, cmdShowInstruments));
registerCmd("map_instrument", WRAP_METHOD(Console, cmdMapInstrument));
registerCmd("audio_list", WRAP_METHOD(Console, cmdAudioList));
registerCmd("audio_dump", WRAP_METHOD(Console, cmdAudioDump));
// Script
registerCmd("addresses", WRAP_METHOD(Console, cmdAddresses));
registerCmd("registers", WRAP_METHOD(Console, cmdRegisters));
registerCmd("dissect_script", WRAP_METHOD(Console, cmdDissectScript));
registerCmd("backtrace", WRAP_METHOD(Console, cmdBacktrace));
registerCmd("bt", WRAP_METHOD(Console, cmdBacktrace)); // alias
registerCmd("trace", WRAP_METHOD(Console, cmdTrace));
registerCmd("t", WRAP_METHOD(Console, cmdTrace)); // alias
registerCmd("s", WRAP_METHOD(Console, cmdTrace)); // alias
registerCmd("stepover", WRAP_METHOD(Console, cmdStepOver));
registerCmd("p", WRAP_METHOD(Console, cmdStepOver)); // alias
registerCmd("step_ret", WRAP_METHOD(Console, cmdStepRet));
registerCmd("pret", WRAP_METHOD(Console, cmdStepRet)); // alias
registerCmd("step_event", WRAP_METHOD(Console, cmdStepEvent));
registerCmd("se", WRAP_METHOD(Console, cmdStepEvent)); // alias
registerCmd("step_global", WRAP_METHOD(Console, cmdStepGlobal));
registerCmd("sg", WRAP_METHOD(Console, cmdStepGlobal)); // alias
registerCmd("step_callk", WRAP_METHOD(Console, cmdStepCallk));
registerCmd("snk", WRAP_METHOD(Console, cmdStepCallk)); // alias
registerCmd("disasm", WRAP_METHOD(Console, cmdDisassemble));
registerCmd("disasm_addr", WRAP_METHOD(Console, cmdDisassembleAddress));
registerCmd("find_callk", WRAP_METHOD(Console, cmdFindKernelFunctionCall));
registerCmd("send", WRAP_METHOD(Console, cmdSend));
registerCmd("go", WRAP_METHOD(Console, cmdGo));
registerCmd("logkernel", WRAP_METHOD(Console, cmdLogKernel));
registerCmd("vocab994", WRAP_METHOD(Console, cmdMapVocab994));
// Breakpoints
registerCmd("bp_list", WRAP_METHOD(Console, cmdBreakpointList));
registerCmd("bplist", WRAP_METHOD(Console, cmdBreakpointList)); // alias
registerCmd("bl", WRAP_METHOD(Console, cmdBreakpointList)); // alias
registerCmd("bp_del", WRAP_METHOD(Console, cmdBreakpointDelete));
registerCmd("bpdel", WRAP_METHOD(Console, cmdBreakpointDelete)); // alias
registerCmd("bc", WRAP_METHOD(Console, cmdBreakpointDelete)); // alias
registerCmd("bp_action", WRAP_METHOD(Console, cmdBreakpointAction));
registerCmd("bpact", WRAP_METHOD(Console, cmdBreakpointAction)); // alias
registerCmd("bp_address", WRAP_METHOD(Console, cmdBreakpointAddress));
registerCmd("bpa", WRAP_METHOD(Console, cmdBreakpointAddress)); // alias
registerCmd("bp_method", WRAP_METHOD(Console, cmdBreakpointMethod));
registerCmd("bpx", WRAP_METHOD(Console, cmdBreakpointMethod)); // alias
registerCmd("bp_read", WRAP_METHOD(Console, cmdBreakpointRead));
registerCmd("bpr", WRAP_METHOD(Console, cmdBreakpointRead)); // alias
registerCmd("bp_write", WRAP_METHOD(Console, cmdBreakpointWrite));
registerCmd("bpw", WRAP_METHOD(Console, cmdBreakpointWrite)); // alias
registerCmd("bp_kernel", WRAP_METHOD(Console, cmdBreakpointKernel));
registerCmd("bpk", WRAP_METHOD(Console, cmdBreakpointKernel)); // alias
registerCmd("bp_function", WRAP_METHOD(Console, cmdBreakpointFunction));
registerCmd("bpe", WRAP_METHOD(Console, cmdBreakpointFunction)); // alias
// VM
registerCmd("script_steps", WRAP_METHOD(Console, cmdScriptSteps));
registerCmd("script_objects", WRAP_METHOD(Console, cmdScriptObjects));
registerCmd("scro", WRAP_METHOD(Console, cmdScriptObjects));
registerCmd("script_strings", WRAP_METHOD(Console, cmdScriptStrings));
registerCmd("scrs", WRAP_METHOD(Console, cmdScriptStrings));
registerCmd("script_said", WRAP_METHOD(Console, cmdScriptSaid));
registerCmd("vm_varlist", WRAP_METHOD(Console, cmdVMVarlist));
registerCmd("vmvarlist", WRAP_METHOD(Console, cmdVMVarlist)); // alias
registerCmd("vl", WRAP_METHOD(Console, cmdVMVarlist)); // alias
registerCmd("vm_vars", WRAP_METHOD(Console, cmdVMVars));
registerCmd("vmvars", WRAP_METHOD(Console, cmdVMVars)); // alias
registerCmd("vv", WRAP_METHOD(Console, cmdVMVars)); // alias
registerCmd("stack", WRAP_METHOD(Console, cmdStack));
registerCmd("value_type", WRAP_METHOD(Console, cmdValueType));
registerCmd("view_listnode", WRAP_METHOD(Console, cmdViewListNode));
registerCmd("view_reference", WRAP_METHOD(Console, cmdViewReference));
registerCmd("vr", WRAP_METHOD(Console, cmdViewReference)); // alias
registerCmd("dump_reference", WRAP_METHOD(Console, cmdDumpReference));
registerCmd("dr", WRAP_METHOD(Console, cmdDumpReference)); // alias
registerCmd("view_object", WRAP_METHOD(Console, cmdViewObject));
registerCmd("vo", WRAP_METHOD(Console, cmdViewObject)); // alias
registerCmd("active_object", WRAP_METHOD(Console, cmdViewActiveObject));
registerCmd("acc_object", WRAP_METHOD(Console, cmdViewAccumulatorObject));
_debugState.seeking = kDebugSeekNothing;
_debugState.seekLevel = 0;
_debugState.runningStep = 0;
_debugState.stopOnEvent = false;
_debugState.debugging = false;
_debugState.breakpointWasHit = false;
_debugState._breakpoints.clear(); // No breakpoints defined
_debugState._activeBreakpointTypes = 0;
}
Console::~Console() {
}
void Console::attach(const char *entry) {
if (entry) {
// Attaching to display a severe error, let the engine know
_engine->severeError();
}
GUI::Debugger::attach(entry);
}
void Console::preEnter() {
GUI::Debugger::preEnter();
}
extern void playVideo(Video::VideoDecoder &videoDecoder);
void Console::postEnter() {
if (!_videoFile.empty()) {
Common::ScopedPtr<Video::VideoDecoder> videoDecoder;
if (_videoFile.hasSuffix(".seq")) {
videoDecoder.reset(new SEQDecoder(_videoFrameDelay));
} else if (_videoFile.hasSuffix(".avi")) {
videoDecoder.reset(new Video::AVIDecoder());
} else {
warning("Unrecognized video type");
}
if (videoDecoder && videoDecoder->loadFile(_videoFile)) {
_engine->_gfxCursor->kernelHide();
playVideo(*videoDecoder);
_engine->_gfxCursor->kernelShow();
} else
warning("Could not play video %s\n", _videoFile.c_str());
_videoFile.clear();
_videoFrameDelay = 0;
}
GUI::Debugger::postEnter();
}
bool Console::cmdHelp(int argc, const char **argv) {
debugPrintf("\n");
debugPrintf("Variables\n");
debugPrintf("---------\n");
debugPrintf("sleeptime_factor: Factor to multiply with wait times in kWait()\n");
debugPrintf("gc_interval: Number of kernel calls in between garbage collections\n");
debugPrintf("simulated_key: Add a key with the specified scan code to the event list\n");
debugPrintf("track_mouse_clicks: Toggles mouse click tracking to the console\n");
debugPrintf("weak_validations: Turns some validation errors into warnings\n");
debugPrintf("script_abort_flag: Set to 1 to abort script execution. Set to 2 to force a replay afterwards\n");
debugPrintf("\n");
debugPrintf("Debug flags\n");
debugPrintf("-----------\n");
debugPrintf("debugflag_list - Lists the available debug flags and their status\n");
debugPrintf("debugflag_enable - Enables a debug flag\n");
debugPrintf("debugflag_disable - Disables a debug flag\n");
debugPrintf("debuglevel - Shows or sets debug level\n");
debugPrintf("\n");
debugPrintf("Commands\n");
debugPrintf("--------\n");
debugPrintf("Kernel:\n");
debugPrintf(" opcodes - Lists the opcode names\n");
debugPrintf(" selectors - Lists the selector names\n");
debugPrintf(" selector - Attempts to find the requested selector by name\n");
debugPrintf(" functions - Lists the kernel functions\n");
debugPrintf(" class_table - Shows the available classes\n");
debugPrintf("\n");
debugPrintf("Parser:\n");
debugPrintf(" suffixes - Lists the vocabulary suffixes\n");
debugPrintf(" parse_grammar - Shows the parse grammar, in strict GNF\n");
debugPrintf(" parser_nodes - Shows the specified number of nodes from the parse node tree\n");
debugPrintf(" parser_words - Shows the words from the parse node tree\n");
debugPrintf(" sentence_fragments - Shows the sentence fragments (used to build Parse trees)\n");
debugPrintf(" parse - Parses a sequence of words and prints the resulting parse tree\n");
debugPrintf(" set_parse_nodes - Sets the contents of all parse nodes\n");
debugPrintf(" said - Match a string against a said spec\n");
debugPrintf("\n");
debugPrintf("Resources:\n");
debugPrintf(" diskdump - Dumps the specified resource to disk as a patch file\n");
debugPrintf(" hexdump - Dumps the specified resource to standard output\n");
debugPrintf(" resource_id - Identifies a resource number by splitting it up in resource type and resource number\n");
debugPrintf(" resource_info - Shows info about a resource\n");
debugPrintf(" resource_types - Shows the valid resource types\n");
debugPrintf(" list - Lists all the resources of a given type\n");
debugPrintf(" alloc_list - Lists all allocated resources\n");
debugPrintf(" hexgrep - Searches some resources for a particular sequence of bytes, represented as hexadecimal numbers\n");
debugPrintf(" verify_scripts - Performs sanity checks on SCI1.1-SCI2.1 game scripts (e.g. if they're up to 64KB in total)\n");
debugPrintf(" integrity_dump - Dumps integrity data about resources in the current game to disk\n");
debugPrintf("\n");
debugPrintf("Game:\n");
debugPrintf(" save_game - Saves the current game state to the hard disk\n");
debugPrintf(" restore_game - Restores a saved game from the hard disk\n");
debugPrintf(" list_saves - List all saved games including filenames\n");
debugPrintf(" restart_game - Restarts the game\n");
debugPrintf(" version - Shows the resource and interpreter versions\n");
debugPrintf(" room - Gets or sets the current room number\n");
debugPrintf(" quit - Quits the game\n");
debugPrintf("\n");
debugPrintf("Graphics:\n");
debugPrintf(" show_map - Switches to visual, priority, control or display screen\n");
debugPrintf(" set_palette - Sets a palette resource\n");
debugPrintf(" draw_pic - Draws a pic resource\n");
debugPrintf(" draw_cel - Draws a cel from a view resource\n");
debugPrintf(" pic_visualize - Enables visualization of the drawing process of EGA pictures\n");
debugPrintf(" undither - Enable/disable undithering\n");
debugPrintf(" play_video - Plays a SEQ, AVI, VMD, RBT or DUK video\n");
debugPrintf(" animate_list / al - Shows the current list of objects in kAnimate's draw list (SCI0 - SCI1.1)\n");
debugPrintf(" window_list / wl - Shows a list of all the windows (ports) in the draw list (SCI0 - SCI1.1)\n");
debugPrintf(" plane_list / pl - Shows a list of all the planes in the draw list (SCI2+)\n");
debugPrintf(" visible_plane_list / vpl - Shows a list of all the planes in the visible draw list (SCI2+)\n");
debugPrintf(" plane_items / pi - Shows a list of all items for a plane (SCI2+)\n");
debugPrintf(" visible_plane_items / vpi - Shows a list of all items for a plane in the visible draw list (SCI2+)\n");
debugPrintf(" saved_bits - List saved bits on the hunk\n");
debugPrintf(" show_saved_bits - Display saved bits\n");
debugPrintf("\n");
debugPrintf("Segments:\n");
debugPrintf(" segment_table / segtable - Lists all segments\n");
debugPrintf(" segment_info / seginfo - Provides information on the specified segment\n");
debugPrintf(" segment_kill / segkill - Deletes the specified segment\n");
debugPrintf("\n");
debugPrintf("Garbage collection:\n");
debugPrintf(" gc - Invokes the garbage collector\n");
debugPrintf(" gc_objects - Lists all reachable objects, normalized\n");
debugPrintf(" gc_reachable - Lists all addresses directly reachable from a given memory object\n");
debugPrintf(" gc_freeable - Lists all addresses freeable in a given segment\n");
debugPrintf(" gc_normalize - Prints the \"normal\" address of a given address\n");
debugPrintf("\n");
debugPrintf("Music/SFX:\n");
debugPrintf(" songlib - Shows the song library\n");
debugPrintf(" songinfo - Shows information about a specified song in the song library\n");
debugPrintf(" togglesound - Starts/stops a sound in the song library\n");
debugPrintf(" stopallsounds - Stops all sounds in the playlist\n");
debugPrintf(" startsound - Starts the specified sound resource, replacing the first song in the song library\n");
debugPrintf(" is_sample - Shows information on a given sound resource, if it's a PCM sample\n");
debugPrintf(" sfx01_header - Dumps the header of a SCI01 song\n");
debugPrintf(" sfx01_track - Dumps a track of a SCI01 song\n");
debugPrintf(" show_instruments - Shows the instruments of a specific song, or all songs\n");
debugPrintf(" map_instrument - Dynamically maps an MT-32 instrument to a GM instrument\n");
debugPrintf(" audio_list - Lists currently active digital audio samples (SCI2+)\n");
debugPrintf(" audio_dump - Dumps the requested audio resource as an uncompressed wave file (SCI2+)\n");
debugPrintf("\n");
debugPrintf("Script:\n");
debugPrintf(" addresses - Provides information on how to pass addresses\n");
debugPrintf(" registers - Shows the current register values\n");
debugPrintf(" dissect_script - Examines a script\n");
debugPrintf(" backtrace / bt - Dumps the send/self/super/call/calle/callb stack\n");
debugPrintf(" trace / t / s - Executes one operation (no parameters) or several operations (specified as a parameter) \n");
debugPrintf(" stepover / p - Executes one operation, skips over call/send\n");
debugPrintf(" step_ret / pret - Steps forward until ret is called on the current execution stack level.\n");
debugPrintf(" step_event / se - Steps forward until a SCI event is received.\n");
debugPrintf(" step_global / sg - Steps until the global variable with the specified index is modified.\n");
debugPrintf(" step_callk / snk - Steps forward until it hits the next callk operation, or a specific callk (specified as a parameter)\n");
debugPrintf(" disasm - Disassembles a method by name\n");
debugPrintf(" disasm_addr - Disassembles one or more commands\n");
debugPrintf(" send - Sends a message to an object\n");
debugPrintf(" go - Executes the script\n");
debugPrintf(" logkernel - Logs kernel calls\n");
debugPrintf("\n");
debugPrintf("Breakpoints:\n");
debugPrintf(" bp_list / bplist / bl - Lists the current breakpoints\n");
debugPrintf(" bp_del / bpdel / bc - Deletes a breakpoint with the specified index\n");
debugPrintf(" bp_action / bpact - Set action to be performed when breakpoint is triggered\n");
debugPrintf(" bp_address / bpa - Sets a breakpoint on a script address\n");
debugPrintf(" bp_method / bpx - Sets a breakpoint on the execution of a specified method/selector\n");
debugPrintf(" bp_read / bpr - Sets a breakpoint on reading of a specified selector\n");
debugPrintf(" bp_write / bpw - Sets a breakpoint on writing to a specified selector\n");
debugPrintf(" bp_kernel / bpk - Sets a breakpoint on execution of a kernel function\n");
debugPrintf(" bp_function / bpe - Sets a breakpoint on the execution of the specified exported function\n");
debugPrintf("\n");
debugPrintf("VM:\n");
debugPrintf(" script_steps - Shows the number of executed SCI operations\n");
debugPrintf(" script_objects / scro - Shows all objects inside a specified script\n");
debugPrintf(" script_strings / scrs - Shows all strings inside a specified script\n");
debugPrintf(" script_said - Shows all said - strings inside a specified script\n");
debugPrintf(" vm_varlist / vmvarlist / vl - Shows the addresses of variables in the VM\n");
debugPrintf(" vm_vars / vmvars / vv - Displays or changes variables in the VM\n");
debugPrintf(" stack - Lists the specified number of stack elements\n");
debugPrintf(" value_type - Determines the type of a value\n");
debugPrintf(" view_listnode - Examines the list node at the given address\n");
debugPrintf(" view_reference / vr - Examines an arbitrary reference\n");
debugPrintf(" dump_reference / dr - Dumps an arbitrary reference to disk\n");
debugPrintf(" view_object / vo - Examines the object at the given address\n");
debugPrintf(" active_object - Shows information on the currently active object or class\n");
debugPrintf(" acc_object - Shows information on the object or class at the address indexed by the accumulator\n");
debugPrintf("\n");
return true;
}
ResourceType parseResourceType(const char *resid) {
// Gets the resource number of a resource string, or returns -1
ResourceType res = kResourceTypeInvalid;
for (int i = 0; i < kResourceTypeInvalid; i++)
if (strcmp(getResourceTypeName((ResourceType)i), resid) == 0)
res = (ResourceType)i;
return res;
}
bool Console::cmdGetVersion(int argc, const char **argv) {
const char *viewTypeDesc[] = { "Unknown", "EGA", "Amiga ECS 32 colors", "Amiga AGA 64 colors", "VGA", "VGA SCI1.1" };
bool hasVocab997 = g_sci->getResMan()->testResource(ResourceId(kResourceTypeVocab, VOCAB_RESOURCE_SELECTORS)) ? true : false;
Common::String gameVersion = "N/A";
Common::File versionFile;
if (versionFile.open("VERSION")) {
gameVersion = versionFile.readLine();
versionFile.close();
}
debugPrintf("Game ID: %s\n", _engine->getGameIdStr());
debugPrintf("Emulated interpreter version: %s\n", getSciVersionDesc(getSciVersion()));
debugPrintf("\n");
debugPrintf("Detected features:\n");
debugPrintf("------------------\n");
debugPrintf("Sound type: %s\n", getSciVersionDesc(_engine->_features->detectDoSoundType()));
debugPrintf("Graphics functions type: %s\n", getSciVersionDesc(_engine->_features->detectGfxFunctionsType()));
debugPrintf("Lofs type: %s\n", getSciVersionDesc(_engine->_features->detectLofsType()));
debugPrintf("Move count type: %s\n", (_engine->_features->handleMoveCount()) ? "increment" : "ignore");
debugPrintf("SetCursor type: %s\n", getSciVersionDesc(_engine->_features->detectSetCursorType()));
debugPrintf("PseudoMouse ability: %s\n", _engine->_features->detectPseudoMouseAbility() == kPseudoMouseAbilityTrue ? "yes" : "no");
#ifdef ENABLE_SCI32
if ((getSciVersion() >= SCI_VERSION_2_1_EARLY) && (getSciVersion() <= SCI_VERSION_2_1_LATE))
debugPrintf("SCI2.1 kernel table: %s\n", (_engine->_features->detectSci21KernelType() == SCI_VERSION_2) ? "modified SCI2 (old)" : "SCI2.1 (new)");
#endif
debugPrintf("View type: %s\n", viewTypeDesc[g_sci->getResMan()->getViewType()]);
if (getSciVersion() <= SCI_VERSION_1_1) {
debugPrintf("kAnimate fastCast enabled: %s\n", g_sci->_gfxAnimate->isFastCastEnabled() ? "yes" : "no");
}
if (getSciVersion() < SCI_VERSION_2) {
debugPrintf("Uses palette merging: %s\n", g_sci->_gfxPalette16->isMerging() ? "yes" : "no");
debugPrintf("Uses 16 bit color matching: %s\n", g_sci->_gfxPalette16->isUsing16bitColorMatch() ? "yes" : "no");
}
debugPrintf("Resource volume version: %s\n", g_sci->getResMan()->getVolVersionDesc());
debugPrintf("Resource map version: %s\n", g_sci->getResMan()->getMapVersionDesc());
debugPrintf("Contains selector vocabulary (vocab.997): %s\n", hasVocab997 ? "yes" : "no");
debugPrintf("Has CantBeHere selector: %s\n", g_sci->getKernel()->_selectorCache.cantBeHere != -1 ? "yes" : "no");
if (getSciVersion() >= SCI_VERSION_2) {
debugPrintf("Plane id base: %d\n", g_sci->_features->detectPlaneIdBase());
}
debugPrintf("Game version (VERSION file): %s\n", gameVersion.c_str());
debugPrintf("\n");
return true;
}
bool Console::cmdOpcodes(int argc, const char **argv) {
// Load the opcode table from vocab.998 if it exists, to obtain the opcode names
Resource *r = _engine->getResMan()->findResource(ResourceId(kResourceTypeVocab, 998), 0);
// If the resource couldn't be loaded, leave
if (!r) {
debugPrintf("unable to load vocab.998");
return true;
}
int count = r->getUint16LEAt(0);
debugPrintf("Opcode names in numeric order [index: type name]:\n");
for (int i = 0; i < count; i++) {
int offset = r->getUint16LEAt(2 + i * 2);
int len = r->getUint16LEAt(offset) - 2;
int type = r->getUint16LEAt(offset + 2);
// QFG3 has empty opcodes
Common::String name = len > 0 ? r->getStringAt(offset + 4, len) : "Dummy";
debugPrintf("%03x: %03x %20s | ", i, type, name.c_str());
if ((i % 3) == 2)
debugPrintf("\n");
}
debugPrintf("\n");
return true;
}
bool Console::cmdSelector(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Attempts to find the requested selector by name.\n");
debugPrintf("Usage: %s <selector name>\n", argv[0]);
return true;
}
Common::String name = argv[1];
int seeker = _engine->getKernel()->findSelector(name.c_str());
if (seeker >= 0) {
debugPrintf("Selector %s found at %03x (%d)\n", name.c_str(), seeker, seeker);
return true;
}
debugPrintf("Selector %s wasn't found\n", name.c_str());
return true;
}
bool Console::cmdSelectors(int argc, const char **argv) {
debugPrintf("Selector names in numeric order:\n");
Common::String selectorName;
for (uint seeker = 0; seeker < _engine->getKernel()->getSelectorNamesSize(); seeker++) {
selectorName = _engine->getKernel()->getSelectorName(seeker);
if (selectorName != "BAD SELECTOR")
debugPrintf("%03x: %20s | ", seeker, selectorName.c_str());
else
continue;
if ((seeker % 3) == 2)
debugPrintf("\n");
}
debugPrintf("\n");
#if 0
// For debug/development
// If we ever need to modify static_selectors.cpp, this code will print the selectors
// in a ready to use format
Common::DumpFile *outFile = new Common::DumpFile();
outFile->open("selectors.txt");
char buf[50];
Common::String selName;
uint totalSize = _engine->getKernel()->getSelectorNamesSize();
uint seeker = 0;
while (seeker < totalSize) {
selName = "\"" + _engine->getKernel()->getSelectorName(seeker) + "\"";
sprintf(buf, "%15s, ", selName.c_str());
outFile->writeString(buf);
if (!((seeker + 1) % 5) && seeker)
outFile->writeByte('\n');
seeker++;
}
outFile->finalize();
outFile->close();
#endif
return true;
}
bool Console::cmdKernelFunctions(int argc, const char **argv) {
debugPrintf("Kernel function names in numeric order:\n");
for (uint seeker = 0; seeker < _engine->getKernel()->getKernelNamesSize(); seeker++) {
debugPrintf("%03x: %20s | ", seeker, _engine->getKernel()->getKernelName(seeker).c_str());
if ((seeker % 3) == 2)
debugPrintf("\n");
}
debugPrintf("\n");
return true;
}
bool Console::cmdSuffixes(int argc, const char **argv) {
_engine->getVocabulary()->printSuffixes();
return true;
}
bool Console::cmdParserWords(int argc, const char **argv) {
_engine->getVocabulary()->printParserWords();
return true;
}
bool Console::cmdSetParseNodes(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Sets the contents of all parse nodes.\n");
debugPrintf("Usage: %s <parse node1> <parse node2> ... <parse noden>\n", argv[0]);
debugPrintf("Tokens should be separated by blanks and enclosed in parentheses\n");
return true;
}
int i = 0;
int pos = -1;
int nextToken = 0, nextValue = 0;
const char *token = argv[i++];
if (!strcmp(token, "(")) {
nextToken = kParseOpeningParenthesis;
} else if (!strcmp(token, ")")) {
nextToken = kParseClosingParenthesis;
} else if (!strcmp(token, "nil")) {
nextToken = kParseNil;
} else {
nextValue = strtol(token, NULL, 0);
nextToken = kParseNumber;
}
if (_engine->getVocabulary()->parseNodes(&i, &pos, nextToken, nextValue, argc, argv) == -1)
return 1;
_engine->getVocabulary()->dumpParseTree();
return true;
}
bool Console::cmdRegisters(int argc, const char **argv) {
EngineState *s = _engine->_gamestate;
debugPrintf("Current register values:\n");
debugPrintf("acc=%04x:%04x prev=%04x:%04x &rest=%x\n", PRINT_REG(s->r_acc), PRINT_REG(s->r_prev), s->r_rest);
if (!s->_executionStack.empty()) {
debugPrintf("pc=%04x:%04x obj=%04x:%04x fp=ST:%04x sp=ST:%04x\n",
PRINT_REG(s->xs->addr.pc), PRINT_REG(s->xs->objp),
(unsigned)(s->xs->fp - s->stack_base), (unsigned)(s->xs->sp - s->stack_base));
} else
debugPrintf("<no execution stack: pc,obj,fp omitted>\n");
return true;
}
bool Console::parseResourceNumber36(const char *userParameter, uint16 &resourceNumber, uint32 &resourceTuple) {
int userParameterLen = strlen(userParameter);
if (userParameterLen != 10) {
debugPrintf("Audio36/Sync36 resource numbers must be specified as RRRNNVVCCS\n");
debugPrintf("where RRR is the resource number/map\n");
debugPrintf(" NN is the noun\n");
debugPrintf(" VV is the verb\n");
debugPrintf(" CC is the cond\n");
debugPrintf(" S is the seq\n");
return false;
}
// input: RRRNNVVCCS
resourceNumber = strtol(Common::String(userParameter, 3).c_str(), 0, 36);
uint16 noun = strtol(Common::String(userParameter + 3, 2).c_str(), 0, 36);
uint16 verb = strtol(Common::String(userParameter + 5, 2).c_str(), 0, 36);
uint16 cond = strtol(Common::String(userParameter + 7, 2).c_str(), 0, 36);
uint16 seq = strtol(Common::String(userParameter + 9, 1).c_str(), 0, 36);
resourceTuple = ((noun & 0xff) << 24) | ((verb & 0xff) << 16) | ((cond & 0xff) << 8) | (seq & 0xff);
return true;
}
bool Console::cmdDiskDump(int argc, const char **argv) {
bool resourceAll = false;
uint16 resourceNumber = 0;
uint32 resourceTuple = 0;
if (argc != 3) {
debugPrintf("Dumps the specified resource to disk as a patch file\n");
debugPrintf("Usage: %s <resource type> <resource number>\n", argv[0]);
debugPrintf(" <resource number> may be '*' to dump all resources of given type\n");
cmdResourceTypes(argc, argv);
return true;
}
ResourceType resourceType = parseResourceType(argv[1]);
if (resourceType == kResourceTypeInvalid) {
debugPrintf("Resource type '%s' is not valid\n", argv[1]);
return true;
}
if (strcmp(argv[2], "*") == 0) {
resourceAll = true;
} else {
switch (resourceType) {
case kResourceTypeAudio36:
case kResourceTypeSync36:
if (!parseResourceNumber36(argv[2], resourceNumber, resourceTuple)) {
return true;
}
break;
default:
resourceNumber = atoi(argv[2]);
break;
}
}
if (resourceType == kResourceTypeInvalid) {
debugPrintf("Resource type '%s' is not valid\n", argv[1]);
return true;
}
if (resourceAll) {
// "*" used, dump everything of that type
Common::List<ResourceId> resources = _engine->getResMan()->listResources(resourceType, -1);
Common::sort(resources.begin(), resources.end());
Common::List<ResourceId>::iterator itr;
for (itr = resources.begin(); itr != resources.end(); ++itr) {
resourceNumber = itr->getNumber();
resourceTuple = itr->getTuple();
cmdDiskDumpWorker(resourceType, resourceNumber, resourceTuple);
}
} else {
// id was given, dump only this resource
cmdDiskDumpWorker(resourceType, resourceNumber, resourceTuple);
}
return true;
}
void Console::cmdDiskDumpWorker(ResourceType resourceType, int resourceNumber, uint32 resourceTuple) {
const char *resourceTypeName = getResourceTypeName(resourceType);
ResourceId resourceId;
Resource *resource = NULL;
char outFileName[50];
switch (resourceType) {
case kResourceTypeAudio36:
case kResourceTypeSync36: {
resourceId = ResourceId(resourceType, resourceNumber, resourceTuple);
resource = _engine->getResMan()->findResource(resourceId, 0);
sprintf(outFileName, "%s", resourceId.toPatchNameBase36().c_str());
// patch filename is: [type:1 char] [map:3 chars] [noun:2 chars] [verb:2 chars] "." [cond: 2 chars] [seq:1 char]
// e.g. "@5EG0000.014"
break;
}
default:
resourceId = ResourceId(resourceType, resourceNumber);
resource = _engine->getResMan()->findResource(resourceId, 0);
sprintf(outFileName, "%s.%03d", resourceTypeName, resourceNumber);
// patch filename is: [resourcetype].[resourcenumber]
// e.g. "Script.0"
break;
}
if (resource) {
Common::DumpFile *outFile = new Common::DumpFile();
outFile->open(outFileName);
resource->writeToStream(outFile);
outFile->finalize();
outFile->close();
delete outFile;
debugPrintf("Resource %s (located in %s) has been dumped to disk\n", outFileName, resource->getResourceLocation().c_str());
} else {
debugPrintf("Resource %s not found\n", outFileName);
}
}
bool Console::cmdHexDump(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Dumps the specified resource to standard output\n");
debugPrintf("Usage: %s <resource type> <resource number>\n", argv[0]);
cmdResourceTypes(argc, argv);
return true;
}
int resNum = atoi(argv[2]);
ResourceType res = parseResourceType(argv[1]);
if (res == kResourceTypeInvalid)
debugPrintf("Resource type '%s' is not valid\n", argv[1]);
else {
Resource *resource = _engine->getResMan()->findResource(ResourceId(res, resNum), 0);
if (resource) {
Common::hexdump(resource->getUnsafeDataAt(0), resource->size(), 16, 0);
debugPrintf("Resource %s.%03d has been dumped to standard output\n", argv[1], resNum);
} else {
debugPrintf("Resource %s.%03d not found\n", argv[1], resNum);
}
}
return true;
}
bool Console::cmdResourceId(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Identifies a resource number by splitting it up in resource type and resource number\n");
debugPrintf("Usage: %s <resource number>\n", argv[0]);
return true;
}
int id = atoi(argv[1]);
debugPrintf("%s.%d (0x%x)\n", getResourceTypeName((ResourceType)(id >> 11)), id & 0x7ff, id & 0x7ff);
return true;
}
bool Console::cmdList(int argc, const char **argv) {
int selectedMapNumber = -1;
Common::List<ResourceId> resources;
Common::List<ResourceId>::iterator itr;
int displayCount = 0;
int currentMap = -1;
if (argc < 2) {
debugPrintf("Lists all the resources of a given type\n");
cmdResourceTypes(argc, argv);
return true;
}
ResourceType resourceType = parseResourceType(argv[1]);
if (resourceType == kResourceTypeInvalid) {
debugPrintf("Unknown resource type: '%s'\n", argv[1]);
return true;
}
switch (resourceType) {
case kResourceTypeAudio36:
case kResourceTypeSync36:
if (argc != 3) {
debugPrintf("Please specify map number (-1: all maps)\n");
return true;
}
selectedMapNumber = atoi(argv[2]);
resources = _engine->getResMan()->listResources(resourceType, selectedMapNumber);
Common::sort(resources.begin(), resources.end());
for (itr = resources.begin(); itr != resources.end(); ++itr) {
const uint16 map = itr->getNumber();
const uint32 resourceTuple = itr->getTuple();
const uint16 noun = (resourceTuple >> 24) & 0xff;
const uint16 verb = (resourceTuple >> 16) & 0xff;
const uint16 cond = (resourceTuple >> 8) & 0xff;
const uint16 seq = resourceTuple & 0xff;
if (currentMap != map) {
if (displayCount % 3)
debugPrintf("\n");
debugPrintf("Map %04x (%i):\n", map, map);
currentMap = map;
displayCount = 0;
}
if (displayCount % 3 == 0)
debugPrintf(" ");
debugPrintf("%02x %02x %02x %02x (%3i %3i %3i %3i) ", noun, verb, cond, seq, noun, verb, cond, seq);
if (++displayCount % 3 == 0)
debugPrintf("\n");
}
break;
default:
resources = _engine->getResMan()->listResources(resourceType);
Common::sort(resources.begin(), resources.end());
for (itr = resources.begin(); itr != resources.end(); ++itr) {
debugPrintf("%8i", itr->getNumber());
if (++displayCount % 10 == 0)
debugPrintf("\n");
}
break;
}
debugPrintf("\n");
return true;
}
bool Console::cmdResourceIntegrityDump(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Dumps integrity data about resources in the current game to disk.\n");
debugPrintf("Usage: %s <filename> [<skip video file hashing>] [<skip video files altogether>]\n", argv[0]);
return true;
}
Common::DumpFile outFile;
if (!outFile.open(argv[1])) {
debugPrintf("Failed to open output file %s.\n", argv[1]);
return true;
}
const bool hashVideoFiles = argc < 3;
const bool videoFiles = argc < 4;
for (int i = 0; i < kResourceTypeInvalid; ++i) {
const ResourceType resType = (ResourceType)i;
// This will list video resources inside of resource bundles even if
// video files are skipped, but this seems fine since those files are
// small because they were intended to load into memory. (This happens
// with VMDs in GK2.)
Common::List<ResourceId> resources = _engine->getResMan()->listResources(resType);
const char *extension = "";
if (videoFiles) {
switch (resType) {
case kResourceTypeRobot:
case kResourceTypeVMD:
case kResourceTypeDuck:
case kResourceTypeClut: {
extension = getResourceTypeExtension(resType);
assert(*extension != '\0');
const Common::String filesGlob = Common::String::format("*.%s", extension).c_str();
Common::ArchiveMemberList files;
const int numMatches = SearchMan.listMatchingMembers(files, filesGlob);
if (numMatches > 0) {
Common::ArchiveMemberList::const_iterator it;
for (it = files.begin(); it != files.end(); ++it) {
const uint resNo = atoi((*it)->getName().c_str());
resources.push_back(ResourceId(resType, resNo));
}
}
break;
}
default:
break;
}
}
if (resources.size()) {
Common::sort(resources.begin(), resources.end());
Common::List<ResourceId>::const_iterator it;
debugPrintf("%s: ", getResourceTypeName(resType));
for (it = resources.begin(); it != resources.end(); ++it) {
Common::String statusName;
if (resType == kResourceTypeAudio36 || resType == kResourceTypeSync36) {
statusName = it->toPatchNameBase36();
} else {
statusName = Common::String::format("%d", it->getNumber());
}
const Common::String resourceName = it->toString();
Resource *resource = _engine->getResMan()->findResource(*it, false);
if (resource) {
Common::MemoryReadStream stream = resource->toStream();
writeIntegrityDumpLine(statusName, resourceName, outFile, &stream, resource->size(), true);
} else if (videoFiles && *extension != '\0') {
const Common::String fileName = Common::String::format("%u.%s", it->getNumber(), extension);
Common::File file;
Common::ReadStream *stream = nullptr;
if (file.open(fileName)) {
stream = &file;
}
writeIntegrityDumpLine(statusName, resourceName, outFile, stream, file.size(), hashVideoFiles);
}
}
debugPrintf("\n");
}
}
const char *otherVideoFiles[] = { "avi", "seq" };
for (uint i = 0; i < ARRAYSIZE(otherVideoFiles); ++i) {
const char *extension = otherVideoFiles[i];
Common::ArchiveMemberList files;
if (SearchMan.listMatchingMembers(files, Common::String::format("*.%s", extension).c_str()) > 0) {
debugPrintf("%s: ", extension);
Common::sort(files.begin(), files.end(), Common::ArchiveMemberListComparator());
Common::ArchiveMemberList::const_iterator it;
for (it = files.begin(); it != files.end(); ++it) {
const Common::ArchiveMember &file = **it;
Common::ScopedPtr<Common::SeekableReadStream> stream(file.createReadStream());
writeIntegrityDumpLine(file.getName(), file.getName(), outFile, stream.get(), stream->size(), hashVideoFiles);
}
debugPrintf("\n");
}
}
return true;
}
bool Console::cmdAllocList(int argc, const char **argv) {
ResourceManager *resMan = _engine->getResMan();
for (int i = 0; i < kResourceTypeInvalid; ++i) {
Common::List<ResourceId> resources = _engine->getResMan()->listResources((ResourceType)i);
if (resources.size()) {
Common::sort(resources.begin(), resources.end());
bool hasAlloc = false;
Common::List<ResourceId>::const_iterator it;
for (it = resources.begin(); it != resources.end(); ++it) {
Resource *resource = resMan->testResource(*it);
if (resource != nullptr && resource->data() != nullptr) {
if (hasAlloc) {
debugPrintf(", ");
} else {
debugPrintf("%s: ", getResourceTypeName((ResourceType)i));
}
hasAlloc = true;
debugPrintf("%u (%u locks)", resource->getNumber(), resource->getNumLockers());
}
}
if (hasAlloc) {
debugPrintf("\n");
}
}
}
return true;
}
bool Console::cmdDissectScript(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Examines a script\n");
debugPrintf("Usage: %s <script number>\n", argv[0]);
return true;
}
_engine->getKernel()->dissectScript(atoi(argv[1]), _engine->getVocabulary());
return true;
}
bool Console::cmdRoomNumber(int argc, const char **argv) {
// The room number is stored in global var 13
// The same functionality is provided by "vmvars g 13" (but this one is more straighforward)
if (argc != 2) {
debugPrintf("Current room number is %d\n", _engine->_gamestate->currentRoomNumber());
debugPrintf("Calling this command with the room number (in decimal or hexadecimal) changes the room\n");
} else {
Common::String roomNumberStr = argv[1];
int roomNumber = strtol(roomNumberStr.c_str(), NULL, roomNumberStr.hasSuffix("h") ? 16 : 10);
_engine->_gamestate->setRoomNumber(roomNumber);
debugPrintf("Room number changed to %d (%x in hex)\n", roomNumber, roomNumber);
}
return true;
}
bool Console::cmdResourceInfo(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Shows information about a resource\n");
debugPrintf("Usage: %s <resource type> <resource number>\n", argv[0]);
return true;
}
int resNum = atoi(argv[2]);
ResourceType res = parseResourceType(argv[1]);
if (res == kResourceTypeInvalid)
debugPrintf("Resource type '%s' is not valid\n", argv[1]);
else {
Resource *resource = _engine->getResMan()->findResource(ResourceId(res, resNum), 0);
if (resource) {
debugPrintf("Resource size: %u\n", resource->size());
debugPrintf("Resource location: %s\n", resource->getResourceLocation().c_str());
Common::MemoryReadStream stream = resource->toStream();
const Common::String hash = Common::computeStreamMD5AsString(stream);
debugPrintf("Resource hash (decompressed): %s\n", hash.c_str());
} else {
debugPrintf("Resource %s.%03d not found\n", argv[1], resNum);
}
}
return true;
}
bool Console::cmdResourceTypes(int argc, const char **argv) {
debugPrintf("The %d valid resource types are:\n", kResourceTypeInvalid);
for (int i = 0; i < kResourceTypeInvalid; i++) {
debugPrintf("%s", getResourceTypeName((ResourceType) i));
debugPrintf((i < kResourceTypeInvalid - 1) ? ", " : "\n");
}
return true;
}
bool Console::cmdHexgrep(int argc, const char **argv) {
if (argc < 4) {
debugPrintf("Searches some resources for a particular sequence of bytes, represented as decimal or hexadecimal numbers.\n");
debugPrintf("Usage: %s <resource type> <resource number> <search string>\n", argv[0]);
debugPrintf("<resource number> can be a specific resource number, or \"all\" for all of the resources of the specified type\n");
debugPrintf("EXAMPLES:\n hexgrep script all 0xe8 0x03 0xc8 0x00\n hexgrep pic 0x42 0xfe\n");
cmdResourceTypes(argc, argv);
return true;
}
ResourceType restype = parseResourceType(argv[1]);
int resNumber = 0, resMax = 0;
Resource *script = NULL;
if (restype == kResourceTypeInvalid) {
debugPrintf("Resource type '%s' is not valid\n", argv[1]);
return true;
}
if (!scumm_stricmp(argv[2], "all")) {
resNumber = 0;
resMax = 65535;
} else {
resNumber = resMax = atoi(argv[2]);
}
// Convert the bytes
Common::Array<int> byteString;
byteString.resize(argc - 3);
for (uint i = 0; i < byteString.size(); i++)
if (!parseInteger(argv[i + 3], byteString[i]))
return true;
for (; resNumber <= resMax; resNumber++) {
script = _engine->getResMan()->findResource(ResourceId(restype, resNumber), 0);
if (script) {
uint32 seeker = 0, seekerold = 0;
uint32 comppos = 0;
int output_script_name = 0;
while (seeker < script->size()) {
if (script->getUint8At(seeker) == byteString[comppos]) {
if (comppos == 0)
seekerold = seeker;
comppos++;
if (comppos == byteString.size()) {
comppos = 0;
seeker = seekerold + 1;
if (!output_script_name) {
debugPrintf("\nIn %s.%03d:\n", getResourceTypeName((ResourceType)restype), resNumber);
output_script_name = 1;
}
debugPrintf(" 0x%04x\n", seekerold);
}
} else
comppos = 0;
seeker++;
}
}
}
return true;
}
bool Console::cmdVerifyScripts(int argc, const char **argv) {
if (getSciVersion() < SCI_VERSION_1_1) {
debugPrintf("This script check is only meant for SCI1.1-SCI3 games\n");
return true;
}
Common::List<ResourceId> resources = _engine->getResMan()->listResources(kResourceTypeScript);
Common::sort(resources.begin(), resources.end());
debugPrintf("%d SCI1.1-SCI3 scripts found, performing sanity checks...\n", resources.size());
Resource *script, *heap;
Common::List<ResourceId>::iterator itr;
for (itr = resources.begin(); itr != resources.end(); ++itr) {
script = _engine->getResMan()->findResource(*itr, false);
if (!script)
debugPrintf("Error: script %d couldn't be loaded\n", itr->getNumber());
if (getSciVersion() <= SCI_VERSION_2_1_LATE) {
heap = _engine->getResMan()->findResource(ResourceId(kResourceTypeHeap, itr->getNumber()), false);
if (!heap)
debugPrintf("Error: script %d doesn't have a corresponding heap\n", itr->getNumber());
if (script && heap && (script->size() + heap->size() > 65535))
debugPrintf("Error: script and heap %d together are larger than 64KB (%u bytes)\n",
itr->getNumber(), script->size() + heap->size());
} else { // SCI3
if (script && script->size() > 0x3FFFF)
debugPrintf("Error: script %d is larger than 256KB (%u bytes)\n",
itr->getNumber(), script->size());
}
}
debugPrintf("SCI1.1-SCI2.1 script check finished\n");
return true;
}
// Same as in sound/drivers/midi.cpp
uint8 getGmInstrument(const Mt32ToGmMap &Mt32Ins) {
if (Mt32Ins.gmInstr == MIDI_MAPPED_TO_RHYTHM)
return Mt32Ins.gmRhythmKey + 0x80;
else
return Mt32Ins.gmInstr;
}
bool Console::cmdShowInstruments(int argc, const char **argv) {
int songNumber = -1;
if (argc == 2)
songNumber = atoi(argv[1]);
SciVersion doSoundVersion = _engine->_features->detectDoSoundType();
MidiPlayer *player = MidiPlayer_Midi_create(doSoundVersion);
MidiParser_SCI *parser = new MidiParser_SCI(doSoundVersion, 0);
parser->setMidiDriver(player);
Common::List<ResourceId> resources = _engine->getResMan()->listResources(kResourceTypeSound);
Common::sort(resources.begin(), resources.end());
int instruments[128];
bool instrumentsSongs[128][1000];
for (int i = 0; i < 128; i++)
instruments[i] = 0;
for (int i = 0; i < 128; i++)
for (int j = 0; j < 1000; j++)
instrumentsSongs[i][j] = false;
if (songNumber == -1) {
debugPrintf("%d sounds found, checking their instrument mappings...\n", resources.size());
debugPrintf("Instruments:\n");
debugPrintf("============\n");
}
Common::List<ResourceId>::iterator itr;
for (itr = resources.begin(); itr != resources.end(); ++itr) {
if (songNumber >= 0 && itr->getNumber() != songNumber)
continue;
SoundResource sound(itr->getNumber(), _engine->getResMan(), doSoundVersion);
int channelFilterMask = sound.getChannelFilterMask(player->getPlayId(), player->hasRhythmChannel());
SoundResource::Track *track = sound.getTrackByType(player->getPlayId());
if (!track || track->digitalChannelNr != -1) {
// Skip digitized sound effects
continue;
}
parser->loadMusic(track, NULL, channelFilterMask, doSoundVersion);
SciSpan<const byte> channelData = parser->getMixedData();
byte curEvent = 0, prevEvent = 0, command = 0;
bool endOfTrack = false;
bool firstOneShown = false;
debugPrintf("Song %d: ", itr->getNumber());
do {
while (*channelData == 0xF8)
channelData++;
channelData++; // delta
if ((*channelData & 0xF0) >= 0x80)
curEvent = *(channelData++);
else
curEvent = prevEvent;
if (curEvent < 0x80)
continue;
prevEvent = curEvent;
command = curEvent >> 4;
byte channel;
switch (command) {
case 0xC: // program change
channel = curEvent & 0x0F;
if (channel != 15) { // SCI special
byte instrument = *channelData++;
if (!firstOneShown)
firstOneShown = true;
else
debugPrintf(",");
debugPrintf(" %d", instrument);
instruments[instrument]++;
instrumentsSongs[instrument][itr->getNumber()] = true;
} else {
channelData++;
}
break;
case 0xD:
channelData++; // param1
break;
case 0xB:
case 0x8:
case 0x9:
case 0xA:
case 0xE:
channelData++; // param1
channelData++; // param2
break;
case 0xF:
if ((curEvent & 0x0F) == 0x2) {
channelData++; // param1
channelData++; // param2
} else if ((curEvent & 0x0F) == 0x3) {
channelData++; // param1
} else if ((curEvent & 0x0F) == 0xF) { // META
byte type = *channelData++;
if (type == 0x2F) {// end of track reached
endOfTrack = true;
} else {
// no further processing necessary
}
}
break;
default:
break;
}
} while (!endOfTrack);
debugPrintf("\n");
}
delete parser;
delete player;
debugPrintf("\n");
if (songNumber == -1) {
debugPrintf("Used instruments: ");
for (int i = 0; i < 128; i++) {
if (instruments[i] > 0)
debugPrintf("%d, ", i);
}
debugPrintf("\n\n");
}
debugPrintf("Instruments not mapped in the MT32->GM map: ");
for (int i = 0; i < 128; i++) {
if (instruments[i] > 0 && getGmInstrument(Mt32MemoryTimbreMaps[i]) == MIDI_UNMAPPED)
debugPrintf("%d, ", i);
}
debugPrintf("\n\n");
if (songNumber == -1) {
debugPrintf("Used instruments in songs:\n");
for (int i = 0; i < 128; i++) {
if (instruments[i] > 0) {
debugPrintf("Instrument %d: ", i);
for (int j = 0; j < 1000; j++) {
if (instrumentsSongs[i][j])
debugPrintf("%d, ", j);
}
debugPrintf("\n");
}
}
debugPrintf("\n\n");
}
return true;
}
bool Console::cmdMapInstrument(int argc, const char **argv) {
if (argc != 4) {
debugPrintf("Maps an MT-32 custom instrument to a GM instrument on the fly\n\n");
debugPrintf("Usage %s <MT-32 instrument name> <GM instrument> <GM rhythm key>\n", argv[0]);
debugPrintf("Each MT-32 instrument is always 10 characters and is mapped to either a GM instrument, or a GM rhythm key\n");
debugPrintf("A value of 255 (0xff) signifies an unmapped instrument\n");
debugPrintf("Please replace the spaces in the instrument name with underscores (\"_\"). They'll be converted to spaces afterwards\n\n");
debugPrintf("Example: %s test_0__XX 1 255\n", argv[0]);
debugPrintf("The above example will map the MT-32 instrument \"test 0 XX\" to GM instrument 1\n\n");
} else {
if (Mt32dynamicMappings != NULL) {
Mt32ToGmMap newMapping;
char *instrumentName = new char[11];
Common::strlcpy(instrumentName, argv[1], 11);
for (uint16 i = 0; i < Common::strnlen(instrumentName, 11); i++)
if (instrumentName[i] == '_')
instrumentName[i] = ' ';
newMapping.name = instrumentName;
newMapping.gmInstr = atoi(argv[2]);
newMapping.gmRhythmKey = atoi(argv[3]);
Mt32dynamicMappings->push_back(newMapping);
}
}
debugPrintf("Current dynamic mappings:\n");
if (Mt32dynamicMappings != NULL) {
const Mt32ToGmMapList::iterator end = Mt32dynamicMappings->end();
for (Mt32ToGmMapList::iterator it = Mt32dynamicMappings->begin(); it != end; ++it) {
debugPrintf("\"%s\" -> %d / %d\n", (*it).name, (*it).gmInstr, (*it).gmRhythmKey);
}
}
return true;
}
bool Console::cmdAudioList(int argc, const char **argv) {
#ifdef ENABLE_SCI32
if (_engine->_audio32) {
debugPrintf("Audio list (%d active channels):\n", _engine->_audio32->getNumActiveChannels());
_engine->_audio32->printAudioList(this);
} else {
debugPrintf("This SCI version does not have a software digital audio mixer\n");
}
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdAudioDump(int argc, const char **argv) {
#ifdef ENABLE_SCI32
if (argc != 2 && argc != 6) {
debugPrintf("Dumps the requested audio resource as an uncompressed wave file.\n");
debugPrintf("Usage (audio): %s <audio resource id>\n", argv[0]);
debugPrintf("Usage (audio36): %s <audio map id> <noun> <verb> <cond> <seq>\n", argv[0]);
return true;
}
ResourceId id;
if (argc == 2) {
id = ResourceId(kResourceTypeAudio, atoi(argv[1]));
} else {
id = ResourceId(kResourceTypeAudio36, atoi(argv[1]), atoi(argv[2]), atoi(argv[3]), atoi(argv[4]), atoi(argv[5]));
}
Resource *resource = _engine->_resMan->findResource(id, false);
if (!resource) {
debugPrintf("Not found.\n");
return true;
}
Common::MemoryReadStream stream = resource->toStream();
Common::DumpFile outFile;
const Common::String fileName = Common::String::format("%s.wav", id.toString().c_str());
if (!outFile.open(fileName)) {
debugPrintf("Could not open dump file %s.\n", fileName.c_str());
return true;
}
const bool isSol = detectSolAudio(stream);
const bool isWave = !isSol && detectWaveAudio(stream);
const bool isRaw = !isSol && !isWave;
if (isSol || isRaw) {
uint16 sampleRate = 11025;
int numChannels = 1;
int bytesPerSample = 1;
bool sourceIs8Bit = true;
uint32 compressedSize = 0;
uint32 decompressedSize;
if (isSol) {
stream.seek(6, SEEK_SET);
sampleRate = stream.readUint16LE();
const byte flags = stream.readByte();
compressedSize = stream.readUint32LE();
// All AudioStreams must output 16-bit samples
bytesPerSample = 2;
decompressedSize = compressedSize;
if (flags & kCompressed) {
decompressedSize *= 2;
}
if (flags & k16Bit) {
sourceIs8Bit = false;
} else {
// 8-bit is implicitly up-converted by AudioStream to 16-bit
decompressedSize *= 2;
}
if (flags & kStereo) {
numChannels = 2;
}
} else {
decompressedSize = resource->size();
}
enum {
kWaveHeaderSize = 36
};
outFile.writeString("RIFF");
outFile.writeUint32LE(kWaveHeaderSize + decompressedSize);
outFile.writeString("WAVEfmt ");
outFile.writeUint32LE(16);
outFile.writeUint16LE(1);
outFile.writeUint16LE(numChannels);
outFile.writeUint32LE(sampleRate);
outFile.writeUint32LE(sampleRate * bytesPerSample * numChannels);
outFile.writeUint16LE(bytesPerSample * numChannels);
outFile.writeUint16LE(bytesPerSample * 8);
outFile.writeString("data");
outFile.writeUint32LE(decompressedSize);
if (isSol) {
stream.seek(0, SEEK_SET);
Common::ScopedPtr<Audio::SeekableAudioStream> audioStream(makeSOLStream(&stream, DisposeAfterUse::NO));
if (!audioStream) {
debugPrintf("Could not create SOL stream.\n");
return true;
}
byte buffer[4096];
const int samplesToRead = ARRAYSIZE(buffer) / 2;
uint bytesWritten = 0;
int samplesRead;
while ((samplesRead = audioStream->readBuffer((int16 *)buffer, samplesToRead))) {
uint bytesToWrite = samplesRead * bytesPerSample;
outFile.write(buffer, bytesToWrite);
bytesWritten += bytesToWrite;
}
if (bytesWritten != decompressedSize) {
debugPrintf("WARNING: Should have written %u bytes but wrote %u bytes!\n", decompressedSize, bytesWritten);
while (bytesWritten < decompressedSize) {
outFile.writeByte(0);
++bytesWritten;
}
}
const char *bits;
if (sourceIs8Bit) {
bits = "upconverted 16";
} else {
bits = "16";
}
debugPrintf("%s-bit %uHz %d-channel SOL audio, %u -> %u bytes\n", bits, sampleRate, numChannels, compressedSize, decompressedSize);
} else {
outFile.write(resource->data(), resource->size());
debugPrintf("%d-bit %uHz %d-channel raw audio, %u bytes\n", bytesPerSample * 8, sampleRate, numChannels, decompressedSize);
}
} else if (isWave) {
outFile.write(resource->data(), resource->size());
debugPrintf("Raw wave file\n");
} else {
error("Impossible situation");
}
debugPrintf("Written to %s successfully.\n", fileName.c_str());
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdSaveGame(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Saves the current game state to the hard disk\n");
debugPrintf("Usage: %s <filename>\n", argv[0]);
return true;
}
int result = 0;
for (uint i = 0; i < _engine->_gamestate->_fileHandles.size(); i++)
if (_engine->_gamestate->_fileHandles[i].isOpen())
result++;
if (result)
debugPrintf("Note: Game state has %d open file handles.\n", result);
Common::SaveFileManager *saveFileMan = g_engine->getSaveFileManager();
Common::OutSaveFile *out = saveFileMan->openForSaving(argv[1]);
const char *version = "";
if (!out) {
debugPrintf("Error opening savegame \"%s\" for writing\n", argv[1]);
return true;
}
// TODO: enable custom descriptions? force filename into a specific format?
if (!gamestate_save(_engine->_gamestate, out, "debugging", version)) {
debugPrintf("Saving the game state to '%s' failed\n", argv[1]);
} else {
out->finalize();
if (out->err()) {
warning("Writing the savegame failed");
}
delete out;
}
return true;
}
bool Console::cmdRestoreGame(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Restores a saved game from the hard disk\n");
debugPrintf("Usage: %s <filename>\n", argv[0]);
return true;
}
Common::SaveFileManager *saveFileMan = g_engine->getSaveFileManager();
Common::SeekableReadStream *in = saveFileMan->openForLoading(argv[1]);
if (in) {
// found a savegame file
gamestate_restore(_engine->_gamestate, in);
delete in;
}
if (_engine->_gamestate->r_acc == make_reg(0, 1)) {
debugPrintf("Restoring gamestate '%s' failed.\n", argv[1]);
return true;
}
return cmdExit(0, 0);
}
bool Console::cmdRestartGame(int argc, const char **argv) {
_engine->_gamestate->abortScriptProcessing = kAbortRestartGame;
return cmdExit(0, 0);
}
// The scripts get IDs ranging from 100->199, because the scripts require us to assign unique ids THAT EVEN STAY BETWEEN
// SAVES and the scripts also use "saves-count + 1" to create a new savedgame slot.
// SCI1.1 actually recycles ids, in that case we will currently get "0".
// This behavior is required especially for LSL6. In this game, it's possible to quick save. The scripts will use
// the last-used id for that feature. If we don't assign sticky ids, the feature will overwrite different saves all the
// time. And sadly we can't just use the actual filename ids directly, because of the creation method for new slots.
extern void listSavegames(Common::Array<SavegameDesc> &saves);
bool Console::cmdListSaves(int argc, const char **argv) {
Common::Array<SavegameDesc> saves;
listSavegames(saves);
for (uint i = 0; i < saves.size(); i++) {
Common::String filename = g_sci->getSavegameName(saves[i].id);
debugPrintf("%s: '%s'\n", filename.c_str(), saves[i].name);
}
return true;
}
bool Console::cmdClassTable(int argc, const char **argv) {
debugPrintf("Available classes (parse a parameter to filter the table by a specific class):\n");
for (uint i = 0; i < _engine->_gamestate->_segMan->classTableSize(); i++) {
Class temp = _engine->_gamestate->_segMan->_classTable[i];
if (temp.reg.getSegment()) {
const char *className = _engine->_gamestate->_segMan->getObjectName(temp.reg);
if (argc == 1 || (argc == 2 && !strcmp(className, argv[1]))) {
debugPrintf(" Class 0x%x (%s) at %04x:%04x (script %d)\n", i,
className,
PRINT_REG(temp.reg),
temp.script);
} else debugPrintf(" Class 0x%x (not loaded; can't get name) (script %d)\n", i, temp.script);
}
}
return true;
}
bool Console::cmdSentenceFragments(int argc, const char **argv) {
debugPrintf("Sentence fragments (used to build Parse trees)\n");
for (uint i = 0; i < _engine->getVocabulary()->getParserBranchesSize(); i++) {
int j = 0;
const parse_tree_branch_t &branch = _engine->getVocabulary()->getParseTreeBranch(i);
debugPrintf("R%02d: [%x] ->", i, branch.id);
while ((j < 10) && branch.data[j]) {
int dat = branch.data[j++];
switch (dat) {
case VOCAB_TREE_NODE_COMPARE_TYPE:
dat = branch.data[j++];
debugPrintf(" C(%x)", dat);
break;
case VOCAB_TREE_NODE_COMPARE_GROUP:
dat = branch.data[j++];
debugPrintf(" WG(%x)", dat);
break;
case VOCAB_TREE_NODE_FORCE_STORAGE:
dat = branch.data[j++];
debugPrintf(" FORCE(%x)", dat);
break;
default:
if (dat > VOCAB_TREE_NODE_LAST_WORD_STORAGE) {
int dat2 = branch.data[j++];
debugPrintf(" %x[%x]", dat, dat2);
} else
debugPrintf(" ?%x?", dat);
}
}
debugPrintf("\n");
}
debugPrintf("%d rules.\n", _engine->getVocabulary()->getParserBranchesSize());
return true;
}
bool Console::cmdParse(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Parses a sequence of words with a GNF rule set and prints the resulting parse tree\n");
debugPrintf("Usage: %s <word1> <word2> ... <wordn>\n", argv[0]);
return true;
}
char *error;
Common::String string = argv[1];
// Construct the string
for (int i = 2; i < argc; i++) {
string += " ";
string += argv[i];
}
debugPrintf("Parsing '%s'\n", string.c_str());
ResultWordListList words;
bool res = _engine->getVocabulary()->tokenizeString(words, string.c_str(), &error);
if (res && !words.empty()) {
int syntax_fail = 0;
_engine->getVocabulary()->synonymizeTokens(words);
debugPrintf("Parsed to the following blocks:\n");
for (ResultWordListList::const_iterator i = words.begin(); i != words.end(); ++i) {
debugPrintf(" ");
for (ResultWordList::const_iterator j = i->begin(); j != i->end(); ++j) {
debugPrintf("%sType[%04x] Group[%04x]", j == i->begin() ? "" : " / ", j->_class, j->_group);
}
debugPrintf("\n");
}
if (_engine->getVocabulary()->parseGNF(words, true))
syntax_fail = 1; // Building a tree failed
if (syntax_fail)
debugPrintf("Building a tree failed.\n");
else
_engine->getVocabulary()->dumpParseTree();
} else {
debugPrintf("Unknown word: '%s'\n", error);
free(error);
}
return true;
}
bool Console::cmdSaid(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Matches a string against a said spec\n");
debugPrintf("Usage: %s <string> > & <said spec>\n", argv[0]);
debugPrintf("<string> is a sequence of actual words.\n");
debugPrintf("<said spec> is a sequence of hex tokens.\n");
return true;
}
char *error;
Common::String string = argv[1];
byte spec[1000];
int p;
// Construct the string
for (p = 2; p < argc && strcmp(argv[p],"&") != 0; p++) {
string += " ";
string += argv[p];
}
if (p >= argc-1) {
debugPrintf("Matches a string against a said spec\n");
debugPrintf("Usage: %s <string> > & <said spec>\n", argv[0]);
debugPrintf("<string> is a sequence of actual words.\n");
debugPrintf("<said spec> is a sequence of hex tokens.\n");
return true;
}
// TODO: Maybe turn this into a proper said spec compiler
uint32 len = 0;
for (p++; p < argc; p++) {
if (strcmp(argv[p], ",") == 0) {
spec[len++] = 0xf0;
} else if (strcmp(argv[p], "&") == 0) {
spec[len++] = 0xf1;
} else if (strcmp(argv[p], "/") == 0) {
spec[len++] = 0xf2;
} else if (strcmp(argv[p], "(") == 0) {
spec[len++] = 0xf3;
} else if (strcmp(argv[p], ")") == 0) {
spec[len++] = 0xf4;
} else if (strcmp(argv[p], "[") == 0) {
spec[len++] = 0xf5;
} else if (strcmp(argv[p], "]") == 0) {
spec[len++] = 0xf6;
} else if (strcmp(argv[p], "#") == 0) {
spec[len++] = 0xf7;
} else if (strcmp(argv[p], "<") == 0) {
spec[len++] = 0xf8;
} else if (strcmp(argv[p], ">") == 0) {
spec[len++] = 0xf9;
} else if (strcmp(argv[p], "[<") == 0) {
spec[len++] = 0xf5;
spec[len++] = 0xf8;
} else if (strcmp(argv[p], "[/") == 0) {
spec[len++] = 0xf5;
spec[len++] = 0xf2;
} else if (strcmp(argv[p], "!*") == 0) {
spec[len++] = 0x0f;
spec[len++] = 0xfe;
} else if (strcmp(argv[p], "[!*]") == 0) {
spec[len++] = 0xf5;
spec[len++] = 0x0f;
spec[len++] = 0xfe;
spec[len++] = 0xf6;
} else {
uint32 s = strtol(argv[p], 0, 16);
if (s >= 0xf0 && s <= 0xff) {
spec[len++] = s;
} else {
spec[len++] = s >> 8;
spec[len++] = s & 0xFF;
}
}
}
spec[len++] = 0xFF;
debugN("Matching '%s' against:", string.c_str());
_engine->getVocabulary()->debugDecipherSaidBlock(SciSpan<const byte>(spec, len));
debugN("\n");
ResultWordListList words;
bool res = _engine->getVocabulary()->tokenizeString(words, string.c_str(), &error);
if (res && !words.empty()) {
int syntax_fail = 0;
_engine->getVocabulary()->synonymizeTokens(words);
debugPrintf("Parsed to the following blocks:\n");
for (ResultWordListList::const_iterator i = words.begin(); i != words.end(); ++i) {
debugPrintf(" ");
for (ResultWordList::const_iterator j = i->begin(); j != i->end(); ++j) {
debugPrintf("%sType[%04x] Group[%04x]", j == i->begin() ? "" : " / ", j->_class, j->_group);
}
debugPrintf("\n");
}
if (_engine->getVocabulary()->parseGNF(words, true))
syntax_fail = 1; // Building a tree failed
if (syntax_fail)
debugPrintf("Building a tree failed.\n");
else {
_engine->getVocabulary()->dumpParseTree();
_engine->getVocabulary()->parserIsValid = true;
int ret = said((byte *)spec, true);
debugPrintf("kSaid: %s\n", (ret == SAID_NO_MATCH ? "No match" : "Match"));
}
} else {
debugPrintf("Unknown word: '%s'\n", error);
free(error);
}
return true;
}
bool Console::cmdParserNodes(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Shows the specified number of nodes from the parse node tree\n");
debugPrintf("Usage: %s <nr>\n", argv[0]);
debugPrintf("where <nr> is the number of nodes to show from the parse node tree\n");
return true;
}
int end = MIN<int>(atoi(argv[1]), VOCAB_TREE_NODES);
_engine->getVocabulary()->printParserNodes(end);
return true;
}
bool Console::cmdSetPalette(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Sets a palette resource (SCI16)\n");
debugPrintf("Usage: %s <resourceId>\n", argv[0]);
debugPrintf("where <resourceId> is the number of the palette resource to set\n");
return true;
}
uint16 resourceId = atoi(argv[1]);
#ifdef ENABLE_SCI32
if (getSciVersion() >= SCI_VERSION_2) {
debugPrintf("This SCI version does not support this command\n");
return true;
}
#endif
_engine->_gfxPalette16->kernelSetFromResource(resourceId, true);
return true;
}
bool Console::cmdDrawPic(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Draws a pic resource\n");
debugPrintf("Usage: %s <resourceId>\n", argv[0]);
debugPrintf("where <resourceId> is the number of the pic resource to draw\n");
return true;
}
#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
// If a graphical debugger overlay is used, hide it here, so that the
// results can be drawn.
g_system->hideOverlay();
#endif
uint16 resourceId = atoi(argv[1]);
_engine->_gfxPaint16->kernelDrawPicture(resourceId, 100, false, false, false, 0);
_engine->_gfxScreen->copyToScreen();
_engine->sleep(2000);
#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
// Show the graphical debugger overlay
g_system->showOverlay();
#endif
return true;
}
bool Console::cmdDrawCel(int argc, const char **argv) {
if (argc < 4) {
debugPrintf("Draws a cel from a view resource\n");
debugPrintf("Usage: %s <resourceId> <loopNr> <celNr> \n", argv[0]);
debugPrintf("where <resourceId> is the number of the view resource to draw\n");
return true;
}
uint16 resourceId = atoi(argv[1]);
uint16 loopNo = atoi(argv[2]);
uint16 celNo = atoi(argv[3]);
if (_engine->_gfxPaint16) {
_engine->_gfxPaint16->kernelDrawCel(resourceId, loopNo, celNo, 50, 50, 0, 0, 128, 128, false, NULL_REG);
} else {
GfxView *view = _engine->_gfxCache->getView(resourceId);
Common::Rect celRect(50, 50, 50 + view->getWidth(loopNo, celNo), 50 + view->getHeight(loopNo, celNo));
view->draw(celRect, celRect, celRect, loopNo, celNo, 255, 0, false);
_engine->_gfxScreen->copyRectToScreen(celRect);
}
return true;
}
bool Console::cmdUndither(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Enable/disable undithering.\n");
debugPrintf("Usage: %s <0/1>\n", argv[0]);
return true;
}
bool flag = atoi(argv[1]) ? true : false;
_engine->_gfxScreen->enableUndithering(flag);
if (flag)
debugPrintf("undithering ENABLED\n");
else
debugPrintf("undithering DISABLED\n");
return true;
}
bool Console::cmdPicVisualize(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Enable/disable picture visualization (EGA only)\n");
debugPrintf("Usage: %s <0/1>\n", argv[0]);
return true;
}
bool state = atoi(argv[1]) ? true : false;
if (_engine->_resMan->getViewType() == kViewEga) {
_engine->_gfxPaint16->debugSetEGAdrawingVisualize(state);
if (state)
debugPrintf("picture visualization ENABLED\n");
else
debugPrintf("picture visualization DISABLED\n");
} else {
debugPrintf("picture visualization only available for EGA games\n");
}
return true;
}
bool Console::cmdPlayVideo(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Plays a SEQ or AVI video.\n");
debugPrintf("Usage: %s <video file name> <delay>\n", argv[0]);
debugPrintf("The video file name should include the extension\n");
debugPrintf("Delay is only used in SEQ videos and is measured in ticks (default: 10)\n");
return true;
}
Common::String filename = argv[1];
filename.toLowercase();
if (filename.hasSuffix(".seq") || filename.hasSuffix(".avi")) {
_videoFile = filename;
_videoFrameDelay = (argc == 2) ? 10 : atoi(argv[2]);
return cmdExit(0, 0);
} else {
debugPrintf("Unknown video file type\n");
return true;
}
}
bool Console::cmdAnimateList(int argc, const char **argv) {
if (_engine->_gfxAnimate) {
debugPrintf("Animate list:\n");
_engine->_gfxAnimate->printAnimateList(this);
} else {
debugPrintf("This SCI version does not have an animate list\n");
}
return true;
}
bool Console::cmdWindowList(int argc, const char **argv) {
if (_engine->_gfxPorts) {
debugPrintf("Window list:\n");
_engine->_gfxPorts->printWindowList(this);
} else {
debugPrintf("This SCI version does not have a list of ports\n");
}
return true;
}
bool Console::cmdPlaneList(int argc, const char **argv) {
#ifdef ENABLE_SCI32
if (_engine->_gfxFrameout) {
debugPrintf("Plane list:\n");
_engine->_gfxFrameout->printPlaneList(this);
} else {
debugPrintf("This SCI version does not have a list of planes\n");
}
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdVisiblePlaneList(int argc, const char **argv) {
#ifdef ENABLE_SCI32
if (_engine->_gfxFrameout) {
debugPrintf("Visible plane list:\n");
_engine->_gfxFrameout->printVisiblePlaneList(this);
} else {
debugPrintf("This SCI version does not have a list of planes\n");
}
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdPlaneItemList(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Shows the list of items for a plane\n");
debugPrintf("Usage: %s <plane address>\n", argv[0]);
return true;
}
reg_t planeObject = NULL_REG;
if (parse_reg_t(_engine->_gamestate, argv[1], &planeObject)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
#ifdef ENABLE_SCI32
if (_engine->_gfxFrameout) {
debugPrintf("Plane item list:\n");
_engine->_gfxFrameout->printPlaneItemList(this, planeObject);
} else {
debugPrintf("This SCI version does not have a list of plane items\n");
}
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdVisiblePlaneItemList(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Shows the list of items for a plane\n");
debugPrintf("Usage: %s <plane address>\n", argv[0]);
return true;
}
reg_t planeObject = NULL_REG;
if (parse_reg_t(_engine->_gamestate, argv[1], &planeObject)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
#ifdef ENABLE_SCI32
if (_engine->_gfxFrameout) {
debugPrintf("Visible plane item list:\n");
_engine->_gfxFrameout->printVisiblePlaneItemList(this, planeObject);
} else {
debugPrintf("This SCI version does not have a list of plane items\n");
}
#else
debugPrintf("SCI32 isn't included in this compiled executable\n");
#endif
return true;
}
bool Console::cmdSavedBits(int argc, const char **argv) {
SegManager *segman = _engine->_gamestate->_segMan;
SegmentId id = segman->findSegmentByType(SEG_TYPE_HUNK);
HunkTable* hunks = (HunkTable *)segman->getSegmentObj(id);
if (!hunks) {
debugPrintf("No hunk segment found.\n");
return true;
}
Common::Array<reg_t> entries = hunks->listAllDeallocatable(id);
for (uint i = 0; i < entries.size(); ++i) {
uint32 offset = entries[i].getOffset();
const Hunk& h = hunks->at(offset);
if (strcmp(h.type, "SaveBits()") == 0) {
byte* memoryPtr = (byte *)h.mem;
if (memoryPtr) {
debugPrintf("%04x:%04x:", PRINT_REG(entries[i]));
Common::Rect rect;
byte mask;
assert(h.size >= sizeof(rect) + sizeof(mask));
memcpy((void *)&rect, memoryPtr, sizeof(rect));
memcpy((void *)&mask, memoryPtr + sizeof(rect), sizeof(mask));
debugPrintf(" %d,%d - %d,%d", rect.top, rect.left,
rect.bottom, rect.right);
if (mask & GFX_SCREEN_MASK_VISUAL)
debugPrintf(" visual");
if (mask & GFX_SCREEN_MASK_PRIORITY)
debugPrintf(" priority");
if (mask & GFX_SCREEN_MASK_CONTROL)
debugPrintf(" control");
if (mask & GFX_SCREEN_MASK_DISPLAY)
debugPrintf(" display");
debugPrintf("\n");
}
}
}
return true;
}
bool Console::cmdShowSavedBits(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Display saved bits.\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t memoryHandle = NULL_REG;
if (parse_reg_t(_engine->_gamestate, argv[1], &memoryHandle)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
if (memoryHandle.isNull()) {
debugPrintf("Invalid address.\n");
return true;
}
SegManager *segman = _engine->_gamestate->_segMan;
SegmentId id = segman->findSegmentByType(SEG_TYPE_HUNK);
HunkTable* hunks = (HunkTable *)segman->getSegmentObj(id);
if (!hunks) {
debugPrintf("No hunk segment found.\n");
return true;
}
if (memoryHandle.getSegment() != id || !hunks->isValidOffset(memoryHandle.getOffset())) {
debugPrintf("Invalid address.\n");
return true;
}
const Hunk& h = hunks->at(memoryHandle.getOffset());
if (strcmp(h.type, "SaveBits()") != 0) {
debugPrintf("Invalid address.\n");
return true;
}
byte *memoryPtr = segman->getHunkPointer(memoryHandle);
if (!memoryPtr) {
debugPrintf("Invalid or freed bits.\n");
return true;
}
// Now we _finally_ know these are valid saved bits
Common::Rect rect;
byte mask;
assert(h.size >= sizeof(rect) + sizeof(mask));
memcpy((void *)&rect, memoryPtr, sizeof(rect));
memcpy((void *)&mask, memoryPtr + sizeof(rect), sizeof(mask));
Common::Point tl(rect.left, rect.top);
Common::Point tr(rect.right-1, rect.top);
Common::Point bl(rect.left, rect.bottom-1);
Common::Point br(rect.right-1, rect.bottom-1);
debugPrintf(" %d,%d - %d,%d", rect.top, rect.left,
rect.bottom, rect.right);
if (mask & GFX_SCREEN_MASK_VISUAL)
debugPrintf(" visual");
if (mask & GFX_SCREEN_MASK_PRIORITY)
debugPrintf(" priority");
if (mask & GFX_SCREEN_MASK_CONTROL)
debugPrintf(" control");
if (mask & GFX_SCREEN_MASK_DISPLAY)
debugPrintf(" display");
debugPrintf("\n");
if (!_engine->_gfxPaint16 || !_engine->_gfxScreen)
return true;
// We backup all planes, and then flash the saved bits
// FIXME: This probably won't work well with hi-res games
byte bakMask = GFX_SCREEN_MASK_VISUAL | GFX_SCREEN_MASK_PRIORITY | GFX_SCREEN_MASK_CONTROL;
int bakSize = _engine->_gfxScreen->bitsGetDataSize(rect, bakMask);
reg_t bakScreen = segman->allocateHunkEntry("show_saved_bits backup", bakSize);
byte* bakMemory = segman->getHunkPointer(bakScreen);
assert(bakMemory);
_engine->_gfxScreen->bitsSave(rect, bakMask, bakMemory);
#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
// If a graphical debugger overlay is used, hide it here, so that the
// results can be drawn.
g_system->hideOverlay();
#endif
const int paintCount = 3;
for (int i = 0; i < paintCount; ++i) {
_engine->_gfxScreen->bitsRestore(memoryPtr);
_engine->_gfxScreen->drawLine(tl, tr, 0, 255, 255);
_engine->_gfxScreen->drawLine(tr, br, 0, 255, 255);
_engine->_gfxScreen->drawLine(br, bl, 0, 255, 255);
_engine->_gfxScreen->drawLine(bl, tl, 0, 255, 255);
_engine->_gfxScreen->copyRectToScreen(rect);
g_system->updateScreen();
g_sci->sleep(500);
_engine->_gfxScreen->bitsRestore(bakMemory);
_engine->_gfxScreen->copyRectToScreen(rect);
g_system->updateScreen();
if (i < paintCount - 1)
g_sci->sleep(500);
}
_engine->_gfxPaint16->bitsFree(bakScreen);
#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
// Show the graphical debugger overlay
g_system->showOverlay();
#endif
return true;
}
bool Console::cmdParseGrammar(int argc, const char **argv) {
debugPrintf("Parse grammar, in strict GNF:\n");
_engine->getVocabulary()->buildGNF(true);
return true;
}
bool Console::cmdPrintSegmentTable(int argc, const char **argv) {
debugPrintf("Segment table:\n");
for (uint i = 0; i < _engine->_gamestate->_segMan->_heap.size(); i++) {
SegmentObj *mobj = _engine->_gamestate->_segMan->_heap[i];
if (mobj && mobj->getType()) {
debugPrintf(" [%04x] ", i);
switch (mobj->getType()) {
case SEG_TYPE_SCRIPT:
debugPrintf("S script.%03d l:%d ", (*(Script *)mobj).getScriptNumber(), (*(Script *)mobj).getLockers());
break;
case SEG_TYPE_CLONES:
debugPrintf("C clones (%d allocd)", (*(CloneTable *)mobj).entries_used);
break;
case SEG_TYPE_LOCALS:
debugPrintf("V locals %03d", (*(LocalVariables *)mobj).script_id);
break;
case SEG_TYPE_STACK:
debugPrintf("D data stack (%d)", (*(DataStack *)mobj)._capacity);
break;
case SEG_TYPE_LISTS:
debugPrintf("L lists (%d)", (*(ListTable *)mobj).entries_used);
break;
case SEG_TYPE_NODES:
debugPrintf("N nodes (%d)", (*(NodeTable *)mobj).entries_used);
break;
case SEG_TYPE_HUNK:
debugPrintf("H hunk (%d)", (*(HunkTable *)mobj).entries_used);
break;
case SEG_TYPE_DYNMEM:
debugPrintf("M dynmem: %d bytes", (*(DynMem *)mobj)._size);
break;
#ifdef ENABLE_SCI32
case SEG_TYPE_ARRAY:
debugPrintf("A SCI32 arrays (%d)", (*(ArrayTable *)mobj).entries_used);
break;
case SEG_TYPE_BITMAP:
debugPrintf("T SCI32 bitmaps (%d)", (*(BitmapTable *)mobj).entries_used);
break;
#endif
default:
debugPrintf("I Invalid (type = %x)", mobj->getType());
break;
}
debugPrintf(" \n");
}
}
debugPrintf("\n");
return true;
}
bool Console::segmentInfo(int nr) {
debugPrintf("[%04x] ", nr);
if ((nr < 0) || ((uint)nr >= _engine->_gamestate->_segMan->_heap.size()) || !_engine->_gamestate->_segMan->_heap[nr])
return false;
SegmentObj *mobj = _engine->_gamestate->_segMan->_heap[nr];
switch (mobj->getType()) {
case SEG_TYPE_SCRIPT: {
Script *scr = (Script *)mobj;
debugPrintf("script.%03d locked by %d, bufsize=%d (%x)\n", scr->getScriptNumber(), scr->getLockers(), (uint)scr->getBufSize(), (uint)scr->getBufSize());
if (scr->getExportsNr()) {
const uint location = scr->getExportsOffset();
debugPrintf(" Exports: %4d at %d\n", scr->getExportsNr(), location);
} else
debugPrintf(" Exports: none\n");
debugPrintf(" Synonyms: %4d\n", scr->getSynonymsNr());
if (scr->getLocalsCount() > 0)
debugPrintf(" Locals : %4d in segment 0x%x\n", scr->getLocalsCount(), scr->getLocalsSegment());
else
debugPrintf(" Locals : none\n");
const ObjMap &objects = scr->getObjectMap();
debugPrintf(" Objects: %4d\n", objects.size());
ObjMap::const_iterator it;
const ObjMap::const_iterator end = objects.end();
for (it = objects.begin(); it != end; ++it) {
debugPrintf(" ");
// Object header
const Object *obj = _engine->_gamestate->_segMan->getObject(it->_value.getPos());
if (obj)
debugPrintf("[%04x:%04x] %s : %3d vars, %3d methods\n", PRINT_REG(it->_value.getPos()),
_engine->_gamestate->_segMan->getObjectName(it->_value.getPos()),
obj->getVarCount(), obj->getMethodCount());
}
}
break;
case SEG_TYPE_LOCALS: {
LocalVariables *locals = (LocalVariables *)mobj;
debugPrintf("locals for script.%03d\n", locals->script_id);
debugPrintf(" %d (0x%x) locals\n", locals->_locals.size(), locals->_locals.size());
}
break;
case SEG_TYPE_STACK: {
DataStack *stack = (DataStack *)mobj;
debugPrintf("stack\n");
debugPrintf(" %d (0x%x) entries\n", stack->_capacity, stack->_capacity);
}
break;
case SEG_TYPE_CLONES: {
CloneTable &ct = *(CloneTable *)mobj;
debugPrintf("clones\n");
for (uint i = 0; i < ct.size(); i++)
if (ct.isValidEntry(i)) {
reg_t objpos = make_reg(nr, i);
debugPrintf(" [%04x] %s; copy of ", i, _engine->_gamestate->_segMan->getObjectName(objpos));
// Object header
const Object *obj = _engine->_gamestate->_segMan->getObject(ct[i].getPos());
if (obj)
debugPrintf("[%04x:%04x] %s : %3d vars, %3d methods\n", PRINT_REG(ct[i].getPos()),
_engine->_gamestate->_segMan->getObjectName(ct[i].getPos()),
obj->getVarCount(), obj->getMethodCount());
}
}
break;
case SEG_TYPE_LISTS: {
ListTable < = *(ListTable *)mobj;
debugPrintf("lists\n");
for (uint i = 0; i < lt.size(); i++)
if (lt.isValidEntry(i)) {
debugPrintf(" [%04x]: ", i);
printList(lt[i]);
}
}
break;
case SEG_TYPE_NODES: {
debugPrintf("nodes (total %d)\n", (*(NodeTable *)mobj).entries_used);
break;
}
case SEG_TYPE_HUNK: {
HunkTable &ht = *(HunkTable *)mobj;
debugPrintf("hunk (total %d)\n", ht.entries_used);
for (uint i = 0; i < ht.size(); i++)
if (ht.isValidEntry(i)) {
debugPrintf(" [%04x] %d bytes at %p, type=%s\n",
i, ht[i].size, ht[i].mem, ht[i].type);
}
}
break;
case SEG_TYPE_DYNMEM: {
debugPrintf("dynmem (%s): %d bytes\n",
(*(DynMem *)mobj)._description.c_str(), (*(DynMem *)mobj)._size);
Common::hexdump((*(DynMem *)mobj)._buf, (*(DynMem *)mobj)._size, 16, 0);
}
break;
#ifdef ENABLE_SCI32
case SEG_TYPE_ARRAY: {
ArrayTable &table = *(ArrayTable *)mobj;
debugPrintf("SCI32 arrays\n");
for (uint i = 0; i < table.size(); ++i) {
if (table.isValidEntry(i)) {
debugPrintf(" [%04x] %s\n", i, table[i].toDebugString().c_str());
}
}
break;
}
case SEG_TYPE_BITMAP: {
BitmapTable &table = *(BitmapTable *)mobj;
debugPrintf("SCI32 bitmaps (total %d)\n", table.entries_used);
for (uint i = 0; i < table.size(); ++i) {
if (table.isValidEntry(i)) {
debugPrintf(" [%04x] %s\n", i, table[i].toString().c_str());
}
}
break;
}
#endif
default :
debugPrintf("Invalid type %d\n", mobj->getType());
break;
}
debugPrintf("\n");
return true;
}
bool Console::cmdSegmentInfo(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Provides information on the specified segment(s)\n");
debugPrintf("Usage: %s <segment number>\n", argv[0]);
debugPrintf("<segment number> can be a number, which shows the information of the segment with\n");
debugPrintf("the specified number, or \"all\" to show information on all active segments\n");
return true;
}
if (!scumm_stricmp(argv[1], "all")) {
for (uint i = 0; i < _engine->_gamestate->_segMan->_heap.size(); i++)
segmentInfo(i);
} else {
int segmentNr;
if (!parseInteger(argv[1], segmentNr))
return true;
if (!segmentInfo(segmentNr))
debugPrintf("Segment %04xh does not exist\n", segmentNr);
}
return true;
}
bool Console::cmdKillSegment(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Deletes the specified segment\n");
debugPrintf("Usage: %s <segment number>\n", argv[0]);
return true;
}
int segmentNumber;
if (!parseInteger(argv[1], segmentNumber))
return true;
_engine->_gamestate->_segMan->getScript(segmentNumber)->setLockers(0);
return true;
}
bool Console::cmdShowMap(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Switches to one of the following screen maps\n");
debugPrintf("Usage: %s <screen map>\n", argv[0]);
debugPrintf("Screen maps:\n");
debugPrintf("- 0: visual map\n");
debugPrintf("- 1: priority map\n");
debugPrintf("- 2: control map\n");
debugPrintf("- 3: display screen\n");
return true;
}
#ifdef ENABLE_SCI32
if (getSciVersion() >= SCI_VERSION_2) {
debugPrintf("Command not available / implemented for SCI32 games.\n");
return true;
}
#endif
int map = atoi(argv[1]);
switch (map) {
case 0:
case 1:
case 2:
case 3:
if (_engine->_gfxScreen) {
_engine->_gfxScreen->debugShowMap(map);
}
break;
default:
debugPrintf("Map %d is not available.\n", map);
return true;
}
return cmdExit(0, 0);
}
bool Console::cmdSongLib(int argc, const char **argv) {
debugPrintf("Song library:\n");
g_sci->_soundCmd->printPlayList(this);
return true;
}
bool Console::cmdSongInfo(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Shows information about a given song in the playlist\n");
debugPrintf("Usage: %s <song object>\n", argv[0]);
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
g_sci->_soundCmd->printSongInfo(addr, this);
return true;
}
bool Console::cmdStartSound(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Adds the requested sound resource to the playlist, and starts playing it\n");
debugPrintf("Usage: %s <sound resource id>\n", argv[0]);
return true;
}
int16 number = atoi(argv[1]);
if (!_engine->getResMan()->testResource(ResourceId(kResourceTypeSound, number))) {
debugPrintf("Unable to load this sound resource, most probably it has an equivalent audio resource (SCI1.1)\n");
return true;
}
// TODO: Maybe also add a playBed option.
g_sci->_soundCmd->startNewSound(number);
return cmdExit(0, 0);
}
bool Console::cmdToggleSound(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Plays or stops the specified sound in the playlist\n");
debugPrintf("Usage: %s <address> <state>\n", argv[0]);
debugPrintf("Where:\n");
debugPrintf("- <address> is the address of the sound to play or stop.\n");
debugPrintf("- <state> is the new state (play or stop).\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t id;
if (parse_reg_t(_engine->_gamestate, argv[1], &id)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
Common::String newState = argv[2];
newState.toLowercase();
if (newState == "play") {
// Maybe also have a 'playbed' option. (Second argument to processPlaySound.)
g_sci->_soundCmd->processPlaySound(id, false);
} else if (newState == "stop")
g_sci->_soundCmd->processStopSound(id, false);
else
debugPrintf("New state can either be 'play' or 'stop'");
return true;
}
bool Console::cmdStopAllSounds(int argc, const char **argv) {
g_sci->_soundCmd->stopAllSounds();
debugPrintf("All sounds have been stopped\n");
return true;
}
bool Console::cmdIsSample(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Tests whether a given sound resource is a PCM sample, \n");
debugPrintf("and displays information on it if it is.\n");
debugPrintf("Usage: %s <sample id>\n", argv[0]);
return true;
}
int16 number = atoi(argv[1]);
if (!_engine->getResMan()->testResource(ResourceId(kResourceTypeSound, number))) {
debugPrintf("Unable to load this sound resource, most probably it has an equivalent audio resource (SCI1.1)\n");
return true;
}
SoundResource soundRes(number, _engine->getResMan(), _engine->_features->detectDoSoundType());
if (!soundRes.exists()) {
debugPrintf("Not a sound resource!\n");
return true;
}
SoundResource::Track *track = soundRes.getDigitalTrack();
if (!track || track->digitalChannelNr == -1) {
debugPrintf("Valid song, but not a sample.\n");
return true;
}
debugPrintf("Sample size: %d, sample rate: %d, channels: %d, digital channel number: %d\n",
track->digitalSampleSize, track->digitalSampleRate, track->channelCount, track->digitalChannelNr);
return true;
}
bool Console::cmdGCInvoke(int argc, const char **argv) {
debugPrintf("Performing garbage collection...\n");
run_gc(_engine->_gamestate);
return true;
}
bool Console::cmdGCObjects(int argc, const char **argv) {
AddrSet *use_map = findAllActiveReferences(_engine->_gamestate);
debugPrintf("Reachable object references (normalised):\n");
for (AddrSet::iterator i = use_map->begin(); i != use_map->end(); ++i) {
debugPrintf(" - %04x:%04x\n", PRINT_REG(i->_key));
}
delete use_map;
return true;
}
bool Console::cmdGCShowReachable(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Prints all addresses directly reachable from the memory object specified as parameter.\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegmentObj(addr.getSegment());
if (!mobj) {
debugPrintf("Unknown segment : %x\n", addr.getSegment());
return 1;
}
debugPrintf("Reachable from %04x:%04x:\n", PRINT_REG(addr));
const Common::Array<reg_t> tmp = mobj->listAllOutgoingReferences(addr);
for (Common::Array<reg_t>::const_iterator it = tmp.begin(); it != tmp.end(); ++it)
if (it->getSegment())
g_sci->getSciDebugger()->debugPrintf(" %04x:%04x\n", PRINT_REG(*it));
return true;
}
bool Console::cmdGCShowFreeable(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Prints all addresses freeable in the segment associated with the\n");
debugPrintf("given address (offset is ignored).\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegmentObj(addr.getSegment());
if (!mobj) {
debugPrintf("Unknown segment : %x\n", addr.getSegment());
return true;
}
debugPrintf("Freeable in segment %04x:\n", addr.getSegment());
const Common::Array<reg_t> tmp = mobj->listAllDeallocatable(addr.getSegment());
for (Common::Array<reg_t>::const_iterator it = tmp.begin(); it != tmp.end(); ++it)
if (it->getSegment())
g_sci->getSciDebugger()->debugPrintf(" %04x:%04x\n", PRINT_REG(*it));
return true;
}
bool Console::cmdGCNormalize(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Prints the \"normal\" address of a given address,\n");
debugPrintf("i.e. the address we would free in order to free\n");
debugPrintf("the object associated with the original address.\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegmentObj(addr.getSegment());
if (!mobj) {
debugPrintf("Unknown segment : %x\n", addr.getSegment());
return true;
}
addr = mobj->findCanonicAddress(_engine->_gamestate->_segMan, addr);
debugPrintf(" %04x:%04x\n", PRINT_REG(addr));
return true;
}
bool Console::cmdVMVarlist(int argc, const char **argv) {
EngineState *s = _engine->_gamestate;
const char *varnames[] = {"global", "local", "temp", "param"};
debugPrintf("Addresses of variables in the VM:\n");
for (int i = 0; i < 4; i++) {
debugPrintf("%s vars at %04x:%04x ", varnames[i], PRINT_REG(make_reg(s->variablesSegment[i], s->variables[i] - s->variablesBase[i])));
debugPrintf(" total %d", s->variablesMax[i]);
debugPrintf("\n");
}
return true;
}
bool Console::cmdVMVars(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Displays or changes variables in the VM\n");
debugPrintf("Usage: %s <type> <varnum> [<value>]\n", argv[0]);
debugPrintf("First parameter is either g(lobal), l(ocal), t(emp), p(aram) or a(cc).\n");
debugPrintf("Second parameter is the var number (not specified on acc)\n");
debugPrintf("Third parameter (if specified) is the value to set the variable to, in address form\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
EngineState *s = _engine->_gamestate;
const char *varNames[] = {"global", "local", "temp", "param", "acc"};
const char *varAbbrev = "gltpa";
const char *varType_pre = strchr(varAbbrev, *argv[1]);
int varType;
int varIndex = 0;
reg_t *curValue = NULL;
const char *setValue = NULL;
if (!varType_pre) {
debugPrintf("Invalid variable type '%c'\n", *argv[1]);
return true;
}
varType = varType_pre - varAbbrev;
switch (varType) {
case 0:
case 1:
case 2:
case 3: {
if (argc < 3) {
for (int i = 0; i < s->variablesMax[varType]; ++i) {
curValue = &s->variables[varType][i];
debugPrintf("%s var %d == %04x:%04x", varNames[varType], i, PRINT_REG(*curValue));
printBasicVarInfo(*curValue);
debugPrintf("\n");
}
return true;
}
if (argc > 4) {
debugPrintf("Too many arguments\n");
return true;
}
if (!parseInteger(argv[2], varIndex))
return true;
if (varIndex < 0) {
debugPrintf("Variable number may not be negative\n");
return true;
}
if (s->variablesMax[varType] <= varIndex) {
debugPrintf("Maximum variable number for this type is %d (0x%x)\n", s->variablesMax[varType], s->variablesMax[varType]);
return true;
}
curValue = &s->variables[varType][varIndex];
if (argc == 4)
setValue = argv[3];
break;
}
case 4:
// acc
if (argc > 3) {
debugPrintf("Too many arguments\n");
return true;
}
curValue = &s->r_acc;
if (argc == 3)
setValue = argv[2];
break;
default:
break;
}
if (!setValue) {
if (varType == 4)
debugPrintf("%s == %04x:%04x", varNames[varType], PRINT_REG(*curValue));
else
debugPrintf("%s var %d == %04x:%04x", varNames[varType], varIndex, PRINT_REG(*curValue));
printBasicVarInfo(*curValue);
debugPrintf("\n");
} else {
if (parse_reg_t(s, setValue, curValue)) {
debugPrintf("Invalid value/address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
debugPrintf("Or pass a decimal or hexadecimal value directly (e.g. 12, 1Ah)\n");
return true;
}
}
return true;
}
bool Console::cmdStack(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Lists the specified number of stack elements.\n");
debugPrintf("Usage: %s <elements>\n", argv[0]);
return true;
}
if (_engine->_gamestate->_executionStack.empty()) {
debugPrintf("No exec stack!");
return true;
}
const ExecStack &xs = _engine->_gamestate->_executionStack.back();
int nr = atoi(argv[1]);
for (int i = nr; i > 0; i--) {
if ((xs.sp - xs.fp - i) == 0)
debugPrintf("-- temp variables --\n");
if (xs.sp - i >= _engine->_gamestate->stack_base)
debugPrintf("ST:%04x = %04x:%04x\n", (unsigned)(xs.sp - i - _engine->_gamestate->stack_base), PRINT_REG(xs.sp[-i]));
}
return true;
}
bool Console::cmdValueType(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Determines the type of a value.\n");
debugPrintf("The type can be one of the following:\n");
debugPrintf("Invalid, list, object, reference or arithmetic\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t val;
if (parse_reg_t(_engine->_gamestate, argv[1], &val)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
int t = g_sci->getKernel()->findRegType(val);
switch (t) {
case SIG_TYPE_LIST:
debugPrintf("List");
break;
case SIG_TYPE_OBJECT:
debugPrintf("Object");
break;
case SIG_TYPE_REFERENCE:
debugPrintf("Reference");
break;
case SIG_TYPE_INTEGER:
debugPrintf("Integer");
break;
case SIG_TYPE_INTEGER | SIG_TYPE_NULL:
debugPrintf("Null");
break;
default:
debugPrintf("Erroneous unknown type 0x%02x (%d decimal)\n", t, t);
}
return true;
}
bool Console::cmdViewListNode(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Examines the list node at the given address.\n");
debugPrintf("Usage: %s <address>\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
printNode(addr);
return true;
}
bool Console::cmdViewReference(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Examines an arbitrary reference.\n");
debugPrintf("Usage: %s <start address> [<end address>]\n", argv[0]);
debugPrintf("Where <start address> is the starting address to examine\n");
debugPrintf("<end address>, if provided, is the address where examining ends at\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t reg = NULL_REG;
reg_t reg_end = NULL_REG;
if (parse_reg_t(_engine->_gamestate, argv[1], ®)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
if (argc > 2) {
if (parse_reg_t(_engine->_gamestate, argv[2], ®_end)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
}
printReference(reg, reg_end);
return true;
}
bool Console::cmdDumpReference(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Dumps an arbitrary reference to disk.\n");
debugPrintf("Usage: %s <start address> [<end address>]\n", argv[0]);
debugPrintf("Where <start address> is the starting address to dump\n");
debugPrintf("<end address>, if provided, is the address where the dump ends\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t reg = NULL_REG;
reg_t reg_end = NULL_REG;
if (parse_reg_t(_engine->_gamestate, argv[1], ®)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
if (argc > 2) {
if (parse_reg_t(_engine->_gamestate, argv[2], ®_end)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
}
if (reg.getSegment() == 0 && reg.getOffset() == 0) {
debugPrintf("Register is null.\n");
return true;
}
if (g_sci->getKernel()->findRegType(reg) != SIG_TYPE_REFERENCE) {
debugPrintf("%04x:%04x is not a reference\n", PRINT_REG(reg));
return true;
}
if (reg_end.getSegment() != reg.getSegment() && reg_end != NULL_REG) {
debugPrintf("Ending segment different from starting segment. Assuming no bound on dump.\n");
reg_end = NULL_REG;
}
Common::DumpFile out;
Common::String outFileName;
uint32 bytesWritten;
switch (_engine->_gamestate->_segMan->getSegmentType(reg.getSegment())) {
#ifdef ENABLE_SCI32
case SEG_TYPE_BITMAP: {
outFileName = Common::String::format("%04x_%04x.tga", PRINT_REG(reg));
out.open(outFileName);
SciBitmap &bitmap = *_engine->_gamestate->_segMan->lookupBitmap(reg);
const Color *color = g_sci->_gfxPalette32->getCurrentPalette().colors;
const uint16 numColors = ARRAYSIZE(g_sci->_gfxPalette32->getCurrentPalette().colors);
out.writeByte(0); // image id length
out.writeByte(1); // color map type (present)
out.writeByte(1); // image type (uncompressed color-mapped)
out.writeSint16LE(0); // index of first color map entry
out.writeSint16LE(numColors); // number of color map entries
out.writeByte(24); // number of bits per color entry (RGB24)
out.writeSint16LE(0); // bottom-left x-origin
out.writeSint16LE(bitmap.getHeight() - 1); // bottom-left y-origin
out.writeSint16LE(bitmap.getWidth()); // width
out.writeSint16LE(bitmap.getHeight()); // height
out.writeByte(8); // bits per pixel
out.writeByte(1 << 5); // origin of pixel data (top-left)
bytesWritten = 18;
for (int i = 0; i < numColors; ++i) {
out.writeByte(color->b);
out.writeByte(color->g);
out.writeByte(color->r);
++color;
}
bytesWritten += numColors * 3;
bytesWritten += out.write(bitmap.getPixels(), bitmap.getWidth() * bitmap.getHeight());
break;
}
#endif
default: {
const SegmentRef block = _engine->_gamestate->_segMan->dereference(reg);
uint32 size = block.maxSize;
if (size == 0) {
debugPrintf("Size of reference is zero.\n");
return true;
}
if (reg_end.getSegment() != 0 && (size < reg_end.getOffset() - reg.getOffset())) {
debugPrintf("Block end out of bounds (size %d). Resetting.\n", size);
reg_end = NULL_REG;
}
if (reg_end.getSegment() != 0 && (size >= reg_end.getOffset() - reg.getOffset())) {
size = reg_end.getOffset() - reg.getOffset();
}
if (reg_end.getSegment() != 0) {
debugPrintf("Block size less than or equal to %d\n", size);
}
outFileName = Common::String::format("%04x_%04x.dmp", PRINT_REG(reg));
out.open(outFileName);
bytesWritten = out.write(block.raw, size);
break;
}
}
out.finalize();
out.close();
debugPrintf("Wrote %u bytes to %s\n", bytesWritten, outFileName.c_str());
return true;
}
bool Console::cmdViewObject(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Examines the object at the given address.\n");
debugPrintf("Usage: %s <address> [<selector name> ...]\n", argv[0]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
if (argc >= 3) {
for (int i = 2; i < argc; ++i) {
const Object *obj = _engine->_gamestate->_segMan->getObject(addr);
if (!obj) {
debugPrintf("%04x:%04x is not an object.\n", PRINT_REG(addr));
break;
}
const Selector selector = _engine->getKernel()->findSelector(argv[i]);
if (selector == -1) {
debugPrintf("Invalid selector '%s'.\n", argv[i]);
break;
}
const int index = obj->locateVarSelector(_engine->_gamestate->_segMan, selector);
if (index == -1) {
debugPrintf("Selector '%s' is not valid for object %04x:%04x.\n", argv[i], PRINT_REG(addr));
break;
}
const reg_t value = obj->getVariable(index);
if (i == argc - 1) {
if (value.isPointer()) {
printReference(value);
} else {
debugPrintf("%04x:%04x (%u)\n", PRINT_REG(value), value.toUint16());
}
} else if (!value.isPointer()) {
debugPrintf("Selector '%s' on object %04x:%04x is not a pointer to an object.\n", argv[i], PRINT_REG(addr));
debugPrintf("Value is %04x:%04x (%u).\n", PRINT_REG(value), value.toUint16());
break;
} else {
addr = value;
}
}
} else {
debugPrintf("Information on the object at the given address:\n");
printObject(addr);
}
return true;
}
bool Console::cmdViewActiveObject(int argc, const char **argv) {
debugPrintf("Information on the currently active object or class:\n");
printObject(_engine->_gamestate->xs->objp);
return true;
}
bool Console::cmdViewAccumulatorObject(int argc, const char **argv) {
debugPrintf("Information on the currently active object or class at the address indexed by the accumulator:\n");
printObject(_engine->_gamestate->r_acc);
return true;
}
bool Console::cmdScriptSteps(int argc, const char **argv) {
debugPrintf("Number of executed SCI operations: %d\n", _engine->_gamestate->scriptStepCounter);
return true;
}
bool Console::cmdScriptObjects(int argc, const char **argv) {
int curScriptNr = -1;
if (argc < 2) {
debugPrintf("Shows all objects inside a specified script.\n");
debugPrintf("Usage: %s <script number>\n", argv[0]);
debugPrintf("Example: %s 999\n", argv[0]);
debugPrintf("<script number> may be * to show objects inside all loaded scripts\n");
return true;
}
if (strcmp(argv[1], "*") == 0) {
// get said-strings of all currently loaded scripts
curScriptNr = -1;
} else {
curScriptNr = atoi(argv[1]);
}
printOffsets(curScriptNr, SCI_SCR_OFFSET_TYPE_OBJECT);
return true;
}
bool Console::cmdScriptStrings(int argc, const char **argv) {
int curScriptNr = -1;
if (argc < 2) {
debugPrintf("Shows all strings inside a specified script.\n");
debugPrintf("Usage: %s <script number>\n", argv[0]);
debugPrintf("Example: %s 999\n", argv[0]);
debugPrintf("<script number> may be * to show strings inside all loaded scripts\n");
return true;
}
if (strcmp(argv[1], "*") == 0) {
// get strings of all currently loaded scripts
curScriptNr = -1;
} else {
curScriptNr = atoi(argv[1]);
}
printOffsets(curScriptNr, SCI_SCR_OFFSET_TYPE_STRING);
return true;
}
bool Console::cmdScriptSaid(int argc, const char **argv) {
int curScriptNr = -1;
if (argc < 2) {
debugPrintf("Shows all said-strings inside a specified script.\n");
debugPrintf("Usage: %s <script number>\n", argv[0]);
debugPrintf("Example: %s 999\n", argv[0]);
debugPrintf("<script number> may be * to show said-strings inside all loaded scripts\n");
return true;
}
if (strcmp(argv[1], "*") == 0) {
// get said-strings of all currently loaded scripts
curScriptNr = -1;
} else {
curScriptNr = atoi(argv[1]);
}
printOffsets(curScriptNr, SCI_SCR_OFFSET_TYPE_SAID);
return true;
}
void Console::printOffsets(int scriptNr, uint16 showType) {
SegManager *segMan = _engine->_gamestate->_segMan;
Vocabulary *vocab = _engine->_vocabulary;
SegmentId curSegmentNr;
Common::List<SegmentId> segmentNrList;
SegmentType curSegmentType = SEG_TYPE_INVALID;
SegmentObj *curSegmentObj = NULL;
Script *curScriptObj = NULL;
const byte *curScriptData = NULL;
segmentNrList.clear();
if (scriptNr < 0) {
// get offsets of all currently loaded scripts
for (curSegmentNr = 0; curSegmentNr < segMan->_heap.size(); curSegmentNr++) {
curSegmentObj = segMan->_heap[curSegmentNr];
if (curSegmentObj && curSegmentObj->getType() == SEG_TYPE_SCRIPT) {
segmentNrList.push_back(curSegmentNr);
}
}
} else {
curSegmentNr = segMan->getScriptSegment(scriptNr);
if (!curSegmentNr) {
debugPrintf("Script %d is currently not loaded/available\n", scriptNr);
return;
}
segmentNrList.push_back(curSegmentNr);
}
const offsetLookupArrayType *scriptOffsetLookupArray;
offsetLookupArrayType::const_iterator arrayIterator;
int showTypeCount = 0;
reg_t objectPos;
const char *objectNamePtr = NULL;
const byte *stringPtr = NULL;
const byte *saidPtr = NULL;
Common::List<SegmentId>::iterator it;
const Common::List<SegmentId>::iterator end = segmentNrList.end();
for (it = segmentNrList.begin(); it != end; it++) {
curSegmentNr = *it;
// get object of this segment
curSegmentObj = segMan->getSegmentObj(curSegmentNr);
if (!curSegmentObj)
continue;
curSegmentType = curSegmentObj->getType();
if (curSegmentType != SEG_TYPE_SCRIPT) // safety check
continue;
curScriptObj = (Script *)curSegmentObj;
debugPrintf("=== SCRIPT %d inside Segment %d ===\n", curScriptObj->getScriptNumber(), curSegmentNr);
debugN("=== SCRIPT %d inside Segment %d ===\n", curScriptObj->getScriptNumber(), curSegmentNr);
// now print the list
scriptOffsetLookupArray = curScriptObj->getOffsetArray();
curScriptData = curScriptObj->getBuf();
showTypeCount = 0;
for (arrayIterator = scriptOffsetLookupArray->begin(); arrayIterator != scriptOffsetLookupArray->end(); arrayIterator++) {
if (arrayIterator->type == showType) {
switch (showType) {
case SCI_SCR_OFFSET_TYPE_OBJECT:
objectPos = make_reg(curSegmentNr, arrayIterator->offset);
objectNamePtr = segMan->getObjectName(objectPos);
debugPrintf(" %03d:%04x: %s\n", arrayIterator->id, arrayIterator->offset, objectNamePtr);
debugN(" %03d:%04x: %s\n", arrayIterator->id, arrayIterator->offset, objectNamePtr);
break;
case SCI_SCR_OFFSET_TYPE_STRING:
stringPtr = curScriptData + arrayIterator->offset;
debugPrintf(" %03d:%04x: '%s' (size %d)\n", arrayIterator->id, arrayIterator->offset, stringPtr, arrayIterator->stringSize);
debugN(" %03d:%04x: '%s' (size %d)\n", arrayIterator->id, arrayIterator->offset, stringPtr, arrayIterator->stringSize);
break;
case SCI_SCR_OFFSET_TYPE_SAID:
saidPtr = curScriptData + arrayIterator->offset;
debugPrintf(" %03d:%04x:\n", arrayIterator->id, arrayIterator->offset);
debugN(" %03d:%04x: ", arrayIterator->id, arrayIterator->offset);
vocab->debugDecipherSaidBlock(SciSpan<const byte>(saidPtr, (arrayIterator + 1)->offset - arrayIterator->offset));
debugN("\n");
break;
default:
break;
}
showTypeCount++;
}
}
if (showTypeCount == 0) {
switch (showType) {
case SCI_SCR_OFFSET_TYPE_OBJECT:
debugPrintf(" no objects\n");
debugN(" no objects\n");
break;
case SCI_SCR_OFFSET_TYPE_STRING:
debugPrintf(" no strings\n");
debugN(" no strings\n");
break;
case SCI_SCR_OFFSET_TYPE_SAID:
debugPrintf(" no said-strings\n");
debugN(" no said-strings\n");
break;
default:
break;
}
}
debugPrintf("\n");
debugN("\n");
}
}
bool Console::cmdBacktrace(int argc, const char **argv) {
logBacktrace();
return true;
}
bool Console::cmdTrace(int argc, const char **argv) {
if (argc == 2 && atoi(argv[1]) > 0)
_debugState.runningStep = atoi(argv[1]) - 1;
_debugState.debugging = true;
return cmdExit(0, 0);
}
bool Console::cmdStepOver(int argc, const char **argv) {
_debugState.seeking = kDebugSeekStepOver;
_debugState.seekLevel = _engine->_gamestate->_executionStack.size();
return cmdTrace(argc, argv);
}
bool Console::cmdStepEvent(int argc, const char **argv) {
_debugState.stopOnEvent = true;
_debugState.debugging = true;
return cmdExit(0, 0);
}
bool Console::cmdStepRet(int argc, const char **argv) {
_debugState.seeking = kDebugSeekLevelRet;
_debugState.seekLevel = _engine->_gamestate->_executionStack.size() - 1;
_debugState.debugging = true;
return cmdExit(0, 0);
}
bool Console::cmdStepGlobal(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Steps until the global variable with the specified index is modified.\n");
debugPrintf("Usage: %s <global variable index>\n", argv[0]);
return true;
}
_debugState.seeking = kDebugSeekGlobal;
_debugState.seekSpecial = atoi(argv[1]);
_debugState.debugging = true;
return cmdExit(0, 0);
}
bool Console::cmdStepCallk(int argc, const char **argv) {
int callk_index;
char *endptr;
if (argc == 2) {
/* Try to convert the parameter to a number. If the conversion stops
before end of string, assume that the parameter is a function name
and scan the function table to find out the index. */
callk_index = strtoul(argv[1], &endptr, 0);
if (*endptr != '\0') {
callk_index = -1;
for (uint i = 0; i < _engine->getKernel()->getKernelNamesSize(); i++)
if (argv[1] == _engine->getKernel()->getKernelName(i)) {
callk_index = i;
break;
}
if (callk_index == -1) {
debugPrintf("Unknown kernel function '%s'\n", argv[1]);
return true;
}
}
_debugState.seeking = kDebugSeekSpecialCallk;
_debugState.seekSpecial = callk_index;
} else {
_debugState.seeking = kDebugSeekCallk;
}
_debugState.debugging = true;
return cmdExit(0, 0);
}
bool Console::cmdDisassemble(int argc, const char **argv) {
if (argc < 3) {
debugPrintf("Disassembles a method by name.\n");
debugPrintf("Usage: %s <object> <method> <options>\n", argv[0]);
debugPrintf("Valid options are:\n");
debugPrintf(" bwt : Print byte/word tag\n");
debugPrintf(" bc : Print bytecode\n");
debugPrintf(" bcc : Print bytecode, formatted to use in C code\n");
return true;
}
reg_t objAddr = NULL_REG;
bool printBytecode = false;
bool printBWTag = false;
bool printCSyntax = false;
if (parse_reg_t(_engine->_gamestate, argv[1], &objAddr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
const Object *obj = _engine->_gamestate->_segMan->getObject(objAddr);
int selectorId = _engine->getKernel()->findSelector(argv[2]);
reg_t addr = NULL_REG;
if (!obj) {
debugPrintf("Not an object.\n");
return true;
}
if (selectorId < 0) {
debugPrintf("Not a valid selector name.\n");
return true;
}
if (lookupSelector(_engine->_gamestate->_segMan, objAddr, selectorId, NULL, &addr) != kSelectorMethod) {
debugPrintf("Not a method.\n");
return true;
}
for (int i = 3; i < argc; i++) {
if (!scumm_stricmp(argv[i], "bwt"))
printBWTag = true;
else if (!scumm_stricmp(argv[i], "bc"))
printBytecode = true;
else if (!scumm_stricmp(argv[i], "bcc")) {
printBytecode = true;
printCSyntax = true;
}
}
reg_t farthestTarget = addr;
do {
reg_t prevAddr = addr;
reg_t jumpTarget;
if (isJumpOpcode(_engine->_gamestate, addr, jumpTarget)) {
if (jumpTarget > farthestTarget)
farthestTarget = jumpTarget;
}
addr = disassemble(_engine->_gamestate, make_reg32(addr.getSegment(), addr.getOffset()), obj, printBWTag, printBytecode, printCSyntax);
if (addr.isNull() && prevAddr < farthestTarget)
addr = prevAddr + 1; // skip past the ret
} while (addr.getOffset() > 0);
return true;
}
bool Console::cmdDisassembleAddress(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Disassembles one or more commands.\n");
debugPrintf("Usage: %s [startaddr] <options>\n", argv[0]);
debugPrintf("Valid options are:\n");
debugPrintf(" bwt : Print byte/word tag\n");
debugPrintf(" c<x> : Disassemble <x> bytes\n");
debugPrintf(" bc : Print bytecode\n");
debugPrintf(" bcc : Print bytecode, formatted to use in C code\n");
return true;
}
reg_t vpc = NULL_REG;
uint opCount = 1;
bool printBWTag = false;
bool printBytes = false;
bool printCSyntax = false;
uint32 size;
if (parse_reg_t(_engine->_gamestate, argv[1], &vpc)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
SegmentRef ref = _engine->_gamestate->_segMan->dereference(vpc);
size = ref.maxSize + vpc.getOffset(); // total segment size
for (int i = 2; i < argc; i++) {
if (!scumm_stricmp(argv[i], "bwt"))
printBWTag = true;
else if (!scumm_stricmp(argv[i], "bc"))
printBytes = true;
else if (!scumm_stricmp(argv[i], "bcc")) {
printBytes = true;
printCSyntax = true;
} else if (toupper(argv[i][0]) == 'C')
opCount = atoi(argv[i] + 1);
else {
debugPrintf("Invalid option '%s'\n", argv[i]);
return true;
}
}
do {
vpc = disassemble(_engine->_gamestate, make_reg32(vpc.getSegment(), vpc.getOffset()), nullptr, printBWTag, printBytes, printCSyntax);
} while ((vpc.getOffset() > 0) && (vpc.getOffset() + 6 < size) && (--opCount));
return true;
}
void Console::printKernelCallsFound(int kernelFuncNum, bool showFoundScripts) {
Common::List<ResourceId> resources = _engine->getResMan()->listResources(kResourceTypeScript);
Common::sort(resources.begin(), resources.end());
if (showFoundScripts)
debugPrintf("%d scripts found, dissassembling...\n", resources.size());
int scriptSegment;
Script *script;
// Create a custom segment manager here, so that the game's segment
// manager won't be affected by loading and unloading scripts here.
SegManager *customSegMan = new SegManager(_engine->getResMan(), _engine->getScriptPatcher());
Common::List<ResourceId>::iterator itr;
for (itr = resources.begin(); itr != resources.end(); ++itr) {
// Ignore specific leftover scripts, which require other non-existing scripts
if ((_engine->getGameId() == GID_HOYLE3 && itr->getNumber() == 995) ||
(_engine->getGameId() == GID_KQ5 && itr->getNumber() == 980) ||
(_engine->getGameId() == GID_KQ7 && itr->getNumber() == 111) ||
(_engine->getGameId() == GID_MOTHERGOOSE256 && itr->getNumber() == 980) ||
(_engine->getGameId() == GID_SLATER && itr->getNumber() == 947)) {
continue;
}
// Load script
scriptSegment = customSegMan->instantiateScript(itr->getNumber());
script = customSegMan->getScript(scriptSegment);
// Iterate through all the script's objects
const ObjMap &objects = script->getObjectMap();
ObjMap::const_iterator it;
const ObjMap::const_iterator end = objects.end();
for (it = objects.begin(); it != end; ++it) {
const Object *obj = customSegMan->getObject(it->_value.getPos());
const char *objName = customSegMan->getObjectName(it->_value.getPos());
// Now dissassemble each method of the script object
for (uint16 i = 0; i < obj->getMethodCount(); i++) {
reg_t fptr = obj->getFunction(i);
uint32 offset = fptr.getOffset();
int16 opparams[4];
byte extOpcode;
byte opcode;
uint16 maxJmpOffset = 0;
for (;;) {
offset += readPMachineInstruction(script->getBuf(offset), extOpcode, opparams);
opcode = extOpcode >> 1;
if (opcode == op_callk) {
uint16 kFuncNum = opparams[0];
uint16 argc2 = opparams[1];
if (kFuncNum == kernelFuncNum) {
debugPrintf("Called from script %d, object %s, method %s(%d) with %d bytes for arguments\n",
itr->getNumber(), objName,
_engine->getKernel()->getSelectorName(obj->getFuncSelector(i)).c_str(), i, argc2);
}
}
// Monitor all jump opcodes (bt, bnt and jmp), so that if
// there is a jump after a ret, we don't stop processing
if (opcode == op_bt || opcode == op_bnt || opcode == op_jmp) {
uint16 curJmpOffset = offset + (uint16)opparams[0];
// QFG2 has invalid jumps outside the script buffer in script 260
if (curJmpOffset > maxJmpOffset && curJmpOffset < script->getScriptSize())
maxJmpOffset = curJmpOffset;
}
// Check for end of function/script
if (offset >= script->getBufSize())
break;
if (opcode == op_ret && offset >= maxJmpOffset)
break;
} // while (true)
} // for (uint16 i = 0; i < obj->getMethodCount(); i++)
} // for (it = script->_objects.begin(); it != end; ++it)
customSegMan->uninstantiateScript(itr->getNumber());
}
delete customSegMan;
}
bool Console::cmdFindKernelFunctionCall(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Finds the scripts and methods that call a specific kernel function.\n");
debugPrintf("Usage: %s <kernel function>\n", argv[0]);
debugPrintf("Example: %s Display\n", argv[0]);
debugPrintf("Special usage:\n");
debugPrintf("%s Dummy - find all calls to actual dummy functions "
"(mapped to kDummy, and dummy in the kernel table). "
"There shouldn't be calls to these (apart from a known "
"one in Shivers)\n", argv[0]);
debugPrintf("%s Unused - find all calls to unused functions (mapped to "
"kDummy - i.e. mapped in SSCI but dummy in ScummVM, thus "
"they'll error out when called). Only debug scripts should "
"be calling these\n", argv[0]);
debugPrintf("%s Unmapped - find all calls to currently unmapped or "
"unimplemented functions (mapped to kStub/kStubNull)\n", argv[0]);
return true;
}
Kernel *kernel = _engine->getKernel();
Common::String funcName(argv[1]);
if (funcName != "Dummy" && funcName != "Unused" && funcName != "Unmapped") {
// Find the number of the kernel function call
int kernelFuncNum = kernel->findKernelFuncPos(argv[1]);
if (kernelFuncNum < 0) {
debugPrintf("Invalid kernel function requested\n");
return true;
}
printKernelCallsFound(kernelFuncNum, true);
} else if (funcName == "Dummy") {
// Find all actual dummy kernel functions (mapped to kDummy, and dummy
// in the kernel table)
for (uint i = 0; i < kernel->_kernelFuncs.size(); i++) {
if (kernel->_kernelFuncs[i].function == &kDummy && kernel->getKernelName(i) == "Dummy") {
debugPrintf("Searching for kernel function %d (%s)...\n", i, kernel->getKernelName(i).c_str());
printKernelCallsFound(i, false);
}
}
} else if (funcName == "Unused") {
// Find all actual dummy kernel functions (mapped to kDummy - i.e.
// mapped in SSCI but dummy in ScummVM, thus they'll error out when
// called)
for (uint i = 0; i < kernel->_kernelFuncs.size(); i++) {
if (kernel->_kernelFuncs[i].function == &kDummy && kernel->getKernelName(i) != "Dummy") {
debugPrintf("Searching for kernel function %d (%s)...\n", i, kernel->getKernelName(i).c_str());
printKernelCallsFound(i, false);
}
}
} else if (funcName == "Unmapped") {
// Find all unmapped kernel functions (mapped to kStub/kStubNull)
for (uint i = 0; i < kernel->_kernelFuncs.size(); i++) {
if (kernel->_kernelFuncs[i].function == &kStub ||
kernel->_kernelFuncs[i].function == &kStubNull) {
debugPrintf("Searching for kernel function %d (%s)...\n", i, kernel->getKernelName(i).c_str());
printKernelCallsFound(i, false);
}
}
}
return true;
}
bool Console::cmdSend(int argc, const char **argv) {
if (argc < 3) {
debugPrintf("Sends a message to an object.\n");
debugPrintf("Usage: %s <object> <selector name> <param1> <param2> ... <paramn>\n", argv[0]);
debugPrintf("Example: %s ?fooScript cue\n", argv[0]);
return true;
}
reg_t object;
if (parse_reg_t(_engine->_gamestate, argv[1], &object)) {
debugPrintf("Invalid address \"%s\" passed.\n", argv[1]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
const char *selectorName = argv[2];
int selectorId = _engine->getKernel()->findSelector(selectorName);
if (selectorId < 0) {
debugPrintf("Unknown selector: \"%s\"\n", selectorName);
return true;
}
const Object *o = _engine->_gamestate->_segMan->getObject(object);
if (o == NULL) {
debugPrintf("Address \"%04x:%04x\" is not an object\n", PRINT_REG(object));
return true;
}
SelectorType selector_type = lookupSelector(_engine->_gamestate->_segMan, object, selectorId, NULL, NULL);
if (selector_type == kSelectorNone) {
debugPrintf("Object does not support selector: \"%s\"\n", selectorName);
return true;
}
// everything after the selector name is passed as an argument to the send
int send_argc = argc - 3;
// Create the data block for send_selector() at the top of the stack:
// [selector_number][argument_counter][arguments...]
StackPtr stackframe = _engine->_gamestate->_executionStack.back().sp;
stackframe[0] = make_reg(0, selectorId);
stackframe[1] = make_reg(0, send_argc);
for (int i = 0; i < send_argc; i++) {
if (parse_reg_t(_engine->_gamestate, argv[3+i], &stackframe[2+i])) {
debugPrintf("Invalid address \"%s\" passed.\n", argv[3+i]);
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
}
reg_t old_acc = _engine->_gamestate->r_acc;
// Now commit the actual function:
ExecStack *old_xstack, *xstack;
old_xstack = &_engine->_gamestate->_executionStack.back();
xstack = send_selector(_engine->_gamestate, object, object,
stackframe + 2 + send_argc,
2 + send_argc, stackframe);
bool restore_acc = old_xstack != xstack || argc == 3;
if (old_xstack != xstack) {
_engine->_gamestate->_executionStackPosChanged = true;
debugPrintf("Message scheduled for execution\n");
// We call run_engine explictly so we can restore the value of r_acc
// after execution.
run_vm(_engine->_gamestate);
_engine->_gamestate->xs = old_xstack;
}
if (restore_acc) {
// varselector read or message executed
debugPrintf("Message completed. Value returned: %04x:%04x\n", PRINT_REG(_engine->_gamestate->r_acc));
_engine->_gamestate->r_acc = old_acc;
}
return true;
}
bool Console::cmdGo(int argc, const char **argv) {
// CHECKME: is this necessary?
_debugState.seeking = kDebugSeekNothing;
return cmdExit(argc, argv);
}
bool Console::cmdLogKernel(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Logs calls to specified kernel function.\n");
debugPrintf("Usage: %s <kernel function/*>\n", argv[0]);
debugPrintf("Example: %s StrCpy\n", argv[0]);
debugPrintf("This is an alias for: bpk <kernel function> log\n");
return true;
}
const char *bpk_argv[] = { "bpk", argv[1], "log" };
cmdBreakpointKernel(3, bpk_argv);
return true;
}
void Console::printBreakpoint(int index, const Breakpoint &bp) {
debugPrintf(" #%i: ", index);
const char *bpaction;
switch (bp._action) {
case BREAK_LOG:
bpaction = " (action: log only)";
break;
case BREAK_BACKTRACE:
bpaction = " (action: show backtrace)";
break;
case BREAK_INSPECT:
bpaction = " (action: show object)";
break;
case BREAK_NONE:
bpaction = " (action: ignore)";
break;
default:
bpaction = "";
}
switch (bp._type) {
case BREAK_SELECTOREXEC:
debugPrintf("Execute %s%s\n", bp._name.c_str(), bpaction);
break;
case BREAK_SELECTORREAD:
debugPrintf("Read %s%s\n", bp._name.c_str(), bpaction);
break;
case BREAK_SELECTORWRITE:
debugPrintf("Write %s%s\n", bp._name.c_str(), bpaction);
break;
case BREAK_EXPORT: {
int bpdata = bp._address;
debugPrintf("Execute script %d, export %d%s\n", bpdata >> 16, bpdata & 0xFFFF, bpaction);
break;
}
case BREAK_ADDRESS:
debugPrintf("Execute address %04x:%04x%s\n", PRINT_REG(bp._regAddress), bpaction);
break;
case BREAK_KERNEL:
debugPrintf("Kernel call k%s%s\n", bp._name.c_str(), bpaction);
break;
default:
debugPrintf("UNKNOWN TYPE\n");
break;
}
}
bool Console::cmdBreakpointList(int argc, const char **argv) {
int i = 0;
debugPrintf("Breakpoint list:\n");
Common::List<Breakpoint>::const_iterator bp = _debugState._breakpoints.begin();
Common::List<Breakpoint>::const_iterator end = _debugState._breakpoints.end();
for (; bp != end; ++bp)
printBreakpoint(i++, *bp);
if (!i)
debugPrintf(" No breakpoints defined.\n");
return true;
}
bool Console::cmdBreakpointDelete(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Deletes a breakpoint with the specified index.\n");
debugPrintf("Usage: %s <breakpoint index>\n", argv[0]);
debugPrintf("<index> * will remove all breakpoints\n");
return true;
}
if (strcmp(argv[1], "*") == 0) {
_debugState._breakpoints.clear();
_debugState._activeBreakpointTypes = 0;
return true;
}
const int idx = atoi(argv[1]);
// Find the breakpoint at index idx.
Common::List<Breakpoint>::iterator bp = _debugState._breakpoints.begin();
const Common::List<Breakpoint>::iterator end = _debugState._breakpoints.end();
for (int i = 0; bp != end && i < idx; ++bp, ++i) {
// do nothing
}
if (bp == end) {
debugPrintf("Invalid breakpoint index %i\n", idx);
return true;
}
// Delete it
_debugState._breakpoints.erase(bp);
_debugState.updateActiveBreakpointTypes();
return true;
}
static bool stringToBreakpointAction(Common::String str, BreakpointAction &action) {
if (str == "break")
action = BREAK_BREAK;
else if (str == "log")
action = BREAK_LOG;
else if (str == "bt")
action = BREAK_BACKTRACE;
else if (str == "inspect")
action = BREAK_INSPECT;
else if (str == "ignore")
action = BREAK_NONE;
else
return false;
return true;
}
bool Console::cmdBreakpointAction(int argc, const char **argv) {
bool usage = false;
if (argc != 3) {
usage = true;
}
Common::String arg;
if (argc >= 3)
arg = argv[2];
BreakpointAction bpaction;
if (!stringToBreakpointAction(arg, bpaction))
usage = true;
if (usage) {
debugPrintf("Change the action for the breakpoint with the specified index.\n");
debugPrintf("Usage: %s <breakpoint index> break|log|bt|inspect|ignore\n", argv[0]);
debugPrintf("<index> * will process all breakpoints\n");
debugPrintf("Actions: break : break into debugger\n");
debugPrintf(" log : log without breaking\n");
debugPrintf(" bt : show backtrace without breaking\n");
debugPrintf(" inspect: show object (only for bpx/bpr/bpw)\n");
debugPrintf(" ignore : ignore breakpoint\n");
return true;
}
Common::List<Breakpoint>::iterator bp = _debugState._breakpoints.begin();
const Common::List<Breakpoint>::iterator end = _debugState._breakpoints.end();
if (strcmp(argv[1], "*") == 0) {
for (; bp != end; ++bp)
bp->_action = bpaction;
_debugState.updateActiveBreakpointTypes();
return true;
}
const int idx = atoi(argv[1]);
// Find the breakpoint at index idx.
for (int i = 0; bp != end && i < idx; ++bp, ++i) {
// do nothing
}
if (bp == end) {
debugPrintf("Invalid breakpoint index %i\n", idx);
return true;
}
bp->_action = bpaction;
_debugState.updateActiveBreakpointTypes();
printBreakpoint(idx, *bp);
return true;
}
bool Console::cmdBreakpointMethod(int argc, const char **argv) {
if (argc < 2 || argc > 3) {
debugPrintf("Sets a breakpoint on execution of a specified method/selector.\n");
debugPrintf("Usage: %s <name> [<action>]\n", argv[0]);
debugPrintf("Example: %s ego::doit\n", argv[0]);
debugPrintf(" %s ego::doit log\n", argv[0]);
debugPrintf("May also be used to set a breakpoint that applies whenever an object\n");
debugPrintf("of a specific type is touched: %s foo::\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 3) {
if (!stringToBreakpointAction(argv[2], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[2]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
/* Note: We can set a breakpoint on a method that has not been loaded yet.
Thus, we can't check whether the command argument is a valid method name.
A breakpoint set on an invalid method name will just never trigger. */
Breakpoint bp;
bp._type = BREAK_SELECTOREXEC;
bp._name = argv[1];
bp._action = action;
_debugState._breakpoints.push_back(bp);
if (action != BREAK_NONE)
_debugState._activeBreakpointTypes |= BREAK_SELECTOREXEC;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdBreakpointRead(int argc, const char **argv) {
if (argc < 2 || argc > 3) {
debugPrintf("Sets a breakpoint on reading of a specified selector.\n");
debugPrintf("Usage: %s <name> [<action>]\n", argv[0]);
debugPrintf("Example: %s ego::view\n", argv[0]);
debugPrintf(" %s ego::view log\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 3) {
if (!stringToBreakpointAction(argv[2], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[2]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
Breakpoint bp;
bp._type = BREAK_SELECTORREAD;
bp._name = argv[1];
bp._action = action;
_debugState._breakpoints.push_back(bp);
if (action != BREAK_NONE)
_debugState._activeBreakpointTypes |= BREAK_SELECTORREAD;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdBreakpointWrite(int argc, const char **argv) {
if (argc < 2 || argc > 3) {
debugPrintf("Sets a breakpoint on writing of a specified selector.\n");
debugPrintf("Usage: %s <name> [<action>]\n", argv[0]);
debugPrintf("Example: %s ego::view\n", argv[0]);
debugPrintf(" %s ego::view log\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 3) {
if (!stringToBreakpointAction(argv[2], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[2]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
Breakpoint bp;
bp._type = BREAK_SELECTORWRITE;
bp._name = argv[1];
bp._action = action;
_debugState._breakpoints.push_back(bp);
if (action != BREAK_NONE)
_debugState._activeBreakpointTypes |= BREAK_SELECTORWRITE;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdBreakpointKernel(int argc, const char **argv) {
if (argc < 2 || argc > 3) {
debugPrintf("Sets a breakpoint on execution of a kernel function.\n");
debugPrintf("Usage: %s <name> [<action>]\n", argv[0]);
debugPrintf("Example: %s DrawPic\n", argv[0]);
debugPrintf(" %s DoSoundPlay,DoSoundStop\n", argv[0]);
debugPrintf(" %s DoSound*\n", argv[0]);
debugPrintf(" %s DoSound*,!DoSoundUpdateCues\n", argv[0]);
debugPrintf(" %s DrawPic log\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 3) {
if (!stringToBreakpointAction(argv[2], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[2]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
// Check if any kernel functions match, to catch typos
Common::String pattern = argv[1];
bool found = false;
const Kernel::KernelFunctionArray &kernelFuncs = _engine->getKernel()->_kernelFuncs;
for (uint id = 0; id < kernelFuncs.size() && !found; id++) {
if (kernelFuncs[id].name) {
const KernelSubFunction *kernelSubCall = kernelFuncs[id].subFunctions;
if (!kernelSubCall) {
Common::String kname = kernelFuncs[id].name;
if (matchKernelBreakpointPattern(pattern, kname))
found = true;
} else {
uint kernelSubCallCount = kernelFuncs[id].subFunctionCount;
for (uint subId = 0; subId < kernelSubCallCount; subId++) {
if (kernelSubCall->name) {
Common::String kname = kernelSubCall->name;
if (matchKernelBreakpointPattern(pattern, kname))
found = true;
}
kernelSubCall++;
}
}
}
}
if (!found) {
debugPrintf("No kernel functions match %s.\n", pattern.c_str());
return true;
}
Breakpoint bp;
bp._type = BREAK_KERNEL;
bp._name = pattern;
bp._action = action;
_debugState._breakpoints.push_back(bp);
if (action != BREAK_NONE)
_debugState._activeBreakpointTypes |= BREAK_KERNEL;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdBreakpointFunction(int argc, const char **argv) {
if (argc < 3 || argc > 4) {
debugPrintf("Sets a breakpoint on the execution of the specified exported function.\n");
debugPrintf("Usage: %s <script number> <export number> [<action>]\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 4) {
if (!stringToBreakpointAction(argv[3], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[3]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
/* Note: We can set a breakpoint on a method that has not been loaded yet.
Thus, we can't check whether the command argument is a valid method name.
A breakpoint set on an invalid method name will just never trigger. */
Breakpoint bp;
bp._type = BREAK_EXPORT;
// script number, export number
bp._address = (atoi(argv[1]) << 16 | atoi(argv[2]));
bp._action = action;
_debugState._breakpoints.push_back(bp);
_debugState._activeBreakpointTypes |= BREAK_EXPORT;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdBreakpointAddress(int argc, const char **argv) {
if (argc < 2 || argc > 3) {
debugPrintf("Sets a breakpoint on the execution of the specified code address.\n");
debugPrintf("Usage: %s <address> [<action>]\n", argv[0]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
reg_t addr;
if (parse_reg_t(_engine->_gamestate, argv[1], &addr)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
BreakpointAction action = BREAK_BREAK;
if (argc == 3) {
if (!stringToBreakpointAction(argv[2], action)) {
debugPrintf("Invalid breakpoint action %s.\n", argv[2]);
debugPrintf("See bp_action usage for possible actions.\n");
return true;
}
}
Breakpoint bp;
bp._type = BREAK_ADDRESS;
bp._regAddress = make_reg32(addr.getSegment(), addr.getOffset());
bp._action = action;
_debugState._breakpoints.push_back(bp);
_debugState._activeBreakpointTypes |= BREAK_ADDRESS;
printBreakpoint(_debugState._breakpoints.size() - 1, bp);
return true;
}
bool Console::cmdSfx01Header(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Dumps the header of a SCI01 song\n");
debugPrintf("Usage: %s <track>\n", argv[0]);
return true;
}
Resource *song = _engine->getResMan()->findResource(ResourceId(kResourceTypeSound, atoi(argv[1])), false);
if (!song) {
debugPrintf("Doesn't exist\n");
return true;
}
uint32 offset = 0;
debugPrintf("SCI01 song track mappings:\n");
if (song->getUint8At(0) == 0xf0) // SCI1 priority spec
offset = 8;
if (song->size() <= 0)
return 1;
while (song->getUint8At(offset) != 0xff) {
byte device_id = song->getUint8At(offset);
debugPrintf("* Device %02x:\n", device_id);
offset++;
if (offset + 1 >= song->size())
return 1;
while (song->getUint8At(offset) != 0xff) {
int track_offset;
int end;
byte header1, header2;
if (offset + 7 >= song->size())
return 1;
offset += 2;
track_offset = song->getUint16LEAt(offset);
header1 = song->getUint8At(track_offset);
header2 = song->getUint8At(track_offset + 1);
track_offset += 2;
end = song->getUint16LEAt(offset + 2);
debugPrintf(" - %04x -- %04x", track_offset, track_offset + end);
if (track_offset == 0xfe)
debugPrintf(" (PCM data)\n");
else
debugPrintf(" (channel %d, special %d, %d playing notes, %d foo)\n",
header1 & 0xf, header1 >> 4, header2 & 0xf, header2 >> 4);
offset += 4;
}
offset++;
}
return true;
}
static int _parse_ticks(const byte *data, int *offset_p, int size) {
int ticks = 0;
int tempticks;
int offset = 0;
do {
tempticks = data[offset++];
ticks += (tempticks == SCI_MIDI_TIME_EXPANSION_PREFIX) ? SCI_MIDI_TIME_EXPANSION_LENGTH : tempticks;
} while (tempticks == SCI_MIDI_TIME_EXPANSION_PREFIX && offset < size);
if (offset_p)
*offset_p = offset;
return ticks;
}
// Specialised for SCI01 tracks (this affects the way cumulative cues are treated)
static void midi_hexdump(const byte *data, int size, int notational_offset) {
int offset = 0;
int prev = 0;
const int MIDI_cmdlen[16] = {0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 1, 1, 2, 0};
if (*data == 0xf0) // SCI1 priority spec
offset = 8;
while (offset < size) {
int old_offset = offset;
int offset_mod;
int time = _parse_ticks(data + offset, &offset_mod, size);
int cmd;
int pleft;
int firstarg = 0;
int i;
int blanks = 0;
offset += offset_mod;
debugN(" [%04x] %d\t",
old_offset + notational_offset, time);
cmd = data[offset];
if (!(cmd & 0x80)) {
cmd = prev;
if (prev < 0x80) {
debugN("Track broken at %x after"
" offset mod of %d\n",
offset + notational_offset, offset_mod);
Common::hexdump(data, size, 16, notational_offset);
return;
}
debugN("(rs %02x) ", cmd);
blanks += 8;
} else {
++offset;
debugN("%02x ", cmd);
blanks += 3;
}
prev = cmd;
pleft = MIDI_cmdlen[cmd >> 4];
if (SCI_MIDI_CONTROLLER(cmd) && data[offset] == SCI_MIDI_CUMULATIVE_CUE)
--pleft; // This is SCI(0)1 specific
for (i = 0; i < pleft; i++) {
if (i == 0)
firstarg = data[offset];
debugN("%02x ", data[offset++]);
blanks += 3;
}
while (blanks < 16) {
blanks += 4;
debugN(" ");
}
while (blanks < 20) {
++blanks;
debugN(" ");
}
if (cmd == SCI_MIDI_EOT)
debugN(";; EOT");
else if (cmd == SCI_MIDI_SET_SIGNAL) {
if (firstarg == SCI_MIDI_SET_SIGNAL_LOOP)
debugN(";; LOOP point");
else
debugN(";; CUE (%d)", firstarg);
} else if (SCI_MIDI_CONTROLLER(cmd)) {
if (firstarg == SCI_MIDI_CUMULATIVE_CUE)
debugN(";; CUE (cumulative)");
else if (firstarg == SCI_MIDI_RESET_ON_SUSPEND)
debugN(";; RESET-ON-SUSPEND flag");
}
debugN("\n");
if (old_offset >= offset) {
debugN("-- Not moving forward anymore,"
" aborting (%x/%x)\n", offset, old_offset);
return;
}
}
}
bool Console::cmdSfx01Track(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Dumps a track of a SCI01 song\n");
debugPrintf("Usage: %s <track> <offset>\n", argv[0]);
return true;
}
Resource *song = _engine->getResMan()->findResource(ResourceId(kResourceTypeSound, atoi(argv[1])), 0);
int offset = atoi(argv[2]);
if (!song) {
debugPrintf("Doesn't exist\n");
return true;
}
midi_hexdump(song->getUnsafeDataAt(offset), song->size() - offset, offset);
return true;
}
bool Console::cmdMapVocab994(int argc, const char **argv) {
EngineState *s = _engine->_gamestate; // for the several defines in this function
reg_t reg;
if (argc != 4) {
debugPrintf("Attempts to map a range of vocab.994 entries to a given class\n");
debugPrintf("Usage: %s <class addr> <first> <last>\n", argv[0]);
return true;
}
if (parse_reg_t(_engine->_gamestate, argv[1], ®)) {
debugPrintf("Invalid address passed.\n");
debugPrintf("Check the \"addresses\" command on how to use addresses\n");
return true;
}
Resource *resource = _engine->_resMan->findResource(ResourceId(kResourceTypeVocab, 994), false);
const Object *obj = s->_segMan->getObject(reg);
SciSpan<const uint16> data = resource->subspan<const uint16>(0);
uint32 first = atoi(argv[2]);
uint32 last = atoi(argv[3]);
Common::Array<bool> markers;
markers.resize(_engine->getKernel()->getSelectorNamesSize());
if (!obj->isClass() && getSciVersion() != SCI_VERSION_3)
obj = s->_segMan->getObject(obj->getSuperClassSelector());
first = MIN<uint32>(first, resource->size() / 2 - 2);
last = MIN<uint32>(last, resource->size() / 2 - 2);
for (uint32 i = first; i <= last; ++i) {
uint16 ofs = data[i];
if (obj && ofs < obj->getVarCount()) {
uint16 varSelector = obj->getVarSelector(ofs);
debugPrintf("%d: property at index %04x of %s is %s %s\n", i, ofs,
s->_segMan->getObjectName(reg),
_engine->getKernel()->getSelectorName(varSelector).c_str(),
markers[varSelector] ? "(repeat!)" : "");
markers[varSelector] = true;
}
else {
debugPrintf("%d: property at index %04x doesn't match up with %s\n", i, ofs,
s->_segMan->getObjectName(reg));
}
}
return true;
}
bool Console::cmdQuit(int argc, const char **argv) {
if (argc != 2) {
}
if (argc == 2 && !scumm_stricmp(argv[1], "now")) {
// Quit ungracefully
g_system->quit();
} else if (argc == 1 || (argc == 2 && !scumm_stricmp(argv[1], "game"))) {
// Quit gracefully
_engine->_gamestate->abortScriptProcessing = kAbortQuitGame; // Terminate VM
_debugState.seeking = kDebugSeekNothing;
_debugState.runningStep = 0;
} else {
debugPrintf("%s [game] - exit gracefully\n", argv[0]);
debugPrintf("%s now - exit ungracefully\n", argv[0]);
return true;
}
return cmdExit(0, 0);
}
bool Console::cmdAddresses(int argc, const char **argv) {
debugPrintf("Address parameters may be passed in one of three forms:\n");
debugPrintf(" - ssss:oooo -- where 'ssss' denotes a segment and 'oooo' an offset.\n");
debugPrintf(" Example: \"a:c5\" would address something in segment 0xa at offset 0xc5.\n");
debugPrintf(" - &scr:oooo -- where 'scr' is a script number and oooo an offset within that script; will\n");
debugPrintf(" fail if the script is not currently loaded\n");
debugPrintf(" - $REG -- where 'REG' is one of 'PC', 'ACC', 'PREV' or 'OBJ': References the address\n");
debugPrintf(" indicated by the register of this name.\n");
debugPrintf(" - $REG+n (or -n) -- Like $REG, but modifies the offset part by a specific amount (which\n");
debugPrintf(" is specified in hexadecimal).\n");
debugPrintf(" - ?obj -- Looks up an object with the specified name, uses its address. This will abort if\n");
debugPrintf(" the object name is ambiguous; in that case, a list of addresses and indices is provided.\n");
debugPrintf(" ?obj.idx may be used to disambiguate 'obj' by the index 'idx'.\n");
debugPrintf(" Underscores are used as substitute characters for spaces in object names.\n");
debugPrintf(" For example, an object named \"Glass Jar\" can be accessed as \"Glass_Jar\".\n");
return true;
}
// Returns 0 on success
static int parse_reg_t(EngineState *s, const char *str, reg_t *dest) {
// Pointer to the part of str which contains a numeric offset (if any)
const char *offsetStr = NULL;
// Flag that tells whether the value stored in offsetStr is an absolute offset,
// or a relative offset against dest->offset.
bool relativeOffset = false;
// Non-NULL: Parse end of string for relative offsets
char *endptr;
if (*str == '$') { // Register: "$FOO" or "$FOO+NUM" or "$FOO-NUM
relativeOffset = true;
if (!scumm_strnicmp(str + 1, "PC", 2)) {
*dest = s->_executionStack.back().addr.pc;
offsetStr = str + 3;
} else if (!scumm_strnicmp(str + 1, "P", 1)) {
*dest = s->_executionStack.back().addr.pc;
offsetStr = str + 2;
} else if (!scumm_strnicmp(str + 1, "PREV", 4)) {
*dest = s->r_prev;
offsetStr = str + 5;
} else if (!scumm_strnicmp(str + 1, "ACC", 3)) {
*dest = s->r_acc;
offsetStr = str + 4;
} else if (!scumm_strnicmp(str + 1, "A", 1)) {
*dest = s->r_acc;
offsetStr = str + 2;
} else if (!scumm_strnicmp(str + 1, "OBJ", 3)) {
*dest = s->_executionStack.back().objp;
offsetStr = str + 4;
} else if (!scumm_strnicmp(str + 1, "O", 1)) {
*dest = s->_executionStack.back().objp;
offsetStr = str + 2;
} else
return 1; // No matching register
if (!*offsetStr)
offsetStr = NULL;
else if (*offsetStr != '+' && *offsetStr != '-')
return 1;
} else if (*str == '&') { // Script relative: "&SCRIPT-ID:OFFSET"
// Look up by script ID. The text from start till just before the colon
// (resp. end of string, if there is no colon) contains the script ID.
const char *colon = strchr(str, ':');
if (!colon)
return 1;
// Extract the script id and parse it
Common::String scriptStr(str, colon);
int script_nr = strtol(scriptStr.c_str() + 1, &endptr, 10);
if (*endptr)
return 1;
// Now lookup the script's segment
dest->setSegment(s->_segMan->getScriptSegment(script_nr));
if (!dest->getSegment()) {
return 1;
}
// Finally, after the colon comes the offset
offsetStr = colon + 1;
} else {
// Now we either got an object name, or segment:offset or plain value
// segment:offset is recognized by the ":"
// plain value may be "123" or "123h" or "fffh" or "0xfff"
// object name is assumed if nothing else matches or a "?" is used as prefix as override
// object name may contain "+", "-" and "." for relative calculations, those chars are used nowhere else
// First we cycle through the string counting special chars
const char *strLoop = str;
int charsCount = strlen(str);
int charsCountObject = 0;
int charsCountSegmentOffset = 0;
int charsCountLetter = 0;
int charsCountNumber = 0;
bool charsForceHex = false;
bool charsForceObject = false;
while (*strLoop) {
switch (*strLoop) {
case '+':
case '-':
case '.':
charsCountObject++;
break;
case '?':
if (strLoop == str) {
charsForceObject = true;
str++; // skip over prefix
}
break;
case ':':
charsCountSegmentOffset++;
break;
case 'h':
if (*(strLoop + 1) == 0)
charsForceHex = true;
else
charsCountObject++;
break;
case '0':
if (*(strLoop + 1) == 'x') {
str += 2; // skip "0x"
strLoop++; // skip "x"
charsForceHex = true;
}
charsCountNumber++;
break;
default:
if ((*strLoop >= '0') && (*strLoop <= '9'))
charsCountNumber++;
if ((*strLoop >= 'a') && (*strLoop <= 'f'))
charsCountLetter++;
if ((*strLoop >= 'A') && (*strLoop <= 'F'))
charsCountLetter++;
if ((*strLoop >= 'i') && (*strLoop <= 'z'))
charsCountObject++;
if ((*strLoop >= 'I') && (*strLoop <= 'Z'))
charsCountObject++;
if (*strLoop == '_') // underscores are used as substitutes for spaces in object names
charsCountObject++;
}
strLoop++;
}
if ((charsCountObject) && (charsCountSegmentOffset))
return 1; // input doesn't make sense
if (!charsForceObject) {
// input may be values/segment:offset
if (charsCountSegmentOffset) {
// ':' found, so must be segment:offset
const char *colon = strchr(str, ':');
offsetStr = colon + 1;
Common::String segmentStr(str, colon);
dest->setSegment(strtol(segmentStr.c_str(), &endptr, 16));
if (*endptr)
return 1;
} else {
int val = 0;
dest->setSegment(0);
if (charsCountNumber == charsCount) {
// Only numbers in input, assume decimal value
val = strtol(str, &endptr, 10);
if (*endptr)
return 1; // strtol failed?
dest->setOffset(val);
return 0;
} else {
// We also got letters, check if there were only hexadecimal letters and '0x' at the start or 'h' at the end
if ((charsForceHex) && (!charsCountObject)) {
val = strtol(str, &endptr, 16);
if ((*endptr != 'h') && (*endptr != 0))
return 1;
dest->setOffset(val);
return 0;
} else {
// Something else was in input, assume object name
charsForceObject = true;
}
}
}
}
if (charsForceObject) {
// We assume now that input is object name
// Object by name: "?OBJ" or "?OBJ.INDEX" or "?OBJ.INDEX+OFFSET" or "?OBJ.INDEX-OFFSET"
// The (optional) index can be used to distinguish multiple object with the same name.
int index = -1;
// Look for an offset. It starts with + or -
relativeOffset = true;
offsetStr = strchr(str, '+');
if (!offsetStr) // No + found, look for -
offsetStr = strchr(str, '-');
// Strip away the offset and the leading '?'
Common::String str_objname;
if (offsetStr)
str_objname = Common::String(str, offsetStr);
else
str_objname = str;
// Scan for a period, after which (if present) we'll find an index
const char *tmp = Common::find(str_objname.begin(), str_objname.end(), '.');
if (tmp != str_objname.end()) {
index = strtol(tmp + 1, &endptr, 16);
if (*endptr) {
// The characters after the dot do not represent an index.
// This can happen if an object contains a dot in its name,
// like 'dominoes.opt' in Hoyle 3.
index = -1;
} else {
// Valid index found, chop it off
str_objname = Common::String(str_objname.c_str(), tmp);
}
}
// Replace all underscores in the name with spaces
for (uint i = 0; i < str_objname.size(); i++) {
if (str_objname[i] == '_')
str_objname.setChar(' ', i);
}
// Now all values are available; iterate over all objects.
*dest = s->_segMan->findObjectByName(str_objname, index);
if (dest->isNull())
return 1;
}
}
if (offsetStr) {
int val = strtol(offsetStr, &endptr, 16);
if (relativeOffset)
dest->incOffset(val);
else
dest->setOffset(val);
if (*endptr)
return 1;
}
return 0;
}
bool Console::parseInteger(const char *argument, int &result) {
char *endPtr = 0;
int idxLen = strlen(argument);
const char *lastChar = argument + idxLen - (idxLen == 0 ? 0 : 1);
if ((strncmp(argument, "0x", 2) == 0) || (*lastChar == 'h')) {
// hexadecimal number
result = strtol(argument, &endPtr, 16);
if ((*endPtr != 0) && (*endPtr != 'h')) {
debugPrintf("Invalid hexadecimal number '%s'\n", argument);
return false;
}
} else {
// decimal number
result = strtol(argument, &endPtr, 10);
if (*endPtr != 0) {
debugPrintf("Invalid decimal number '%s'\n", argument);
return false;
}
}
return true;
}
void Console::printBasicVarInfo(reg_t variable) {
int regType = g_sci->getKernel()->findRegType(variable);
int segType = regType;
SegManager *segMan = g_sci->getEngineState()->_segMan;
segType &= SIG_TYPE_INTEGER | SIG_TYPE_OBJECT | SIG_TYPE_REFERENCE | SIG_TYPE_NODE | SIG_TYPE_LIST | SIG_TYPE_UNINITIALIZED | SIG_TYPE_ERROR;
switch (segType) {
case SIG_TYPE_INTEGER: {
uint16 content = variable.toUint16();
if (content >= 10)
debugPrintf(" (%dd)", content);
break;
}
case SIG_TYPE_OBJECT:
debugPrintf(" (object '%s')", segMan->getObjectName(variable));
break;
case SIG_TYPE_REFERENCE:
debugPrintf(" (reference)");
break;
case SIG_TYPE_NODE:
debugPrintf(" (node)");
break;
case SIG_TYPE_LIST:
debugPrintf(" (list)");
break;
case SIG_TYPE_UNINITIALIZED:
debugPrintf(" (uninitialized)");
break;
case SIG_TYPE_ERROR:
debugPrintf(" (error)");
break;
default:
debugPrintf(" (??\?)");
}
if (regType & SIG_IS_INVALID)
debugPrintf(" IS INVALID!");
}
void Console::printList(reg_t reg) {
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegment(reg.getSegment(), SEG_TYPE_LISTS);
if (!mobj) {
debugPrintf("list:\nCould not find list segment.\n");
return;
}
ListTable *table = static_cast<ListTable *>(mobj);
if (!table->isValidEntry(reg.getOffset())) {
debugPrintf("list:\nAddress does not contain a valid list.\n");
return;
}
const List &list = table->at(reg.getOffset());
debugPrintf("list:\n");
printList(list);
}
void Console::printList(const List &list) {
reg_t pos = list.first;
reg_t my_prev = NULL_REG;
debugPrintf("\t<\n");
while (!pos.isNull()) {
Node *node;
NodeTable *nt = (NodeTable *)_engine->_gamestate->_segMan->getSegment(pos.getSegment(), SEG_TYPE_NODES);
if (!nt || !nt->isValidEntry(pos.getOffset())) {
debugPrintf(" WARNING: %04x:%04x: Doesn't contain list node!\n", PRINT_REG(pos));
return;
}
node = &nt->at(pos.getOffset());
debugPrintf("\t%04x:%04x : %04x:%04x -> %04x:%04x\n", PRINT_REG(pos), PRINT_REG(node->key), PRINT_REG(node->value));
if (my_prev != node->pred)
debugPrintf(" WARNING: current node gives %04x:%04x as predecessor!\n", PRINT_REG(node->pred));
my_prev = pos;
pos = node->succ;
}
if (my_prev != list.last)
debugPrintf(" WARNING: Last node was expected to be %04x:%04x, was %04x:%04x!\n",
PRINT_REG(list.last), PRINT_REG(my_prev));
debugPrintf("\t>\n");
}
int Console::printNode(reg_t addr) {
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegment(addr.getSegment(), SEG_TYPE_LISTS);
if (mobj) {
ListTable *lt = (ListTable *)mobj;
List *list;
if (!lt->isValidEntry(addr.getOffset())) {
debugPrintf("Address does not contain a list\n");
return 1;
}
list = <->at(addr.getOffset());
debugPrintf("%04x:%04x : first x last = (%04x:%04x, %04x:%04x)\n", PRINT_REG(addr), PRINT_REG(list->first), PRINT_REG(list->last));
} else {
NodeTable *nt;
Node *node;
mobj = _engine->_gamestate->_segMan->getSegment(addr.getSegment(), SEG_TYPE_NODES);
if (!mobj) {
debugPrintf("Segment #%04x is not a list or node segment\n", addr.getSegment());
return 1;
}
nt = (NodeTable *)mobj;
if (!nt->isValidEntry(addr.getOffset())) {
debugPrintf("Address does not contain a node\n");
return 1;
}
node = &nt->at(addr.getOffset());
debugPrintf("%04x:%04x : prev x next = (%04x:%04x, %04x:%04x); maps %04x:%04x -> %04x:%04x\n",
PRINT_REG(addr), PRINT_REG(node->pred), PRINT_REG(node->succ), PRINT_REG(node->key), PRINT_REG(node->value));
}
return 0;
}
void Console::printReference(reg_t reg, reg_t reg_end) {
int type_mask = g_sci->getKernel()->findRegType(reg);
int filter;
int found = 0;
debugPrintf("%04x:%04x is of type 0x%x: ", PRINT_REG(reg), type_mask);
if (reg.getSegment() == 0 && reg.getOffset() == 0) {
debugPrintf("Null.\n");
return;
}
if (reg_end.getSegment() != reg.getSegment() && reg_end != NULL_REG) {
debugPrintf("Ending segment different from starting segment. Assuming no bound on dump.\n");
reg_end = NULL_REG;
}
for (filter = 1; filter < 0xf000; filter <<= 1) {
int type = type_mask & filter;
if (found && type) {
debugPrintf("--- Alternatively, it could be a ");
}
switch (type) {
case 0:
break;
case SIG_TYPE_LIST:
printList(reg);
break;
case SIG_TYPE_NODE:
debugPrintf("list node\n");
printNode(reg);
break;
case SIG_TYPE_OBJECT:
debugPrintf("object\n");
printObject(reg);
break;
case SIG_TYPE_REFERENCE: {
switch (_engine->_gamestate->_segMan->getSegmentType(reg.getSegment())) {
#ifdef ENABLE_SCI32
case SEG_TYPE_ARRAY:
printArray(reg);
break;
case SEG_TYPE_BITMAP:
printBitmap(reg);
break;
#endif
default: {
const SegmentRef block = _engine->_gamestate->_segMan->dereference(reg);
uint16 size = block.maxSize;
debugPrintf("raw data\n");
if (reg_end.getSegment() != 0 && (size < reg_end.getOffset() - reg.getOffset())) {
debugPrintf("Block end out of bounds (size %d). Resetting.\n", size);
reg_end = NULL_REG;
}
if (reg_end.getSegment() != 0 && (size >= reg_end.getOffset() - reg.getOffset()))
size = reg_end.getOffset() - reg.getOffset();
if (reg_end.getSegment() != 0)
debugPrintf("Block size less than or equal to %d\n", size);
if (block.isRaw)
Common::hexdump(block.raw, size, 16, 0);
else
hexDumpReg(block.reg, size / 2, 4, 0);
}
}
break;
}
case SIG_TYPE_INTEGER:
debugPrintf("arithmetic value\n %d (%04x)\n", (int16) reg.getOffset(), reg.getOffset());
break;
default:
debugPrintf("unknown type %d.\n", type);
}
if (type) {
debugPrintf("\n");
found = 1;
}
}
}
#ifdef ENABLE_SCI32
void Console::printArray(reg_t reg) {
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegment(reg.getSegment(), SEG_TYPE_ARRAY);
if (!mobj) {
debugPrintf("SCI32 array:\nCould not find array segment.\n");
return;
}
ArrayTable *table = static_cast<ArrayTable *>(mobj);
if (!table->isValidEntry(reg.getOffset())) {
debugPrintf("SCI32 array:\nAddress does not contain a valid array.\n");
return;
}
const SciArray &array = table->at(reg.getOffset());
const char *arrayType;
switch (array.getType()) {
case kArrayTypeID:
arrayType = "reg_t";
break;
case kArrayTypeByte:
arrayType = "byte";
break;
case kArrayTypeInt16:
arrayType = "int16 (as reg_t)";
break;
case kArrayTypeString:
arrayType = "string";
break;
default:
arrayType = "invalid";
break;
}
debugPrintf("SCI32 %s array (%u entries):\n", arrayType, array.size());
switch (array.getType()) {
case kArrayTypeInt16:
case kArrayTypeID: {
hexDumpReg((const reg_t *)array.getRawData(), array.size(), 4, 0, true);
break;
}
case kArrayTypeByte:
case kArrayTypeString: {
Common::hexdump((const byte *)array.getRawData(), array.size(), 16, 0);
break;
}
default:
break;
}
}
void Console::printBitmap(reg_t reg) {
SegmentObj *mobj = _engine->_gamestate->_segMan->getSegment(reg.getSegment(), SEG_TYPE_BITMAP);
if (!mobj) {
debugPrintf("SCI32 bitmap:\nCould not find bitmap segment.\n");
return;
}
BitmapTable *table = static_cast<BitmapTable *>(mobj);
if (!table->isValidEntry(reg.getOffset())) {
debugPrintf("SCI32 bitmap:\nAddress does not contain a valid bitmap.\n");
return;
}
const SciBitmap &bitmap = table->at(reg.getOffset());
debugPrintf("SCI32 bitmap (%s):\n", bitmap.toString().c_str());
Common::hexdump((const byte *) bitmap.getRawData(), bitmap.getRawSize(), 16, 0);
}
#endif
void Console::writeIntegrityDumpLine(const Common::String &statusName, const Common::String &resourceName, Common::WriteStream &out, Common::ReadStream *const data, const int size, const bool writeHash) {
debugPrintf("%s", statusName.c_str());
out.writeString(resourceName);
if (!data) {
out.writeString(" ERROR\n");
debugPrintf("[ERR] ");
} else {
out.writeString(Common::String::format(" %d ", size));
if (writeHash) {
out.writeString(Common::computeStreamMD5AsString(*data));
} else {
out.writeString("disabled");
}
out.writeString("\n");
debugPrintf("[OK] ");
}
}
static void printChar(byte c) {
if (c < 32 || c >= 127)
c = '.';
debugN("%c", c);
}
void Console::hexDumpReg(const reg_t *data, int len, int regsPerLine, int startOffset, bool isArray) {
// reg_t version of Common::hexdump
assert(1 <= regsPerLine && regsPerLine <= 8);
int i;
int offset = startOffset;
while (len >= regsPerLine) {
debugN("%06x: ", offset);
for (i = 0; i < regsPerLine; i++) {
debugN("%04x:%04x ", PRINT_REG(data[i]));
}
debugN(" |");
for (i = 0; i < regsPerLine; i++) {
if (g_sci->isBE()) {
printChar(data[i].toUint16() >> 8);
printChar(data[i].toUint16() & 0xff);
} else {
printChar(data[i].toUint16() & 0xff);
printChar(data[i].toUint16() >> 8);
}
}
debugN("|\n");
data += regsPerLine;
len -= regsPerLine;
offset += regsPerLine * (isArray ? 1 : 2);
}
if (len <= 0)
return;
debugN("%06x: ", offset);
for (i = 0; i < regsPerLine; i++) {
if (i < len)
debugN("%04x:%04x ", PRINT_REG(data[i]));
else
debugN(" ");
}
debugN(" |");
for (i = 0; i < len; i++) {
if (g_sci->isBE()) {
printChar(data[i].toUint16() >> 8);
printChar(data[i].toUint16() & 0xff);
} else {
printChar(data[i].toUint16() & 0xff);
printChar(data[i].toUint16() >> 8);
}
}
for (; i < regsPerLine; i++)
debugN(" ");
debugN("|\n");
}
} // End of namespace Sci
|