/usr/include/fcml/fcml_common.hpp is in libfcml-dev 1.1.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 | /*
* FCML - Free Code Manipulation Library.
* Copyright (C) 2010-2015 Slawomir Wojtasiak
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/** @file fcml_common.hpp
* C++ wrappers common classes.
*
* @copyright Copyright (C) 2010-2015 Slawomir Wojtasiak. All rights reserved.
* This project is released under the GNU Lesser General Public License.
*/
#ifndef FCML_COMMON_HPP_
#define FCML_COMMON_HPP_
#include <stdlib.h>
#include <string.h>
#include <new>
#include <iostream>
#include <sstream>
#include <stdexcept>
#include <memory>
#include <vector>
#include "fcml_types.h"
#include "fcml_common.h"
#include "fcml_common_utils.h"
#include "fcml_errors.h"
namespace fcml {
#define FCML_TO_CPP_BOOL( x ) ( (x) ? true : false )
/**
* By using this type definition here, it will be definitely much
* easier to support UNICODE in future releases.
* @since 1.1.0
*/
typedef std::basic_string<fcml_char> fcml_cstring;
/**
* String output stream.
* @since 1.1.0
*/
typedef std::basic_ostringstream<fcml_char> fcml_costream;
/**
* Exposes API responsible for environment specific operations, even if standard CPP library is used
* to implement them.
*
* @since 1.1.0
* @remarks Internal API, not intended to be used outside.
*/
class Env {
public:
/**
* @throw std::bad_alloc
* @since 1.1.0
*/
static fcml_string strDup( const fcml_string str ) {
if ( !str ) {
return NULL;
}
#if defined(FCML_MSCC)
fcml_string newStr = _strdup( str );
#else
fcml_string newStr = strdup( str );
#endif
if ( !newStr ) {
throw std::bad_alloc();
}
return newStr;
}
static void strFree( fcml_string str ) {
free( str );
}
};
/**
* A base iterator interface.
* @since 1.1.0
*/
template <typename T>
class Iterator {
public:
Iterator() {}
virtual ~Iterator() {}
/**
* Gets true if there is an another element in the iterator.
*/
virtual bool hasNext() = 0;
/**
* Gets a next element from the iterator.
*/
virtual T next() = 0;
};
/** Wrapper for nullable value types.
* @since 1.1.0
*/
template<typename T>
class Nullable {
public:
Nullable( const T& value, bool is_not_null = false ) :
_value( value ), _is_not_null( is_not_null ) {
}
Nullable() :
_is_not_null( false ) {
}
bool isNotNull() const {
return _is_not_null;
}
void setNotNull(bool isNull) {
_is_not_null = isNull;
}
T getValue() const {
return _value;
}
T& getValue() {
return _value;
}
void setValue(const T& value) {
this->_value = value;
}
private:
/** Value. */
T _value;
/** Information if value is set or not. */
bool _is_not_null;
};
/**
* Base exception for all exceptions exposed by FCML library.
* @since 1.1.0
*/
class BaseException {
public:
BaseException( fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) {
this->_error = error;
}
BaseException( const fcml_cstring &msg, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) {
this->_msg = msg;
this->_error = error;
}
BaseException( const BaseException &cpy ) {
this->_msg = cpy._msg;
this->_error = cpy._error;
}
virtual ~BaseException() {
}
BaseException& operator=( const BaseException &exc ) {
if ( &exc != this ) {
this->_msg = exc._msg;
this->_error = exc._error;
}
return *this;
}
public:
const fcml_cstring getMsg() const {
return _msg;
}
const fcml_ceh_error& getError() const {
return _error;
}
private:
void* operator new( size_t size ) {
return ::operator new( size );
}
private:
/** Error message. */
fcml_cstring _msg;
/** Error code */
fcml_ceh_error _error;
};
/**
* Component can not be initialized correctly.
* @since 1.1.0
*/
class InitException: public BaseException {
public:
InitException( const fcml_cstring &msg, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) :
BaseException( msg, error ) {
}
};
/**
* Bad arguments.
* @since 1.1.0
*/
class BadArgumentException: public BaseException {
public:
BadArgumentException( const fcml_cstring &msg, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) :
BaseException( msg, error ) {
}
};
/**
* Illegal state exception.
* @since 1.1.0
*/
class IllegalStateException: public BaseException {
public:
IllegalStateException( const fcml_cstring &msg, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) :
BaseException( msg, error ) {
}
};
/**
* Illegal argument exception.
* @since 1.1.0
*/
class IllegalArgumentException: public BaseException {
public:
IllegalArgumentException( const fcml_cstring &msg, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR ) :
BaseException( msg, error ) {
}
};
/**
* Operation is not supported.
* @since 1.1.0
*/
class OperationNotSupportedException: public BaseException {
public:
OperationNotSupportedException( const fcml_cstring &msg ) :
BaseException( msg ) {
}
OperationNotSupportedException() {
}
};
/**
* Object which shouldn't be copied can inherit from this class.
* @since 1.1.0
*/
class NonCopyable {
protected:
NonCopyable() {
}
private:
/**
* @throw OperationNotSupportedException
*/
NonCopyable( const NonCopyable &cpy ) {
throw OperationNotSupportedException();
}
/**
* @throw OperationNotSupportedException
*/
NonCopyable& operator=( const NonCopyable &exc ) {
throw OperationNotSupportedException();
}
};
/** Wraps instruction prefix and prepares factory methods for the hints.
* The static method "create" is used here just to avoid the constructor overloading
* what can be a bit problematic because fcml_prefix is an ordinal integer type.
* @since 1.1.0
*/
class InstructionPrefix {
private:
/**
* Creates an instance of the instruction prefix for the given FCML prefix.
* @param prefix The native FCML prefix.
* @return Instruction prefix instance.
*/
static InstructionPrefix create( fcml_prefixes prefix ) {
InstructionPrefix instructionPrefix;
instructionPrefix._prefix = prefix;
return instructionPrefix;
}
public:
/**
* Creates instruction prefix: LOCK.
* @return Created instruction prefix.
*/
static const InstructionPrefix LOCK() {
return create(FCML_PREFIX_LOCK);
}
/**
* Creates instruction prefix: REPNE.
* @return Created instruction prefix.
*/
static const InstructionPrefix REPNE() {
return create(FCML_PREFIX_REPNE);
}
/**
* Creates instruction prefix: REPNZ.
* @return Created instruction prefix.
*/
static const InstructionPrefix REPNZ() {
return create(FCML_PREFIX_REPNZ);
}
/**
* Creates instruction prefix: REP.
* @return Created instruction prefix.
*/
static const InstructionPrefix REP() {
return create(FCML_PREFIX_REP);
}
/**
* Creates instruction prefix: REPE.
* @return Created instruction prefix.
*/
static const InstructionPrefix REPE() {
return create(FCML_PREFIX_REPE);
}
/**
* Creates instruction prefix: REPZ.
* @return Created instruction prefix.
*/
static const InstructionPrefix REPZ() {
return create(FCML_PREFIX_REPZ);
}
/**
* Creates instruction prefix: XACQUIRE.
* @return Created instruction prefix.
*/
static const InstructionPrefix XACQUIRE() {
return create(FCML_PREFIX_XACQUIRE);
}
/**
* Creates instruction prefix: XRELEASE.
* @return Created instruction prefix.
*/
static const InstructionPrefix XRELEASE() {
return create(FCML_PREFIX_XRELEASE);
}
/**
* Creates instruction prefix: BRANCH_HINT.
* @return Created instruction prefix.
*/
static const InstructionPrefix BRANCH_HINT() {
return create(FCML_PREFIX_BRANCH_HINT);
}
/**
* Creates instruction prefix: NOBRANCH_HINT.
* @return Created instruction prefix.
*/
static const InstructionPrefix NOBRANCH_HINT() {
return create(FCML_PREFIX_NOBRANCH_HINT);
}
public:
fcml_prefixes _prefix;
};
/** Wraps instruction hint and exposes factory methods for instruction hints.
* @since 1.1.0
*/
struct InstructionHint {
private:
/**
* Creates an instruction level hints for given native FCML hints.
* @param hints The hints set.
*/
InstructionHint(fcml_en_instruction_hints hints) :
_hint(hints) {
}
public:
/**
* Creates instruction hint: NO_HINTS.
* @return Instruction hint.
*/
static const InstructionHint NO_HINTS() {
return InstructionHint(FCML_HINT_NO_HINTS);
}
/**
* Creates instruction hint: NEAR_POINTER.
* @return Instruction hint.
*/
static const InstructionHint NEAR_POINTER() {
return InstructionHint(FCML_HINT_NEAR_POINTER);
}
/**
* Creates instruction hint: FAR_POINTER.
* @return Instruction hint.
*/
static const InstructionHint FAR_POINTER() {
return InstructionHint(FCML_HINT_FAR_POINTER);
}
/**
* Creates instruction hint: LONG_FORM_POINTER.
* @return Instruction hint.
*/
static const InstructionHint LONG_FORM_POINTER() {
return InstructionHint(FCML_HINT_LONG_FORM_POINTER);
}
/**
* Creates instruction hint: INDIRECT_POINTER.
* @return Instruction hint.
*/
static const InstructionHint INDIRECT_POINTER() {
return InstructionHint(FCML_HINT_INDIRECT_POINTER);
}
/**
* Creates instruction hint: DIRECT_POINTER.
* @return Instruction hint.
*/
static const InstructionHint DIRECT_POINTER() {
return InstructionHint(FCML_HINT_DIRECT_POINTER);
}
public:
fcml_en_instruction_hints _hint;
};
/** Wraps operand hint and exposes factory methods for instruction hints.
* @since 1.1.0
*/
struct OperandHint {
private:
OperandHint(fcml_en_operand_hints hint) :
_hint(hint) {
}
public:
/**
* Creates operand level hint: UNDEFIEND.
* @return Operand level hint.
*/
static const OperandHint UNDEFIEND() {
return OperandHint(FCML_OP_HINT_UNDEFIEND);
}
/**
* Creates operand level hint: MULTIMEDIA_INSTRUCTION.
* @return Operand level hint.
*/
static const OperandHint MULTIMEDIA() {
return OperandHint(FCML_OP_HINT_MULTIMEDIA_INSTRUCTION);
}
/**
* Creates operand level hint: DISPLACEMENT_RELATIVE_ADDRESS.
* @return Operand level hint.
*/
static const OperandHint DISPLACEMENT_RELATIVE_ADDRESS() {
return OperandHint(FCML_OP_HINT_DISPLACEMENT_RELATIVE_ADDRESS);
}
/**
* Creates operand level hint: PSEUDO_OPCODE.
* @return Operand level hint.
*/
static const OperandHint PSEUDO_OPCODE() {
return OperandHint(FCML_OP_HINT_PSEUDO_OPCODE);
}
/**
* Creates operand level hint: ABSOLUTE_ADDRESSING.
* @return Operand level hint.
*/
static const OperandHint ABSOLUTE_ADDRESSING() {
return OperandHint(FCML_OP_HINT_ABSOLUTE_ADDRESSING);
}
/**
* Creates operand level hint: RELATIVE_ADDRESSING.
* @return Operand level hint.
*/
static const OperandHint RELATIVE_ADDRESSING() {
return OperandHint(FCML_OP_HINT_RELATIVE_ADDRESSING);
}
/**
* Creates operand level hint: SIB_ENCODING.
* @return Operand level hint.
*/
static const OperandHint SIB_ENCODING() {
return OperandHint(FCML_OP_HINT_SIB_ENCODING);
}
public:
fcml_en_operand_hints _hint;
};
/**
* Holds instruction pointer, processor operating mode and memory segment flags.
* @since 1.1.0
*/
class EntryPoint {
public:
/**
* Supported operating modes.
* @since 1.1.0
*/
enum OperatingMode {
OM_16_BIT = FCML_OM_16_BIT,
OM_32_BIT = FCML_OM_32_BIT,
OM_64_BIT = FCML_OM_64_BIT
};
/**
* Creates an empty entry point instance.
* @since 1.1.0
*/
EntryPoint() :
_opMode(OM_32_BIT),
_addressSizeAttribute(FCML_DS_32),
_operandSizeAttribute(FCML_DS_32),
_ip(0) {
}
/**
* Creates an entry point instance for given processor operating mode, instruction pointer and optionally size attributes.
* @param opMode The processor operating mode.
* @param ip The instruction pointer.
* @param addressSizeAttribute The optional address size attribute.
* @param operandSizeAttribute The optional operand size attribute.
* @since 1.1.0
*/
EntryPoint(OperatingMode opMode, fcml_ip ip = 0, fcml_usize addressSizeAttribute = FCML_DS_UNDEF, fcml_usize operandSizeAttribute = FCML_DS_UNDEF ) :
_opMode(opMode),
_addressSizeAttribute(addressSizeAttribute),
_operandSizeAttribute(operandSizeAttribute),
_ip(ip) {
}
virtual ~EntryPoint() {
}
public:
/**
* Checks if two entry points are equal.
*
* @param ep The source entry point.
* @return True if they are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const EntryPoint &ep ) const {
return _opMode == ep._opMode &&
_ip == ep._ip &&
_operandSizeAttribute == ep._operandSizeAttribute &&
_addressSizeAttribute == ep._addressSizeAttribute;
}
/**
* Checks if two entry points are not equal.
*
* @param ep The source entry point.
* @return True if they are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const EntryPoint &ep ) const {
return !(ep == *this);
}
public:
/**
* Gets address size attribute held by the entry point.
*
* @return Address size attribute.
* @since 1.1.0
*/
fcml_usize getAddressSizeAttribute() const {
return _addressSizeAttribute;
}
/**
* Sets a new address size attribute for the entry point.
*
* @param addressSizeAttribute The address size attribute.
* @since 1.1.0
*/
void setAddressSizeAttribute( fcml_usize addressSizeAttribute ) {
_addressSizeAttribute = addressSizeAttribute;
}
/**
* Gets operand size attribute held by the entry point.
*
* @return Operand size attribute.
* @since 1.1.0
*/
fcml_usize getOperandSizeAttribute() const {
return _operandSizeAttribute;
}
/**
* Sets a new operand size attribute for the entry point.
*
* @param operandSizeAttribute The operand size attribute.
* @since 1.1.0
*/
void setOperandSizeAttribute( fcml_usize operandSizeAttribute ) {
_operandSizeAttribute = operandSizeAttribute;
}
/**
* Gets instruction pointer held by the entry point.
*
* @return Instruction pointer.
* @since 1.1.0
*/
fcml_ip getIP() const {
return _ip;
}
/**
* Sets a new instruction pointer for the entry point.
*
* @param ip The new instruction pointer.
* @since 1.1.0
*/
void setIP( fcml_ip ip ) {
_ip = ip;
}
/**
* Gets processor operating mode.
*
* @return Processor operating mode.
* @since 1.1.0
*/
OperatingMode getOpMode() const {
return _opMode;
}
/**
* Sets a new processor operating mode for the entry point.
*
* @param opMode The new processor operating mode.
* @since 1.1.0
*/
void setOpMode( OperatingMode opMode ) {
_opMode = opMode;
}
/**
* Increments the instruction pointer by given number of bytes.
*
* @param ip Number for bytes the instruction pointer should be incremented by.
* @since 1.1.0
*/
void incrementIP( fcml_ip ip ) {
_ip += ip;
}
private:
/** Processor operating mode */
OperatingMode _opMode;
/** Size of the address size attribute. */
fcml_usize _addressSizeAttribute;
/** Size of the operand size attribute. */
fcml_usize _operandSizeAttribute;
/** Instruction pointer. Content of the EIP/RIP register. */
fcml_ip _ip;
};
/**
* Represents integer value.
* @since 1.1.0
*/
class Integer {
public:
/** @since 1.1.0 */
Integer() :
_size( FCML_DS_64 ), _isSigned( FCML_FALSE ), _vint8( 0 ), _vint16( 0 ), _vint32( 0 ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_int8_t value ) :
_size( FCML_DS_8 ), _isSigned( FCML_TRUE ), _vint8( value ), _vint16( 0 ), _vint32( 0 ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_int16_t value ) :
_size( FCML_DS_16 ), _isSigned( FCML_TRUE ), _vint8( 0 ), _vint16( value ), _vint32( 0 ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_int32_t value ) :
_size( FCML_DS_32 ), _isSigned( FCML_TRUE ), _vint8( 0 ), _vint16( 0 ), _vint32( value ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_int64_t value ) :
_size( FCML_DS_64 ), _isSigned( FCML_TRUE ), _vint8( 0 ), _vint16( 0 ), _vint32( 0 ), _vint64( value ) {
}
/** @since 1.1.0 */
Integer( fcml_uint8_t value ) :
_size( FCML_DS_8 ), _isSigned( FCML_FALSE ), _vint8( static_cast<fcml_uint8_t>( value ) ), _vint16( 0 ), _vint32( 0 ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_uint16_t value ) :
_size( FCML_DS_16 ), _isSigned( FCML_FALSE ), _vint8( 0 ), _vint16( static_cast<fcml_uint16_t>( value ) ), _vint32( 0 ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_uint32_t value ) :
_size( FCML_DS_32 ), _isSigned( FCML_FALSE ), _vint8( 0 ), _vint16( 0 ), _vint32( static_cast<fcml_uint32_t>( value ) ), _vint64( 0 ) {
}
/** @since 1.1.0 */
Integer( fcml_uint64_t value ) :
_size( FCML_DS_64 ), _isSigned( FCML_FALSE ), _vint8( 0 ), _vint16( 0 ), _vint32( 0 ), _vint64( static_cast<fcml_uint64_t>( value ) ) {
}
/** @since 1.1.0 */
virtual ~Integer() {
}
public:
/** @since 1.1.0 */
fcml_int16_t getInt16() const {
return _vint16;
}
/** @since 1.1.0 */
Integer& setInt16( fcml_int16_t int16 ) {
_vint16 = int16;
return *this;
}
/** @since 1.1.0 */
fcml_int32_t getInt32() const {
return _vint32;
}
/** @since 1.1.0 */
Integer& setInt32( fcml_int32_t int32 ) {
_vint32 = int32;
return *this;
}
/** @since 1.1.0 */
fcml_int64_t getInt64() const {
return _vint64;
}
/** @since 1.1.0 */
Integer& setInt64( fcml_int64_t int64 ) {
_vint64 = int64;
return *this;
}
/** @since 1.1.0 */
fcml_int8_t getInt8() const {
return _vint8;
}
/** @since 1.1.0 */
Integer& setInt8( fcml_int8_t int8 ) {
_vint8 = int8;
return *this;
}
/** @since 1.1.0 */
fcml_bool isSigned() const {
return _isSigned;
}
/** @since 1.1.0 */
Integer& setSigned( fcml_bool isSigned ) {
_isSigned = isSigned;
return *this;
}
/** @since 1.1.0 */
fcml_usize getSize() const {
return _size;
}
/** @since 1.1.0 */
Integer& setSize( fcml_usize size ) {
_size = size;
return *this;
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_uint8_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_int8_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_uint16_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_int16_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_uint32_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_int32_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_uint64_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const fcml_int64_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are equal; otherwise false.
* @since 1.1.0
*/
bool operator==( const Integer &value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) == static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) == static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_uint8_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_int8_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_uint16_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_int16_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_uint32_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_int32_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_uint64_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const fcml_int64_t value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* Checks if the integer is not equal to the passed value.
*
* @param value The source value to be compared with the integer.
* @return True if values are not equal; otherwise false.
* @since 1.1.0
*/
bool operator!=( const Integer &value ) const {
return _isSigned ? static_cast<fcml_int64_t>( *this ) != static_cast<fcml_int64_t>( value ) : static_cast<fcml_uint64_t>( *this ) != static_cast<fcml_uint64_t>( value );
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong data size.
*/
operator fcml_int8_t() const {
fcml_int8_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_int8_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_int8_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_int8_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_int8_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong indeger size.
*/
operator fcml_uint8_t() const {
fcml_uint8_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_uint8_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_uint8_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_uint8_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_uint8_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_int16_t() const {
fcml_int16_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_int16_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_int16_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_int16_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_int16_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_uint16_t() const {
fcml_uint16_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_uint16_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_uint16_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_uint16_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_uint16_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_int32_t() const {
fcml_int32_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_int32_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_int32_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_int32_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_int32_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_uint32_t() const {
fcml_uint32_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_uint32_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_uint32_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_uint32_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_uint32_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_int64_t() const {
fcml_int64_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_int64_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_int64_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_int64_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_int64_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* A casting operator.
* @since 1.1.0
* @throw BadArgumentException Wrong integer size.
*/
operator fcml_uint64_t() const {
fcml_uint64_t result;
switch ( _size ) {
case FCML_DS_8:
result = static_cast<fcml_uint64_t>( _isSigned ? _vint8 : (fcml_uint8_t)_vint8 );
break;
case FCML_DS_16:
result = static_cast<fcml_uint64_t>( _isSigned ? _vint16 : (fcml_uint16_t)_vint16 );
break;
case FCML_DS_32:
result = static_cast<fcml_uint64_t>( _isSigned ? _vint32 : (fcml_uint32_t)_vint32 );
break;
case FCML_DS_64:
result = static_cast<fcml_uint64_t>( _isSigned ? _vint64 : (fcml_uint64_t)_vint64 );
break;
default:
throw BadArgumentException( FCML_TEXT( "Wrong size." ) );
}
return result;
}
/**
* Addition assignment.
* @since 1.1.0
*/
Integer& operator +=( const Integer &arg ) {
plus( *this, arg );
return ( *this );
}
/**
* Multiplication assignment.
* @since 1.1.0
*/
Integer& operator *=( const Integer &arg ) {
mul( *this, arg );
return ( *this );
}
/**
* Division assignment.
* @since 1.1.0
*/
Integer& operator /=( const Integer &arg ) {
div( *this, arg );
return ( *this );
}
/**
* Subtraction assignment.
* @since 1.1.0
*/
Integer& operator -=( const Integer &arg ) {
minus( *this, arg );
return ( *this );
}
/**
* Addition operator.
* @since 1.1.0
*/
Integer operator+( const Integer &src ) const {
const Integer &thisRef = *this;
Integer result( thisRef );
plus( result, src );
return result;
}
/**
* Subtraction operator.
* @since 1.1.0
*/
Integer operator-( const Integer &src ) const {
const Integer &thisRef = *this;
Integer result( thisRef );
minus( result, src );
return result;
}
/**
* Multiplication operator.
* @since 1.1.0
*/
Integer operator*( const Integer &src ) const {
const Integer &thisRef = *this;
Integer result( thisRef );
mul( result, src );
return result;
}
/**
* Division operator.
* @since 1.1.0
*/
Integer operator/( const Integer &src ) const {
const Integer &thisRef = *this;
Integer result( thisRef );
div( result, src );
return result;
}
public:
/**
* Factory method which creates an instance fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer int8( fcml_int8_t value ) {
return Integer( value );
}
/**
* Factory method which creates an instance fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer uint8( fcml_uint8_t value ) {
return Integer( value );
}
/**
* Factory method which creates an instance fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer int16( fcml_int16_t value ) {
return Integer( value );
}
/**
* Factory method which creates an instance fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer uint16( fcml_uint16_t value ) {
return Integer( value );
}
/**
* Factory method which creates an insatnce fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer int32( fcml_int32_t value ) {
return Integer( value );
}
/**
* Factory method which creates an insatnce fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer uint32( fcml_uint32_t value ) {
return Integer( value );
}
/**
* Factory method which creates an insatnce fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer int64( fcml_int64_t value ) {
return Integer( value );
}
/**
* Factory method which creates an insatnce fo the Integer for given parameter.
* @param value The value for the newly created Integer.
* @return The created Integer instance.
* @since 1.1.0
*/
static Integer uint64( fcml_uint64_t value ) {
return Integer( value );
}
private:
/**
* @remark An internal API.
* @since 1.1.0
*/
void minus( Integer &result, const Integer &src ) const {
callMathExpression( &doMinus, &doUMinus, result, src );
}
/**
* @remark An internal API.
* @since 1.1.0
*/
void mul( Integer &result, const Integer &src ) const {
callMathExpression( &doMul, &doUMul, result, src );
}
/**
* @remark An internal API.
* @since 1.1.0
*/
void div( Integer &result, const Integer &src ) const {
callMathExpression( &doDiv, &doUDiv, result, src );
}
/**
* @remark An internal API.
* @since 1.1.0
*/
void plus( Integer &result, const Integer &src ) const {
callMathExpression( &doPlus, &doUPlus, result, src );
}
private:
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_int64_t doPlus( fcml_int64_t thisValue, fcml_int64_t thatValue ) {
return thisValue + thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_int64_t doMinus( fcml_int64_t thisValue, fcml_int64_t thatValue ) {
return thisValue - thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_int64_t doMul( fcml_int64_t thisValue, fcml_int64_t thatValue ) {
return thisValue * thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_int64_t doDiv( fcml_int64_t thisValue, fcml_int64_t thatValue ) {
return thisValue / thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_uint64_t doUPlus( fcml_uint64_t thisValue, fcml_uint64_t thatValue ) {
return thisValue + thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_uint64_t doUMinus( fcml_uint64_t thisValue, fcml_uint64_t thatValue ) {
return thisValue - thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_uint64_t doUMul( fcml_uint64_t thisValue, fcml_uint64_t thatValue ) {
return thisValue * thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
static fcml_uint64_t doUDiv( fcml_uint64_t thisValue, fcml_uint64_t thatValue ) {
return thisValue / thatValue;
}
/**
* @remark An internal API.
* @since 1.1.0
*/
void callMathExpression( fcml_int64_t (*signedExpressionFn)( fcml_int64_t thisValue, fcml_int64_t thatValue ), fcml_uint64_t (*unsignedExpressionFn)( fcml_uint64_t thisValue, fcml_uint64_t thatValue ), Integer &result, const Integer &src ) const {
if( _isSigned ) {
fcml_int64_t thisValue;
fcml_int64_t thatValue;
// Prepare "that". It has to be converted to the same sign.
switch( src._size ) {
case FCML_DS_8:
thatValue = src._isSigned ? src._vint8 : static_cast<fcml_uint8_t>( src._vint8 );
break;
case FCML_DS_16:
thatValue = src._isSigned ? src._vint16 : static_cast<fcml_uint16_t>( src._vint16 );
break;
case FCML_DS_32:
thatValue = src._isSigned ? src._vint32 : static_cast<fcml_uint32_t>( src._vint32 );
break;
case FCML_DS_64:
thatValue = src._isSigned ? src._vint64 : static_cast<fcml_uint64_t>( src._vint64 );
break;
}
// Now "this".
switch( result._size ) {
case FCML_DS_8:
thisValue = result._isSigned ? result._vint8 : static_cast<fcml_uint8_t>(result._vint8 );
thisValue = (*signedExpressionFn)( thisValue, thatValue );
result._vint8 = static_cast<fcml_int8_t>( thisValue );
break;
case FCML_DS_16:
thisValue = result._isSigned ? result._vint16 : static_cast<fcml_uint16_t>( result._vint16 );
thisValue = (*signedExpressionFn)( thisValue, thatValue );
result._vint16 = static_cast<fcml_int16_t>( thisValue );
break;
case FCML_DS_32:
thisValue = result._isSigned ? result._vint32 : static_cast<fcml_uint32_t>( result._vint32 );
thisValue = (*signedExpressionFn)( thisValue, thatValue );
result._vint32 = static_cast<fcml_int32_t>( thisValue );
break;
case FCML_DS_64:
thisValue = result._isSigned ? result._vint64 : static_cast<fcml_uint64_t>( result._vint64 );
thisValue = (*signedExpressionFn)( thisValue, thatValue );
result._vint64 = thisValue;
break;
}
} else {
fcml_uint64_t thisValue;
fcml_uint64_t thatValue;
// Prepare "that". It has to be converted to the same sign.
switch( src._size ) {
case FCML_DS_8:
thatValue = src._isSigned ? src._vint8 : static_cast<fcml_uint8_t>( src._vint8 );
break;
case FCML_DS_16:
thatValue = src._isSigned ? src._vint16 : static_cast<fcml_uint16_t>( src._vint16 );
break;
case FCML_DS_32:
thatValue = src._isSigned ? src._vint32 : static_cast<fcml_uint32_t>( src._vint32 );
break;
case FCML_DS_64:
thatValue = src._isSigned ? src._vint64 : static_cast<fcml_uint64_t>( src._vint64 );
break;
}
// Now "this".
switch( result._size ) {
case FCML_DS_8:
thisValue = result._isSigned ? result._vint8 : static_cast<fcml_uint8_t>( result._vint8 );
thisValue = (*unsignedExpressionFn)( thisValue, thatValue );
result._vint8 = static_cast<fcml_int8_t>( thisValue );
break;
case FCML_DS_16:
thisValue = result._isSigned ? result._vint16 : static_cast<fcml_uint16_t>( result._vint16 );
thisValue = (*unsignedExpressionFn)( thisValue, thatValue );
result._vint16 = static_cast<fcml_int16_t>( thisValue );
break;
case FCML_DS_32:
thisValue = result._isSigned ? result._vint32 : static_cast<fcml_uint32_t>( result._vint32 );
thisValue = (*unsignedExpressionFn)( thisValue, thatValue );
result._vint32 = static_cast<fcml_int32_t>( thisValue );
break;
case FCML_DS_64:
thisValue = result._isSigned ? result._vint64 : static_cast<fcml_uint64_t>( result._vint64 );
thisValue = (*unsignedExpressionFn)( thisValue, thatValue );
result._vint64 = thisValue;
break;
}
}
}
private:
fcml_usize _size;
fcml_bool _isSigned;
fcml_int8_t _vint8;
fcml_int16_t _vint16;
fcml_int32_t _vint32;
fcml_int64_t _vint64;
};
/**
* x86 - 64 register representation.
* @since 1.1.0
*/
class Register {
public:
/** Register types.
* @since 1.1.0
*/
enum RegisterType {
/** Undefined register type. */
REG_UNDEFINED = FCML_REG_UNDEFINED,
/** General purpose register. */
REG_GPR = FCML_REG_GPR,
/** SIMD (SSE, MMX) register. */
REG_SIMD = FCML_REG_SIMD,
/** FPU register. */
REG_FPU = FCML_REG_FPU,
/** Segment register */
REG_SEG = FCML_REG_SEG,
/** Control register. */
REG_CR = FCML_REG_CR,
/** Debug register */
REG_DR = FCML_REG_DR,
/** Instruction pointer register. Used for relative RIP addressing. */
REG_IP = FCML_REG_IP
};
/**
* Creates an empty register instance.
* @since 1.1.0
*/
Register() :
_type(REG_UNDEFINED),
_size(0),
_reg(0),
_x64_exp(FCML_FALSE) {
}
/**
* Creates a register instance for given register structure.
* @param reg The source register as the FCML structure.
* @since 1.1.0
*/
Register( const fcml_st_register ® ) :
_type(static_cast<RegisterType>( reg.type )),
_size(reg.size),
_reg(reg.reg),
_x64_exp(reg.x64_exp? true : false) {
}
/**
* Creates a register instance for given parameters.
* @param reg The FCML register number.
* @param size The register size.
* @param type The register type.
* @param x64_exp True if it's a 8-bit general purpose register for REX aware instruction. See manual.
* @since 1.1.0
*/
Register( fcml_uint8_t reg, fcml_usize size, RegisterType type = REG_GPR, fcml_bool x64_exp = FCML_FALSE ) :
_type(type),
_size(size),
_reg(reg),
_x64_exp(x64_exp?true:false) {
}
/**
* @since 1.1.0
*/
virtual ~Register() {
}
public:
/**
* Gets the register number.
* @return The register number.
* @since 1.1.0
*/
fcml_uint8_t getReg() const {
return _reg;
}
/**
* Sets the register number.
* @param reg The register number.
* @since 1.1.0
*/
void setReg( fcml_uint8_t reg ) {
_reg = reg;
}
/**
* Gets the register size.
* @return The register size.
* @since 1.1.0
*/
fcml_usize getSize() const {
return _size;
}
/**
* Sets the register size.
* @param size The register size.
* @since 1.1.0
*/
void setSize( fcml_usize size ) {
_size = size;
}
/**
* Gets the register type.
* @return The register type.
* @since 1.1.0
*/
RegisterType getType() const {
return _type;
}
/**
* Sets the register type.
* @param type The register type.
* @since 1.1.0
*/
void setType( RegisterType type ) {
_type = type;
}
/**
* Gets true if it's a 8-bit general purpose register for REX aware instruction. See manual.
* @return True if it's a 8-bit general purpose register for REX aware instruction. See manual..
* @since 1.1.0
*/
bool getX64Exp() const {
return _x64_exp;
}
/**
* Sets x64exp flag, see manual.
* @param x64Exp The flag value.
* @since 1.1.0
*/
void setX64Exp( bool x64Exp ) {
_x64_exp = x64Exp;
}
public:
/**
* Compares registers.
* @param reg The source register.
* @return True if registers are equal.
* @since 1.1.0
*/
bool operator==( const Register ® ) const {
return _reg == reg._reg && _type == reg._type && _size == reg._size && _x64_exp == reg._x64_exp;
}
/**
* Compares registers.
* @param reg The source register.
* @return True if registers are NOT equal.
* @since 1.1.0
*/
bool operator!=( const Register ® ) const {
return !( reg == *this );
}
public:
/**
* Factory method for an undefined register.
* @return A register instance.
* @since 1.1.0
*/
static const Register UNDEF() {
Register reg( 0, 0, Register::REG_UNDEFINED, FCML_FALSE );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register AL() {
Register reg( ::fcml_reg_AL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register AX() {
Register reg( ::fcml_reg_AX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EAX() {
Register reg( ::fcml_reg_EAX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RAX() {
Register reg( ::fcml_reg_RAX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM0() {
Register reg( ::fcml_reg_MM0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM0() {
Register reg( ::fcml_reg_XMM0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM0() {
Register reg( ::fcml_reg_YMM0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CL() {
Register reg( ::fcml_reg_CL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CX() {
Register reg( ::fcml_reg_CX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ECX() {
Register reg( ::fcml_reg_ECX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RCX() {
Register reg( ::fcml_reg_RCX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM1() {
Register reg( ::fcml_reg_MM1 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM1() {
Register reg( ::fcml_reg_XMM1 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM1() {
Register reg( ::fcml_reg_YMM1 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DL() {
Register reg( ::fcml_reg_DL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DX() {
Register reg( ::fcml_reg_DX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EDX() {
Register reg( ::fcml_reg_EDX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RDX() {
Register reg( ::fcml_reg_RDX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM2() {
Register reg( ::fcml_reg_MM2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM2() {
Register reg( ::fcml_reg_XMM2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM2() {
Register reg( ::fcml_reg_YMM2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register BL() {
Register reg( ::fcml_reg_BL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register BX() {
Register reg( ::fcml_reg_BX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EBX() {
Register reg( ::fcml_reg_EBX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RBX() {
Register reg( ::fcml_reg_RBX );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM3() {
Register reg( ::fcml_reg_MM3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM3() {
Register reg( ::fcml_reg_XMM3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM3() {
Register reg( ::fcml_reg_YMM3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register AH() {
Register reg( ::fcml_reg_AH );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register SPL() {
Register reg( ::fcml_reg_SPL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register SP() {
Register reg( ::fcml_reg_SP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ESP() {
Register reg( ::fcml_reg_ESP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RSP() {
Register reg( ::fcml_reg_RSP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM4() {
Register reg( ::fcml_reg_MM4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM4() {
Register reg( ::fcml_reg_XMM4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM4() {
Register reg( ::fcml_reg_YMM4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CH() {
Register reg( ::fcml_reg_CH );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register BPL() {
Register reg( ::fcml_reg_BPL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register BP() {
Register reg( ::fcml_reg_BP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EBP() {
Register reg( ::fcml_reg_EBP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RBP() {
Register reg( ::fcml_reg_RBP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM5() {
Register reg( ::fcml_reg_MM5 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM5() {
Register reg( ::fcml_reg_XMM5 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM5() {
Register reg( ::fcml_reg_YMM5 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DH() {
Register reg( ::fcml_reg_DH );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register SIL() {
Register reg( ::fcml_reg_SIL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register SI() {
Register reg( ::fcml_reg_SI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ESI() {
Register reg( ::fcml_reg_ESI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RSI() {
Register reg( ::fcml_reg_RSI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM6() {
Register reg( ::fcml_reg_MM6 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM6() {
Register reg( ::fcml_reg_XMM6 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM6() {
Register reg( ::fcml_reg_YMM6 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register BH() {
Register reg( ::fcml_reg_BH );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DIL() {
Register reg( ::fcml_reg_DIL );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DI() {
Register reg( ::fcml_reg_DI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EDI() {
Register reg( ::fcml_reg_EDI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RDI() {
Register reg( ::fcml_reg_RDI );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register MM7() {
Register reg( ::fcml_reg_MM7 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM7() {
Register reg( ::fcml_reg_XMM7 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM7() {
Register reg( ::fcml_reg_YMM7 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R8L() {
Register reg( ::fcml_reg_R8L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R8W() {
Register reg( ::fcml_reg_R8W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R8D() {
Register reg( ::fcml_reg_R8D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R8() {
Register reg( ::fcml_reg_R8 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM8() {
Register reg( ::fcml_reg_XMM8 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM8() {
Register reg( ::fcml_reg_YMM8 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R9L() {
Register reg( ::fcml_reg_R9L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R9W() {
Register reg( ::fcml_reg_R9W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R9D() {
Register reg( ::fcml_reg_R9D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R9() {
Register reg( ::fcml_reg_R9 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM9() {
Register reg( ::fcml_reg_XMM9 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM9() {
Register reg( ::fcml_reg_YMM9 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R10L() {
Register reg( ::fcml_reg_R10L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R10W() {
Register reg( ::fcml_reg_R10W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R10D() {
Register reg( ::fcml_reg_R10D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R10() {
Register reg( ::fcml_reg_R10 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM10() {
Register reg( ::fcml_reg_XMM10 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM10() {
Register reg( ::fcml_reg_YMM10 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R11L() {
Register reg( ::fcml_reg_R11L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R11W() {
Register reg( ::fcml_reg_R11W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R11D() {
Register reg( ::fcml_reg_R11D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R11() {
Register reg( ::fcml_reg_R11 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM11() {
Register reg( ::fcml_reg_XMM11 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM11() {
Register reg( ::fcml_reg_YMM11 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R12L() {
Register reg( ::fcml_reg_R12L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R12W() {
Register reg( ::fcml_reg_R12W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R12D() {
Register reg( ::fcml_reg_R12D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R12() {
Register reg( ::fcml_reg_R12 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM12() {
Register reg( ::fcml_reg_XMM12 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM12() {
Register reg( ::fcml_reg_YMM12 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R13L() {
Register reg( ::fcml_reg_R13L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R13W() {
Register reg( ::fcml_reg_R13W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R13D() {
Register reg( ::fcml_reg_R13D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R13() {
Register reg( ::fcml_reg_R13 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM13() {
Register reg( ::fcml_reg_XMM13 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM13() {
Register reg( ::fcml_reg_YMM13 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R14L() {
Register reg( ::fcml_reg_R14L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R14W() {
Register reg( ::fcml_reg_R14W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R14D() {
Register reg( ::fcml_reg_R14D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R14() {
Register reg( ::fcml_reg_R14 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM14() {
Register reg( ::fcml_reg_XMM14 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM14() {
Register reg( ::fcml_reg_YMM14 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R15L() {
Register reg( ::fcml_reg_R15L );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R15W() {
Register reg( ::fcml_reg_R15W );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R15D() {
Register reg( ::fcml_reg_R15D );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register R15() {
Register reg( ::fcml_reg_R15 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register XMM15() {
Register reg( ::fcml_reg_XMM15 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register YMM15() {
Register reg( ::fcml_reg_YMM15 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ES() {
Register reg( ::fcml_reg_ES );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CS() {
Register reg( ::fcml_reg_CS );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register SS() {
Register reg( ::fcml_reg_SS );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DS() {
Register reg( ::fcml_reg_DS );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register FS() {
Register reg( ::fcml_reg_FS );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register GS() {
Register reg( ::fcml_reg_GS );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST0() {
Register reg( ::fcml_reg_ST0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST1() {
Register reg( ::fcml_reg_ST1 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST2() {
Register reg( ::fcml_reg_ST2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST3() {
Register reg( ::fcml_reg_ST3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST4() {
Register reg( ::fcml_reg_ST4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST5() {
Register reg( ::fcml_reg_ST5 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST6() {
Register reg( ::fcml_reg_ST6 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register ST7() {
Register reg( ::fcml_reg_ST7 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CR0() {
Register reg( ::fcml_reg_CR0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CR2() {
Register reg( ::fcml_reg_CR2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CR3() {
Register reg( ::fcml_reg_CR3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CR4() {
Register reg( ::fcml_reg_CR4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register CR8() {
Register reg( ::fcml_reg_CR8 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR0() {
Register reg( ::fcml_reg_DR0 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR1() {
Register reg( ::fcml_reg_DR1 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR2() {
Register reg( ::fcml_reg_DR2 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR3() {
Register reg( ::fcml_reg_DR3 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR4() {
Register reg( ::fcml_reg_DR4 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR5() {
Register reg( ::fcml_reg_DR5 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR6() {
Register reg( ::fcml_reg_DR6 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register DR7() {
Register reg( ::fcml_reg_DR7 );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register IP() {
Register reg( ::fcml_reg_IP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register EIP() {
Register reg( ::fcml_reg_EIP );
return reg;
}
/**
* Factory method for a register.
* @return A register instance.
* @since 1.1.0
*/
static const Register RIP() {
Register reg( ::fcml_reg_RIP );
return reg;
}
private:
/** Register type. */
RegisterType _type;
/** Register size in bits. */
fcml_usize _size;
/** Register itself as a positive integer. @see REGISTERS_GROUP */
fcml_uint8_t _reg;
/** In case of SPL,BPL,SIL,DIL GPR registers has to be set to true. */
bool _x64_exp;
};
/**
* Describes far pointer.
* @since 1.1.0
*/
class FarPointer {
public:
/**
* Creates an far pointer instance.
* @since 1.1.0
*/
FarPointer() :
_segment(0),
_offset_size(0),
_offset16(0),
_offset32(0) {
}
/**
* Creates an far pointer instance.
* @param segment A segment selector.
* @param offset16 A 16-bit offset in the given segment.
* @since 1.1.0
*/
FarPointer( fcml_uint16_t segment, fcml_int16_t offset16 ) :
_segment(segment),
_offset_size(FCML_DS_16),
_offset16(offset16),
_offset32(0) {
}
/**
* Creates an far pointer instance.
* @param segment A segment selector.
* @param offset32 A 32-bit offset in the given segment.
* @since 1.1.0
*/
FarPointer( fcml_uint16_t segment, fcml_int32_t offset32 ) :
_segment(segment),
_offset_size(FCML_DS_32),
_offset16(0),
_offset32(offset32) {
}
virtual ~FarPointer() {
}
public:
/**
* Compares two far pointers.
* @param fp The far pointer to be compared with the current one.
* @return True if they are equal.
* @since 1.1.0
*/
bool operator==( const FarPointer &fp ) const {
fcml_int32_t thisOffset;
switch( _offset_size ) {
case FCML_DS_32:
thisOffset = _offset32;
break;
case FCML_DS_16:
thisOffset = _offset16;
break;
}
fcml_int32_t thatOffset;
switch( fp._offset_size ) {
case FCML_DS_32:
thatOffset = fp._offset32;
break;
case FCML_DS_16:
thatOffset = fp._offset16;
break;
}
return thisOffset == thatOffset;
}
/**
* Compares two far pointers.
* @param fp The far pointer to be compared with the current one.
* @return True if they are NOT equal.
* @since 1.1.0
*/
bool operator!=( const FarPointer &fp) const {
return !(fp == *this);
}
public:
/**
* Creates FarPointer instance for 16 bit segment and 16-bit offset.
*
* @param segment Segment selector.
* @param offset 16-bit address.
* @return FarPointer instance.
* @since 1.1.0
*/
static FarPointer off16( fcml_uint16_t segment, fcml_int16_t offset ) {
return FarPointer(segment, offset);
}
/**
* Creates FarPointer instance for 16 bit segment and 32-bit offset.
*
* @param segment Segment selector.
* @param offset 32-bit address.
* @return FarPointer instance.
*/
static FarPointer off32( fcml_uint16_t segment, fcml_int32_t offset ) {
return FarPointer(segment, offset);
}
public:
/**
* Gets offset size.
*
* @return Offset size.
* @since 1.1.0
*/
fcml_usize getOffsetSize() const {
return _offset_size;
}
/**
* Sets offset size.
*
* @param offsetSize The new offset size to be set.
* @since 1.1.0
*/
void setOffsetSize( fcml_usize offsetSize ) {
_offset_size = offsetSize;
}
/**
* Gets the 16-bit offset.
*
* @return 16-bit offset.
* @since 1.1.0
*/
fcml_int16_t getOffset16() const {
return _offset16;
}
/**
* Sets 16-bit offset.
*
* @param offset16 Sets 16-bit offset.
* @since 1.1.0
*/
void setOffset16( fcml_int16_t offset16 ) {
_offset16 = offset16;
}
/**
* Gets 32-bit offset.
*
* @return 32-bit offset.
* @since 1.1.0
*/
fcml_int32_t getOffset32() const {
return _offset32;
}
/**
* Sets 32-bit offset.
*
* @param offset32 Sets 32-bit offset.
* @since 1.1.0
*/
void setOffset32( fcml_int32_t offset32 ) {
_offset32 = offset32;
}
/**
* Gets segment selector.
*
* @return 16-bit segment selector.
* @since 1.1.0
*/
fcml_uint16_t getSegment() const {
return _segment;
}
/**
* Sets segment selector.
*
* @param segment Segment selector.
* @since 1.1.0
*/
void setSegment( fcml_uint16_t segment ) {
_segment = segment;
}
private:
/** 16-bit Code segment. */
fcml_uint16_t _segment;
/** Size of the offset. */
fcml_usize _offset_size;
/** 16-bit offset. */
fcml_int16_t _offset16;
/** 32-bit offset. */
fcml_int32_t _offset32;
};
/**
* Describes segment register.
* @since 1.1.0
*/
class SegmentSelector {
public:
/**
* Creates an empty segment selector instance.
* @since 1.1.0
*/
SegmentSelector() :
_segmentSelector(),
_isDefaultReg(false) {
}
/**
* Creates a segment selector instance for given parameters.
* @param segmentSelector A segment register.
* @param isDefaultReg Information if the register is the default one.
* @since 1.1.0
*/
SegmentSelector( const Register &segmentSelector, bool isDefaultReg = FCML_TRUE ) :
_segmentSelector(segmentSelector),
_isDefaultReg(isDefaultReg) {
}
virtual ~SegmentSelector() {
}
public:
/**
* Checks if two segment selector are equal.
* @param segmentSelector The source segment selector.
* @return True if they are equal.
* @since 1.1.0
*/
bool operator==( const SegmentSelector &segmentSelector ) const {
// It really doesn't matter if it is the default segment register in a given context.
return segmentSelector._segmentSelector == _segmentSelector;
}
/**
* Checks if two segment selector are not equal.
* @param segmentSelector The source segment selector.
* @return True if they are NOT equal.
* @since 1.1.0
*/
bool operator!=( const SegmentSelector &segmentSelector ) const {
return !(*this == segmentSelector);
}
/**
* Casting operator.
* @return The segment register.
* @since 1.1.0
*/
operator Register() const {
return _segmentSelector;
}
/**
* Copies one segment selector to another.
* @param reg The source segment selector.
* @return The destination segment selector.
* @since 1.1.0
*/
SegmentSelector& operator=( const SegmentSelector ® ) {
if( ® != this ) {
_isDefaultReg = reg._isDefaultReg;
_segmentSelector = reg._segmentSelector;
}
return *this;
}
public:
/**
* Creates segment selector for the given register.
*
* @param segmentSelector Segment register.
* @param isDefaultReg True if the register is the default one in the given context.
* @return Prepared segment selector.
* @since 1.1.0
*/
static SegmentSelector seg( const Register &segmentSelector, bool isDefaultReg ) {
return SegmentSelector( segmentSelector, isDefaultReg );
}
public:
/**
* Returns true if a register stored in the segment selector is the default one
* in the context the segment selector is used.
*
* @return True if register is the default one.
* @since 1.1.0
*/
bool isDefaultReg() const {
return _isDefaultReg;
}
/**
* Sets "default" flag for the segment selector.
*
* @param isDefaultReg True if the register is the default one in the given context.
* @since 1.1.0
*/
void setDefaultReg( bool isDefaultReg ) {
_isDefaultReg = isDefaultReg;
}
/**
* Gets constant segment register associated with the selector.
*
* @return Constant segment register.
* @since 1.1.0
*/
const Register& getSegmentSelector() const {
return _segmentSelector;
}
/**
* Gets segment register associated with the selector.
*
* @return Segment register.
* @since 1.1.0
*/
Register& getSegmentSelector() {
return _segmentSelector;
}
/**
* Sets segment register for the selector.
*
* @param segmentSelector Segment register.
* @since 1.1.0
*/
void setSegmentSelector( const Register& segmentSelector ) {
_segmentSelector = segmentSelector;
}
private:
/** Segment register. */
Register _segmentSelector;
/** True if this is a default segment register. */
bool _isDefaultReg;
};
/**
* Describes effective address.
*
* It's a counterpart to the fcml_st_effective_address structure.
* @since 1.1.0
*/
class EffectiveAddress {
public:
/**
* Creates an empry effective address.
* @since 1.1.0
*/
EffectiveAddress() :
_scaleFactor(0){
}
/**
* Creates an effective address instance with the displacement only.
* @param displacement The displacement value.
* @since 1.1.0
*/
EffectiveAddress( const Integer &displacement ) :
_scaleFactor(0),
_displacement(displacement) {
}
/**
* Creates an effective address instance with the base register only.
* @param base The base register.
* @since 1.1.0
*/
EffectiveAddress( const Register &base ) :
_base(base),
_scaleFactor(0) {
}
/**
* Creates an effective address instance with the base register and displacement only.
* @param base The base register.
* @param displacement The displacement value.
* @since 1.1.0
*/
EffectiveAddress( const Register &base, const Integer &displacement ) :
_base(base),
_scaleFactor(0),
_displacement(displacement) {
}
/**
* Creates an effective address instance with the index register, scale factor and displacement.
* @param index The index register.
* @param scaleFactor The scale factor value.
* @param displacement The displacement.
* @since 1.1.0
*/
EffectiveAddress( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) :
_index(index),
_scaleFactor(scaleFactor),
_displacement(displacement) {
}
/**
* Creates an effective address instance with the base register and index register.
* @param base The base register.
* @param index The index register.
* @since 1.1.0
*/
EffectiveAddress( const Register &base, const Register &index ) :
_base(base),
_index(index),
_scaleFactor(0) {
}
/**
* Creates an effective address instance with the base register, index register and scale factor set.
* @param base The base register.
* @param index THe index register.
* @param scaleFactor The scale factor.
* @since 1.1.0
*/
EffectiveAddress( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) :
_base(base),
_index(index),
_scaleFactor(scaleFactor) {
}
/**
* Creates an effective address instance with the base register, index register, scale factor and displacement set.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor value.
* @param displacement The displacement.
* @since 1.1.0
*/
EffectiveAddress( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) :
_base(base),
_index(index),
_scaleFactor(scaleFactor),
_displacement(displacement) {
}
/**
* @since 1.1.0
*/
virtual ~EffectiveAddress() {
}
public:
/**
* Checks whether two effective addresses are equal or not.
* @param address The source address to be compared.
* @return True if they are equal.
* @since 1.1.0
*/
bool operator==( const EffectiveAddress &address ) const {
if( &address == this ) {
return true;
}
return _base == address._base &&
_index == address._index &&
_scaleFactor == address._scaleFactor &&
_displacement == address._displacement;
}
/**
* Checks whether two effective addresses are equal or not.
* @param address The source address to be compared.
* @return True if they are NOT equal.
* @since 1.1.0
*/
bool operator!=( const EffectiveAddress &address ) const {
return !(address == *this);
}
public:
/**
* Factory method which creates an effective address instance with the displacement only.
* @param displacement The displacement value.
* @since 1.1.0
*/
static EffectiveAddress addr( const Integer &displacement ) {
return EffectiveAddress( displacement );
}
/**
* Factory method which creates an effective address instance with the base register only.
* @param base The base register.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &base ) {
return EffectiveAddress( base );
}
/**
* Factory method which creates an effective address instance with the base register and displacement.
* @param base The base register.
* @param displacement The displacement value.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &base, const Integer &displacement ) {
return EffectiveAddress( base, displacement );
}
/**
* Factory method which creates an effective address instance with the index register, scale factor and displacement.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return EffectiveAddress( index, scaleFactor, displacement );
}
/**
* Factory method which creates an effective address instance with the base register and index register.
* @param base The base register.
* @param index The index register.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &base, const Register &index ) {
return EffectiveAddress( base, index, 0 );
}
/**
* Factory method which creates an effective address instance with the base register, index register and scale factor.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
return EffectiveAddress( base, index, scaleFactor );
}
/**
* Factory method which creates an effective address instance with the base register, index register, scale factor and displacement.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @since 1.1.0
*/
static EffectiveAddress addr( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return EffectiveAddress( base, index, scaleFactor, displacement );
}
public:
/**
* Gets the constant base register associated with the effective address.
*
* @return The constant base register.
* @since 1.1.0
*/
const Register& getBase() const {
return _base;
}
/**
* Gets the base register associated with the effective address.
*
* @return The base register.
* @since 1.1.0
*/
Register& getBase() {
return _base;
}
/**
* Sets a new base register for the effective address.
*
* @param base The new base register to be set.
* @return Effective address itself.
* @since 1.1.0
*/
EffectiveAddress& setBase( const Register &base ) {
_base = base;
return *this;
}
/**
* Gets the constant displacement associated with the effective address.
*
* @return The constant displacement.
* @since 1.1.0
*/
const Integer& getDisplacement() const {
return _displacement;
}
/**
* Gets the displacement associated with the effective address.
*
* @return The displacement.
* @since 1.1.0
*/
Integer& getDisplacement() {
return _displacement;
}
/**
* Sets a new displacement value for the effective address.
*
* @param displacement The new displacement for effective address.
* @return The effective address itself.
* @since 1.1.0
*/
EffectiveAddress& setDisplacement( const Integer &displacement ) {
_displacement = displacement;
return *this;
}
/**
* Gets the constant index register associated with the effective address.
*
* @return The index register.
* @since 1.1.0
*/
const Register& getIndex() const {
return _index;
}
/**
* Gets the index register associated with the effective address.
*
* @return The index register.
* @since 1.1.0
*/
Register& getIndex() {
return _index;
}
/**
* Sets a new index register for the effective address.
*
* @param index The new index register for the effective address.
* @return The effective address itself.
* @since 1.1.0
*/
EffectiveAddress& setIndex( const Register &index ) {
_index = index;
return *this;
}
/**
* Gets a scale factor value associated with the effective address.
*
* @return The scale factor.
* @since 1.1.0
*/
fcml_uint8_t getScaleFactor() const {
return _scaleFactor;
}
/**
* Sets a new scale factor for the effective address.
*
* @param scaleFactor The new scale factor value.
* @return Effective address itself.
* @since 1.1.0
*/
EffectiveAddress& setScaleFactor( fcml_uint8_t scaleFactor ) {
_scaleFactor = scaleFactor;
return *this;
}
private:
/** Base register. */
Register _base;
/** Index register. */
Register _index;
/** Scale factor. */
fcml_uint8_t _scaleFactor;
/** Displacement. */
Integer _displacement;
};
/** Address operand.
*
* It's a counterpart to the fcml_st_address structure.
* @since 1.1.0
*/
class Address {
public:
/** Addressing type, see fcml_en_address_form enumerator.
* @since 1.1.0
*/
enum AddressForm {
/** Default value set if memory addressing hasn't been configured. */
AF_UNDEFINED = FCML_AF_UNDEFINED,
/** Absolute offset (address). */
AF_OFFSET = FCML_AF_OFFSET,
/** Effective address combined from address components like base register, index registers, factor, displacement etc... */
AF_COMBINED = FCML_AF_COMBINED
};
/**
* Creates an empty address.
* @since 1.1.0
*/
Address() :
_size_operator( FCML_DS_UNDEF ),
_address_form( AF_UNDEFINED ) {
}
/**
* Creates an address instance with an offset and optional size operator set.
*
* @param offset Offset to be set for the address.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @since 1.1.0
*/
Address( const Integer &offset, fcml_usize sizeOperator = FCML_DS_UNDEF ) :
_size_operator( sizeOperator ),
_address_form( AF_OFFSET ),
_offset( offset ) {
}
/**
* Creates an address instance with an effective address and optional size operator set.
*
* @param effectiveAddress The effective address to be set for the address.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @since 1.1.0
*/
Address( const EffectiveAddress &effectiveAddress, fcml_usize sizeOperator = FCML_DS_UNDEF ) :
_size_operator( sizeOperator ),
_address_form( AF_COMBINED ),
_effective_address( effectiveAddress ) {
}
/**
* Creates an address instance with an effective address, segment selector and optional size operator set.
*
* @param effectiveAddress The effective address to be set for the address.
* @param segmentSelector The segment selector.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @since 1.1.0
*/
Address( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector, fcml_usize sizeOperator = FCML_DS_UNDEF ) :
_size_operator( sizeOperator ),
_address_form( AF_COMBINED ),
_segment_selector( segmentSelector ),
_effective_address( effectiveAddress ) {
}
/** @since 1.1.0 */
virtual ~Address() {
}
public:
/**
* Factory method which creates an effective address instance with the displacement only.
* @param displacement The displacement value.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the base register only.
* @param base The base register.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &base, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( base ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the base register and displacement.
* @param base The base register.
* @param displacement The displacement value.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &base, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( base, displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the index register, scale factor and displacement.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( index, scaleFactor, displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the base register and index register.
* @param base The base register.
* @param index The index register.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &base, const Register &index, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( base, index, 0 ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the base register, index register and scale factor.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &base, const Register &index, fcml_uint8_t scaleFactor, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( base, index, scaleFactor ), sizeOperator );
}
/**
* Factory method which creates an effective address instance with the base register, index register, scale factor and displacement.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator Size operator.
* @since 1.1.0
*/
static Address effective( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return effective( EffectiveAddress( base, index, scaleFactor, displacement ), sizeOperator );
}
public:
/**
* Checks if two addresses are equal or not.
* @param address The address to be compared with the current one.
* @return True if they are equal.
* @since 1.1.0
*/
bool operator==( const Address &address ) const {
if( &address == this ) {
return true;
}
return _size_operator == address._size_operator &&
_address_form == address._address_form &&
_segment_selector == address._segment_selector &&
_effective_address == address._effective_address &&
_offset == address._offset;
}
/**
* Checks if two addresses are equal or not.
* @param address The address to be compared with the current one.
* @return True if they are NOT equal.
* @since 1.1.0
*/
bool operator!=( const Address &address ) const {
return !(address == *this );
}
public:
/**
* Factor method which creates an instance of the address for an effective address, segment selector and optional size operator.
*
* @param effectiveAddress The effective address to be set for the address.
* @param segmentSelector The segment selector.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @return The created address instance.
* @since 1.1.0
*/
static Address effective( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Address( effectiveAddress, segmentSelector, sizeOperator );
}
/**
* Factor method which creates an address instance with an effective address and optional size operator set.
*
* @param effectiveAddress The effective address to be set for the address.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @return The created address instance.
* @since 1.1.0
*/
static Address effective( const EffectiveAddress &effectiveAddress, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Address( effectiveAddress, sizeOperator );
}
/**
* Factor method which creates an address instance with an offset and optional size operator set.
*
* @param offset The offset to be set for the address.
* @param sizeOperator The optional size operator, set to FCML_DS_UNDEF by default.
* @return The created address instance.
* @since 1.1.0
*/
static Address offset( const Integer &offset, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Address( offset, sizeOperator );
}
public:
/**
* Returns true if address holds effective address.
*
* @return Returns true if address holds effective address.
* @since 1.1.0
*/
bool isEffectiveAddress() const {
return _address_form == AF_COMBINED;
}
/**
* Returns true if address holds an offset only.
*
* @return Returns true if address holds an offset only.
* @since 1.1.0
*/
bool isOffset() const {
return _address_form == AF_OFFSET;
}
/**
* Gets an address form. See fcml_en_address_form for more details.
*
* @return The address form.
* @since 1.1.0
*/
AddressForm getAddressForm() const {
return _address_form;
}
/**
* Sets a new address form for the effective address.
*
* @param addressForm The address form to be set for the effective address.
*
* @return Address itself.
* @since 1.1.0
*/
Address& setAddressForm( AddressForm addressForm ) {
_address_form = addressForm;
return *this;
}
/**
* Gets reference to the constant effective address associated with the address.
*
* @return The constant effective address.
* @since 1.1.0
*/
const EffectiveAddress& getEffectiveAddress() const {
return _effective_address;
}
/**
* Gets reference to the effective address associated with the address.
*
* @return The effective address.
* @since 1.1.0
*/
EffectiveAddress& getEffectiveAddress() {
return _effective_address;
}
/**
* Sets a new effective address for the address.
*
* @param effectiveAddress The new address to be set for the effective address.
* @return The address itself.
* @since 1.1.0
*/
Address& setEffectiveAddress( const EffectiveAddress& effectiveAddress ) {
_effective_address = effectiveAddress;
return *this;
}
/**
* Gets the constant offset associated with the address.
*
* @return The offset associated with the address.
* @since 1.1.0
*/
const Integer& getOffset() const {
return _offset;
}
/**
* Gets the offset associated with the address.
*
* @return The offset associated with the address.
* @since 1.1.0
*/
Integer& getOffset() {
return _offset;
}
/**
* Sets a new offset for the address.
*
* @param offset The enw offset to be set for the address.
* @return The address itself.
* @since 1.1.0
*/
Address& setOffset( const Integer &offset ) {
this->_offset = offset;
return *this;
}
/**
* Gets the constant segment selector associated with the address.
*
* @return The segment selector associated with the address.
* @since 1.1.0
*/
const SegmentSelector& getSegmentSelector() const {
return _segment_selector;
}
/**
* Gets the segment selector associated with the address.
*
* @return The segment selector associated with the address.
* @since 1.1.0
*/
SegmentSelector& getSegmentSelector() {
return _segment_selector;
}
/**
* Sets a new segment selector for the address.
*
* @param segmentSelector The new segment selector for the address.
* @return The address itself.
* @since 1.1.0
*/
Address& setSegmentSelector( const SegmentSelector &segmentSelector ) {
_segment_selector = segmentSelector;
return *this;
}
/**
* Gets the size operator associated with the address.
*
* @return The size operator.
* @since 1.1.0
*/
fcml_usize getSizeOperator() const {
return _size_operator;
}
/**
* Sets a new size operator for the address.
*
* @param sizeOperator The size operator.
* @since 1.1.0
*/
Address& setSizeOperator( fcml_usize sizeOperator ) {
_size_operator = sizeOperator;
return *this;
}
private:
/** Size of data accessed in memory.*/
fcml_usize _size_operator;
/** Memory addressing format: absolute offset/effective address. @see fcml_en_effective_address_form*/
AddressForm _address_form;
/** Segment register.*/
SegmentSelector _segment_selector;
/** Memory address for FCML_AF_COMBINED form.*/
EffectiveAddress _effective_address;
/** Memory address for FCML_AF_OFFSET form.*/
Integer _offset;
};
/** Instruction operand.
* @since 1.1.0
*/
class Operand {
public:
/** See fcml_en_operand_type structure for more details.
* @since 1.1.0
*/
enum OperandType {
/** Operand not used. */
OT_NONE = FCML_OT_NONE,
/** Immediate integer value. */
OT_IMMEDIATE = FCML_OT_IMMEDIATE,
/** Direct far pointer. */
OT_FAR_POINTER = FCML_OT_FAR_POINTER,
/** Memory address. */
OT_ADDRESS = FCML_OT_ADDRESS,
/** Processor register. */
OT_REGISTER = FCML_OT_REGISTER
};
/**
* Creates an undefined operand.
* @since 1.1.0
*/
Operand() :
_hints( FCML_OP_HINT_UNDEFIEND ),
_operandType( OT_NONE ) {
}
/**
* Creates an immediate value operand for given integer.
*
* @param imm The immediate value as integer.
* @param hints Optional operand level hints.
* @since 1.1.0
*/
Operand( const Integer &imm, fcml_hints hints = FCML_OP_HINT_UNDEFIEND ) :
_hints( hints ),
_operandType(OT_IMMEDIATE ),
_immediate( imm ) {
}
/**
* Creates a far pointer operand for given far pointer.
*
* @param pointer The far pointer for the operand.
* @param hints Optional operand level hints.
* @since 1.1.0
*/
Operand( const FarPointer &pointer, fcml_hints hints = FCML_OP_HINT_UNDEFIEND ) :
_hints( hints ),
_operandType( OT_FAR_POINTER ),
_farPointer( pointer ) {
}
/**
* Creates an address operand for given address.
*
* @param address The address for the created operand.
* @param hints Optional operand level hints.
* @since 1.1.0
*/
Operand( const Address &address, fcml_hints hints = FCML_OP_HINT_UNDEFIEND ) :
_hints( hints ),
_operandType( OT_ADDRESS ),
_address( address ) {
}
/**
* Creates a new register operand for given register.
*
* @param reg The register for the new operand being created.
* @param hints Optional operand level hints.
* @since 1.1.0
*/
Operand( const Register ®, fcml_hints hints = FCML_OP_HINT_UNDEFIEND ) :
_hints( hints ),
_operandType( OT_REGISTER ),
_register( reg ) {
}
public:
/**
* Checks if two operands are equal or not.
*
* @param op The operand to be compared with the current one.
* @return True if the operands are equal.
* @since 1.1.0
*/
bool operator==( const Operand &op ) const {
if( &op == this ) {
return true;
}
bool equal = false;
switch( _operandType ) {
case OT_ADDRESS:
equal = _address == op._address;
break;
case OT_FAR_POINTER:
equal = _farPointer == op._farPointer;
break;
case OT_IMMEDIATE:
equal = _immediate == op._immediate;
break;
case OT_REGISTER:
equal = _register == op._register;
break;
case OT_NONE:
equal = true;
break;
}
return equal && op._hints == _hints;
}
/**
* Checks if two operands are equal or not.
*
* @param op The operand to be compared with the current one.
* @return True if the operands are NOT equal.
* @since 1.1.0
*/
bool operator!=( const Operand &op ) const {
return !(op == *this);
}
public:
/**
* Converts operand to the undefined one.
* @since 1.1.0
*/
void undef() {
_operandType = OT_NONE;
}
/**
* Sets given immediate value for the operand and makes it to be an immediate operand.
*
* @param imm The immediate value.
* @since 1.1.0
*/
void imm( const Integer &imm ) {
_operandType = OT_IMMEDIATE;
_immediate = imm;
}
/**
* Converts operand to the far pointer and sets the segment selector and offset for it.
*
* @param seg The segment selector.
* @param addr Offset.
* @since 1.1.0
*/
void far_ptr( fcml_uint16_t seg, fcml_int16_t addr ) {
_operandType = OT_FAR_POINTER;
_farPointer = FarPointer( seg, addr );
}
/**
* Prepares far pointer operand for given components.
*
* @param seg The segment selector.
* @param addr The offset.
* @since 1.1.0
*/
void far_ptr( fcml_uint16_t seg, fcml_int32_t addr ) {
_operandType = OT_FAR_POINTER;
_farPointer = FarPointer( seg, addr );
}
/**
* Prepares far pointer operand for given far pointer.
*
* @param pointer Far pointer to be set for the operand.
* @since 1.1.0
*/
void far_ptr( const FarPointer &pointer ) {
_operandType = OT_FAR_POINTER;
_farPointer = pointer;
}
/**
* Prepares address operand for given address.
*
* @param address The address to be set for the operand.
* @since 1.1.0
*/
void addr( const Address &address ) {
_operandType = OT_ADDRESS;
_address = address;
}
/**
* Prepares address operand for given offset.
*
* @param offset The offset to be set for the operand.
* @param sizeOperator The size operator to be set for the address.
* @since 1.1.0
*/
void off( const Integer &offset, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
_operandType = OT_ADDRESS;
_address = Address( offset, sizeOperator );
}
/**
* Prepares an address operand for given effective address and optional size operator.
*
* @param effectiveAddress The effective address.
* @param sizeOperator The size operator.
* @since 1.1.0
*/
void addr( const EffectiveAddress &effectiveAddress, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
_operandType = OT_ADDRESS;
_address = Address( effectiveAddress, sizeOperator );
}
/**
* Prepares address operator for given parameters.
*
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @param sizeOperator The size operator.
* @since 1.1.0
*/
void addr( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
_operandType = OT_ADDRESS;
_address = Address( effectiveAddress, segmentSelector, sizeOperator );
}
/**
* Prepares operator for the given register.
*
* @param reg The register for the operator.
* @since 1.1.0
*/
void reg( const Register ® ) {
_operandType = OT_REGISTER;
_register = reg;
}
/**
* Prepares an register operator for given register compounds.
*
* @param reg A register number.
* @param size A register size.
* @param type A register type.
* @param x64_exp An optional marker for the SPL, BPL, SIL etc. registers. See manual for more information.
* @since 1.1.0
*/
void reg( fcml_uint8_t reg, fcml_usize size, Register::RegisterType type = Register::REG_GPR, fcml_bool x64_exp = FCML_FALSE ) {
_operandType = OT_REGISTER;
_register = Register( reg, size, type, x64_exp );
}
public:
/**
* Returns true if operand is an immediate value operand.
*
* @return True if operand is an immediate value operand.
* @since 1.1.0
*/
bool isImm() const {
return _operandType == OT_IMMEDIATE;
}
/**
* Returns true if operand is a register operand.
*
* @return True if operand is a register operand.
* @since 1.1.0
*/
bool isReg() const {
return _operandType == OT_REGISTER;
}
/**
* Returns true if operand is an address operand.
*
* @return True if operand is an address operand.
* @since 1.1.0
*/
bool isAddr() const {
return _operandType == OT_ADDRESS;
}
/**
* Returns true if operand is a far pointer operand.
*
* @return True if operand is a far pointer operand.
* @since 1.1.0
*/
bool isFar() const {
return _operandType == OT_FAR_POINTER;
}
/**
* Gets reference to the constant address associated with the operand.
*
* @return The reference to the address.
* @since 1.1.0
*/
const Address& getAddress() const {
return _address;
}
/**
* Gets reference to the address associated with the operand.
*
* @return The reference to the address.
* @since 1.1.0
*/
Address& getAddress() {
return _address;
}
/**
* Sets a new address for the operand.
*
* @param address The new address.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setAddress( const Address &address ) {
_address = address;
return *this;
}
/**
* Gets a reference to the constant far pointer instance associated with the address.
*
* @return The far pointer instance associated with the address.
* @since 1.1.0
*/
const FarPointer& getFarPointer() const {
return _farPointer;
}
/**
* Gets a reference to the far pointer instance associated with the address.
*
* @return The far pointer instance associated with the address.
* @since 1.1.0
*/
FarPointer& getFarPointer() {
return _farPointer;
}
/**
* Sets a new far pointer for the operand.
*
* @param farPointer The new far pointer instance.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setFarPointer( const FarPointer &farPointer ) {
_farPointer = farPointer;
return *this;
}
/**
* Gets a reference to the constant immediate value associated with the operand.
*
* @return The immediate value.
* @since 1.1.0
*/
const Integer& getImmediate() const {
return _immediate;
}
/**
* Gets a reference to the immediate value associated with the operand.
*
* @return The immediate value.
* @since 1.1.0
*/
Integer& getImmediate() {
return _immediate;
}
/**
* Sets a new immediate value for the address.
*
* @param immediate The new immediate value.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setImmediate( const Integer &immediate ) {
_immediate = immediate;
return *this;
}
/**
* Gets operand type.
*
* @return The operand type.
* @since 1.1.0
*/
OperandType getOperandType() const {
return _operandType;
}
/**
* Sets a new operand type.
*
* @param operandType The new operand type.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setOperandType( OperandType operandType ) {
_operandType = operandType;
return *this;
}
/**
* Returns a reference to the constant register associated with the operand.
*
* @return The reference to the register associated with the operand.
* @since 1.1.0
*/
const Register& getRegister() const {
return _register;
}
/**
* Returns a reference to the register associated with the operand.
*
* @return The reference to the register associated with the operand.
* @since 1.1.0
*/
Register& getRegister() {
return _register;
}
/**
* Sets a new register for the operand.
*
* @param reg The new register.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setRegister( const Register ® ) {
this->_register = reg;
return *this;
}
/**
* Gets hits associated with the operand.
*
* @return The hits associated with the operand.
* @since 1.1.0
*/
fcml_hints getHints() const {
return _hints;
}
/**
* Sets new operand level hits for the operand.
*
* @param hints The new hits to be set.
* @return The operand itself.
* @since 1.1.0
*/
Operand& setHints( fcml_hints hints ) {
_hints = hints;
return *this;
}
// Hints
/**
* Returns information if the operand is multimedia one or not. For more details about the
* multimedia operand head over to the manual pages.
*
* @return true if it's a multimedia operand.
* @since 1.1.0
*/
bool isMultimedia() const {
return _hints & FCML_OP_HINT_MULTIMEDIA_INSTRUCTION;
}
/**
* Returns true if it's an displacement relative address.
*
* @return True if it's an displacement relative address.
* @since 1.1.0
*/
bool isDisRelativeAddress() const {
return ( _hints & FCML_OP_HINT_DISPLACEMENT_RELATIVE_ADDRESS ) ? true : false;
}
/**
* Returns true if it's pseudo opcode operand. More information
* about pseudo opcodes in the manual.
*
* @return True if it's pseudo opcode operand.
* @since 1.1.0
*/
bool isPseudoOpcode() const {
return ( _hints & FCML_OP_HINT_PSEUDO_OPCODE ) ? true : false;
}
/**
* Returns true if it's an absolute offset being set in the operand.
*
* @return True in case of absolute addressing being used.
* @since 1.1.0
*/
bool isAbsoluteAddressing() const {
return ( _hints & FCML_OP_HINT_ABSOLUTE_ADDRESSING ) ? true : false;
}
/**
* Returns true is relative addressing is used.
*
* @return True in case of relative addressing.
* @since 1.1.0
*/
bool isRelativeAddressing() const {
return ( _hints & FCML_OP_HINT_RELATIVE_ADDRESSING ) ? true : false;
}
/**
* Returns true if the SIB byte is used.
*
* @return True if the SIB byte is used.
* @since 1.1.0
*/
bool isSIBEncoding() const {
return ( _hints & FCML_OP_HINT_SIB_ENCODING ) ? true : false;
}
public:
/**
* A casting operator.
* @since 1.1.0
*/
operator const Integer&() const {
return _immediate;
}
/**
* A casting operator.
* @since 1.1.0
*/
operator const FarPointer&() const {
return _farPointer;
}
/**
* A casting operator.
* @since 1.1.0
*/
operator const Address&() const {
return _address;
}
/**
* A casting operator.
* @since 1.1.0
*/
operator const Register&() const {
return _register;
}
private:
/** Operand hints */
fcml_hints _hints;
/** Operand type */
OperandType _operandType;
/** Describes immediate operand */
Integer _immediate;
/** Describes far pointer. */
FarPointer _farPointer;
/* Describes address. */
Address _address;
/* Describes register. */
Register _register;
};
/** Operand builder.
* A builder that exposes various factory methods that can be used to create
* several types of the instruction operands. These methods are very simple
* so no API documentation has been provided for now. Just take a look at
* the source code.
*
* @since 1.1.0
*/
class OB {
public:
/**
* Factory method which builds an empty operand.
* @return The empty operand.
* @since 1.1.0
*/
static Operand undef() {
return Operand();
}
/**
* Factory method which builds an immediate operand.
* @return The immediate operand.
* @since 1.1.0
*/
static Operand imm( const Integer &imm ) {
return Operand( imm );
}
/**
* Factory method which builds a far pointer operand.
* @param seg A segment selector.
* @param addr An 16-bit offset value.
* @return The far pointer operand.
* @since 1.1.0
*/
static Operand far_ptr( fcml_uint16_t seg, fcml_int16_t addr ) {
return Operand( FarPointer( seg, addr ) );
}
/**
* Factory method which builds a far pointer operand.
* @param seg A segment selector.
* @param addr An 32-bit offset value.
* @return The far pointer operand.
* @since 1.1.0
*/
static Operand far_ptr( fcml_uint16_t seg, fcml_int32_t addr ) {
return Operand( FarPointer( seg, addr ) );
}
/**
* Factory method which builds a far pointer operand.
* @param pointer A far pointer instance.
* @return The far pointer operand.
* @since 1.1.0
*/
static Operand far_ptr( const FarPointer &pointer ) {
return Operand( pointer );
}
/**
* Factory method which builds an address operand.
* @param address An address instance.
* @return The address operand.
* @since 1.1.0
*/
static Operand addr( const Address &address ) {
return Operand( address );
}
/**
* Factory method which builds an address operand.
* @param offset An offset instance.
* @param sizeOperator An optional size operator.
* @return The address operand.
* @since 1.1.0
*/
static Operand off( const Integer &offset, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Operand( Address( offset, sizeOperator ) );
}
/**
* Factory method which builds an offset based address operand with byte size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
static Operand offb( const Integer &offset ) {
return Operand( Address( offset, FCML_DS_8 ) );
}
/**
* Factory method which builds an offset based address operand with word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
static Operand offw( const Integer &offset ) {
return Operand( Address( offset, FCML_DS_16 ) );
}
/**
* Factory method which builds an offset based address operand with double word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
static Operand offd( const Integer &offset ) {
return Operand( Address( offset, FCML_DS_32 ) );
}
/**
* Factory method which builds an offset based address operand with quadro word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
static Operand offq( const Integer &offset ) {
return Operand( Address( offset, FCML_DS_64 ) );
}
/**
* Factory method which creates address type operand for given effective address and optional size operator.
* @param effectiveAddress The effective address.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand addr( const EffectiveAddress &effectiveAddress, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Operand( Address( effectiveAddress, sizeOperator ) );
}
/**
* Factory method which creates address type operand for given effective address and byte size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrb( const EffectiveAddress &effectiveAddress ) {
return Operand( Address( effectiveAddress, FCML_DS_8 ) );
}
/**
* Factory method which creates address type operand for given effective address and word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrw( const EffectiveAddress &effectiveAddress ) {
return Operand( Address( effectiveAddress, FCML_DS_16 ) );
}
/**
* Factory method which creates address type operand for given effective address and double word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrd( const EffectiveAddress &effectiveAddress ) {
return Operand( Address( effectiveAddress, FCML_DS_32 ) );
}
/**
* Factory method which creates address type operand for given effective address and quadro word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrq( const EffectiveAddress &effectiveAddress ) {
return Operand( Address( effectiveAddress, FCML_DS_64 ) );
}
/**
* Factory method which creates address type operand for given segment selector, effective address and optional size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand addr( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return Operand( Address( effectiveAddress, segmentSelector, sizeOperator ) );
}
/**
* Factory method which creates address type operand for given effective address and byte size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrb( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
return Operand( Address( effectiveAddress, segmentSelector, FCML_DS_8 ) );
}
/**
* Factory method which creates address type operand for given effective address and word size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrw( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
return Operand( Address( effectiveAddress, segmentSelector, FCML_DS_16 ) );
}
/**
* Factory method which creates address type operand for given effective address and double word size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrd( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
return Operand( Address( effectiveAddress, segmentSelector, FCML_DS_32 ) );
}
/**
* Factory method which creates address type operand for given effective address and quadro word size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
static Operand addrq( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
return Operand( Address( effectiveAddress, segmentSelector, FCML_DS_64 ) );
}
/**
* Factory method which creates an register based operator for given register.
* @param reg The register.
* @return The created operator.
* @since 1.1.0
*/
static Operand reg( const Register ® ) {
return Operand( reg );
}
/**
* Factory method which creates an register based operator for given parameters.
* @param reg The FCML register number.
* @param size The register size.
* @param type The register type.
* @param x64_exp See manual for more information.
* @return The created operator.
* @since 1.1.0
*/
static Operand reg( fcml_uint8_t reg, fcml_usize size, Register::RegisterType type = Register::REG_GPR, fcml_bool x64_exp = FCML_FALSE ) {
return Operand( Register( reg, size, type, x64_exp ) );
}
/**
* Factory method which creates an effective address based operator for a displacement and optional size operator.
* @param displacement The displacement value.
* @param sizeOperator The size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a displacement and byte size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Integer &displacement ) {
return addr( EffectiveAddress( displacement ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a displacement and word size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Integer &displacement ) {
return addr( EffectiveAddress( displacement ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a displacement and double word size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Integer &displacement ) {
return addr( EffectiveAddress( displacement ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a displacement and quadro byte size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Integer &displacement ) {
return addr( EffectiveAddress( displacement ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for a base register and optional size operator.
* @param base The base register.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &base, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( base ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a base register and byte size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &base ) {
return addr( EffectiveAddress( base ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a base register and word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &base ) {
return addr( EffectiveAddress( base ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a base register and double word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &base ) {
return addr( EffectiveAddress( base ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a base register and quadro word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &base ) {
return addr( EffectiveAddress( base ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for a base register, displacement and optional size operator.
* @param base The base register.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &base, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( base, displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a base register, displacement and byte size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &base, const Integer &displacement ) {
return addr( EffectiveAddress( base, displacement ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a base register, displacement and word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &base, const Integer &displacement ) {
return addr( EffectiveAddress( base, displacement ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a base register, displacement and double word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &base, const Integer &displacement ) {
return addr( EffectiveAddress( base, displacement ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a base register, displacement and quadro word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &base, const Integer &displacement ) {
return addr( EffectiveAddress( base, displacement ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for an index register, scaleFactor, displacement and optional size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( index, scaleFactor, displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for an index register, scaleFactor, displacement and byte size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for an index register, scaleFactor, displacement and word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for an index register, scaleFactor, displacement and double word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for an index register, scaleFactor, displacement and quadro word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register and optional size operator.
* @param base The base register.
* @param index The index register.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &base, const Register &index, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( base, index ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a base register, index register and byte size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &base, const Register &index ) {
return addr( EffectiveAddress( base, index ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register and word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &base, const Register &index ) {
return addr( EffectiveAddress( base, index ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register and double word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &base, const Register &index ) {
return addr( EffectiveAddress( base, index ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register and quadro word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &base, const Register &index ) {
return addr( EffectiveAddress( base, index ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and optional size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &base, const Register &index, fcml_uint8_t scaleFactor, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( base, index, scaleFactor ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and byte size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
return addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
return addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and double word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
return addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and quadro word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
return addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_64 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and optional size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
static Operand eff( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
return addr( EffectiveAddress( base, index, scaleFactor, displacement ), sizeOperator );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and byte size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effb( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_8 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effw( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_16 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and double word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effd( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_32 );
}
/**
* Factory method which creates an effective address based operator for a base register, index register, scale factor and quardo word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
static Operand effq( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
return addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_64 );
}
};
/** Instruction condition.
*
* It's counterpart to the fcml_st_condition structure.
*
* @since 1.1.0
*/
class Condition {
public:
/** See fcml_st_condition for more details.
* @since 1.1.0
*/
enum ConditionType {
/** 0 Overflow*/
CONDITION_O = FCML_CONDITION_O,
/** 1 Below*/
CONDITION_B = FCML_CONDITION_B,
/** 2 Equal*/
CONDITION_E = FCML_CONDITION_E,
/** 3 Below or equal*/
CONDITION_BE = FCML_CONDITION_BE,
/** 4 Sign*/
CONDITION_S = FCML_CONDITION_S,
/** 5 Parity*/
CONDITION_P = FCML_CONDITION_P,
/** 6 Less than*/
CONDITION_L = FCML_CONDITION_L,
/** 7 Less than or equal to*/
CONDITION_LE = FCML_CONDITION_LE
};
/**
* Creates an empty condition.
* @since 1.1.0
*/
Condition() :
_conditionType(CONDITION_O),
_isNegation(false) {
}
/**
* Creates a condition for given parameters.
*
* @param type A condition type.
* @param negation True in order to negate condition.
* @since 1.1.0
*/
Condition( ConditionType type, bool negation = false ) :
_conditionType( type ),
_isNegation( negation ) {
}
public:
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isO() const {
return check( CONDITION_O );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition O() {
const Condition condition( CONDITION_O );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNO() const {
return check( CONDITION_O, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NO() {
const Condition condition( CONDITION_O );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isB() const {
return check( CONDITION_B );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition B() {
const Condition condition( CONDITION_B );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNB() const {
return check( CONDITION_B, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NB() {
const Condition condition( CONDITION_B, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNAE() const {
return check( CONDITION_B );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NAE() {
const Condition condition( CONDITION_B );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isAE() const {
return check( CONDITION_B, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition AE() {
const Condition condition( CONDITION_B, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isC() const {
return check( CONDITION_B );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition C() {
const Condition condition( CONDITION_B );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNC() const {
return check( CONDITION_B, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NC() {
const Condition condition( CONDITION_B, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isE() const {
return check( CONDITION_E );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition E() {
const Condition condition( CONDITION_E );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isZ() const {
return check( CONDITION_E );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition Z() {
const Condition condition( CONDITION_E );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNE() const {
return check( CONDITION_E, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NE() {
const Condition condition( CONDITION_E, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNZ() const {
return check( CONDITION_E, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NZ() {
const Condition condition( CONDITION_E, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isBE() const {
return check( CONDITION_BE );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition BE() {
const Condition condition( CONDITION_BE );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNA() const {
return check( CONDITION_BE );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NA() {
const Condition condition( CONDITION_BE );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNBE() const {
return check( CONDITION_BE, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NBE() {
const Condition condition( CONDITION_BE, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isA() const {
return check( CONDITION_BE, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition A() {
const Condition condition( CONDITION_BE, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isS() const {
return check( CONDITION_S );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition S() {
const Condition condition( CONDITION_S );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNS() const {
return check( CONDITION_S, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NS() {
const Condition condition( CONDITION_S, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isP() const {
return check( CONDITION_P );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition P() {
const Condition condition( CONDITION_P );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isPE() const {
return check( CONDITION_P );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition PE() {
const Condition condition( CONDITION_P );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNP() const {
return check( CONDITION_P, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NP() {
const Condition condition( CONDITION_P, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isPO() const {
return check( CONDITION_P, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition PO() {
const Condition condition( CONDITION_P, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isL() const {
return check( CONDITION_L );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition L() {
const Condition condition( CONDITION_L );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNGE() const {
return check( CONDITION_L );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NGE() {
const Condition condition( CONDITION_L );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNL() const {
return check( CONDITION_L, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NL() {
const Condition condition( CONDITION_L, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isGE() const {
return check( CONDITION_L, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition GE() {
const Condition condition( CONDITION_L, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isLE() const {
return check( CONDITION_LE );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition LE() {
const Condition condition( CONDITION_LE );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNG() const {
return check( CONDITION_LE );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NG() {
const Condition condition( CONDITION_LE );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isNLE() const {
return check( CONDITION_LE, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition NLE() {
const Condition condition( CONDITION_LE, true );
return condition;
}
/**
* Gets true the condition is of a given type.
* @return True the condition is of a given type.
* @since 1.1.0
*/
bool isG() const {
return check( CONDITION_LE, true );
}
/**
* Factory method which creates a condition of a given type.
* @return The condition with a type described by the method name.
* @since 1.1.0
*/
static const Condition G() {
const Condition condition( CONDITION_LE, true );
return condition;
}
public:
/**
* Checks if two condition are equal.
*
* @param cond The condition to be compared to the current one.
* @return True if they are equal.
* @since 1.1.0
*/
bool operator==( const Condition &cond ) const {
return cond._conditionType == _conditionType && cond._isNegation == _isNegation;
}
/**
* Checks if two condition are equal.
*
* @param cond The condition to be compared to the current one.
* @return True if they are NOT equal.
* @since 1.1.0
*/
bool operator!=( const Condition &cond ) const {
return !(*this == cond);
}
public:
/**
* Gets a type of the condition.
*
* @return The type of the condition.
* @since 1.1.0
*/
ConditionType getConditionType() const {
return _conditionType;
}
/**
* Sets condition type.
*
* @param conditionType The condition type to be set.
* @since 1.1.0
*/
Condition& setConditionType( ConditionType conditionType ) {
_conditionType = conditionType;
return *this;
}
/**
* Returns true if condition is negated.
*
* @return True if condition is negated.
* @since 1.1.0
*/
bool isNegation() const {
return _isNegation;
}
/**
* Sets negation flag for the condition.
*
* @param isNegation The negation flag.
* @since 1.1.0
*/
Condition& setNegation( bool isNegation ) {
_isNegation = isNegation;
return *this;
}
private:
/**
* Checks if the condition is of given type and negation flag.
*
* @param type The condition type.
* @param negation The negation flag.
* @return True if the condition has the same type and negation set.
* @since 1.1.0
*/
bool check( ConditionType type, bool negation = false ) const {
return _conditionType == type && _isNegation == negation;
}
private:
/* Condition type.*/
ConditionType _conditionType;
/* True if condition should be negated.*/
bool _isNegation;
};
/** Describes an instruction.
*
* It's counterpart to the fcml_st_instruction structure.
* @since 1.1.0
*/
class Instruction {
public:
/**
* Creates an empty instruction.
* @since 1.1.0
*/
Instruction() :
_prefixes(0),
_hints(FCML_HINT_NO_HINTS),
_isConditional(false),
_operandsCount(0) {
}
/**
* Creates an empty instruction for given mnemonic.
*
* @param mnemonic The mnemonic for the newly created instruction.
* @since 1.1.0
*/
Instruction( const fcml_cstring &mnemonic ) :
_prefixes(0),
_hints(FCML_HINT_NO_HINTS),
_mnemonic(mnemonic),
_isConditional(false),
_operandsCount(0) {
}
public:
/**
* Adds a new operand to the instruction.
*
* @param operand The operand to be added to the instruction.
* @throw IllegalStateException No more operands allowed.
* @since 1.1.0
*/
void add( const Operand &operand ) {
if( _operandsCount == FCML_OPERANDS_COUNT ) {
throw IllegalStateException( FCML_TEXT( "No more operands allowed." ) );
}
_operands[_operandsCount++] = operand;
}
/**
* Sets a new oeprand for the instruction at given index.
*
* @param operand The operand to be set.
* @param index The index operand should be set at.
* @throw IllegalStateException Operand's number exceeds maximal number of operands allowed.
* @since 1.1.0
*/
void setOperand( const Operand &operand, fcml_int index ) {
if( index >= FCML_OPERANDS_COUNT ) {
throw IllegalStateException( FCML_TEXT( "Operand's number exceeds maximal number of operands allowed." ) );
}
_operands[index] = operand;
}
/**
* Gets reference to the constant operand at given index.
*
* @param index The operand index.
* @return The operand available at given index.
* @since 1.1.0
*/
const Operand & operator[]( fcml_int index ) const {
checkArrayAccess(index);
return _operands[index];
}
/**
* Gets reference to the operand at given index.
*
* @param index The operand index.
* @return The operand available at given index.
* @since 1.1.0
*/
Operand & operator[]( fcml_int index ) {
checkArrayAccess(index);
return _operands[index];
}
/**
* Cleans the instruction by removing all operands from it.
* @since 1.1.0
*/
void clean() {
for( int i = 0; i < FCML_OPERANDS_COUNT; i++ ) {
// Clean the operand.
_operands[i] = Operand();
}
_operandsCount = 0;
}
public:
/**
* Gets a pointer to the constant condition associated with the instruction.
*
* @return A reference to the condition.
* @since 1.1.0
*/
const Condition& getCondition() const {
return _condition;
}
/**
* Gets a pointer to the condition associated with the instruction.
*
* @return A reference to the condition.
* @since 1.1.0
*/
Condition& getCondition() {
return _condition;
}
/**
* Sets a new condition for the instruction.
*
* @param condition The condition to be set for the instruction.
* @return The instruction itself.
* @since 1.1.0
*/
Instruction& setCondition( const Condition &condition ) {
_condition = condition;
return *this;
}
/**
* Gets instruction level hits associated with the instruction.
*
* @return The instruction level hits associated with the instruction.
* @since 1.1.0
*/
fcml_hints getHints() const {
return _hints;
}
/**
* Sets new instruction hints.
*
* @param hints The hints to be set.
* @return The instruction itself.
* @since 1.1.0
*/
Instruction& setHints( fcml_hints hints ) {
_hints = hints;
return *this;
}
/**
* Gets true if it's a conditional instruction.
*
* @return True in case of the conditional instruction.
* @since 1.1.0
*/
bool isConditional() const {
return _isConditional;
}
/**
* Sets conditional flag for the instruction.
*
* @param isConditional Set to true in order to mark instruction as conditional one.
* @return The instruction itself.
* @since 1.1.0
*/
Instruction& setConditional( bool isConditional ) {
_isConditional = isConditional;
return *this;
}
/**
* Gets the mnemonic associated with the instruction.
*
* @return The mnemonic associated with the instruction.
* @since 1.1.0
*/
const fcml_cstring& getMnemonic() const {
return _mnemonic;
}
/**
* Sets a new mnemonic for the instruction.
*
* @param mnemonic The new mnemonic.
* @return The instruction itself.
* @since 1.1.0
*/
Instruction& setMnemonic( const fcml_cstring &mnemonic ) {
_mnemonic = mnemonic;
return *this;
}
/**
* Gets number of operands associated with the instruction.
*
* @return The number of operands in the instruction.
* @since 1.1.0
*/
fcml_int getOperandsCount() const {
return _operandsCount;
}
/**
* Sets number of operands available in the instruction.
*
* @param operandsCount Number of operands.
* @return The number of instructions.
* @since 1.1.0
*/
Instruction& setOperandsCount( fcml_int operandsCount ) {
_operandsCount = operandsCount;
return *this;
}
/**
* Gets prefixes associated with the instruction.
*
* @return The prefixes.
* @since 1.1.0
*/
fcml_prefixes getPrefixes() const {
return _prefixes;
}
/**
* Sets a new set of prefixes for the instruction.
*
* @param prefixes The set of prefixes to be set for the instruction.
* @return The instruction itself.
* @since 1.1.0
*/
Instruction& setPrefixes( fcml_prefixes prefixes ) {
_prefixes = prefixes;
return *this;
}
public:
// Helper methods to identify prefixes and hints.
/**
* Returns true if lock prefix is set.
* @return True if lock prefix is set.
* @since 1.1.0
*/
bool isLock() const {
return ( _prefixes & FCML_PREFIX_LOCK ) ? true : false;
}
/**
* Returns true if repne prefix is set.
* @return True if repne prefix is set.
* @since 1.1.0
*/
bool isRepne() const {
return ( _prefixes & FCML_PREFIX_REPNE ) ? true : false;
}
/**
* Returns true if lock repnz is set.
* @return True if lock repnz is set.
* @since 1.1.0
*/
bool isRepnz() const {
return ( _prefixes & FCML_PREFIX_REPNZ ) ? true : false;
}
/**
* Returns true if rep prefix is set.
* @return True if rep prefix is set.
* @since 1.1.0
*/
bool isRep() const {
return ( _prefixes & FCML_PREFIX_REP ) ? true : false;
}
/**
* Returns true if repe prefix is set.
* @return True if repe prefix is set.
* @since 1.1.0
*/
bool isRepe() const {
return ( _prefixes & FCML_PREFIX_REPE ) ? true : false;
}
/**
* Returns true if repz prefix is set.
* @return True if repz prefix is set.
* @since 1.1.0
*/
bool isRepz() const {
return ( _prefixes & FCML_PREFIX_REPZ ) ? true : false;
}
/**
* Returns true if xacquire prefix is set.
* @return True if xacquire prefix is set.
* @since 1.1.0
*/
bool isXAcquire() const {
return ( _prefixes & FCML_PREFIX_XACQUIRE ) ? true : false;
}
/**
* Returns true if xrelease prefix is set.
* @return True if xrelease prefix is set.
* @since 1.1.0
*/
bool isXRelease() const {
return ( _prefixes & FCML_PREFIX_XRELEASE ) ? true : false;
}
/**
* Returns true if branch_hint prefix is set.
* @return True if branch_hint prefix is set.
* @since 1.1.0
*/
bool isBranchHint() const {
return ( _prefixes & FCML_PREFIX_BRANCH_HINT ) ? true : false;
}
/**
* Returns true if no_branch_hint prefix is set.
* @return True if no_branch_hint prefix is set.
* @since 1.1.0
*/
bool isNoBranchHint() const {
return ( _prefixes & FCML_PREFIX_NOBRANCH_HINT ) ? true : false;
}
/**
* Returns true if far pointer hint is set.
* @return True if far pointer hint is set.
* @since 1.1.0
*/
bool isFarPointer() const {
return ( _hints & FCML_HINT_FAR_POINTER ) ? true : false;
}
/**
* Returns true if near pointer hint is set.
* @return True if near pointer hint is set.
* @since 1.1.0
*/
bool isNearPointer() const {
return ( _hints & FCML_HINT_NEAR_POINTER ) ? true : false;
}
/**
* Returns true if long form pointer hint is set. See manual for more information about this hint.
* @return True if long form pointer hint is set.
* @since 1.1.0
*/
bool isLongFormPointer() const {
return ( _hints & FCML_HINT_LONG_FORM_POINTER ) ? true : false;
}
/**
* Returns true if indirect pointer hint is set.
* @return True if indirect pointer hint is set.
* @since 1.1.0
*/
bool isIndirectPointer() const {
return ( _hints & FCML_HINT_INDIRECT_POINTER ) ? true : false;
}
/**
* Returns true if direct pointer hint is set.
* @return True if direct pointer hint is set.
* @since 1.1.0
*/
bool isDirectPointer() const {
return ( _hints & FCML_HINT_DIRECT_POINTER ) ? true : false;
}
private:
/**
* Throws if given operand index is wrong.
* @throw BadArgumentException Index exceeds the allowed number of operands.
* @remarks An internal API, not intended to be used outside.
*/
void checkArrayAccess( fcml_int index) const {
if( index < 0 || index >= FCML_OPERANDS_COUNT ) {
throw BadArgumentException( FCML_TEXT( "Index exceeds the allowed number of operands." ) );
}
}
private:
/** Describes explicit instruction prefixes. @ref PREFIX_GROUP "List of explicit prefixes." */
fcml_prefixes _prefixes;
/** Holds instruction level hints. */
fcml_hints _hints;
/** Dialect-dependent instruction mnemonic. @see fcml_en_instruction_hints */
fcml_cstring _mnemonic;
/** True for conditional instructions. */
bool _isConditional;
/** Describes condition used by assembled/disassembled conditional instruction. */
Condition _condition;
/** Fixed size array of instruction operands. */
Operand _operands[FCML_OPERANDS_COUNT];
/** Number of operands defined for instruction. */
fcml_int _operandsCount;
};
/** An instruction builder.
*
* A classic builder that can be used to prepare instruction in a
* more convenient way than doing it manually using setters.
*
* @since 1.1.0
*/
class IB {
public:
/** Creates builder for the given mnemonic.
*
* @param mnemonic Mnemonic for the instruction being created.
* @since 1.1.0
*/
IB( const fcml_cstring &mnemonic ) :
_hints(FCML_HINT_NO_HINTS),
_prefixes(0),
_mnemonic(mnemonic),
_operandsCount(0) {
}
/**
* Creates builder for the given mnemonic and prefixes.
*
* @param prefixes The prefixes for the new instruction.
* @param mnemonic Mnemonic for the instruction being created.
* @since 1.1.0
*/
IB( fcml_prefixes prefixes, const fcml_cstring &mnemonic ) :
_hints(FCML_HINT_NO_HINTS),
_prefixes(prefixes),
_mnemonic(mnemonic),
_operandsCount(0) {
}
/**
* Creates an instruction builder for given mnemonic and hints.
*
* @param mnemonic The instruction mnemonic.
* @param hints The instruction hints.
* @since 1.1.0
*/
IB( const fcml_cstring &mnemonic, fcml_hints hints) :
_hints(hints),
_prefixes(0),
_mnemonic(mnemonic),
_operandsCount(0) {
}
/**
* Creates an instruction builder for given prefixes, mnemonic and hints.
*
* @param prefixes The instruction prefixes.
* @param mnemonic The instruction mnemonic.
* @param hints The instruction hints.
* @since 1.1.0
*/
IB( fcml_prefixes prefixes, const fcml_cstring &mnemonic, fcml_hints hints ) :
_hints(hints),
_prefixes(prefixes),
_mnemonic(mnemonic),
_operandsCount(0) {
}
/**
* Converts builder to the instruction instance.
* @since 1.1.0
* @return The built instruction.
*/
operator Instruction() const {
return build();
}
/**
* Builds an instruction instance for the current state of the builder.
*
* @return The built instruction instance.
* @since 1.1.0
*/
Instruction build() const {
Instruction instruction(_mnemonic);
instruction.setHints(_hints);
instruction.setPrefixes(_prefixes);
instruction.setOperandsCount(_operandsCount);
for( int i = 0; i < FCML_OPERANDS_COUNT; i++ ) {
instruction.setOperand( _operands[i], i );
}
return instruction;
}
/**
* Sets a next operand for the instruction.
*
* @param operand The next operand to be added to the instruction.
* @throw IllegalStateException No more operands allowed.
* @since 1.1.0
*/
void op( const Operand &operand ) {
if( _operandsCount == FCML_OPERANDS_COUNT ) {
throw IllegalStateException( FCML_TEXT( "No more operands allowed." ) );
}
_operands[_operandsCount++] = operand;
}
/**
* Factory method that can be used to create instruction builder.
*
* @param mnemonic The mnemonic for the instruction builder.
* @return Instruction builder instance.
* @since 1.1.0
*/
static IB inst( const fcml_cstring &mnemonic ) {
return IB(mnemonic);
}
// Hints.
/**
* Creates a hint instance described by the name of the method. Such a hint can be then used
* together with shift operator overridden by the builder in order to set an appropriate hint
* for the instruction being built.
* @return The hint indicator for the builder.
* @since 1.1.0
*/
static const InstructionHint FAR_PTR() {
return InstructionHint::FAR_POINTER();
}
/**
* Sets a hint described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate hint set.
* @since 1.1.0
*/
IB& farPtr() {
_hints |= FCML_HINT_FAR_POINTER;
return *this;
}
/**
* Creates a hint instance described by the name of the method. Such a hint can be then used
* together with shift operator overridden by the builder in order to set an appropriate hint
* for the instruction being built.
* @return The hint indicator for the builder.
* @since 1.1.0
*/
static const InstructionHint NEAR_PTR() {
return InstructionHint::NEAR_POINTER();
}
/**
* Sets a hint described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate hint set.
* @since 1.1.0
*/
IB& nearPtr() {
_hints |= FCML_HINT_NEAR_POINTER;
return *this;
}
/**
* Creates a hint instance described by the name of the method. Such a hint can be then used
* together with shift operator overridden by the builder in order to set an appropriate hint
* for the instruction being built.
* @return The hint indicator for the builder.
* @since 1.1.0
*/
static const InstructionHint LONG_FORM_PTR() {
return InstructionHint::LONG_FORM_POINTER();
}
/**
* Sets a hint described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate hint set.
* @since 1.1.0
*/
IB& longFormPtr() {
_hints |= FCML_HINT_LONG_FORM_POINTER;
return *this;
}
/**
* Creates a hint instance described by the name of the method. Such a hint can be then used
* together with shift operator overridden by the builder in order to set an appropriate hint
* for the instruction being built.
* @return The hint indicator for the builder.
* @since 1.1.0
*/
static const InstructionHint INDIRECT_PTR() {
return InstructionHint::INDIRECT_POINTER();
}
/**
* Sets a hint described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate hint set.
* @since 1.1.0
*/
IB& indirectPtr() {
_hints |= FCML_HINT_INDIRECT_POINTER;
return *this;
}
/**
* Creates a hint instance described by the name of the method. Such a hint can be then used
* together with shift operator overridden by the builder in order to set an appropriate hint
* for the instruction being built.
* @return The hint indicator for the builder.
* @since 1.1.0
*/
static const InstructionHint DIRECT_PTR() {
return InstructionHint::DIRECT_POINTER();
}
/**
* Sets a hint described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate hint set.
* @since 1.1.0
*/
IB& directPtr() {
_hints |= FCML_HINT_DIRECT_POINTER;
return *this;
}
// Prefixes.
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix LOCK() {
return InstructionPrefix::LOCK();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& lock() {
_prefixes |= FCML_PREFIX_LOCK;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix REPNE() {
return InstructionPrefix::REPNE();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& repne() {
_prefixes |= FCML_PREFIX_REPNE;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix REPNZ() {
return InstructionPrefix::REPNZ();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& repnz() {
_prefixes |= FCML_PREFIX_REPNZ;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix REP() {
return InstructionPrefix::REP();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& rep() {
_prefixes |= FCML_PREFIX_REP;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix REPE() {
return InstructionPrefix::REPE();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& repe() {
_prefixes |= FCML_PREFIX_REPE;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix REPZ() {
return InstructionPrefix::REPZ();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& repz() {
_prefixes |= FCML_PREFIX_REPZ;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix XACQUIRE() {
return InstructionPrefix::XACQUIRE();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& xacquire() {
_prefixes |= FCML_PREFIX_XACQUIRE;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix XRELEASE() {
return InstructionPrefix::XRELEASE();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& xrelease() {
_prefixes |= FCML_PREFIX_XRELEASE;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix BRANCH() {
return InstructionPrefix::BRANCH_HINT();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& branchHint() {
_prefixes |= FCML_PREFIX_BRANCH_HINT;
return *this;
}
/**
* Creates a prefix instance described by the name of the method. Such a prefix can be then used
* together with the shift operator overridden by the builder in order to set an appropriate prefix
* for the instruction being built.
* @return The prefix indicator for the builder.
* @since 1.1.0
*/
static const InstructionPrefix NO_BRANCH() {
return InstructionPrefix::NOBRANCH_HINT();
}
/**
* Sets a prefix described by the name of the method for the instruction being built.
* @return The instruction builder with the appropriate prefix set.
* @since 1.1.0
*/
IB& nobranchHint() {
_prefixes |= FCML_PREFIX_NOBRANCH_HINT;
return *this;
}
/**
* Gets multimedia hint for the operand.
* @return The multimedia hint.
*/
static const OperandHint OP_MULTIMEDIA_HINT() {
return OperandHint::MULTIMEDIA();
}
/**
* Gets relative address hint for the operand.
* @return The multimedia hint.
*/
static const OperandHint OP_RELATIVE_ADDRESSING() {
return OperandHint::RELATIVE_ADDRESSING();
}
/**
* Gets absolute hint for the operand.
* @return The multimedia hint.
*/
static const OperandHint OP_ABSOLUTE_ADDRESSING() {
return OperandHint::ABSOLUTE_ADDRESSING();
}
/**
* Gets SIB encoding hint for the operand.
* @return The SIB encoding hint.
*/
static const OperandHint OP_SIB_ENCODING() {
return OperandHint::SIB_ENCODING();
}
/**
* Marks the lastly added operand as a multimedia one.
* @return The instruction builder itself.
*/
IB& operandMultimediaHint() {
set( OP_MULTIMEDIA_HINT() );
return *this;
}
/**
* Marks the lastly added address operand as a relative one.
* @return The instruction builder itself.
*/
IB& operandRelativeHint() {
set( OP_MULTIMEDIA_HINT() );
return *this;
}
/**
* Marks the lastly added address operand as a absolute one.
* @return The instruction builder itself.
*/
IB& operandAbsoluteHint() {
set( OP_MULTIMEDIA_HINT() );
return *this;
}
/**
* Sets preferred encoding to SIB for the lastly added ModR/M operand.
* @return The instruction builder itself.
*/
IB& operandSIBEncodingHint() {
set( OP_MULTIMEDIA_HINT() );
return *this;
}
// Operands.
/**
* Adds an immediate operand.
* @return The immediate operand.
* @since 1.1.0
*/
IB& imm( const Integer &imm ) {
sanityCheck();
_operands[_operandsCount++].imm(imm);
return *this;
}
/**
* Adds a far pointer operand.
* @param seg A segment selector.
* @param addr An 16-bit offset value.
* @return The far pointer operand.
* @since 1.1.0
*/
IB& far_ptr( fcml_uint16_t seg, fcml_int16_t addr ) {
sanityCheck();
_operands[_operandsCount++].far_ptr(seg, addr);
return *this;
}
/**
* Adds a far pointer operand.
* @param seg A segment selector.
* @param addr An 32-bit offset value.
* @return The far pointer operand.
* @since 1.1.0
*/
IB& far_ptr( fcml_uint16_t seg, fcml_int32_t addr ) {
sanityCheck();
_operands[_operandsCount++].far_ptr(seg, addr);
return *this;
}
/**
* Adds a far pointer operand.
* @param pointer A far pointer instance.
* @return The far pointer operand.
* @since 1.1.0
*/
IB& far_ptr( const FarPointer &pointer ) {
sanityCheck();
_operands[_operandsCount++].far_ptr( pointer );
return *this;
}
/**
* Adds an address operand.
* @param address An address instance.
* @return The address operand.
* @since 1.1.0
*/
IB& addr( const Address &address ) {
sanityCheck();
_operands[_operandsCount++].addr(address);
return *this;
}
/**
* Adds an offset operand.
* @param offset An offset instance.
* @param sizeOperator An optional size operator.
* @return The address operand.
* @since 1.1.0
*/
IB& off( const Integer &offset, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
sanityCheck();
_operands[_operandsCount++].off( offset, sizeOperator );
return *this;
}
/**
* Adds an offset based address operand with byte size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
IB& offb( const Integer &offset ) {
sanityCheck();
_operands[_operandsCount++].off( offset, FCML_DS_8 );
return *this;
}
/**
* Adds an offset based address operand with word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
IB& offw( const Integer &offset ) {
sanityCheck();
_operands[_operandsCount++].off( offset, FCML_DS_16 );
return *this;
}
/**
* Adds an offset based address operand with double word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
IB& offd( const Integer &offset ) {
sanityCheck();
_operands[_operandsCount++].off( offset, FCML_DS_32 );
return *this;
}
/**
* Adds an offset based address operand with quadro word size operator.
* @param offset An offset instance.
* @return The address operand.
* @since 1.1.0
*/
IB& offq( const Integer &offset ) {
sanityCheck();
_operands[_operandsCount++].off( offset, FCML_DS_64 );
return *this;
}
/**
* Adds an address type operand for given effective address and optional size operator.
* @param effectiveAddress The effective address.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& addr( const EffectiveAddress &effectiveAddress, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, sizeOperator );
return *this;
}
/**
* Adds an address type operand for given effective address and byte size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
IB& addrb( const EffectiveAddress &effectiveAddress ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, FCML_DS_8 );
return *this;
}
/**
* Adds an address type operand for given effective address and word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
IB& addrw( const EffectiveAddress &effectiveAddress ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, FCML_DS_16 );
return *this;
}
/**
* Adds an address type operand for given effective address and double word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
IB& addrd( const EffectiveAddress &effectiveAddress ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, FCML_DS_32 );
return *this;
}
/**
* Adds an address type operand for given effective address and quadro word size operator.
* @param effectiveAddress The effective address.
* @return The created operator.
* @since 1.1.0
*/
IB& addrq( const EffectiveAddress &effectiveAddress ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, FCML_DS_64 );
return *this;
}
/**
* Adds an address type operand for given segment selector, effective address and optional size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& addr( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, segmentSelector, sizeOperator );
return *this;
}
/**
* Adds an address type operand for given effective address and byte size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
IB& addrb( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, segmentSelector, FCML_DS_8 );
return *this;
}
/**
* Adds an address type operand for given effective address and byte size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
IB& addrw( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, segmentSelector, FCML_DS_8 );
return *this;
}
/**
* Adds an address type operand for given effective address and double word size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
IB& addrd( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, segmentSelector, FCML_DS_8 );
return *this;
}
/**
* Adds an address type operand for given effective address and quadro word size operator.
* @param effectiveAddress The effective address.
* @param segmentSelector The segment selector.
* @return The created operator.
* @since 1.1.0
*/
IB& addrq( const EffectiveAddress &effectiveAddress, const SegmentSelector &segmentSelector ) {
sanityCheck();
_operands[_operandsCount++].addr( effectiveAddress, segmentSelector, FCML_DS_8 );
return *this;
}
/**
* Adds an an register based operator for given register.
* @param reg The register.
* @return The created operator.
* @since 1.1.0
*/
IB& reg( const Register ® ) {
sanityCheck();
_operands[_operandsCount++].reg( reg );
return *this;
}
/**
* Adds an an register based operator for given parameters.
* @param reg The FCML register number.
* @param size The register size.
* @param type The register type.
* @param x64_exp See manual for more information.
* @return The created operator.
* @since 1.1.0
*/
IB& reg( fcml_uint8_t reg, fcml_usize size, Register::RegisterType type = Register::REG_GPR, fcml_bool x64_exp = FCML_FALSE ) {
sanityCheck();
_operands[_operandsCount++].reg( Register( reg, size, type, x64_exp ) );
return *this;
}
/**
* Adds an an effective address based operator for a displacement and optional size operator.
* @param displacement The displacement value.
* @param sizeOperator The size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress(displacement), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a displacement and byte size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Integer &displacement ) {
next().addr( EffectiveAddress(displacement), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a displacement and word size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Integer &displacement ) {
next().addr( EffectiveAddress(displacement), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a displacement and double word size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Integer &displacement ) {
next().addr( EffectiveAddress(displacement), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a displacement and quadro byte size operator.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Integer &displacement ) {
next().addr( EffectiveAddress(displacement), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for a base register and optional size operator.
* @param base The base register.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &base, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress(base), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a base register and byte size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &base ) {
next().addr( EffectiveAddress(base), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a base register and word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &base ) {
next().addr( EffectiveAddress(base), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a base register and double word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &base ) {
next().addr( EffectiveAddress(base), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a base register and quadro word size operator.
* @param base The base register.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &base ) {
next().addr( EffectiveAddress(base), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, displacement and optional size operator.
* @param base The base register.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &base, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress( base, displacement ), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a base register, displacement and byte size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &base, const Integer &displacement ) {
next().addr( EffectiveAddress( base, displacement ), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, displacement and word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &base, const Integer &displacement ) {
next().addr( EffectiveAddress( base, displacement ), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, displacement and double word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &base, const Integer &displacement ) {
next().addr( EffectiveAddress( base, displacement ), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, displacement and quadro word size operator.
* @param base The base register.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &base, const Integer &displacement ) {
next().addr( EffectiveAddress( base, displacement ), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for an index register, scaleFactor, displacement and optional size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress( index, scaleFactor, displacement ), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for an index register, scaleFactor, displacement and byte size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for an index register, scaleFactor, displacement and word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for an index register, scaleFactor, displacement and double word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for an index register, scaleFactor, displacement and quadro word size operator.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( index, scaleFactor, displacement ), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register and optional size operator.
* @param base The base register.
* @param index The index register.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &base, const Register &index, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress( base, index ), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register and byte size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &base, const Register &index ) {
next().addr( EffectiveAddress( base, index ), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register and word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &base, const Register &index ) {
next().addr( EffectiveAddress( base, index ), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register and double word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &base, const Register &index ) {
next().addr( EffectiveAddress( base, index ), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register and quadro word size operator.
* @param base The base register.
* @param index The index register.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &base, const Register &index ) {
next().addr( EffectiveAddress( base, index ), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and optional size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &base, const Register &index, fcml_uint8_t scaleFactor, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress( base, index, scaleFactor ), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and byte size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
next().addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
next().addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and double word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
next().addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and quadro word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &base, const Register &index, fcml_uint8_t scaleFactor ) {
next().addr( EffectiveAddress( base, index, scaleFactor ), FCML_DS_64 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and optional size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @param sizeOperator The optional size operator.
* @return The created operator.
* @since 1.1.0
*/
IB& eff( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement, fcml_usize sizeOperator = FCML_DS_UNDEF ) {
next().addr( EffectiveAddress( base, index, scaleFactor, displacement ), sizeOperator );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and byte size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effb( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_8 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effw( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_16 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and double word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effd( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_32 );
return *this;
}
/**
* Adds an an effective address based operator for a base register, index register, scale factor and quardo word size operator.
* @param base The base register.
* @param index The index register.
* @param scaleFactor The scale factor.
* @param displacement The displacement value.
* @return The created operator.
* @since 1.1.0
*/
IB& effq( const Register &base, const Register &index, fcml_uint8_t scaleFactor, const Integer &displacement ) {
next().addr( EffectiveAddress( base, index, scaleFactor, displacement ), FCML_DS_64 );
return *this;
}
/**
* Adds an operand to the instruction being built.
* @param operand The operand to be added.
* @return The instruction builder with the new operand added to it.
* @since 1.1.0
*/
IB& operator <<(const Operand &operand) {
next() = operand;
return *this;
}
/**
* Adds a prefix to the instruction being built.
* @param prefix The prefix to be added.
* @return The instruction builder with the new prefix set for it.
* @since 1.1.0
*/
IB& operator <<(const InstructionPrefix &prefix) {
return set(prefix);
}
/**
* Adds an instruction level hint to the instruction being built.
* @param hint The hint to be added.
* @return The instruction builder with the new hint added to it.
* @since 1.1.0
*/
IB& operator <<(const InstructionHint &hint) {
return set( hint );
}
/**
* Adds an operand level hint to the instruction being built.
* @param hint The hint to be added.
* @return The instruction builder with the new hint added to it.
* @since 1.1.0
*/
IB& operator <<(const OperandHint &hint) {
return set( hint );
}
/**
* Adds a prefix to the instruction being built.
* @param prefix The prefix to be added.
* @return The instruction builder with the new prefix set for it.
* @since 1.1.0
*/
IB& set( const InstructionPrefix &prefix ) {
_prefixes |= prefix._prefix;
return *this;
}
/**
* Adds an instruction level hint to the instruction being built.
* @param hint The hint to be added.
* @return The instruction builder with the new hint added to it.
* @since 1.1.0
*/
IB& set( const InstructionHint &hint ) {
_hints |= hint._hint;
return *this;
}
/**
* Adds an operand level hint to the instruction being built.
* @param hint The hint to be added.
* @return The instruction builder with the new hint added to it.
* @since 1.1.0
*/
IB& set( const OperandHint &hint ) {
if( _operandsCount == 0 ) {
throw IllegalStateException( FCML_TEXT( "There are no operands yet for the current instruction.." ) );
}
_operands[_operandsCount-1].setHints( _operands[_operandsCount-1].getHints() | hint._hint );
return *this;
}
private:
/**
* Gets the next instruction operand.
* @return A reference to the next instruction operand.
* @since 1.1.0
*/
Operand& next() {
sanityCheck();
return _operands[_operandsCount++];
}
/**
* Throws exception if there is no more space for new operands in the builder.
* @throw IllegalStateException Operand's number exceeds maximal number of operands allowed.
* @since 1.1.0
*/
void sanityCheck() const {
if( _operandsCount == FCML_OPERANDS_COUNT ) {
throw IllegalStateException( FCML_TEXT( "Operand's number exceeds maximal number of operands allowed." ) );
}
}
private:
/** Instruction hints. */
fcml_hints _hints;
/** Instruction prefixes.*/
fcml_prefixes _prefixes;
/** Instruction mnemonic. */
fcml_cstring _mnemonic;
/** Number of operands available in the builder. */
fcml_int _operandsCount;
/** Operands for the built instruction. */
Operand _operands[FCML_OPERANDS_COUNT];
};
/** Two way conversion for common types.
* @since 1.1.0
* @remarks Internal API, not intended to be used outside.
*/
class TypeConverter {
public:
static void convert( const fcml_st_entry_point &src, EntryPoint &dest ) {
dest.setIP( src.ip );
dest.setOpMode( static_cast<EntryPoint::OperatingMode>( src.op_mode ) );
dest.setAddressSizeAttribute( src.address_size_attribute );
dest.setOperandSizeAttribute( src.operand_size_attribute );
}
static void convert( const EntryPoint &src, fcml_st_entry_point &dest ) {
dest.ip = src.getIP();
dest.op_mode = static_cast<fcml_en_operating_mode>( src.getOpMode() );
dest.address_size_attribute = src.getAddressSizeAttribute();
dest.operand_size_attribute = src.getOperandSizeAttribute();
}
static void convert( const fcml_st_integer &src, Integer &dest ) {
dest.setInt8( src.int8 );
dest.setInt16( src.int16 );
dest.setInt32( src.int32 );
dest.setInt64( src.int64 );
dest.setSigned( src.is_signed );
dest.setSize( src.size );
}
static void convert( const Integer &src, fcml_st_integer &dest ) {
dest.int8 = src.getInt8();
dest.int16 = src.getInt16();
dest.int32 = src.getInt32();
dest.int64 = src.getInt64();
dest.is_signed = src.isSigned();
dest.size = src.getSize();
}
static void convert( const fcml_st_offset &src, Integer &dest ) {
dest.setInt16( src.off16 );
dest.setInt32( src.off32 );
dest.setInt64( src.off64 );
dest.setSigned( src.is_signed );
dest.setSize( src.size );
}
static void convert( const Integer &src, fcml_st_offset &dest ) {
dest.off16 = src.getSize() == FCML_DS_8 ? src.getInt8() : src.getInt16();
dest.off32 = src.getInt32();
dest.off64 = src.getInt64();
dest.is_signed = src.isSigned();
dest.size = src.getSize();
}
static void convert( const fcml_st_register &src, Register &dest ) {
dest.setReg( src.reg );
dest.setSize( src.size );
dest.setType( static_cast<Register::RegisterType>( src.type ) );
dest.setX64Exp( src.x64_exp ? true : false );
}
static void convert( const Register &src, fcml_st_register &dest ) {
dest.reg = src.getReg();
dest.size = src.getSize();
dest.type = static_cast<fcml_en_register>( src.getType() );
dest.x64_exp = src.getX64Exp();
}
static void convert( const fcml_st_far_pointer &src, FarPointer &dest ) {
dest.setOffset16( src.offset16 );
dest.setOffset32( src.offset32 );
dest.setOffsetSize( src.offset_size );
dest.setSegment( src.segment );
}
static void convert( const FarPointer &src, fcml_st_far_pointer &dest ) {
dest.offset16 = src.getOffset16();
dest.offset32 = src.getOffset32();
dest.offset_size = src.getOffsetSize();
dest.segment = src.getSegment();
}
static void convert( const fcml_st_segment_selector &src, SegmentSelector &dest ) {
dest.setDefaultReg( src.is_default_reg ? true : false );
convert( src.segment_selector, dest.getSegmentSelector() );
}
static void convert( const SegmentSelector &src, fcml_st_segment_selector &dest ) {
dest.is_default_reg = src.isDefaultReg();
convert( src.getSegmentSelector(), dest.segment_selector );
}
static void convert( const fcml_st_effective_address &src, EffectiveAddress &dest ) {
convert( src.base, dest.getBase() );
convert( src.index, dest.getIndex() );
convert( src.displacement, dest.getDisplacement() );
dest.setScaleFactor(src.scale_factor);
}
static void convert( const EffectiveAddress &src, fcml_st_effective_address &dest ) {
convert( src.getBase(), dest.base );
convert( src.getIndex(), dest.index );
convert( src.getDisplacement(), dest.displacement );
dest.scale_factor = src.getScaleFactor();
}
static void convert( const fcml_st_address &src, Address &dest ) {
dest.setAddressForm( static_cast<Address::AddressForm>( src.address_form ) );
dest.setSizeOperator( src.size_operator );
convert( src.segment_selector, dest.getSegmentSelector() );
convert( src.effective_address, dest.getEffectiveAddress() );
convert( src.offset, dest.getOffset() );
}
static void convert( const Address &src, fcml_st_address &dest ) {
dest.address_form = static_cast<fcml_en_effective_address_form>( src.getAddressForm() );
dest.size_operator = src.getSizeOperator();
convert( src.getSegmentSelector(), dest.segment_selector );
convert( src.getEffectiveAddress(), dest.effective_address );
convert( src.getOffset(), dest.offset );
}
static void convert( const fcml_st_operand &src, Operand &dest ) {
dest.setHints( src.hints );
dest.setOperandType( static_cast<Operand::OperandType>( src.type ) );
convert( src.reg, dest.getRegister() );
convert( src.address, dest.getAddress() );
convert( src.far_pointer, dest.getFarPointer() );
convert( src.immediate, dest.getImmediate() );
}
static void convert( const Operand &src, fcml_st_operand &dest ) {
dest.hints = src.getHints();
dest.type = static_cast<fcml_en_operand_type>( src.getOperandType() );
convert( src.getAddress(), dest.address );
convert( src.getFarPointer(), dest.far_pointer );
convert( src.getImmediate(), dest.immediate );
convert( src.getRegister(), dest.reg );
}
static void convert( const fcml_st_condition &src, Condition &dest ) {
dest.setConditionType( static_cast<Condition::ConditionType>( src.condition_type ) );
dest.setNegation( src.is_negation ? true : false );
}
static void convert( const Condition &src, fcml_st_condition &dest ) {
dest.condition_type = static_cast<fcml_en_condition_type>( src.getConditionType() );
dest.is_negation = src.isNegation();
}
static void convert( const fcml_st_instruction &src, Instruction &dest ) {
dest.setMnemonic( src.mnemonic );
convert( src.condition, dest.getCondition() );
dest.setHints( src.hints );
dest.setPrefixes( src.prefixes );
dest.setConditional( src.is_conditional ? true : false );
for( int i = 0; i < FCML_OPERANDS_COUNT; i++ ) {
convert( src.operands[i], dest[i] );
}
dest.setOperandsCount(src.operands_count);
}
static void convert( const Instruction &src, fcml_st_instruction &dest ) {
// Bear in mind that you are responsible for freeing mnemonic duplicated here.
dest.mnemonic = Env::strDup( src.getMnemonic().c_str() );
convert( src.getCondition(), dest.condition );
dest.hints = src.getHints();
dest.prefixes = src.getPrefixes();
dest.is_conditional = src.isConditional();
for( int i = 0; i < FCML_OPERANDS_COUNT; i++ ) {
convert( src[i], dest.operands[i] );
}
dest.operands_count = src.getOperandsCount();
}
static void free( fcml_st_instruction &instruction ) {
if( instruction.mnemonic ) {
Env::strFree( instruction.mnemonic );
instruction.mnemonic = NULL;
}
}
};
}
#endif //FCML_COMMON_HPP_
|