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
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
// SPDX-FileCopyrightText: 2013 Giovanni Campagna <scampa.giovanni@gmail.com>
// SPDX-FileCopyrightText: 2020 Marco Trevisan <marco.trevisan@canonical.com>
#include <config.h>
#include <inttypes.h>
#include <stddef.h> // for size_t
#include <stdint.h>
#include <string.h>
#include <limits>
#include <tuple>
#include <type_traits>
#include <unordered_set> // for unordered_set::erase(), insert()
#include <utility>
#include <ffi.h>
#include <girepository.h>
#include <glib.h>
#include <js/Conversions.h>
#include <js/RootingAPI.h>
#include <js/TypeDecls.h>
#include <js/Utility.h> // for UniqueChars
#include <js/Value.h>
#include <js/experimental/TypedData.h>
#include <jsapi.h> // for InformalValueTypeName, JS_TypeOfValue
#include <jspubtd.h> // for JSTYPE_FUNCTION
#include "gi/arg-cache.h"
#include "gi/arg-inl.h"
#include "gi/arg-types-inl.h"
#include "gi/arg.h"
#include "gi/boxed.h"
#include "gi/closure.h"
#include "gi/foreign.h"
#include "gi/function.h"
#include "gi/fundamental.h"
#include "gi/gerror.h"
#include "gi/gtype.h"
#include "gi/js-value-inl.h"
#include "gi/object.h"
#include "gi/param.h"
#include "gi/union.h"
#include "gi/value.h"
#include "gi/wrapperutils.h" // for GjsTypecheckNoThrow
#include "cjs/byteArray.h"
#include "cjs/enum-utils.h" // for operator&, operator|=, operator|
#include "cjs/jsapi-util.h"
#include "cjs/macros.h"
#include "util/log.h"
enum ExpectedType {
OBJECT,
FUNCTION,
STRING,
LAST,
};
static const char* expected_type_names[] = {"object", "function", "string"};
static_assert(G_N_ELEMENTS(expected_type_names) == ExpectedType::LAST,
"Names must match the values in ExpectedType");
static constexpr void gjs_gi_argument_set_array_length(GITypeTag tag,
GIArgument* arg,
size_t value) {
switch (tag) {
case GI_TYPE_TAG_INT8:
gjs_arg_set<int8_t>(arg, value);
break;
case GI_TYPE_TAG_UINT8:
gjs_arg_set<uint8_t>(arg, value);
break;
case GI_TYPE_TAG_INT16:
gjs_arg_set<int16_t>(arg, value);
break;
case GI_TYPE_TAG_UINT16:
gjs_arg_set<uint16_t>(arg, value);
break;
case GI_TYPE_TAG_INT32:
gjs_arg_set<int32_t>(arg, value);
break;
case GI_TYPE_TAG_UINT32:
gjs_arg_set<uint32_t>(arg, value);
break;
case GI_TYPE_TAG_INT64:
gjs_arg_set<int64_t>(arg, value);
break;
case GI_TYPE_TAG_UINT64:
gjs_arg_set<uint64_t>(arg, value);
break;
default:
g_assert_not_reached();
}
}
GJS_JSAPI_RETURN_CONVENTION
static bool report_typeof_mismatch(JSContext* cx, const char* arg_name,
JS::HandleValue value,
ExpectedType expected) {
gjs_throw(cx, "Expected type %s for argument '%s' but got type %s",
expected_type_names[expected], arg_name,
JS::InformalValueTypeName(value));
return false;
}
GJS_JSAPI_RETURN_CONVENTION
static bool report_gtype_mismatch(JSContext* cx, const char* arg_name,
JS::Value value, GType expected) {
gjs_throw(
cx, "Expected an object of type %s for argument '%s' but got type %s",
g_type_name(expected), arg_name, JS::InformalValueTypeName(value));
return false;
}
GJS_JSAPI_RETURN_CONVENTION
static bool report_invalid_null(JSContext* cx, const char* arg_name) {
gjs_throw(cx, "Argument %s may not be null", arg_name);
return false;
}
// Overload operator| so that Visual Studio won't complain
// when converting unsigned char to GjsArgumentFlags
GjsArgumentFlags operator|(
GjsArgumentFlags const& v1, GjsArgumentFlags const& v2) {
return static_cast<GjsArgumentFlags>(std::underlying_type<GjsArgumentFlags>::type(v1) |
std::underlying_type<GjsArgumentFlags>::type(v2));
}
namespace Gjs {
namespace Arg {
// Arguments Interfaces:
//
// Each of these types are meant to be used to extend each Gjs::Argument
// implementation, taking advantage of the C++ multiple inheritance.
struct BasicType {
constexpr BasicType() : m_tag(GI_TYPE_TAG_VOID) {}
constexpr explicit BasicType(GITypeTag tag) : m_tag(tag) {}
constexpr operator GITypeTag() const { return m_tag; }
GITypeTag m_tag : 5;
};
struct HasTypeInfo {
constexpr GITypeInfo* type_info() const {
// Should be const GITypeInfo*, but G-I APIs won't accept that
return const_cast<GITypeInfo*>(&m_type_info);
}
GITypeInfo m_type_info{};
};
struct Transferable {
constexpr Transferable() : m_transfer(GI_TRANSFER_NOTHING) {}
constexpr explicit Transferable(GITransfer transfer)
: m_transfer(transfer) {}
GITransfer m_transfer : 2;
};
struct Nullable {
constexpr Nullable() : m_nullable(false) {}
bool m_nullable : 1;
bool handle_nullable(JSContext* cx, GIArgument* arg, const char* arg_name);
constexpr GjsArgumentFlags flags() const {
return m_nullable ? GjsArgumentFlags::MAY_BE_NULL
: GjsArgumentFlags::NONE;
}
};
struct Positioned {
void set_arg_pos(int pos) {
g_assert(pos <= Argument::MAX_ARGS &&
"No more than 253 arguments allowed");
m_arg_pos = pos;
}
constexpr bool set_out_parameter(GjsFunctionCallState* state,
GIArgument* arg) {
// Clear all bits of the out C value. No one member is guaranteed to
// span the whole union on all architectures, so use memset() instead of
// gjs_arg_unset<T>().
memset(&state->out_cvalue(m_arg_pos), 0, sizeof(GIArgument));
// The value passed to the function is actually the address of the out
// C value
gjs_arg_set(arg, &state->out_cvalue(m_arg_pos));
return true;
}
constexpr bool set_inout_parameter(GjsFunctionCallState* state,
GIArgument* arg) {
state->out_cvalue(m_arg_pos) = state->inout_original_cvalue(m_arg_pos) =
*arg;
gjs_arg_set(arg, &state->out_cvalue(m_arg_pos));
return true;
}
uint8_t m_arg_pos = 0;
};
struct Array : BasicType {
uint8_t m_length_pos = 0;
GIDirection m_length_direction : 2;
Array() : BasicType(), m_length_direction(GI_DIRECTION_IN) {}
void set_array_length(int pos, GITypeTag tag, GIDirection direction) {
g_assert(pos >= 0 && pos <= Argument::MAX_ARGS &&
"No more than 253 arguments allowed");
m_length_pos = pos;
m_length_direction = direction;
m_tag = tag;
}
};
struct HasIntrospectionInfo {
constexpr explicit HasIntrospectionInfo(GIBaseInfo* info,
const GjsAutoTakeOwnership& add_ref)
: m_info(info, add_ref) {}
constexpr explicit HasIntrospectionInfo(GIBaseInfo* info) : m_info(info) {}
GjsAutoBaseInfo m_info;
};
// boxed / union / GObject
struct GTypedType {
explicit GTypedType(GType gtype) : m_gtype(gtype) {}
constexpr GType gtype() const { return m_gtype; }
protected:
GType m_gtype;
};
struct RegisteredType : GTypedType {
RegisteredType(GType gtype, GIInfoType info_type)
: GTypedType(gtype), m_info_type(info_type) {}
explicit RegisteredType(GIRegisteredTypeInfo* info)
: GTypedType(g_registered_type_info_get_g_type(info)),
m_info_type(g_base_info_get_type(info)) {
g_assert(m_gtype != G_TYPE_NONE &&
"Use RegisteredInterface for this type");
}
GIInfoType m_info_type : 5;
};
struct RegisteredInterface : HasIntrospectionInfo, GTypedType {
explicit RegisteredInterface(GIRegisteredTypeInfo* info)
: HasIntrospectionInfo(info, GjsAutoTakeOwnership{}),
GTypedType(g_registered_type_info_get_g_type(m_info)) {}
};
struct Callback : Nullable, HasIntrospectionInfo {
explicit Callback(GICallbackInfo* info)
: HasIntrospectionInfo(info, GjsAutoTakeOwnership{}),
m_scope(GI_SCOPE_TYPE_INVALID) {}
inline void set_callback_destroy_pos(int pos) {
g_assert(pos <= Argument::MAX_ARGS &&
"No more than 253 arguments allowed");
m_destroy_pos = pos < 0 ? Argument::ABSENT : pos;
}
[[nodiscard]] constexpr bool has_callback_destroy() {
return m_destroy_pos != Argument::ABSENT;
}
inline void set_callback_closure_pos(int pos) {
g_assert(pos <= Argument::MAX_ARGS &&
"No more than 253 arguments allowed");
m_closure_pos = pos < 0 ? Argument::ABSENT : pos;
}
[[nodiscard]] constexpr bool has_callback_closure() {
return m_closure_pos != Argument::ABSENT;
}
uint8_t m_closure_pos = Argument::ABSENT;
uint8_t m_destroy_pos = Argument::ABSENT;
GIScopeType m_scope : 3;
};
struct Enum {
explicit Enum(GIEnumInfo*);
bool m_unsigned : 1;
uint32_t m_min = 0;
uint32_t m_max = 0;
};
struct Flags {
explicit Flags(GIEnumInfo*);
unsigned m_mask = 0;
};
struct CallerAllocates {
size_t m_allocates_size = 0;
};
// Gjs::Arguments:
//
// Each argument, irrespective of the direction, is processed in three phases:
// - before calling the function [in]
// - after calling it, when converting the return value and out arguments [out]
// - at the end of the invocation, to release any allocated memory [release]
//
// Some types don't have direction (for example, caller_allocates is only out,
// and callback is only in), in which case it is implied.
struct SkipAll : Argument {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return skip();
}
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
}
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
protected:
constexpr bool skip() { return true; }
};
struct Generic : SkipAll, Transferable, HasTypeInfo {};
struct GenericIn : Generic {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return invalid(cx, G_STRFUNC);
}
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct GenericInOut : GenericIn, Positioned {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct GenericOut : GenericInOut {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
GITypeTag return_tag() const override {
return g_type_info_get_tag(&const_cast<GenericOut*>(this)->m_type_info);
}
const GITypeInfo* return_type() const override { return &m_type_info; }
};
struct GenericReturn : ReturnValue {
// No in!
bool in(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return invalid(cx, G_STRFUNC);
}
};
template <typename T, GITypeTag TAG = GI_TYPE_TAG_VOID>
struct NumericOut : SkipAll, Positioned {
static_assert(std::is_arithmetic_v<T>, "Not arithmetic type");
bool in(JSContext*, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue) override {
return set_out_parameter(state, arg);
}
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::MutableHandleValue value) override {
return Gjs::c_value_to_js_checked<T, TAG>(cx, gjs_arg_get<T>(arg),
value);
}
};
using BooleanOut = NumericOut<gboolean, GI_TYPE_TAG_BOOLEAN>;
template <typename T, GITypeTag TAG = GI_TYPE_TAG_VOID>
struct NumericReturn : SkipAll {
static_assert(std::is_arithmetic_v<T>, "Not arithmetic type");
bool in(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return invalid(cx, G_STRFUNC);
}
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::MutableHandleValue value) override {
return Gjs::c_value_to_js_checked<T, TAG>(cx, gjs_arg_get<T>(arg),
value);
}
GITypeTag return_tag() const override { return TAG; }
};
using BooleanReturn = NumericReturn<gboolean, GI_TYPE_TAG_BOOLEAN>;
struct SimpleOut : SkipAll, Positioned {
bool in(JSContext*, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue) override {
return set_out_parameter(state, arg);
};
};
struct ExplicitArray : GenericOut, Array, Nullable {
GjsArgumentFlags flags() const override {
return Argument::flags() | Nullable::flags();
}
};
struct ExplicitArrayIn : ExplicitArray {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
};
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct ExplicitArrayInOut : ExplicitArrayIn {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct ExplicitArrayOut : ExplicitArrayInOut {
bool in(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return invalid(cx, G_STRFUNC);
}
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct ReturnArray : ExplicitArrayOut {
bool in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) override {
if (m_length_direction != GI_DIRECTION_OUT) {
gjs_throw(cx,
"Using different length argument direction for array %s"
"is not supported for out arrays",
m_arg_name);
return false;
}
return GenericOut::in(cx, state, arg, value);
};
};
using ArrayLengthOut = SimpleOut;
struct FallbackIn : GenericIn, Nullable {
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
}
GjsArgumentFlags flags() const override {
return Argument::flags() | Nullable::flags();
}
};
using FallbackInOut = GenericInOut;
using FallbackOut = GenericOut;
struct NotIntrospectable : GenericIn {
explicit NotIntrospectable(NotIntrospectableReason reason)
: m_reason(reason) {}
NotIntrospectableReason m_reason;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct NullableIn : SkipAll, Nullable {
inline bool in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue) override {
return handle_nullable(cx, arg, m_arg_name);
}
GjsArgumentFlags flags() const override {
return Argument::flags() | Nullable::flags();
}
};
struct Instance : NullableIn {
// Some calls accept null for the instance (thus we inherit from
// NullableIn), but generally in an object oriented language it's wrong to
// call a method on null.
// As per this we actually default to SkipAll methods.
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return skip();
}
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
}
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
const Instance* as_instance() const override { return this; }
// The instance GType can be useful only in few cases such as GObjects and
// GInterfaces, so we don't store it by default, unless needed.
// See Function's code to see where this is relevant.
virtual GType gtype() const { return G_TYPE_NONE; }
};
struct EnumIn : Instance, Enum {
using Enum::Enum;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct FlagsIn : Instance, Flags {
using Flags::Flags;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct RegisteredIn : Instance, RegisteredType, Transferable {
using RegisteredType::RegisteredType;
GType gtype() const override { return RegisteredType::gtype(); }
};
struct RegisteredInterfaceIn : Instance, RegisteredInterface, Transferable {
using RegisteredInterface::RegisteredInterface;
GType gtype() const override { return RegisteredInterface::gtype(); }
};
struct ForeignStructInstanceIn : RegisteredInterfaceIn {
using RegisteredInterfaceIn::RegisteredInterfaceIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct ForeignStructIn : ForeignStructInstanceIn {
using ForeignStructInstanceIn::ForeignStructInstanceIn;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct FallbackInterfaceIn : RegisteredInterfaceIn, HasTypeInfo {
using RegisteredInterfaceIn::RegisteredInterfaceIn;
bool in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) override {
return gjs_value_to_gi_argument(cx, value, &m_type_info, m_arg_name,
GJS_ARGUMENT_ARGUMENT, m_transfer,
flags(), arg);
}
};
struct BoxedInTransferNone : RegisteredIn {
using RegisteredIn::RegisteredIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
virtual GIBaseInfo* info() const { return nullptr; }
};
struct BoxedIn : BoxedInTransferNone {
using BoxedInTransferNone::BoxedInTransferNone;
// This is a smart argument, no release needed
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
};
struct UnregisteredBoxedIn : BoxedIn, HasIntrospectionInfo {
explicit UnregisteredBoxedIn(GIStructInfo* info)
: BoxedIn(g_registered_type_info_get_g_type(info),
g_base_info_get_type(info)),
HasIntrospectionInfo(info, GjsAutoTakeOwnership{}) {}
// This is a smart argument, no release needed
GIBaseInfo* info() const override { return m_info; }
};
struct GValueIn : BoxedIn {
using BoxedIn::BoxedIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct GValueInTransferNone : GValueIn {
using GValueIn::GValueIn;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct GClosureInTransferNone : BoxedInTransferNone {
using BoxedInTransferNone::BoxedInTransferNone;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct GClosureIn : GClosureInTransferNone {
using GClosureInTransferNone::GClosureInTransferNone;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
};
struct GBytesIn : BoxedIn {
using BoxedIn::BoxedIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument* in_arg,
GIArgument* out_arg) override;
};
struct GBytesInTransferNone : GBytesIn {
using GBytesIn::GBytesIn;
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument* in_arg,
GIArgument* out_arg) override {
return BoxedInTransferNone::release(cx, state, in_arg, out_arg);
}
};
struct ObjectIn : RegisteredIn {
using RegisteredIn::RegisteredIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// This is a smart argument, no release needed
};
struct InterfaceIn : RegisteredIn {
using RegisteredIn::RegisteredIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// This is a smart argument, no release needed
};
struct FundamentalIn : RegisteredIn {
using RegisteredIn::RegisteredIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// This is a smart argument, no release needed
};
struct UnionIn : RegisteredIn {
using RegisteredIn::RegisteredIn;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// This is a smart argument, no release needed
};
struct NullIn : NullableIn {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct BooleanIn : SkipAll {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
template <typename T>
struct NumericIn : SkipAll {
static_assert(std::is_arithmetic_v<T>, "Not arithmetic type");
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
template <typename T, GITypeTag TAG = GI_TYPE_TAG_VOID>
struct NumericInOut : NumericIn<T>, Positioned {
static_assert(std::is_arithmetic_v<T>, "Not arithmetic type");
bool in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) override {
if (!NumericIn<T>::in(cx, state, arg, value))
return false;
return set_inout_parameter(state, arg);
}
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::MutableHandleValue value) override {
return Gjs::c_value_to_js_checked<T, TAG>(cx, gjs_arg_get<T>(arg),
value);
}
};
using BooleanInOut = NumericInOut<gboolean, GI_TYPE_TAG_BOOLEAN>;
struct UnicharIn : SkipAll {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
struct GTypeIn : SkipAll {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
};
template <GITypeTag TAG = GI_TYPE_TAG_UTF8>
struct StringInTransferNone : NullableIn {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct StringIn : StringInTransferNone<GI_TYPE_TAG_UTF8> {
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
};
template <GITransfer TRANSFER = GI_TRANSFER_NOTHING>
struct StringOutBase : SkipAll {
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::MutableHandleValue value) override {
return Gjs::c_value_to_js(cx, gjs_arg_get<char*>(arg), value);
}
bool release(JSContext* cx, GjsFunctionCallState*, GIArgument*,
GIArgument* out_arg [[maybe_unused]]) override {
if constexpr (TRANSFER == GI_TRANSFER_NOTHING) {
return skip();
} else if constexpr (TRANSFER == GI_TRANSFER_EVERYTHING) {
g_clear_pointer(&gjs_arg_member<char*>(out_arg), g_free);
return true;
} else {
return invalid(cx, G_STRFUNC);
}
}
};
template <GITransfer TRANSFER = GI_TRANSFER_NOTHING>
struct StringReturn : StringOutBase<TRANSFER> {
bool in(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override {
return Argument::invalid(cx, G_STRFUNC);
}
GITypeTag return_tag() const override { return GI_TYPE_TAG_UTF8; }
};
template <GITransfer TRANSFER = GI_TRANSFER_NOTHING>
struct StringOut : StringOutBase<TRANSFER>, Positioned {
bool in(JSContext*, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue) override {
return set_out_parameter(state, arg);
}
};
using FilenameInTransferNone = StringInTransferNone<GI_TYPE_TAG_FILENAME>;
struct FilenameIn : FilenameInTransferNone {
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override {
return skip();
}
};
// .out is ignored for the instance parameter
struct GTypeStructInstanceIn : Instance {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// no out
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return invalid(cx, G_STRFUNC);
};
};
struct ParamInstanceIn : Instance, Transferable {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
// no out
bool out(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return invalid(cx, G_STRFUNC);
};
};
struct CallbackIn : SkipAll, Callback {
using Callback::Callback;
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
private:
ffi_closure *m_ffi_closure;
};
using CArrayIn = ExplicitArrayIn;
using CArrayInOut = ExplicitArrayInOut;
using CArrayOut = ReturnArray;
struct CallerAllocatesOut : GenericOut, CallerAllocates {
bool in(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) override;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
GjsArgumentFlags flags() const override {
return GenericOut::flags() | GjsArgumentFlags::CALLER_ALLOCATES;
}
};
struct BoxedCallerAllocatesOut : CallerAllocatesOut, GTypedType {
using GTypedType::GTypedType;
bool release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) override;
};
struct ZeroTerminatedArrayInOut : GenericInOut {
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument*,
GIArgument* out_arg) override {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
GIArgument* original_out_arg = &state->inout_original_cvalue(m_arg_pos);
if (!gjs_gi_argument_release_in_array(cx, transfer, &m_type_info,
original_out_arg))
return false;
transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_EVERYTHING;
return gjs_gi_argument_release_out_array(cx, transfer, &m_type_info,
out_arg);
}
};
struct ZeroTerminatedArrayIn : GenericIn, Nullable {
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
}
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument* in_arg,
GIArgument*) override {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
return gjs_gi_argument_release_in_array(cx, transfer, &m_type_info,
in_arg);
}
GjsArgumentFlags flags() const override {
return Argument::flags() | Nullable::flags();
}
};
struct FixedSizeArrayIn : GenericIn {
bool out(JSContext*, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) override {
return skip();
}
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument* in_arg,
GIArgument*) override {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
int size = g_type_info_get_array_fixed_size(&m_type_info);
return gjs_gi_argument_release_in_array(cx, transfer, &m_type_info,
size, in_arg);
}
};
struct FixedSizeArrayInOut : GenericInOut {
bool release(JSContext* cx, GjsFunctionCallState* state, GIArgument*,
GIArgument* out_arg) override {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
GIArgument* original_out_arg = &state->inout_original_cvalue(m_arg_pos);
int size = g_type_info_get_array_fixed_size(&m_type_info);
if (!gjs_gi_argument_release_in_array(cx, transfer, &m_type_info, size,
original_out_arg))
return false;
transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_EVERYTHING;
return gjs_gi_argument_release_out_array(cx, transfer, &m_type_info,
size, out_arg);
}
};
GJS_JSAPI_RETURN_CONVENTION
bool NotIntrospectable::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument*, JS::HandleValue) {
const char* reason_string = "invalid introspection";
switch (m_reason) {
case CALLBACK_OUT:
reason_string = "callback out-argument";
break;
case DESTROY_NOTIFY_NO_CALLBACK:
reason_string = "DestroyNotify argument with no callback";
break;
case DESTROY_NOTIFY_NO_USER_DATA:
reason_string = "DestroyNotify argument with no user data";
break;
case INTERFACE_TRANSFER_CONTAINER:
reason_string = "type not supported for (transfer container)";
break;
case OUT_CALLER_ALLOCATES_NON_STRUCT:
reason_string = "type not supported for (out caller-allocates)";
break;
case UNREGISTERED_BOXED_WITH_TRANSFER:
reason_string =
"boxed type with transfer not registered as a GType";
break;
case UNREGISTERED_UNION:
reason_string = "union type not registered as a GType";
break;
case UNSUPPORTED_TYPE:
reason_string = "type not supported by introspection";
break;
case LAST_REASON:
g_assert_not_reached();
}
gjs_throw(cx,
"Function %s() cannot be called: argument '%s' with type %s is "
"not introspectable because it has a %s",
state->display_name().get(), m_arg_name,
g_type_tag_to_string(g_type_info_get_tag(&m_type_info)),
reason_string);
return false;
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
return gjs_value_to_gi_argument(cx, value, &m_type_info, m_arg_name,
GJS_ARGUMENT_ARGUMENT, m_transfer, flags(),
arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericInOut::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (!GenericIn::in(cx, state, arg, value))
return false;
return set_inout_parameter(state, arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayIn::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
void* data;
size_t length;
if (m_length_direction != GI_DIRECTION_INOUT &&
m_length_direction != GI_DIRECTION_IN) {
gjs_throw(cx, "Using different length argument direction for array %s"
"is not supported for in arrays", m_arg_name);
return false;
}
if (!gjs_array_to_explicit_array(cx, value, &m_type_info, m_arg_name,
GJS_ARGUMENT_ARGUMENT, m_transfer, flags(),
&data, &length))
return false;
gjs_gi_argument_set_array_length(m_tag, &state->in_cvalue(m_length_pos),
length);
gjs_arg_set(arg, data);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayInOut::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (!ExplicitArrayIn::in(cx, state, arg, value))
return false;
uint8_t length_pos = m_length_pos;
uint8_t ix = m_arg_pos;
if (!gjs_arg_get<void*>(arg)) {
// Special case where we were given JS null to also pass null for
// length, and not a pointer to an integer that derefs to 0.
gjs_arg_unset<void*>(&state->in_cvalue(length_pos));
gjs_arg_unset<int>(&state->out_cvalue(length_pos));
gjs_arg_unset<int>(&state->inout_original_cvalue(length_pos));
gjs_arg_unset<void*>(&state->out_cvalue(ix));
gjs_arg_unset<void*>(&state->inout_original_cvalue(ix));
} else {
if G_LIKELY (m_length_direction == GI_DIRECTION_INOUT) {
state->out_cvalue(length_pos) =
state->inout_original_cvalue(length_pos) =
state->in_cvalue(length_pos);
gjs_arg_set(&state->in_cvalue(length_pos),
&state->out_cvalue(length_pos));
}
state->out_cvalue(ix) = state->inout_original_cvalue(ix) = *arg;
gjs_arg_set(arg, &state->out_cvalue(ix));
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool CallbackIn::in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
GjsCallbackTrampoline* trampoline;
void* closure;
if (value.isNull() && m_nullable) {
closure = nullptr;
trampoline = nullptr;
m_ffi_closure = nullptr;
} else {
if (JS_TypeOfValue(cx, value) != JSTYPE_FUNCTION) {
gjs_throw(cx, "Expected function for callback argument %s, got %s",
m_arg_name, JS::InformalValueTypeName(value));
return false;
}
JS::RootedObject callable(cx, &value.toObject());
bool is_object_method = !!state->instance_object;
trampoline = GjsCallbackTrampoline::create(
cx, callable, m_info, m_scope, is_object_method, false);
if (!trampoline)
return false;
if (m_scope == GI_SCOPE_TYPE_NOTIFIED && is_object_method) {
auto* priv = ObjectInstance::for_js(cx, state->instance_object);
if (!priv) {
gjs_throw(cx, "Signal connected to wrong type of object");
return false;
}
if (!priv->associate_closure(cx, trampoline))
return false;
}
closure = trampoline->closure();
m_ffi_closure = trampoline->get_ffi_closure();
}
if (has_callback_destroy()) {
GDestroyNotify destroy_notify = nullptr;
if (trampoline) {
/* Adding another reference and a DestroyNotify that unsets it */
g_closure_ref(trampoline);
destroy_notify = [](void* data) {
g_assert(data);
g_closure_unref(static_cast<GClosure*>(data));
};
}
gjs_arg_set(&state->in_cvalue(m_destroy_pos), destroy_notify);
}
if (has_callback_closure())
gjs_arg_set(&state->in_cvalue(m_closure_pos), trampoline);
if (trampoline && m_scope == GI_SCOPE_TYPE_ASYNC) {
// Add an extra reference that will be cleared when garbage collecting
// async calls
g_closure_ref(trampoline);
}
bool keep_forever =
!has_callback_destroy() && (
#if GI_CHECK_VERSION(1, 72, 0)
m_scope == GI_SCOPE_TYPE_FOREVER ||
#endif
m_scope == GI_SCOPE_TYPE_NOTIFIED);
if (trampoline && keep_forever) {
trampoline->mark_forever();
}
gjs_arg_set(arg, closure);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericOut::in(JSContext*, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue) {
// Default value in case a broken C function doesn't fill in the pointer
return set_out_parameter(state, arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool CallerAllocatesOut::in(JSContext*, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue) {
void* blob = g_malloc0(m_allocates_size);
gjs_arg_set(arg, blob);
gjs_arg_set(&state->out_cvalue(m_arg_pos), blob);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool NullIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue) {
return handle_nullable(cx, arg, m_arg_name);
}
GJS_JSAPI_RETURN_CONVENTION
bool BooleanIn::in(JSContext*, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
gjs_arg_set(arg, JS::ToBoolean(value));
return true;
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION bool NumericIn<T>::in(JSContext* cx,
GjsFunctionCallState*,
GIArgument* arg,
JS::HandleValue value) {
bool out_of_range = false;
if (!gjs_arg_set_from_js_value<T>(cx, value, arg, &out_of_range)) {
if (out_of_range) {
gjs_throw(cx, "Argument %s: value is out of range for %s",
arg_name(), Gjs::static_type_name<T>());
}
return false;
}
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "%s set to value %s (type %s)",
GjsAutoChar{gjs_argument_display_name(
arg_name(), GJS_ARGUMENT_ARGUMENT)}
.get(),
std::to_string(gjs_arg_get<T>(arg)).c_str(),
Gjs::static_type_name<T>());
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool UnicharIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
if (!value.isString())
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::STRING);
return gjs_unichar_from_string(cx, value, &gjs_arg_member<char32_t>(arg));
}
GJS_JSAPI_RETURN_CONVENTION
bool GTypeIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
if (value.isNull())
return report_invalid_null(cx, m_arg_name);
if (!value.isObject())
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::OBJECT);
JS::RootedObject gtype_obj(cx, &value.toObject());
return gjs_gtype_get_actual_gtype(
cx, gtype_obj, &gjs_arg_member<GType, GI_TYPE_TAG_GTYPE>(arg));
}
// Common code for most types that are pointers on the C side
bool Nullable::handle_nullable(JSContext* cx, GIArgument* arg,
const char* arg_name) {
if (!m_nullable)
return report_invalid_null(cx, arg_name);
gjs_arg_unset<void*>(arg);
return true;
}
template <GITypeTag TAG>
GJS_JSAPI_RETURN_CONVENTION bool StringInTransferNone<TAG>::in(
JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
if (!value.isString())
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::STRING);
if constexpr (TAG == GI_TYPE_TAG_FILENAME) {
GjsAutoChar str;
if (!gjs_string_to_filename(cx, value, &str))
return false;
gjs_arg_set(arg, str.release());
return true;
} else if constexpr (TAG == GI_TYPE_TAG_UTF8) {
JS::UniqueChars str = gjs_string_to_utf8(cx, value);
if (!str)
return false;
gjs_arg_set(arg, g_strdup(str.get()));
return true;
} else {
return invalid(cx, G_STRFUNC);
}
}
GJS_JSAPI_RETURN_CONVENTION
bool EnumIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
int64_t number;
if (!Gjs::js_value_to_c(cx, value, &number))
return false;
// Unpack the values from their uint32_t bitfield. See note in
// Enum::Enum().
int64_t min, max;
if (m_unsigned) {
min = m_min;
max = m_max;
} else {
min = static_cast<int32_t>(m_min);
max = static_cast<int32_t>(m_max);
}
if (number > max || number < min) {
gjs_throw(cx, "%" PRId64 " is not a valid value for enum argument %s",
number, m_arg_name);
return false;
}
if (m_unsigned)
gjs_arg_set<unsigned, GI_TYPE_TAG_INTERFACE>(arg, number);
else
gjs_arg_set<int, GI_TYPE_TAG_INTERFACE>(arg, number);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool FlagsIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
int64_t number;
if (!Gjs::js_value_to_c(cx, value, &number))
return false;
if ((uint64_t(number) & m_mask) != uint64_t(number)) {
gjs_throw(cx,
"0x%" PRId64 " is not a valid value for flags argument %s",
number, m_arg_name);
return false;
}
// We cast to unsigned because that's what makes sense, but then we
// put it in the v_int slot because that's what we use to unmarshal
// flags types at the moment.
gjs_arg_set<int, GI_TYPE_TAG_INTERFACE>(arg, static_cast<unsigned>(number));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool ForeignStructInstanceIn::in(JSContext* cx, GjsFunctionCallState*,
GIArgument* arg, JS::HandleValue value) {
return gjs_struct_foreign_convert_to_gi_argument(
cx, value, m_info, m_arg_name, GJS_ARGUMENT_ARGUMENT, m_transfer,
flags(), arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool GValueIn::in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
if (value.isObject()) {
JS::RootedObject obj(cx, &value.toObject());
GType gtype;
if (!gjs_gtype_get_actual_gtype(cx, obj, >ype))
return false;
if (gtype == G_TYPE_VALUE) {
gjs_arg_set(arg, BoxedBase::to_c_ptr<GValue>(cx, obj));
state->ignore_release.insert(arg);
return true;
}
}
Gjs::AutoGValue gvalue;
if (!gjs_value_to_g_value(cx, value, &gvalue))
return false;
gjs_arg_set(arg, g_boxed_copy(G_TYPE_VALUE, &gvalue));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool BoxedInTransferNone::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
GType gtype = RegisteredType::gtype();
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, gtype);
JS::RootedObject object(cx, &value.toObject());
if (gtype == G_TYPE_ERROR) {
return ErrorBase::transfer_to_gi_argument(cx, object, arg,
GI_DIRECTION_IN, m_transfer);
}
return BoxedBase::transfer_to_gi_argument(cx, object, arg, GI_DIRECTION_IN,
m_transfer, gtype, info());
}
// Unions include ClutterEvent and GdkEvent, which occur fairly often in an
// interactive application, so they're worth a special case in a different
// virtual function.
GJS_JSAPI_RETURN_CONVENTION
bool UnionIn::in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
GType gtype = RegisteredType::gtype();
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, gtype);
JS::RootedObject object(cx, &value.toObject());
return UnionBase::transfer_to_gi_argument(cx, object, arg, GI_DIRECTION_IN,
m_transfer, gtype);
}
GJS_JSAPI_RETURN_CONVENTION
bool GClosureInTransferNone::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
if (!(JS_TypeOfValue(cx, value) == JSTYPE_FUNCTION))
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::FUNCTION);
JS::RootedObject callable(cx, &value.toObject());
GClosure* closure = Gjs::Closure::create_marshaled(cx, callable, "boxed");
gjs_arg_set(arg, closure);
g_closure_ref(closure);
g_closure_sink(closure);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool GBytesIn::in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, G_TYPE_BYTES);
JS::RootedObject object(cx, &value.toObject());
if (JS_IsUint8Array(object)) {
state->ignore_release.insert(arg);
gjs_arg_set(arg, gjs_byte_array_get_bytes(object));
return true;
}
// The bytearray path is taking an extra ref irrespective of transfer
// ownership, so we need to do the same here.
return BoxedBase::transfer_to_gi_argument(
cx, object, arg, GI_DIRECTION_IN, GI_TRANSFER_EVERYTHING, G_TYPE_BYTES);
}
GJS_JSAPI_RETURN_CONVENTION
bool GBytesIn::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg, GIArgument* out_arg) {
if (state->ignore_release.erase(in_arg))
return BoxedIn::release(cx, state, in_arg, out_arg);
return BoxedInTransferNone::release(cx, state, in_arg, out_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool InterfaceIn::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
GType gtype = RegisteredType::gtype();
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, gtype);
JS::RootedObject object(cx, &value.toObject());
// Could be a GObject interface that's missing a prerequisite,
// or could be a fundamental
if (ObjectBase::typecheck(cx, object, nullptr, gtype,
GjsTypecheckNoThrow())) {
return ObjectBase::transfer_to_gi_argument(
cx, object, arg, GI_DIRECTION_IN, m_transfer, gtype);
}
// If this typecheck fails, then it's neither an object nor a
// fundamental
return FundamentalBase::transfer_to_gi_argument(
cx, object, arg, GI_DIRECTION_IN, m_transfer, gtype);
}
GJS_JSAPI_RETURN_CONVENTION
bool ObjectIn::in(JSContext* cx, GjsFunctionCallState* state, GIArgument* arg,
JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
GType gtype = RegisteredType::gtype();
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, gtype);
JS::RootedObject object(cx, &value.toObject());
return ObjectBase::transfer_to_gi_argument(cx, object, arg, GI_DIRECTION_IN,
m_transfer, gtype);
}
GJS_JSAPI_RETURN_CONVENTION
bool FundamentalIn::in(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::HandleValue value) {
if (value.isNull())
return NullableIn::in(cx, state, arg, value);
GType gtype = RegisteredType::gtype();
if (!value.isObject())
return report_gtype_mismatch(cx, m_arg_name, value, gtype);
JS::RootedObject object(cx, &value.toObject());
return FundamentalBase::transfer_to_gi_argument(
cx, object, arg, GI_DIRECTION_IN, m_transfer, gtype);
}
GJS_JSAPI_RETURN_CONVENTION
bool GTypeStructInstanceIn::in(JSContext* cx, GjsFunctionCallState*,
GIArgument* arg, JS::HandleValue value) {
// Instance parameter is never nullable
if (!value.isObject())
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::OBJECT);
JS::RootedObject obj(cx, &value.toObject());
GType actual_gtype;
if (!gjs_gtype_get_actual_gtype(cx, obj, &actual_gtype))
return false;
if (actual_gtype == G_TYPE_NONE) {
gjs_throw(cx, "Invalid GType class passed for instance parameter");
return false;
}
// We use peek here to simplify reference counting (we just ignore transfer
// annotation, as GType classes are never really freed.) We know that the
// GType class is referenced at least once when the JS constructor is
// initialized.
if (g_type_is_a(actual_gtype, G_TYPE_INTERFACE))
gjs_arg_set(arg, g_type_default_interface_peek(actual_gtype));
else
gjs_arg_set(arg, g_type_class_peek(actual_gtype));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool ParamInstanceIn::in(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::HandleValue value) {
// Instance parameter is never nullable
if (!value.isObject())
return report_typeof_mismatch(cx, m_arg_name, value,
ExpectedType::OBJECT);
JS::RootedObject obj(cx, &value.toObject());
if (!gjs_typecheck_param(cx, obj, G_TYPE_PARAM, true))
return false;
gjs_arg_set(arg, gjs_g_param_from_param(cx, obj));
if (m_transfer == GI_TRANSFER_EVERYTHING)
g_param_spec_ref(gjs_arg_get<GParamSpec*>(arg));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericInOut::out(JSContext* cx, GjsFunctionCallState*, GIArgument* arg,
JS::MutableHandleValue value) {
return gjs_value_from_gi_argument(cx, value, &m_type_info, arg, true);
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayInOut::out(JSContext* cx, GjsFunctionCallState* state,
GIArgument* arg, JS::MutableHandleValue value) {
GIArgument* length_arg;
if (m_length_direction != GI_DIRECTION_IN)
length_arg = &(state->out_cvalue(m_length_pos));
else
length_arg = &(state->in_cvalue(m_length_pos));
size_t length = gjs_gi_argument_get_array_length(m_tag, length_arg);
return gjs_value_from_explicit_array(cx, value, &m_type_info, m_transfer,
arg, length);
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericIn::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg, GIArgument*) {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
return gjs_gi_argument_release_in_arg(cx, transfer, &m_type_info, in_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericOut::release(JSContext* cx, GjsFunctionCallState*,
GIArgument* in_arg [[maybe_unused]],
GIArgument* out_arg) {
return gjs_gi_argument_release(cx, m_transfer, &m_type_info, out_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool GenericInOut::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument*, GIArgument* out_arg) {
// For inout, transfer refers to what we get back from the function; for
// the temporary C value we allocated, clearly we're responsible for
// freeing it.
GIArgument* original_out_arg = &state->inout_original_cvalue(m_arg_pos);
if (!gjs_gi_argument_release_in_arg(cx, GI_TRANSFER_NOTHING, &m_type_info,
original_out_arg))
return false;
return gjs_gi_argument_release(cx, m_transfer, &m_type_info, out_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayOut::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg [[maybe_unused]],
GIArgument* out_arg) {
GIArgument* length_arg = &state->out_cvalue(m_length_pos);
size_t length = gjs_gi_argument_get_array_length(m_tag, length_arg);
return gjs_gi_argument_release_out_array(cx, m_transfer, &m_type_info,
length, out_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayIn::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
GIArgument* length_arg = &state->in_cvalue(m_length_pos);
size_t length = gjs_gi_argument_get_array_length(m_tag, length_arg);
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
return gjs_gi_argument_release_in_array(cx, transfer, &m_type_info, length,
in_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool ExplicitArrayInOut::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg [[maybe_unused]],
GIArgument* out_arg) {
GIArgument* length_arg = &state->out_cvalue(m_length_pos);
size_t length = gjs_gi_argument_get_array_length(m_tag, length_arg);
// For inout, transfer refers to what we get back from the function; for
// the temporary C value we allocated, clearly we're responsible for
// freeing it.
GIArgument* original_out_arg = &state->inout_original_cvalue(m_arg_pos);
// Due to https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/192
// Here we've to guess what to do, but in general is "better" to leak than
// crash, so let's assume that in/out transfer is matching.
if (gjs_arg_get<void*>(original_out_arg) != gjs_arg_get<void*>(out_arg)) {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
if (!gjs_gi_argument_release_in_array(cx, transfer, &m_type_info,
length, original_out_arg))
return false;
}
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
return gjs_gi_argument_release_out_array(cx, transfer, &m_type_info, length,
out_arg);
}
GJS_JSAPI_RETURN_CONVENTION
bool CallerAllocatesOut::release(JSContext*, GjsFunctionCallState*,
GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
g_free(gjs_arg_steal<void*>(in_arg));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool BoxedCallerAllocatesOut::release(JSContext*, GjsFunctionCallState*,
GIArgument* in_arg, GIArgument*) {
g_boxed_free(m_gtype, gjs_arg_steal<void*>(in_arg));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool CallbackIn::release(JSContext*, GjsFunctionCallState*, GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
ffi_closure *closure = m_ffi_closure;
if (!closure)
return true;
g_closure_unref(static_cast<GClosure*>(closure->user_data));
// CallbackTrampolines are refcounted because for notified/async closures
// it is possible to destroy it while in call, and therefore we cannot
// check its scope at this point
gjs_arg_unset<void*>(in_arg);
return true;
}
template <GITypeTag TAG>
GJS_JSAPI_RETURN_CONVENTION bool StringInTransferNone<TAG>::release(
JSContext*, GjsFunctionCallState*, GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
g_free(gjs_arg_get<void*>(in_arg));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool ForeignStructIn::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
GITransfer transfer =
state->call_completed() ? m_transfer : GI_TRANSFER_NOTHING;
if (transfer == GI_TRANSFER_NOTHING)
return gjs_struct_foreign_release_gi_argument(cx, m_transfer, m_info,
in_arg);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool BoxedInTransferNone::release(JSContext*, GjsFunctionCallState*,
GIArgument* in_arg,
GIArgument* out_arg [[maybe_unused]]) {
GType gtype = RegisteredType::gtype();
g_assert(g_type_is_a(gtype, G_TYPE_BOXED));
if (!gjs_arg_get<void*>(in_arg))
return true;
g_boxed_free(gtype, gjs_arg_get<void*>(in_arg));
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool GValueInTransferNone::release(JSContext* cx, GjsFunctionCallState* state,
GIArgument* in_arg, GIArgument* out_arg) {
if (state->ignore_release.erase(in_arg))
return true;
return BoxedInTransferNone::release(cx, state, in_arg, out_arg);
}
} // namespace Arg
bool Argument::invalid(JSContext* cx, const char* func) const {
gjs_throw(cx, "%s not implemented", func ? func : "Function");
return false;
}
bool Argument::in(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::HandleValue) {
return invalid(cx, G_STRFUNC);
}
bool Argument::out(JSContext* cx, GjsFunctionCallState*, GIArgument*,
JS::MutableHandleValue) {
return invalid(cx, G_STRFUNC);
}
bool Argument::release(JSContext*, GjsFunctionCallState*, GIArgument*,
GIArgument*) {
return true;
}
// This is a trick to print out the sizes of the structs at compile time, in
// an error message:
// template <int s> struct Measure;
// Measure<sizeof(Arg::)> arg_size;
#ifdef GJS_DO_ARGUMENTS_SIZE_CHECK
template <typename T>
constexpr size_t argument_maximum_size() {
if constexpr (std::is_same_v<T, Arg::NumericIn<int>>)
return 24;
if constexpr (std::is_same_v<T, Arg::ObjectIn> ||
std::is_same_v<T, Arg::BoxedIn>)
return 40;
else
return 120;
}
#endif
template <typename T, Arg::Kind ArgKind, typename... Args>
GjsAutoCppPointer<T> Argument::make(uint8_t index, const char* name,
GITypeInfo* type_info, GITransfer transfer,
GjsArgumentFlags flags, Args&&... args) {
#ifdef GJS_DO_ARGUMENTS_SIZE_CHECK
static_assert(
sizeof(T) <= argument_maximum_size<T>(),
"Think very hard before increasing the size of Gjs::Arguments. "
"One is allocated for every argument to every introspected function.");
#endif
auto arg = new T(args...);
if constexpr (ArgKind == Arg::Kind::INSTANCE) {
g_assert(index == Argument::ABSENT &&
"index was ignored in INSTANCE parameter");
g_assert(name == nullptr && "name was ignored in INSTANCE parameter");
arg->set_instance_parameter();
} else if constexpr (ArgKind == Arg::Kind::RETURN_VALUE) {
g_assert(index == Argument::ABSENT &&
"index was ignored in RETURN_VALUE parameter");
g_assert(name == nullptr &&
"name was ignored in RETURN_VALUE parameter");
arg->set_return_value();
} else {
if constexpr (std::is_base_of_v<Arg::Positioned, T>)
arg->set_arg_pos(index);
arg->m_arg_name = name;
}
arg->m_skip_in = (flags & GjsArgumentFlags::SKIP_IN);
arg->m_skip_out = (flags & GjsArgumentFlags::SKIP_OUT);
if constexpr (std::is_base_of_v<Arg::Nullable, T>)
arg->m_nullable = (flags & GjsArgumentFlags::MAY_BE_NULL);
if constexpr (std::is_base_of_v<Arg::Transferable, T>)
arg->m_transfer = transfer;
if constexpr (std::is_base_of_v<Arg::HasTypeInfo, T> &&
ArgKind != Arg::Kind::INSTANCE) {
arg->m_type_info = std::move(*type_info);
}
return arg;
}
bool ArgsCache::initialize(JSContext* cx, GICallableInfo* callable) {
if (!callable) {
gjs_throw(cx, "Invalid callable provided");
return false;
}
if (m_args) {
gjs_throw(cx, "Arguments cache already initialized!");
return false;
}
GITypeInfo type_info;
g_callable_info_load_return_type(callable, &type_info);
m_has_return = g_type_info_get_tag(&type_info) != GI_TYPE_TAG_VOID ||
g_type_info_is_pointer(&type_info);
m_is_method = !!g_callable_info_is_method(callable);
int size = g_callable_info_get_n_args(callable);
size += (m_is_method ? 1 : 0);
size += (m_has_return ? 1 : 0);
if (size > Argument::MAX_ARGS) {
gjs_throw(cx,
"Too many arguments, only %u are supported, while %d are "
"provided!",
Argument::MAX_ARGS, size);
return false;
}
m_args = new ArgumentPtr[size]{};
return true;
}
template <typename T, Arg::Kind ArgKind, typename... Args>
constexpr T* ArgsCache::set_argument(uint8_t index, const char* name,
GITypeInfo* type_info, GITransfer transfer,
GjsArgumentFlags flags, Args&&... args) {
GjsAutoCppPointer<T> arg = Argument::make<T, ArgKind>(
index, name, type_info, transfer, flags, args...);
arg_get<ArgKind>(index) = arg.release();
return static_cast<T*>(arg_get<ArgKind>(index).get());
}
template <typename T, Arg::Kind ArgKind, typename... Args>
constexpr T* ArgsCache::set_argument(uint8_t index, const char* name,
GITransfer transfer,
GjsArgumentFlags flags, Args&&... args) {
return set_argument<T, ArgKind>(index, name, nullptr, transfer, flags,
args...);
}
template <typename T, Arg::Kind ArgKind, typename... Args>
constexpr T* ArgsCache::set_argument_auto(Args&&... args) {
return set_argument<T, ArgKind>(std::forward<Args>(args)...);
}
template <typename T, Arg::Kind ArgKind, typename Tuple, typename... Args>
constexpr T* ArgsCache::set_argument_auto(Tuple&& tuple, Args&&... args) {
// TODO(3v1n0): Would be nice to have a simple way to check we're handling a
// tuple
return std::apply(
[&](auto&&... largs) {
return set_argument<T, ArgKind>(largs...,
std::forward<Args>(args)...);
},
tuple);
}
template <typename T>
constexpr T* ArgsCache::set_return(GITypeInfo* type_info, GITransfer transfer,
GjsArgumentFlags flags) {
return set_argument<T, Arg::Kind::RETURN_VALUE>(Argument::ABSENT, nullptr,
type_info, transfer, flags);
}
template <typename T>
constexpr T* ArgsCache::set_instance(GITransfer transfer,
GjsArgumentFlags flags) {
return set_argument<T, Arg::Kind::INSTANCE>(Argument::ABSENT, nullptr,
transfer, flags);
}
GType ArgsCache::instance_type() const {
if (!m_is_method)
return G_TYPE_NONE;
return instance()->as_instance()->gtype();
}
GITypeTag ArgsCache::return_tag() const {
Argument* rval = return_value();
if (!rval)
return GI_TYPE_TAG_VOID;
return rval->return_tag();
}
GITypeInfo* ArgsCache::return_type() const {
Argument* rval = return_value();
if (!rval)
return nullptr;
return const_cast<GITypeInfo*>(rval->return_type());
}
constexpr void ArgsCache::set_skip_all(uint8_t index, const char* name) {
set_argument<Arg::SkipAll>(index, name, GI_TRANSFER_NOTHING,
GjsArgumentFlags::SKIP_ALL);
}
template <Arg::Kind ArgKind>
void ArgsCache::set_array_argument(GICallableInfo* callable, uint8_t gi_index,
GITypeInfo* type_info, GIDirection direction,
GIArgInfo* arg, GjsArgumentFlags flags,
int length_pos) {
Arg::ExplicitArray* array;
GIArgInfo length_arg;
g_callable_info_load_arg(callable, length_pos, &length_arg);
GITypeInfo length_type;
g_arg_info_load_type(&length_arg, &length_type);
if constexpr (ArgKind == Arg::Kind::RETURN_VALUE) {
GITransfer transfer = g_callable_info_get_caller_owns(callable);
array = set_return<Arg::ReturnArray>(type_info, transfer,
GjsArgumentFlags::NONE);
} else {
const char* arg_name = g_base_info_get_name(arg);
GITransfer transfer = g_arg_info_get_ownership_transfer(arg);
auto common_args =
std::make_tuple(gi_index, arg_name, type_info, transfer, flags);
if (direction == GI_DIRECTION_IN) {
array = set_argument_auto<Arg::CArrayIn>(common_args);
set_skip_all(length_pos, g_base_info_get_name(&length_arg));
} else if (direction == GI_DIRECTION_INOUT) {
array = set_argument_auto<Arg::CArrayInOut>(common_args);
set_skip_all(length_pos, g_base_info_get_name(&length_arg));
} else {
array = set_argument_auto<Arg::CArrayOut>(common_args);
}
}
if (ArgKind == Arg::Kind::RETURN_VALUE || direction == GI_DIRECTION_OUT) {
// Even if we skip the length argument most of time, we need to
// do some basic initialization here.
set_argument<Arg::ArrayLengthOut>(
length_pos, g_base_info_get_name(&length_arg), &length_type,
GI_TRANSFER_NOTHING,
static_cast<GjsArgumentFlags>(flags | GjsArgumentFlags::SKIP_ALL));
}
array->set_array_length(length_pos, g_type_info_get_tag(&length_type),
g_arg_info_get_direction(&length_arg));
}
void ArgsCache::build_return(GICallableInfo* callable, bool* inc_counter_out) {
g_assert(inc_counter_out && "forgot out parameter");
if (!m_has_return) {
*inc_counter_out = false;
return;
}
GITypeInfo type_info;
g_callable_info_load_return_type(callable, &type_info);
GITransfer transfer = g_callable_info_get_caller_owns(callable);
GITypeTag tag = g_type_info_get_tag(&type_info);
*inc_counter_out = true;
GjsArgumentFlags flags = GjsArgumentFlags::SKIP_IN;
if (g_callable_info_may_return_null(callable))
flags |= GjsArgumentFlags::MAY_BE_NULL;
switch (tag) {
case GI_TYPE_TAG_BOOLEAN:
set_return<Arg::BooleanReturn>(&type_info, transfer, flags);
return;
case GI_TYPE_TAG_INT8:
set_return<Arg::NumericReturn<int8_t, GI_TYPE_TAG_INT8>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_INT16:
set_return<Arg::NumericReturn<int16_t, GI_TYPE_TAG_INT16>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_INT32:
set_return<Arg::NumericReturn<int32_t, GI_TYPE_TAG_INT32>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_UINT8:
set_return<Arg::NumericReturn<uint8_t, GI_TYPE_TAG_UINT8>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_UINT16:
set_return<Arg::NumericReturn<uint16_t, GI_TYPE_TAG_UINT16>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_UINT32:
set_return<Arg::NumericReturn<uint32_t, GI_TYPE_TAG_UINT32>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_INT64:
set_return<Arg::NumericReturn<int64_t, GI_TYPE_TAG_INT64>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_UINT64:
set_return<Arg::NumericReturn<uint64_t, GI_TYPE_TAG_UINT64>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_FLOAT:
set_return<Arg::NumericReturn<float, GI_TYPE_TAG_FLOAT>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_DOUBLE:
set_return<Arg::NumericReturn<double, GI_TYPE_TAG_DOUBLE>>(
&type_info, transfer, flags);
return;
case GI_TYPE_TAG_UTF8:
if (transfer == GI_TRANSFER_NOTHING) {
set_return<Arg::StringReturn<GI_TRANSFER_NOTHING>>(
&type_info, transfer, flags);
return;
} else {
set_return<Arg::StringReturn<GI_TRANSFER_EVERYTHING>>(
&type_info, transfer, flags);
return;
}
case GI_TYPE_TAG_ARRAY: {
int length_pos = g_type_info_get_array_length(&type_info);
if (length_pos >= 0) {
set_array_argument<Arg::Kind::RETURN_VALUE>(
callable, 0, &type_info, GI_DIRECTION_OUT, nullptr, flags,
length_pos);
return;
}
[[fallthrough]];
}
default:
break;
}
// in() is ignored for the return value, but skip_in is not (it is used
// in the failure release path)
set_return<Arg::GenericReturn>(&type_info, transfer, flags);
}
namespace Arg {
Enum::Enum(GIEnumInfo* enum_info) {
int64_t min = std::numeric_limits<int64_t>::max();
int64_t max = std::numeric_limits<int64_t>::min();
int n = g_enum_info_get_n_values(enum_info);
for (int i = 0; i < n; i++) {
GjsAutoValueInfo value_info = g_enum_info_get_value(enum_info, i);
int64_t value = g_value_info_get_value(value_info);
if (value > max)
max = value;
if (value < min)
min = value;
}
// From the docs for g_value_info_get_value(): "This will always be
// representable as a 32-bit signed or unsigned value. The use of gint64 as
// the return type is to allow both."
// We stuff them both into unsigned 32-bit fields, and use a flag to tell
// whether we have to compare them as signed.
m_min = static_cast<uint32_t>(min);
m_max = static_cast<uint32_t>(max);
m_unsigned = (min >= 0 && max > std::numeric_limits<int32_t>::max());
}
Flags::Flags(GIEnumInfo* enum_info) {
uint64_t mask = 0;
int n = g_enum_info_get_n_values(enum_info);
for (int i = 0; i < n; i++) {
GjsAutoValueInfo value_info = g_enum_info_get_value(enum_info, i);
int64_t value = g_value_info_get_value(value_info);
// From the docs for g_value_info_get_value(): "This will always be
// representable as a 32-bit signed or unsigned value. The use of
// gint64 as the return type is to allow both."
// We stuff both into an unsigned, int-sized field, matching the
// internal representation of flags in GLib (which uses guint).
mask |= static_cast<unsigned>(value);
}
m_mask = mask;
}
} // namespace Arg
namespace arg_cache {
[[nodiscard]] static inline bool is_gdk_atom(GIBaseInfo* info) {
return strcmp("Atom", g_base_info_get_name(info)) == 0 &&
strcmp("Gdk", g_base_info_get_namespace(info)) == 0;
}
} // namespace arg_cache
template <Arg::Kind ArgKind>
void ArgsCache::build_interface_in_arg(uint8_t gi_index, GITypeInfo* type_info,
GIBaseInfo* interface_info,
GITransfer transfer, const char* name,
GjsArgumentFlags flags) {
GIInfoType interface_type = g_base_info_get_type(interface_info);
auto base_args =
std::make_tuple(gi_index, name, type_info, transfer, flags);
auto common_args =
std::tuple_cat(base_args, std::make_tuple(interface_info));
// We do some transfer magic later, so let's ensure we don't mess up.
// Should not happen in practice.
if (G_UNLIKELY(transfer == GI_TRANSFER_CONTAINER)) {
set_argument_auto<Arg::NotIntrospectable>(base_args,
INTERFACE_TRANSFER_CONTAINER);
return;
}
switch (interface_type) {
case GI_INFO_TYPE_ENUM:
set_argument_auto<Arg::EnumIn, ArgKind>(common_args);
return;
case GI_INFO_TYPE_FLAGS:
set_argument_auto<Arg::FlagsIn, ArgKind>(common_args);
return;
case GI_INFO_TYPE_STRUCT:
if (g_struct_info_is_foreign(interface_info)) {
if constexpr (ArgKind == Arg::Kind::INSTANCE)
set_argument_auto<Arg::ForeignStructInstanceIn, ArgKind>(
common_args);
else
set_argument_auto<Arg::ForeignStructIn, ArgKind>(
common_args);
return;
}
[[fallthrough]];
case GI_INFO_TYPE_BOXED:
case GI_INFO_TYPE_OBJECT:
case GI_INFO_TYPE_INTERFACE:
case GI_INFO_TYPE_UNION: {
GType gtype = g_registered_type_info_get_g_type(interface_info);
if (interface_type == GI_INFO_TYPE_STRUCT && gtype == G_TYPE_NONE &&
!g_struct_info_is_gtype_struct(interface_info)) {
if constexpr (ArgKind != Arg::Kind::INSTANCE) {
// This covers cases such as GTypeInstance
set_argument_auto<Arg::FallbackInterfaceIn, ArgKind>(
common_args);
return;
}
}
// Transfer handling is a bit complex here, because some of our in()
// arguments know not to copy stuff if we don't need to.
if (gtype == G_TYPE_VALUE) {
if constexpr (ArgKind == Arg::Kind::INSTANCE)
set_argument_auto<Arg::BoxedIn, ArgKind>(common_args);
else if (transfer == GI_TRANSFER_NOTHING)
set_argument_auto<Arg::GValueInTransferNone, ArgKind>(
common_args);
else
set_argument_auto<Arg::GValueIn, ArgKind>(common_args);
return;
}
if (arg_cache::is_gdk_atom(interface_info)) {
// Fall back to the generic marshaller
set_argument_auto<Arg::FallbackInterfaceIn, ArgKind>(
common_args);
return;
}
if (gtype == G_TYPE_CLOSURE) {
if (transfer == GI_TRANSFER_NOTHING &&
ArgKind != Arg::Kind::INSTANCE)
set_argument_auto<Arg::GClosureInTransferNone, ArgKind>(
common_args);
else
set_argument_auto<Arg::GClosureIn, ArgKind>(common_args);
return;
}
if (gtype == G_TYPE_BYTES) {
if (transfer == GI_TRANSFER_NOTHING &&
ArgKind != Arg::Kind::INSTANCE)
set_argument_auto<Arg::GBytesInTransferNone, ArgKind>(
common_args);
else
set_argument_auto<Arg::GBytesIn, ArgKind>(common_args);
return;
}
if (g_type_is_a(gtype, G_TYPE_OBJECT)) {
set_argument_auto<Arg::ObjectIn, ArgKind>(common_args);
return;
}
if (g_type_is_a(gtype, G_TYPE_PARAM)) {
set_argument_auto<Arg::FallbackInterfaceIn, ArgKind>(
common_args);
return;
}
if (interface_type == GI_INFO_TYPE_UNION) {
if (gtype == G_TYPE_NONE) {
// Can't handle unions without a GType
set_argument_auto<Arg::NotIntrospectable>(
base_args, UNREGISTERED_UNION);
return;
}
set_argument_auto<Arg::UnionIn, ArgKind>(common_args);
return;
}
if (G_TYPE_IS_INSTANTIATABLE(gtype)) {
set_argument_auto<Arg::FundamentalIn, ArgKind>(common_args);
return;
}
if (g_type_is_a(gtype, G_TYPE_INTERFACE)) {
set_argument_auto<Arg::InterfaceIn, ArgKind>(common_args);
return;
}
// generic boxed type
if (gtype == G_TYPE_NONE) {
if (transfer != GI_TRANSFER_NOTHING) {
// Can't transfer ownership of a structure type not
// registered as a boxed
set_argument_auto<Arg::NotIntrospectable>(
base_args, UNREGISTERED_BOXED_WITH_TRANSFER);
return;
}
set_argument_auto<Arg::UnregisteredBoxedIn, ArgKind>(
common_args);
return;
}
set_argument_auto<Arg::BoxedIn, ArgKind>(common_args);
return;
} break;
case GI_INFO_TYPE_INVALID:
case GI_INFO_TYPE_FUNCTION:
case GI_INFO_TYPE_CALLBACK:
case GI_INFO_TYPE_CONSTANT:
case GI_INFO_TYPE_INVALID_0:
case GI_INFO_TYPE_VALUE:
case GI_INFO_TYPE_SIGNAL:
case GI_INFO_TYPE_VFUNC:
case GI_INFO_TYPE_PROPERTY:
case GI_INFO_TYPE_FIELD:
case GI_INFO_TYPE_ARG:
case GI_INFO_TYPE_TYPE:
case GI_INFO_TYPE_UNRESOLVED:
default:
// Don't know how to handle this interface type (should not happen
// in practice, for typelibs emitted by g-ir-compiler)
set_argument_auto<Arg::NotIntrospectable>(base_args,
UNSUPPORTED_TYPE);
}
}
void ArgsCache::build_normal_in_arg(uint8_t gi_index, GITypeInfo* type_info,
GIArgInfo* arg, GjsArgumentFlags flags) {
// "Normal" in arguments are those arguments that don't require special
// processing, and don't touch other arguments.
// Main categories are:
// - void*
// - small numbers (fit in 32bit)
// - big numbers (need a double)
// - strings
// - enums/flags (different from numbers in the way they're exposed in GI)
// - objects (GObjects, boxed, unions, etc.)
// - hashes
// - sequences (null-terminated arrays, lists, etc.)
const char* name = g_base_info_get_name(arg);
GITransfer transfer = g_arg_info_get_ownership_transfer(arg);
auto common_args =
std::make_tuple(gi_index, name, type_info, transfer, flags);
GITypeTag tag = g_type_info_get_tag(type_info);
switch (tag) {
case GI_TYPE_TAG_VOID:
set_argument_auto<Arg::NullIn>(common_args);
break;
case GI_TYPE_TAG_BOOLEAN:
set_argument_auto<Arg::BooleanIn>(common_args);
break;
case GI_TYPE_TAG_INT8:
set_argument_auto<Arg::NumericIn<int8_t>>(common_args);
return;
case GI_TYPE_TAG_INT16:
set_argument_auto<Arg::NumericIn<int16_t>>(common_args);
return;
case GI_TYPE_TAG_INT32:
set_argument_auto<Arg::NumericIn<int32_t>>(common_args);
return;
case GI_TYPE_TAG_UINT8:
set_argument_auto<Arg::NumericIn<uint8_t>>(common_args);
return;
case GI_TYPE_TAG_UINT16:
set_argument_auto<Arg::NumericIn<uint16_t>>(common_args);
return;
case GI_TYPE_TAG_UINT32:
set_argument_auto<Arg::NumericIn<uint32_t>>(common_args);
return;
case GI_TYPE_TAG_INT64:
set_argument_auto<Arg::NumericIn<int64_t>>(common_args);
return;
case GI_TYPE_TAG_UINT64:
set_argument_auto<Arg::NumericIn<uint64_t>>(common_args);
return;
case GI_TYPE_TAG_FLOAT:
set_argument_auto<Arg::NumericIn<float>>(common_args);
return;
case GI_TYPE_TAG_DOUBLE:
set_argument_auto<Arg::NumericIn<double>>(common_args);
return;
case GI_TYPE_TAG_UNICHAR:
set_argument_auto<Arg::UnicharIn>(common_args);
break;
case GI_TYPE_TAG_GTYPE:
set_argument_auto<Arg::GTypeIn>(common_args);
break;
case GI_TYPE_TAG_FILENAME:
if (transfer == GI_TRANSFER_NOTHING)
set_argument_auto<Arg::FilenameInTransferNone>(common_args);
else
set_argument_auto<Arg::FilenameIn>(common_args);
break;
case GI_TYPE_TAG_UTF8:
if (transfer == GI_TRANSFER_NOTHING)
set_argument_auto<Arg::StringInTransferNone<GI_TYPE_TAG_UTF8>>(
common_args);
else
set_argument_auto<Arg::StringIn>(common_args);
break;
case GI_TYPE_TAG_INTERFACE: {
GjsAutoBaseInfo interface_info =
g_type_info_get_interface(type_info);
build_interface_in_arg(gi_index, type_info, interface_info,
transfer, name, flags);
return;
}
case GI_TYPE_TAG_ARRAY:
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_ERROR:
default:
// FIXME: Falling back to the generic marshaller
set_argument_auto<Arg::FallbackIn>(common_args);
}
}
void ArgsCache::build_normal_out_arg(uint8_t gi_index, GITypeInfo* type_info,
GIArgInfo* arg, GjsArgumentFlags flags) {
const char* name = g_base_info_get_name(arg);
GITransfer transfer = g_arg_info_get_ownership_transfer(arg);
auto common_args =
std::make_tuple(gi_index, name, type_info, transfer, flags);
GITypeTag tag = g_type_info_get_tag(type_info);
switch (tag) {
case GI_TYPE_TAG_BOOLEAN:
set_argument_auto<Arg::BooleanOut>(common_args);
break;
case GI_TYPE_TAG_INT8:
set_argument_auto<Arg::NumericOut<int8_t>>(common_args);
return;
case GI_TYPE_TAG_INT16:
set_argument_auto<Arg::NumericOut<int16_t>>(common_args);
return;
case GI_TYPE_TAG_INT32:
set_argument_auto<Arg::NumericOut<int32_t>>(common_args);
return;
case GI_TYPE_TAG_UINT8:
set_argument_auto<Arg::NumericOut<uint8_t>>(common_args);
return;
case GI_TYPE_TAG_UINT16:
set_argument_auto<Arg::NumericOut<uint16_t>>(common_args);
return;
case GI_TYPE_TAG_UINT32:
set_argument_auto<Arg::NumericOut<uint32_t>>(common_args);
return;
case GI_TYPE_TAG_INT64:
set_argument_auto<Arg::NumericOut<int64_t>>(common_args);
return;
case GI_TYPE_TAG_UINT64:
set_argument_auto<Arg::NumericOut<uint64_t>>(common_args);
return;
case GI_TYPE_TAG_FLOAT:
set_argument_auto<Arg::NumericOut<float>>(common_args);
return;
case GI_TYPE_TAG_DOUBLE:
set_argument_auto<Arg::NumericOut<double>>(common_args);
return;
case GI_TYPE_TAG_UTF8:
if (transfer == GI_TRANSFER_NOTHING) {
set_argument_auto<Arg::StringOut<GI_TRANSFER_NOTHING>>(
common_args);
} else {
set_argument_auto<Arg::StringOut<GI_TRANSFER_EVERYTHING>>(
common_args);
}
return;
default:
set_argument_auto<Arg::FallbackOut>(common_args);
}
}
void ArgsCache::build_normal_inout_arg(uint8_t gi_index, GITypeInfo* type_info,
GIArgInfo* arg, GjsArgumentFlags flags) {
const char* name = g_base_info_get_name(arg);
GITransfer transfer = g_arg_info_get_ownership_transfer(arg);
auto common_args =
std::make_tuple(gi_index, name, type_info, transfer, flags);
GITypeTag tag = g_type_info_get_tag(type_info);
switch (tag) {
case GI_TYPE_TAG_BOOLEAN:
set_argument_auto<Arg::BooleanInOut>(common_args);
break;
case GI_TYPE_TAG_INT8:
set_argument_auto<Arg::NumericInOut<int8_t>>(common_args);
return;
case GI_TYPE_TAG_INT16:
set_argument_auto<Arg::NumericInOut<int16_t>>(common_args);
return;
case GI_TYPE_TAG_INT32:
set_argument_auto<Arg::NumericInOut<int32_t>>(common_args);
return;
case GI_TYPE_TAG_UINT8:
set_argument_auto<Arg::NumericInOut<uint8_t>>(common_args);
return;
case GI_TYPE_TAG_UINT16:
set_argument_auto<Arg::NumericInOut<uint16_t>>(common_args);
return;
case GI_TYPE_TAG_UINT32:
set_argument_auto<Arg::NumericInOut<uint32_t>>(common_args);
return;
case GI_TYPE_TAG_INT64:
set_argument_auto<Arg::NumericInOut<int64_t>>(common_args);
return;
case GI_TYPE_TAG_UINT64:
set_argument_auto<Arg::NumericInOut<uint64_t>>(common_args);
return;
case GI_TYPE_TAG_FLOAT:
set_argument_auto<Arg::NumericInOut<float>>(common_args);
return;
case GI_TYPE_TAG_DOUBLE:
set_argument_auto<Arg::NumericInOut<double>>(common_args);
return;
default:
set_argument_auto<Arg::FallbackInOut>(common_args);
}
}
void ArgsCache::build_instance(GICallableInfo* callable) {
if (!m_is_method)
return;
GIBaseInfo* interface_info = g_base_info_get_container(callable); // !owned
GITransfer transfer =
g_callable_info_get_instance_ownership_transfer(callable);
// These cases could be covered by the generic marshaller, except that
// there's no way to get GITypeInfo for a method's instance parameter.
// Instead, special-case the arguments here that would otherwise go through
// the generic marshaller.
// See: https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/334
GIInfoType info_type = g_base_info_get_type(interface_info);
if (info_type == GI_INFO_TYPE_STRUCT &&
g_struct_info_is_gtype_struct(interface_info)) {
set_instance<Arg::GTypeStructInstanceIn>(transfer);
return;
}
if (info_type == GI_INFO_TYPE_OBJECT) {
GType gtype = g_registered_type_info_get_g_type(interface_info);
if (g_type_is_a(gtype, G_TYPE_PARAM)) {
set_instance<Arg::ParamInstanceIn>(transfer);
return;
}
}
build_interface_in_arg<Arg::Kind::INSTANCE>(
Argument::ABSENT, nullptr, interface_info, transfer, nullptr,
GjsArgumentFlags::NONE);
}
static constexpr bool type_tag_is_scalar(GITypeTag tag) {
return GI_TYPE_TAG_IS_NUMERIC(tag) || tag == GI_TYPE_TAG_BOOLEAN ||
tag == GI_TYPE_TAG_GTYPE;
}
void ArgsCache::build_arg(uint8_t gi_index, GIDirection direction,
GIArgInfo* arg, GICallableInfo* callable,
bool* inc_counter_out) {
g_assert(inc_counter_out && "forgot out parameter");
GITypeInfo type_info;
const char* arg_name = g_base_info_get_name(arg);
g_arg_info_load_type(arg, &type_info);
GITransfer transfer = g_arg_info_get_ownership_transfer(arg);
GjsArgumentFlags flags = GjsArgumentFlags::NONE;
if (g_arg_info_may_be_null(arg))
flags |= GjsArgumentFlags::MAY_BE_NULL;
if (g_arg_info_is_caller_allocates(arg))
flags |= GjsArgumentFlags::CALLER_ALLOCATES;
if (direction == GI_DIRECTION_IN)
flags |= GjsArgumentFlags::SKIP_OUT;
else if (direction == GI_DIRECTION_OUT)
flags |= GjsArgumentFlags::SKIP_IN;
*inc_counter_out = true;
auto common_args =
std::make_tuple(gi_index, arg_name, &type_info, transfer, flags);
GITypeTag type_tag = g_type_info_get_tag(&type_info);
if (direction == GI_DIRECTION_OUT &&
(flags & GjsArgumentFlags::CALLER_ALLOCATES)) {
size_t size = 0;
if (type_tag == GI_TYPE_TAG_ARRAY) {
GIArrayType array_type = g_type_info_get_array_type(&type_info);
switch (array_type) {
case GI_ARRAY_TYPE_C: {
GjsAutoTypeInfo param_info;
int n_elements =
g_type_info_get_array_fixed_size(&type_info);
if (n_elements <= 0)
break;
param_info = g_type_info_get_param_type(&type_info, 0);
GITypeTag param_tag = g_type_info_get_tag(param_info);
size = gjs_type_get_element_size(param_tag, param_info);
size *= n_elements;
break;
}
default:
break;
}
} else if (!type_tag_is_scalar(type_tag) &&
!g_type_info_is_pointer(&type_info)) {
// Scalar out parameters should not be annotated with
// caller-allocates, which is for structured types that need to be
// allocated in order for the function to fill them in.
size = gjs_type_get_element_size(type_tag, &type_info);
}
if (!size) {
set_argument_auto<Arg::NotIntrospectable>(
common_args, OUT_CALLER_ALLOCATES_NON_STRUCT);
return;
}
if (type_tag == GI_TYPE_TAG_INTERFACE) {
GjsAutoBaseInfo interface_info =
g_type_info_get_interface(&type_info);
GType gtype = g_registered_type_info_get_g_type(interface_info);
if (g_type_is_a(gtype, G_TYPE_BOXED)) {
auto* gjs_arg = set_argument_auto<Arg::BoxedCallerAllocatesOut>(
common_args, gtype);
gjs_arg->m_allocates_size = size;
return;
}
}
auto* gjs_arg = set_argument_auto<Arg::CallerAllocatesOut>(common_args);
gjs_arg->m_allocates_size = size;
return;
}
if (type_tag == GI_TYPE_TAG_INTERFACE) {
GjsAutoBaseInfo interface_info = g_type_info_get_interface(&type_info);
if (interface_info.type() == GI_INFO_TYPE_CALLBACK) {
if (direction != GI_DIRECTION_IN) {
// Can't do callbacks for out or inout
set_argument_auto<Arg::NotIntrospectable>(common_args,
CALLBACK_OUT);
return;
}
if (strcmp(interface_info.name(), "DestroyNotify") == 0 &&
strcmp(interface_info.ns(), "GLib") == 0) {
// We don't know (yet) what to do with GDestroyNotify appearing
// before a callback. If the callback comes later in the
// argument list, then the invalid argument will be
// overwritten with the 'skipped' one. If no callback follows,
// then this is probably an unsupported function, so the
// function invocation code will check this and throw.
set_argument_auto<Arg::NotIntrospectable>(
common_args, DESTROY_NOTIFY_NO_CALLBACK);
*inc_counter_out = false;
} else {
auto* gjs_arg = set_argument_auto<Arg::CallbackIn>(
common_args, interface_info);
int destroy_pos = g_arg_info_get_destroy(arg);
int closure_pos = g_arg_info_get_closure(arg);
if (destroy_pos >= 0)
set_skip_all(destroy_pos);
if (closure_pos >= 0)
set_skip_all(closure_pos);
if (destroy_pos >= 0 && closure_pos < 0) {
set_argument_auto<Arg::NotIntrospectable>(
common_args, DESTROY_NOTIFY_NO_USER_DATA);
return;
}
gjs_arg->m_scope = g_arg_info_get_scope(arg);
gjs_arg->set_callback_destroy_pos(destroy_pos);
gjs_arg->set_callback_closure_pos(closure_pos);
}
return;
}
}
if (type_tag == GI_TYPE_TAG_ARRAY &&
g_type_info_get_array_type(&type_info) == GI_ARRAY_TYPE_C) {
int length_pos = g_type_info_get_array_length(&type_info);
if (length_pos >= 0) {
Argument* cached_length = argument(length_pos);
bool skip_length = cached_length && !(cached_length->skip_in() &&
cached_length->skip_out());
set_array_argument(callable, gi_index, &type_info, direction, arg,
flags, length_pos);
if (length_pos < gi_index && skip_length) {
// we already collected length_pos, remove it
*inc_counter_out = false;
}
return;
} else if (g_type_info_is_zero_terminated(&type_info)) {
if (direction == GI_DIRECTION_IN) {
set_argument_auto<Arg::ZeroTerminatedArrayIn>(common_args);
return;
} else if (direction == GI_DIRECTION_INOUT) {
set_argument_auto<Arg::ZeroTerminatedArrayInOut>(common_args);
return;
}
} else if (g_type_info_get_array_fixed_size(&type_info) >= 0) {
if (direction == GI_DIRECTION_IN) {
set_argument_auto<Arg::FixedSizeArrayIn>(common_args);
return;
} else if (direction == GI_DIRECTION_INOUT) {
set_argument_auto<Arg::FixedSizeArrayInOut>(common_args);
return;
}
}
}
if (direction == GI_DIRECTION_IN)
build_normal_in_arg(gi_index, &type_info, arg, flags);
else if (direction == GI_DIRECTION_INOUT)
build_normal_inout_arg(gi_index, &type_info, arg, flags);
else
build_normal_out_arg(gi_index, &type_info, arg, flags);
return;
}
} // namespace Gjs
|