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
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
// SPDX-FileCopyrightText: 2008 litl, LLC
// SPDX-FileCopyrightText: 2020 Canonical, Ltd.
#include <config.h>
#include <inttypes.h>
#include <stdint.h>
#include <string.h> // for strcmp, strlen, memcpy
#include <algorithm> // for none_of
#include <array>
#include <functional> // for mem_fn
#include <string>
#include <utility> // for move
#include <vector>
#include <girepository/girepository.h>
#include <glib-object.h>
#include <glib.h>
#include <js/Array.h>
#include <js/CharacterEncoding.h>
#include <js/Conversions.h>
#include <js/ErrorReport.h> // for JS_ReportOutOfMemory
#include <js/Exception.h>
#include <js/GCVector.h> // for RootedVector, MutableWrappedPtrOp...
#include <js/Id.h>
#include <js/PropertyAndElement.h> // for JS_GetElement, JS_HasPropertyById
#include <js/PropertyDescriptor.h> // for JSPROP_ENUMERATE
#include <js/RootingAPI.h>
#include <js/String.h>
#include <js/TypeDecls.h>
#include <js/Utility.h> // for UniqueChars
#include <js/Value.h>
#include <js/ValueArray.h>
#include <js/experimental/TypedData.h>
#include <jsapi.h> // for InformalValueTypeName, IdVector
#include <mozilla/Maybe.h>
#include <mozilla/Span.h>
#include <mozilla/Unused.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/fundamental.h"
#include "gi/gerror.h"
#include "gi/gtype.h"
#include "gi/info.h"
#include "gi/interface.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"
#include "gjs/atoms.h"
#include "gjs/auto.h"
#include "gjs/byteArray.h"
#include "gjs/context-private.h"
#include "gjs/enum-utils.h"
#include "gjs/gerror-result.h"
#include "gjs/jsapi-util.h"
#include "gjs/macros.h"
#include "util/log.h"
using mozilla::Maybe, mozilla::Nothing, mozilla::Some;
// This file contains marshalling functions for GIArgument. It is divided into
// three sections, with some helper functions coming first.
// 1. "To" marshallers - JS::Value or other JS data structure to GIArgument or
// pointer, used for in arguments
// 2. "From" marshallers - GIArgument or pointer to JS::Value or other JS data
// structure, used for out arguments and return values
// 3. "Release" marshallers - used when cleaning up GIArguments after a C
// function call
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_g_arg_release_internal(JSContext*, GITransfer,
const GI::TypeInfo, GITypeTag,
GjsArgumentType, GjsArgumentFlags,
GIArgument*);
static void throw_invalid_argument(JSContext*, JS::HandleValue,
const GI::TypeInfo, const char*,
GjsArgumentType);
bool _gjs_flags_value_is_valid(JSContext* cx, GType gtype, int64_t value) {
/* Do proper value check for flags with GType's */
if (gtype != G_TYPE_NONE) {
Gjs::AutoTypeClass<GFlagsClass> gflags_class{gtype};
uint32_t tmpval = static_cast<uint32_t>(value);
/* check all bits are valid bits for the flag and is a 32 bit flag*/
if ((tmpval &= gflags_class->mask) != value) { /* Not a guint32 with invalid mask values*/
gjs_throw(cx, "0x%" PRIx64 " is not a valid value for flags %s",
value, g_type_name(gtype));
return false;
}
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool _gjs_enum_value_is_valid(JSContext* cx, const GI::EnumInfo info,
int64_t value) {
GI::EnumInfo::ValuesIterator values = info.values();
if (std::none_of(values.begin(), values.end(),
[value](GI::AutoValueInfo info) {
return info.value() == value;
})) {
gjs_throw(cx, "%" PRId64 " is not a valid value for enumeration %s",
value, info.name());
return false;
}
return true;
}
/* Check if an argument of the given needs to be released if we created it
* from a JS value to pass it into a function and aren't transferring ownership.
*/
[[nodiscard]]
static bool type_needs_release(const GI::TypeInfo& type_info, GITypeTag tag) {
switch (tag) {
case GI_TYPE_TAG_ARRAY:
case GI_TYPE_TAG_ERROR:
case GI_TYPE_TAG_FILENAME:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_UTF8:
return true;
case GI_TYPE_TAG_INTERFACE: {
GI::AutoBaseInfo interface_info{type_info.interface()};
if (auto reg_info =
interface_info.as<GI::InfoTag::REGISTERED_TYPE>()) {
GType gtype = reg_info->gtype();
if (g_type_is_a(gtype, G_TYPE_CLOSURE))
return true;
else if (g_type_is_a(gtype, G_TYPE_VALUE))
return true;
}
return false;
}
default:
return false;
}
}
[[nodiscard]] static inline bool is_string_type(GITypeTag tag) {
return tag == GI_TYPE_TAG_FILENAME || tag == GI_TYPE_TAG_UTF8;
}
/* Check if an argument of the given needs to be released if we obtained it
* from out argument (or the return value), and we're transferring ownership
*/
[[nodiscard]]
static bool type_needs_out_release(const GI::TypeInfo& type_info,
GITypeTag tag) {
switch (tag) {
case GI_TYPE_TAG_ARRAY:
case GI_TYPE_TAG_ERROR:
case GI_TYPE_TAG_FILENAME:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_UTF8:
return true;
case GI_TYPE_TAG_INTERFACE: {
GI::AutoBaseInfo interface_info{type_info.interface()};
if (interface_info.is_object())
return true;
if (interface_info.is_struct() || interface_info.is_union())
return type_info.is_pointer();
return false;
}
default:
return false;
}
}
///// "TO" MARSHALLERS /////////////////////////////////////////////////////////
// These marshaller functions are responsible for converting JS values to the
// required GIArgument type, for the in parameters of a C function call.
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool gjs_array_to_g_list(
JSContext* cx, JS::HandleValue value, const GI::TypeInfo type_info,
GITransfer transfer, const char* arg_name, GjsArgumentType arg_type,
T** list_p) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
// While a list can be NULL in C, that means empty array in JavaScript, it
// doesn't mean null in JavaScript.
bool is_array;
if (!JS::IsArrayObject(cx, value, &is_array))
return false;
if (!is_array) {
throw_invalid_argument(cx, value, type_info, arg_name, arg_type);
return false;
}
JS::RootedObject array_obj(cx, &value.toObject());
uint32_t length;
if (!JS::GetArrayLength(cx, array_obj, &length)) {
throw_invalid_argument(cx, value, type_info, arg_name, arg_type);
return false;
}
GI::AutoTypeInfo element_type{type_info.element_type()};
GITypeTag element_tag = element_type.tag();
g_assert(!GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use basic_array_to_linked_list() instead");
if (transfer == GI_TRANSFER_CONTAINER) {
if (type_needs_release(element_type, element_tag)) {
/* FIXME: to make this work, we'd have to keep a list of temporary
* GIArguments for the function call so we could free them after
* the surrounding container had been freed by the callee.
*/
gjs_throw(cx, "Container transfer for in parameters not supported");
return false;
}
transfer = GI_TRANSFER_NOTHING;
}
JS::RootedObject array(cx, value.toObjectOrNull());
JS::RootedValue elem(cx);
T* list = nullptr;
for (size_t i = 0; i < length; ++i) {
elem = JS::UndefinedValue();
if (!JS_GetElement(cx, array, i, &elem)) {
gjs_throw(cx, "Missing array element %zu", i);
return false;
}
/* FIXME we don't know if the list elements can be NULL.
* gobject-introspection needs to tell us this.
* Always say they can't for now.
*/
GIArgument elem_arg;
if (!gjs_value_to_gi_argument(cx, elem, element_type,
GJS_ARGUMENT_LIST_ELEMENT, transfer,
&elem_arg)) {
return false;
}
void* hash_pointer = element_type.hash_pointer_from_argument(&elem_arg);
if constexpr (std::is_same_v<T, GList>)
list = g_list_prepend(list, hash_pointer);
else if constexpr (std::is_same_v<T, GSList>)
list = g_slist_prepend(list, hash_pointer);
}
if constexpr (std::is_same_v<T, GList>)
list = g_list_reverse(list);
else if constexpr (std::is_same_v<T, GSList>)
list = g_slist_reverse(list);
*list_p = list;
return true;
}
[[nodiscard]] static GHashTable* create_hash_table_for_key_type(
GITypeTag key_type) {
/* Don't use key/value destructor functions here, because we can't
* construct correct ones in general if the value type is complex.
* Rely on the type-aware gi_argument_release functions. */
if (is_string_type(key_type))
return g_hash_table_new(g_str_hash, g_str_equal);
return g_hash_table_new(NULL, NULL);
}
template <typename IntTag>
GJS_JSAPI_RETURN_CONVENTION static bool hashtable_int_key(JSContext* cx,
JS::HandleValue value,
void** pointer_out) {
using IntType = Gjs::Tag::RealT<IntTag>;
static_assert(std::is_integral_v<IntType>, "Need an integer");
bool out_of_range = false;
Gjs::Tag::JSValueContainingT<IntTag> i;
if (!Gjs::js_value_to_c_checked<IntType>(cx, value, &i, &out_of_range))
return false;
if (out_of_range) {
gjs_throw(cx, "value is out of range for hash table key of type %s",
Gjs::static_type_name<IntTag>());
}
*pointer_out = gjs_int_to_pointer<IntType>(i);
return true;
}
/* Converts a JS::Value to a GHashTable key, stuffing it into @pointer_out if
* possible, otherwise giving the location of an allocated key in @pointer_out.
*/
GJS_JSAPI_RETURN_CONVENTION
static bool value_to_ghashtable_key(JSContext* cx, JS::HandleValue value,
GITypeTag type_tag, void** pointer_out) {
bool unsupported = false;
g_assert((value.isString() || value.isInt32()) &&
"keys from JS_Enumerate must be non-symbol property keys");
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting JS::Value to GHashTable key %s",
gi_type_tag_to_string(type_tag));
switch (type_tag) {
case GI_TYPE_TAG_BOOLEAN:
/* This doesn't seem particularly useful, but it's easy */
*pointer_out = gjs_int_to_pointer(JS::ToBoolean(value));
break;
case GI_TYPE_TAG_UNICHAR:
if (value.isInt32()) {
*pointer_out = gjs_int_to_pointer(value.toInt32());
} else {
uint32_t ch;
if (!gjs_unichar_from_string(cx, value, &ch))
return false;
*pointer_out = gjs_int_to_pointer(ch);
}
break;
case GI_TYPE_TAG_INT8:
if (!hashtable_int_key<int8_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_INT16:
if (!hashtable_int_key<int16_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_INT32:
if (!hashtable_int_key<int32_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_UINT8:
if (!hashtable_int_key<uint8_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_UINT16:
if (!hashtable_int_key<uint16_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_UINT32:
if (!hashtable_int_key<uint32_t>(cx, value, pointer_out))
return false;
break;
case GI_TYPE_TAG_FILENAME: {
Gjs::AutoChar cstr;
JS::RootedValue str_val(cx, value);
if (!str_val.isString()) {
JS::RootedString str(cx, JS::ToString(cx, str_val));
str_val.setString(str);
}
if (!gjs_string_to_filename(cx, str_val, &cstr))
return false;
*pointer_out = cstr.release();
break;
}
case GI_TYPE_TAG_UTF8: {
JS::RootedString str(cx);
if (!value.isString())
str = JS::ToString(cx, value);
else
str = value.toString();
JS::UniqueChars cstr(JS_EncodeStringToUTF8(cx, str));
if (!cstr)
return false;
*pointer_out = g_strdup(cstr.get());
break;
}
case GI_TYPE_TAG_FLOAT:
case GI_TYPE_TAG_DOUBLE:
case GI_TYPE_TAG_INT64:
case GI_TYPE_TAG_UINT64:
// FIXME: The above four could be supported, but are currently not. The ones
// below cannot be key types in a regular JS object; we would need to allow
// marshalling Map objects into GHashTables to support those, as well as
// refactoring this function to take GITypeInfo* and splitting out the
// marshalling for basic types into a different function.
case GI_TYPE_TAG_VOID:
case GI_TYPE_TAG_GTYPE:
case GI_TYPE_TAG_ERROR:
case GI_TYPE_TAG_INTERFACE:
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_ARRAY:
unsupported = true;
break;
default:
g_warning("Unhandled type %s for GHashTable key conversion",
gi_type_tag_to_string(type_tag));
unsupported = true;
break;
}
if (G_UNLIKELY(unsupported)) {
gjs_throw(cx, "Type %s not supported for hash table keys",
gi_type_tag_to_string(type_tag));
return false;
}
return true;
}
template <typename TAG>
[[nodiscard]] static Gjs::Tag::RealT<TAG>* heap_value_new_from_arg(
GIArgument* val_arg) {
auto* heap_val = g_new(Gjs::Tag::RealT<TAG>, 1);
*heap_val = gjs_arg_get<TAG>(val_arg);
return heap_val;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_object_to_g_hash(JSContext* context, JS::HandleObject props,
const GI::TypeInfo type_info,
GITransfer transfer, GHashTable** hash_p) {
size_t id_ix, id_len;
g_assert(props && "Property bag cannot be null");
GI::AutoTypeInfo key_type{type_info.key_type()};
GI::AutoTypeInfo value_type{type_info.value_type()};
GITypeTag key_tag = key_type.tag();
GITypeTag val_type = value_type.tag();
g_assert(
(!GI_TYPE_TAG_IS_BASIC(key_tag) || !GI_TYPE_TAG_IS_BASIC(val_type)) &&
"use gjs_value_to_basic_ghash_gi_argument() instead");
if (transfer == GI_TRANSFER_CONTAINER) {
if (type_needs_release(key_type, key_tag) ||
type_needs_release(value_type, val_type)) {
/* FIXME: to make this work, we'd have to keep a list of temporary
* GIArguments for the function call so we could free them after
* the surrounding container had been freed by the callee.
*/
gjs_throw(context,
"Container transfer for in parameters not supported");
return false;
}
transfer = GI_TRANSFER_NOTHING;
}
JS::Rooted<JS::IdVector> ids(context, context);
if (!JS_Enumerate(context, props, &ids))
return false;
Gjs::AutoPointer<GHashTable, GHashTable, g_hash_table_destroy> result{
create_hash_table_for_key_type(key_tag)};
JS::RootedValue key_js(context), val_js(context);
JS::RootedId cur_id(context);
for (id_ix = 0, id_len = ids.length(); id_ix < id_len; ++id_ix) {
cur_id = ids[id_ix];
gpointer key_ptr, val_ptr;
GIArgument val_arg = { 0 };
if (!JS_IdToValue(context, cur_id, &key_js) ||
// Type check key type.
!value_to_ghashtable_key(context, key_js, key_tag, &key_ptr) ||
!JS_GetPropertyById(context, props, cur_id, &val_js) ||
// Type check and convert value to a C type
!gjs_value_to_gi_argument(context, val_js, value_type, nullptr,
GJS_ARGUMENT_HASH_ELEMENT, transfer,
GjsArgumentFlags::MAY_BE_NULL, &val_arg))
return false;
/* Use heap-allocated values for types that don't fit in a pointer */
if (val_type == GI_TYPE_TAG_INT64) {
val_ptr = heap_value_new_from_arg<int64_t>(&val_arg);
} else if (val_type == GI_TYPE_TAG_UINT64) {
val_ptr = heap_value_new_from_arg<uint64_t>(&val_arg);
} else if (val_type == GI_TYPE_TAG_FLOAT) {
val_ptr = heap_value_new_from_arg<float>(&val_arg);
} else if (val_type == GI_TYPE_TAG_DOUBLE) {
val_ptr = heap_value_new_from_arg<double>(&val_arg);
} else {
// Other types are simply stuffed inside the pointer
val_ptr = value_type.hash_pointer_from_argument(&val_arg);
}
#if __GNUC__ >= 8 // clang-format off
_Pragma("GCC diagnostic push")
_Pragma("GCC diagnostic ignored \"-Wmaybe-uninitialized\"")
#endif
// The compiler isn't smart enough to figure out that key_ptr will
// always be initialized if value_to_ghashtable_key() returns true.
g_hash_table_insert(result, key_ptr, val_ptr);
#if __GNUC__ >= 8
_Pragma("GCC diagnostic pop")
#endif // clang-format on
}
*hash_p = result.release();
return true;
}
template <typename T>
[[nodiscard]] constexpr T* array_allocate(size_t length) {
if constexpr (std::is_same_v<T, char*>)
return g_new0(char*, length);
T* array = g_new(T, length);
array[length - 1] = {0};
return array;
}
template <typename TAG>
GJS_JSAPI_RETURN_CONVENTION static bool js_value_to_c_strict(
JSContext* cx, JS::HandleValue value, Gjs::Tag::RealT<TAG>* out) {
if constexpr (Gjs::type_has_js_getter<TAG,
Gjs::HolderMode::ContainingType>())
return Gjs::js_value_to_c<TAG>(cx, value, out);
Gjs::Tag::JSValueContainingT<TAG> v;
bool ret = Gjs::js_value_to_c<TAG>(cx, value, &v);
*out = v;
return ret;
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool gjs_array_to_auto_array(
JSContext* cx, JS::Value array_value, size_t length, void** arr_p) {
using RealT = Gjs::Tag::RealT<T>;
JS::RootedObject array(cx, array_value.toObjectOrNull());
JS::RootedValue elem(cx);
// Add one so we're always zero terminated
Gjs::SmartPointer<RealT> result{array_allocate<RealT>(length + 1)};
for (size_t i = 0; i < length; ++i) {
elem = JS::UndefinedValue();
if (!JS_GetElement(cx, array, i, &elem)) {
gjs_throw(cx, "Missing array element %" G_GSIZE_FORMAT, i);
return false;
}
if (!js_value_to_c_strict<T>(cx, elem, &result[i])) {
gjs_throw(cx, "Invalid element in %s array",
Gjs::static_type_name<T>());
return false;
}
}
*arr_p = result.release();
return true;
}
bool
gjs_array_to_strv(JSContext *context,
JS::Value array_value,
unsigned int length,
void **arr_p)
{
return gjs_array_to_auto_array<char*>(context, array_value, length, arr_p);
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_string_to_intarray(JSContext* context, JS::HandleString str,
GITypeTag element_type, void** arr_p,
size_t* length) {
char16_t *result16;
switch (element_type) {
case GI_TYPE_TAG_INT8:
case GI_TYPE_TAG_UINT8: {
JS::UniqueChars result;
if (!gjs_string_to_utf8_n(context, str, &result, length))
return false;
*arr_p = Gjs::js_chars_to_glib(std::move(result)).release();
return true;
}
case GI_TYPE_TAG_INT16:
case GI_TYPE_TAG_UINT16: {
if (!gjs_string_get_char16_data(context, str, &result16, length))
return false;
*arr_p = result16;
return true;
}
case GI_TYPE_TAG_UNICHAR: {
gunichar* result_ucs4;
if (!gjs_string_to_ucs4(context, str, &result_ucs4, length))
return false;
*arr_p = result_ucs4;
return true;
}
default:
/* can't convert a string to this type */
gjs_throw(context, "Cannot convert string to array of '%s'",
gi_type_tag_to_string(element_type));
return false;
}
}
GJS_JSAPI_RETURN_CONVENTION
static bool array_to_basic_c_array(JSContext* cx, JS::HandleValue v_array,
size_t length, GITypeTag element_tag,
void** array_out) {
// Always one extra element, to cater for null terminated arrays
Gjs::AutoPointer<void*> array{array_allocate<void*>(length + 1)};
JS::RootedObject array_obj{cx, &v_array.toObject()};
JS::RootedValue elem{cx};
for (size_t ix = 0; ix < length; ix++) {
GIArgument arg;
gjs_arg_unset(&arg);
elem.setUndefined();
if (!JS_GetElement(cx, array_obj, ix, &elem)) {
gjs_throw(cx, "Missing array element %zu", ix);
return false;
}
if (!gjs_value_to_basic_gi_argument(cx, elem, element_tag, &arg,
nullptr, GJS_ARGUMENT_ARRAY_ELEMENT,
GjsArgumentFlags::NONE)) {
gjs_throw(cx, "Invalid element in array");
return false;
}
array[ix] = gjs_arg_get<void*>(&arg);
}
*array_out = array.release();
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_to_ptrarray(JSContext* context, JS::Value array_value,
unsigned length, GITransfer transfer,
const GI::TypeInfo param_info, void** arr_p) {
unsigned int i;
JS::RootedObject array_obj(context, array_value.toObjectOrNull());
JS::RootedValue elem(context);
/* Always one extra element, to cater for null terminated arrays */
Gjs::AutoPointer<void*> array{array_allocate<void*>(length + 1)};
for (i = 0; i < length; i++) {
GIArgument arg;
gjs_arg_unset(&arg);
elem = JS::UndefinedValue();
if (!JS_GetElement(context, array_obj, i, &elem)) {
gjs_throw(context,
"Missing array element %u",
i);
return false;
}
if (!gjs_value_to_gi_argument(context, elem, param_info,
GJS_ARGUMENT_ARRAY_ELEMENT, transfer,
&arg)) {
gjs_throw(context,
"Invalid element in array");
return false;
}
array[i] = gjs_arg_get<void*>(&arg);
}
*arr_p = array.release();
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_to_flat_array(JSContext* cx, JS::HandleValue array_value,
unsigned length,
const GI::TypeInfo param_info,
size_t param_size, void** arr_p) {
g_assert((param_size > 0) &&
"Only flat arrays of elements of known size are supported");
Gjs::AutoPointer<uint8_t> flat_array{g_new0(uint8_t, param_size * length)};
JS::RootedObject array(cx, &array_value.toObject());
JS::RootedValue elem(cx);
for (unsigned i = 0; i < length; i++) {
elem = JS::UndefinedValue();
if (!JS_GetElement(cx, array, i, &elem)) {
gjs_throw(cx, "Missing array element %u", i);
return false;
}
GIArgument arg;
if (!gjs_value_to_gi_argument(cx, elem, param_info,
GJS_ARGUMENT_ARRAY_ELEMENT,
GI_TRANSFER_NOTHING, &arg))
return false;
memcpy(&flat_array[param_size * i], gjs_arg_get<void*>(&arg),
param_size);
}
*arr_p = flat_array.release();
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_to_basic_array(JSContext* cx, JS::HandleValue v_array,
size_t length,
GITypeTag element_storage_type,
void** array_out) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_storage_type));
switch (element_storage_type) {
case GI_TYPE_TAG_UTF8:
return gjs_array_to_strv(cx, v_array, length, array_out);
case GI_TYPE_TAG_FILENAME:
return array_to_basic_c_array(cx, v_array, length,
element_storage_type, array_out);
case GI_TYPE_TAG_BOOLEAN:
return gjs_array_to_auto_array<Gjs::Tag::GBoolean>(
cx, v_array, length, array_out);
case GI_TYPE_TAG_UNICHAR:
return gjs_array_to_auto_array<char32_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_UINT8:
return gjs_array_to_auto_array<uint8_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_INT8:
return gjs_array_to_auto_array<int8_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_UINT16:
return gjs_array_to_auto_array<uint16_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_INT16:
return gjs_array_to_auto_array<int16_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_UINT32:
return gjs_array_to_auto_array<uint32_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_INT32:
return gjs_array_to_auto_array<int32_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_INT64:
return gjs_array_to_auto_array<int64_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_UINT64:
return gjs_array_to_auto_array<uint64_t>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_FLOAT:
return gjs_array_to_auto_array<float>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_DOUBLE:
return gjs_array_to_auto_array<double>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_GTYPE:
return gjs_array_to_auto_array<Gjs::Tag::GType>(cx, v_array, length,
array_out);
case GI_TYPE_TAG_VOID:
gjs_throw(cx, "Unhandled array element type %d",
element_storage_type);
return false;
default:
g_assert_not_reached();
}
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_to_array(JSContext* context, JS::HandleValue array_value,
size_t length, GITransfer transfer,
const GI::TypeInfo param_info, void** arr_p) {
GITypeTag element_type = param_info.storage_type();
if (GI_TYPE_TAG_IS_BASIC(element_type)) {
return gjs_array_to_basic_array(context, array_value, length,
element_type, arr_p);
}
switch (element_type) {
case GI_TYPE_TAG_INTERFACE:
if (!param_info.is_pointer()) {
GI::AutoBaseInfo interface_info{param_info.interface()};
if (auto reg_info =
interface_info.as<GI::InfoTag::REGISTERED_TYPE>();
reg_info && reg_info->is_g_value()) {
// Special case for GValue "flat arrays", this could also
// using the generic case, but if we do so we're leaking
// atm.
return gjs_array_to_auto_array<GValue>(context, array_value,
length, arr_p);
}
size_t element_size =
gjs_type_get_element_size(param_info.tag(), param_info);
if (element_size) {
return gjs_array_to_flat_array(context, array_value, length,
param_info, element_size, arr_p);
}
}
[[fallthrough]];
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:
return gjs_array_to_ptrarray(context,
array_value,
length,
transfer == GI_TRANSFER_CONTAINER ? GI_TRANSFER_NOTHING : transfer,
param_info,
arr_p);
default:
// Basic types already handled in gjs_array_to_basic_array()
gjs_throw(context, "Unhandled array element type %d", element_type);
return false;
}
}
static inline size_t basic_type_element_size(GITypeTag element_tag) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag));
switch (element_tag) {
case GI_TYPE_TAG_BOOLEAN:
return sizeof(gboolean);
case GI_TYPE_TAG_INT8:
return sizeof(int8_t);
case GI_TYPE_TAG_UINT8:
return sizeof(uint8_t);
case GI_TYPE_TAG_INT16:
return sizeof(int16_t);
case GI_TYPE_TAG_UINT16:
return sizeof(uint16_t);
case GI_TYPE_TAG_INT32:
return sizeof(int32_t);
case GI_TYPE_TAG_UINT32:
return sizeof(uint32_t);
case GI_TYPE_TAG_INT64:
return sizeof(int64_t);
case GI_TYPE_TAG_UINT64:
return sizeof(uint64_t);
case GI_TYPE_TAG_FLOAT:
return sizeof(float);
case GI_TYPE_TAG_DOUBLE:
return sizeof(double);
case GI_TYPE_TAG_GTYPE:
return sizeof(GType);
case GI_TYPE_TAG_UNICHAR:
return sizeof(char32_t);
case GI_TYPE_TAG_UTF8:
case GI_TYPE_TAG_FILENAME:
return sizeof(char*);
default:
g_return_val_if_reached(0);
}
}
static inline void set_arg_from_carray_element(GIArgument* arg,
GITypeTag element_tag,
void* value) {
switch (element_tag) {
case GI_TYPE_TAG_BOOLEAN:
gjs_arg_set<gboolean>(arg, *static_cast<gboolean*>(value));
break;
case GI_TYPE_TAG_INT8:
gjs_arg_set<int8_t>(arg, *static_cast<int8_t*>(value));
break;
case GI_TYPE_TAG_UINT8:
gjs_arg_set<uint8_t>(arg, *static_cast<uint8_t*>(value));
break;
case GI_TYPE_TAG_INT16:
gjs_arg_set<int16_t>(arg, *static_cast<int16_t*>(value));
break;
case GI_TYPE_TAG_UINT16:
gjs_arg_set<uint16_t>(arg, *static_cast<uint16_t*>(value));
break;
case GI_TYPE_TAG_INT32:
gjs_arg_set<int32_t>(arg, *static_cast<int32_t*>(value));
break;
case GI_TYPE_TAG_UINT32:
gjs_arg_set<uint32_t>(arg, *static_cast<uint32_t*>(value));
break;
case GI_TYPE_TAG_INT64:
gjs_arg_set<int64_t>(arg, *static_cast<int64_t*>(value));
break;
case GI_TYPE_TAG_UINT64:
gjs_arg_set<uint64_t>(arg, *static_cast<uint64_t*>(value));
break;
case GI_TYPE_TAG_FLOAT:
gjs_arg_set<float>(arg, *static_cast<float*>(value));
break;
case GI_TYPE_TAG_DOUBLE:
gjs_arg_set<double>(arg, *static_cast<double*>(value));
break;
case GI_TYPE_TAG_INTERFACE:
gjs_arg_set(arg, value);
break;
case GI_TYPE_TAG_VOID:
case GI_TYPE_TAG_GTYPE:
case GI_TYPE_TAG_UTF8:
case GI_TYPE_TAG_FILENAME:
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:
case GI_TYPE_TAG_UNICHAR:
// non interface tag support handled elsewhere
g_assert_not_reached();
}
}
size_t gjs_type_get_element_size(GITypeTag element_type,
const GI::TypeInfo type_info) {
if (type_info.is_pointer() && element_type != GI_TYPE_TAG_ARRAY)
return sizeof(void*);
switch (element_type) {
case GI_TYPE_TAG_GLIST:
return sizeof(GSList);
case GI_TYPE_TAG_GSLIST:
return sizeof(GList);
case GI_TYPE_TAG_ERROR:
return sizeof(GError);
case GI_TYPE_TAG_INTERFACE: {
GI::AutoBaseInfo interface_info{type_info.interface()};
if (interface_info.is_enum_or_flags())
return sizeof(unsigned);
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>())
return struct_info->size();
if (auto union_info = interface_info.as<GI::InfoTag::UNION>())
return union_info->size();
return 0;
}
case GI_TYPE_TAG_GHASH:
return sizeof(void*);
case GI_TYPE_TAG_ARRAY:
if (type_info.array_type() == GI_ARRAY_TYPE_C) {
if (!type_info.array_length_index())
return sizeof(void*);
GI::AutoTypeInfo element_type{type_info.element_type()};
return gjs_type_get_element_size(element_type.tag(), element_type);
}
return sizeof(void*);
case GI_TYPE_TAG_VOID:
break;
default:
return basic_type_element_size(element_type);
}
g_return_val_if_reached(0);
}
static GArray* garray_new_for_storage_type(unsigned length,
GITypeTag storage_type,
const GI::TypeInfo type_info) {
size_t element_size = gjs_type_get_element_size(storage_type, type_info);
return g_array_sized_new(true, false, element_size, length);
}
static GArray* garray_new_for_basic_type(unsigned length, GITypeTag tag) {
size_t element_size = basic_type_element_size(tag);
return g_array_sized_new(true, false, element_size, length);
}
char* gjs_argument_display_name(const char* arg_name,
GjsArgumentType arg_type) {
switch (arg_type) {
case GJS_ARGUMENT_ARGUMENT:
return g_strdup_printf("Argument '%s'", arg_name);
case GJS_ARGUMENT_RETURN_VALUE:
return g_strdup("Return value");
case GJS_ARGUMENT_FIELD:
return g_strdup_printf("Field '%s'", arg_name);
case GJS_ARGUMENT_LIST_ELEMENT:
return g_strdup("List element");
case GJS_ARGUMENT_HASH_ELEMENT:
return g_strdup("Hash element");
case GJS_ARGUMENT_ARRAY_ELEMENT:
return g_strdup("Array element");
default:
g_assert_not_reached ();
}
}
static void throw_invalid_argument(JSContext* context, JS::HandleValue value,
const GI::TypeInfo arginfo,
const char* arg_name,
GjsArgumentType arg_type) {
Gjs::AutoChar display_name{gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(context, "Expected type %s for %s but got type '%s'",
arginfo.display_string(), display_name.get(),
JS::InformalValueTypeName(value));
}
GJS_JSAPI_RETURN_CONVENTION
static bool throw_invalid_argument_tag(JSContext* cx, JS::HandleValue value,
GITypeTag type_tag, const char* arg_name,
GjsArgumentType arg_type) {
Gjs::AutoChar display_name{gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(cx, "Expected type %s for %s but got type '%s'",
gi_type_tag_to_string(type_tag), display_name.get(),
JS::InformalValueTypeName(value));
return false;
}
GJS_JSAPI_RETURN_CONVENTION
static bool throw_invalid_interface_argument(JSContext* cx,
JS::HandleValue value,
const GI::BaseInfo interface_info,
const char* arg_name,
GjsArgumentType arg_type) {
Gjs::AutoChar display_name{gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(cx, "Expected type %s for %s but got type '%s'",
interface_info.type_string(), display_name.get(),
JS::InformalValueTypeName(value));
return false;
}
bool gjs_array_to_basic_explicit_array(
JSContext* cx, JS::HandleValue value, GITypeTag element_tag,
const char* arg_name, GjsArgumentType arg_type, GjsArgumentFlags flags,
void** contents_out, size_t* length_out) {
g_assert(contents_out && length_out && "forgot out parameter");
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to C array",
arg_name, gjs_debug_value(value).c_str());
if ((value.isNull() && !(flags & GjsArgumentFlags::MAY_BE_NULL)) ||
(!value.isString() && !value.isObjectOrNull())) {
return throw_invalid_argument_tag(cx, value, element_tag, arg_name,
arg_type);
}
if (value.isNull()) {
*contents_out = nullptr;
*length_out = 0;
return true;
}
if (value.isString()) {
// Allow strings as int8/uint8/int16/uint16 arrays
JS::RootedString str{cx, value.toString()};
return gjs_string_to_intarray(cx, str, element_tag, contents_out,
length_out);
}
JS::RootedObject array_obj{cx, &value.toObject()};
if (JS_IsUint8Array(array_obj) &&
(element_tag == GI_TYPE_TAG_INT8 || element_tag == GI_TYPE_TAG_UINT8)) {
GBytes* bytes = gjs_byte_array_get_bytes(array_obj);
*contents_out = g_bytes_unref_to_data(bytes, length_out);
return true;
}
const GjsAtoms& atoms = GjsContextPrivate::atoms(cx);
bool found_length;
if (!JS_HasPropertyById(cx, array_obj, atoms.length(), &found_length))
return false;
if (found_length) {
uint32_t length;
if (!gjs_object_require_converted_property(cx, array_obj, nullptr,
atoms.length(), &length)) {
return false;
}
// For basic types, type tag == storage type
if (!gjs_array_to_basic_array(cx, value, length, element_tag,
contents_out))
return false;
*length_out = length;
return true;
}
return throw_invalid_argument_tag(cx, value, element_tag, arg_name,
arg_type);
}
bool gjs_array_to_explicit_array(JSContext* context, JS::HandleValue value,
const GI::TypeInfo type_info,
const char* arg_name, GjsArgumentType arg_type,
GITransfer transfer, GjsArgumentFlags flags,
void** contents, size_t* length_p) {
GI::AutoTypeInfo element_type{type_info.element_type()};
GITypeTag element_tag = element_type.tag();
if (GI_TYPE_TAG_IS_BASIC(element_tag)) {
return gjs_array_to_basic_explicit_array(context, value, element_tag,
arg_name, arg_type, flags,
contents, length_p);
}
bool found_length;
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to C array, transfer %d",
arg_name, gjs_debug_value(value).c_str(), transfer);
if ((value.isNull() && !(flags & GjsArgumentFlags::MAY_BE_NULL)) ||
(!value.isString() && !value.isObjectOrNull())) {
throw_invalid_argument(context, value, element_type, arg_name,
arg_type);
return false;
}
if (value.isNull()) {
*contents = NULL;
*length_p = 0;
} else if (value.isString()) {
/* Allow strings as int8/uint8/int16/uint16 arrays */
JS::RootedString str(context, value.toString());
if (!gjs_string_to_intarray(context, str, element_tag, contents, length_p))
return false;
} else {
JS::RootedObject array_obj(context, &value.toObject());
if (JS_IsUint8Array(array_obj) && (element_tag == GI_TYPE_TAG_INT8 ||
element_tag == GI_TYPE_TAG_UINT8)) {
GBytes* bytes = gjs_byte_array_get_bytes(array_obj);
*contents = g_bytes_unref_to_data(bytes, length_p);
return true;
}
const GjsAtoms& atoms = GjsContextPrivate::atoms(context);
if (!JS_HasPropertyById(context, array_obj, atoms.length(),
&found_length))
return false;
if (found_length) {
guint32 length;
if (!gjs_object_require_converted_property(
context, array_obj, nullptr, atoms.length(), &length)) {
return false;
} else {
if (!gjs_array_to_array(context, value, length, transfer,
element_type, contents))
return false;
*length_p = length;
}
} else {
throw_invalid_argument(context, value, element_type, arg_name,
arg_type);
return false;
}
}
return true;
}
static void intern_gdk_atom(const char* name, GIArgument* ret) {
GI::Repository repo;
GI::AutoFunctionInfo atom_intern_fun{
repo.find_by_name<GI::InfoTag::FUNCTION>("Gdk", "atom_intern").value()};
std::vector<GIArgument> atom_intern_args{2};
/* Can only store char * in GIArgument. First argument to gdk_atom_intern
* is const char *, string isn't modified. */
gjs_arg_set(&atom_intern_args[0], name);
gjs_arg_set(&atom_intern_args[1], false);
mozilla::Unused << atom_intern_fun.invoke(atom_intern_args, {}, ret);
}
static bool value_to_gdk_atom_gi_argument_internal(JSContext* cx,
JS::HandleValue value,
GIArgument* arg,
const char* arg_name,
GjsArgumentType arg_type) {
if (!value.isNull() && !value.isString()) {
Gjs::AutoChar display_name{
gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(cx, "Expected type String or null for %s but got type '%s'",
display_name.get(), JS::InformalValueTypeName(value));
return false;
}
if (value.isNull()) {
intern_gdk_atom("NONE", arg);
return true;
}
JS::RootedString str{cx, value.toString()};
JS::UniqueChars name{JS_EncodeStringToUTF8(cx, str)};
if (!name)
return false;
intern_gdk_atom(name.get(), arg);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
bool value_to_interface_gi_argument_internal(
JSContext* cx, JS::HandleValue value, const GI::BaseInfo interface_info,
GITransfer transfer, GIArgument* arg, const char* arg_name,
GjsArgumentType arg_type, GjsArgumentFlags flags) {
auto reg_type = interface_info.as<GI::InfoTag::REGISTERED_TYPE>();
if (reg_type && reg_type->is_gdk_atom()) {
return value_to_gdk_atom_gi_argument_internal(cx, value, arg, arg_name,
arg_type);
}
GType gtype = reg_type.map(std::mem_fn(&GI::RegisteredTypeInfo::gtype))
.valueOr(G_TYPE_NONE);
if (gtype != G_TYPE_NONE)
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "gtype of INTERFACE is %s",
g_type_name(gtype));
if (gtype == G_TYPE_VALUE) {
if (flags & GjsArgumentFlags::CALLER_ALLOCATES) {
if (!gjs_value_to_g_value_no_copy(cx, value,
gjs_arg_get<GValue*>(arg)))
return false;
return true;
}
Gjs::AutoGValue gvalue;
if (!gjs_value_to_g_value(cx, value, &gvalue)) {
gjs_arg_unset(arg);
return false;
}
gjs_arg_set(arg, g_boxed_copy(G_TYPE_VALUE, &gvalue));
return true;
} else if (interface_info.is_enum_or_flags() == value.isObjectOrNull()) {
// for enum/flags, object/null are invalid. for everything else,
// everything except object/null is invalid.
return throw_invalid_interface_argument(cx, value, interface_info,
arg_name, arg_type);
} else if (value.isNull()) {
gjs_arg_set(arg, nullptr);
return true;
} else if (value.isObject()) {
JS::RootedObject obj(cx, &value.toObject());
auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
if (struct_info && struct_info->is_gtype_struct()) {
GType actual_gtype;
if (!gjs_gtype_get_actual_gtype(cx, obj, &actual_gtype))
return false;
if (actual_gtype == G_TYPE_NONE) {
return throw_invalid_interface_argument(
cx, value, interface_info, arg_name, arg_type);
}
// 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.
void* klass;
if (g_type_is_a(actual_gtype, G_TYPE_INTERFACE))
klass = g_type_default_interface_peek(actual_gtype);
else
klass = g_type_class_peek(actual_gtype);
gjs_arg_set(arg, klass);
return true;
}
GType arg_gtype = gtype;
if (struct_info && gtype == G_TYPE_NONE && !struct_info->is_foreign()) {
GType actual_gtype = G_TYPE_NONE;
// In case we have no known type from gi we should try to be
// more dynamic and try to get the type from JS, to handle the
// case in which we're handling a gpointer such as GTypeInstance
// FIXME(3v1n0): would be nice to know if GI would give this info
if (!gjs_gtype_get_actual_gtype(cx, obj, &actual_gtype))
return false;
if (G_TYPE_IS_INSTANTIATABLE(actual_gtype))
gtype = actual_gtype;
}
if (struct_info && !g_type_is_a(gtype, G_TYPE_CLOSURE)) {
// Handle Struct/Union first since we don't necessarily need a GType
// for them. We special case Closures later, so skip them here.
if (g_type_is_a(gtype, G_TYPE_BYTES) && JS_IsUint8Array(obj)) {
gjs_arg_set(arg, gjs_byte_array_get_bytes(obj));
return true;
}
if (g_type_is_a(gtype, G_TYPE_ERROR)) {
return ErrorBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer);
}
if (arg_gtype != G_TYPE_NONE || gtype == G_TYPE_NONE ||
g_type_is_a(gtype, G_TYPE_BOXED) ||
g_type_is_a(gtype, G_TYPE_VALUE) ||
g_type_is_a(gtype, G_TYPE_VARIANT)) {
if (!BoxedBase::typecheck(cx, obj, interface_info)) {
gjs_arg_unset(arg);
return false;
}
return BoxedBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
}
}
if (interface_info.is_union()) {
if (!UnionBase::typecheck(cx, obj, interface_info)) {
gjs_arg_unset(arg);
return false;
}
return UnionBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
}
if (gtype != G_TYPE_NONE) {
if (g_type_is_a(gtype, G_TYPE_OBJECT)) {
return ObjectBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
} else if (g_type_is_a(gtype, G_TYPE_PARAM)) {
if (!gjs_typecheck_param(cx, obj, gtype, true)) {
gjs_arg_unset(arg);
return false;
}
gjs_arg_set(arg, gjs_g_param_from_param(cx, obj));
if (transfer != GI_TRANSFER_NOTHING)
g_param_spec_ref(gjs_arg_get<GParamSpec*>(arg));
return true;
} else if (g_type_is_a(gtype, G_TYPE_BOXED)) {
if (g_type_is_a(gtype, G_TYPE_CLOSURE)) {
if (BoxedBase::typecheck(cx, obj, interface_info,
GjsTypecheckNoThrow{}) &&
BoxedBase::typecheck(cx, obj, gtype,
GjsTypecheckNoThrow{})) {
return BoxedBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
}
GClosure* closure =
Gjs::Closure::create_marshaled(cx, obj, "boxed");
// GI doesn't know about floating GClosure references. We
// guess that if this is a return value going from JS::Value
// to GIArgument, it's intended to be passed to a C API that
// will consume the floating reference.
if (arg_type != GJS_ARGUMENT_RETURN_VALUE) {
g_closure_ref(closure);
g_closure_sink(closure);
}
gjs_arg_set(arg, closure);
return true;
}
// Should have been caught above as STRUCT/BOXED/UNION
gjs_throw(
cx,
"Boxed type %s registered for unexpected interface_type %s",
g_type_name(gtype), interface_info.type_string());
return false;
} else if (G_TYPE_IS_INSTANTIATABLE(gtype)) {
return FundamentalBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
} else if (G_TYPE_IS_INTERFACE(gtype)) {
// Could be a GObject interface that's missing a prerequisite,
// or could be a fundamental
if (ObjectBase::typecheck(cx, obj, gtype,
GjsTypecheckNoThrow{})) {
return ObjectBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
}
// If this typecheck fails, then it's neither an object nor a
// fundamental
return FundamentalBase::transfer_to_gi_argument(
cx, obj, arg, GI_DIRECTION_IN, transfer, gtype);
}
gjs_throw(cx, "Unhandled GType %s unpacking GIArgument from Object",
g_type_name(gtype));
gjs_arg_unset(arg);
return false;
}
gjs_debug(GJS_DEBUG_GFUNCTION,
"conversion of JSObject value %s to type %s failed",
gjs_debug_value(value).c_str(), interface_info.name());
gjs_throw(cx,
"Unexpected unregistered type unpacking GIArgument from "
"Object");
return false;
} else if (value.isNumber()) {
if (auto enum_info = interface_info.as<GI::InfoTag::ENUM>()) {
int64_t value_int64;
if (!JS::ToInt64(cx, value, &value_int64))
return false;
if (interface_info.is_flags()) {
if (!_gjs_flags_value_is_valid(cx, gtype, value_int64))
return false;
} else {
if (!_gjs_enum_value_is_valid(cx, enum_info.value(),
value_int64))
return false;
}
gjs_arg_set<Gjs::Tag::Enum>(arg,
enum_info->enum_to_int(value_int64));
return true;
} else if (gtype == G_TYPE_NONE) {
gjs_throw(cx,
"Unexpected unregistered type unpacking GIArgument from "
"Number");
return false;
}
gjs_throw(cx, "Unhandled GType %s unpacking GIArgument from Number",
g_type_name(gtype));
return false;
}
gjs_debug(GJS_DEBUG_GFUNCTION,
"JSObject type '%s' is neither null nor an object",
JS::InformalValueTypeName(value));
return throw_invalid_interface_argument(cx, value, interface_info, arg_name,
arg_type);
}
template <typename TAG>
GJS_JSAPI_RETURN_CONVENTION inline static bool gjs_arg_set_from_js_value(
JSContext* cx, JS::HandleValue value, GIArgument* arg, const char* arg_name,
GjsArgumentType arg_type) {
bool out_of_range = false;
if (!gjs_arg_set_from_js_value<TAG>(cx, value, arg, &out_of_range)) {
if (out_of_range) {
Gjs::AutoChar display_name{
gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(cx, "value %s is out of range for %s (type %s)",
std::to_string(gjs_arg_get<TAG>(arg)).c_str(),
display_name.get(), Gjs::static_type_name<TAG>());
}
return false;
}
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION, "%s set to value %s (type %s)",
Gjs::AutoChar{gjs_argument_display_name(arg_name, arg_type)}.get(),
std::to_string(gjs_arg_get<TAG>(arg)).c_str(),
Gjs::static_type_name<TAG>());
return true;
}
static bool check_nullable_argument(JSContext* cx, const char* arg_name,
GjsArgumentType arg_type,
GITypeTag type_tag, GjsArgumentFlags flags,
GIArgument* arg) {
if (!(flags & GjsArgumentFlags::MAY_BE_NULL) && !gjs_arg_get<void*>(arg)) {
Gjs::AutoChar display_name{
gjs_argument_display_name(arg_name, arg_type)};
gjs_throw(cx, "%s (type %s) may not be null", display_name.get(),
gi_type_tag_to_string(type_tag));
return false;
}
return true;
}
bool gjs_value_to_basic_gi_argument(JSContext* cx, JS::HandleValue value,
GITypeTag type_tag, GIArgument* arg,
const char* arg_name,
GjsArgumentType arg_type,
GjsArgumentFlags flags) {
g_assert(GI_TYPE_TAG_IS_BASIC(type_tag) &&
"use gjs_value_to_gi_argument() for non-basic types");
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type %s", arg_name,
gjs_debug_value(value).c_str(), gi_type_tag_to_string(type_tag));
switch (type_tag) {
case GI_TYPE_TAG_VOID:
// don't know how to handle non-pointer VOID
return throw_invalid_argument_tag(cx, value, type_tag, arg_name,
arg_type);
case GI_TYPE_TAG_INT8:
return gjs_arg_set_from_js_value<int8_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_UINT8:
return gjs_arg_set_from_js_value<uint8_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_INT16:
return gjs_arg_set_from_js_value<int16_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_UINT16:
return gjs_arg_set_from_js_value<uint16_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_INT32:
return gjs_arg_set_from_js_value<int32_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_UINT32:
return gjs_arg_set_from_js_value<uint32_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_INT64:
return gjs_arg_set_from_js_value<int64_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_UINT64:
return gjs_arg_set_from_js_value<uint64_t>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_BOOLEAN:
gjs_arg_set(arg, JS::ToBoolean(value));
return true;
case GI_TYPE_TAG_FLOAT:
return gjs_arg_set_from_js_value<float>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_DOUBLE:
return gjs_arg_set_from_js_value<double>(cx, value, arg, arg_name,
arg_type);
case GI_TYPE_TAG_UNICHAR:
if (value.isString()) {
return gjs_unichar_from_string(cx, value,
&gjs_arg_member<char32_t>(arg));
}
return throw_invalid_argument_tag(cx, value, type_tag, arg_name,
arg_type);
case GI_TYPE_TAG_GTYPE:
if (value.isObjectOrNull()) {
GType gtype;
JS::RootedObject obj{cx, value.toObjectOrNull()};
if (!gjs_gtype_get_actual_gtype(cx, obj, >ype))
return false;
if (gtype == G_TYPE_INVALID)
return false;
gjs_arg_set<Gjs::Tag::GType>(arg, gtype);
return true;
}
return throw_invalid_argument_tag(cx, value, type_tag, arg_name,
arg_type);
case GI_TYPE_TAG_FILENAME:
if (value.isNull()) {
gjs_arg_set(arg, nullptr);
} else if (value.isString()) {
Gjs::AutoChar filename_str;
if (!gjs_string_to_filename(cx, value, &filename_str))
return false;
gjs_arg_set(arg, filename_str.release());
} else {
return throw_invalid_argument_tag(cx, value, type_tag, arg_name,
arg_type);
}
return check_nullable_argument(cx, arg_name, arg_type, type_tag,
flags, arg);
case GI_TYPE_TAG_UTF8:
if (value.isNull()) {
gjs_arg_set(arg, nullptr);
} else if (value.isString()) {
JS::RootedString str{cx, value.toString()};
JS::UniqueChars utf8_str{JS_EncodeStringToUTF8(cx, str)};
if (!utf8_str)
return false;
gjs_arg_set(
arg, Gjs::js_chars_to_glib(std::move(utf8_str)).release());
} else {
return throw_invalid_argument_tag(cx, value, type_tag, arg_name,
arg_type);
}
return check_nullable_argument(cx, arg_name, arg_type, type_tag,
flags, arg);
default:
g_return_val_if_reached(false); // non-basic type
}
}
bool gjs_value_to_gerror_gi_argument(JSContext* cx, JS::HandleValue value,
GITransfer transfer, GIArgument* arg,
const char* arg_name,
GjsArgumentType arg_type,
GjsArgumentFlags flags) {
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type error",
arg_name, gjs_debug_value(value).c_str());
if (value.isNull()) {
gjs_arg_set(arg, nullptr);
} else if (value.isObject()) {
JS::RootedObject obj(cx, &value.toObject());
if (!ErrorBase::transfer_to_gi_argument(cx, obj, arg, GI_DIRECTION_IN,
transfer))
return false;
} else {
return throw_invalid_argument_tag(cx, value, GI_TYPE_TAG_ERROR,
arg_name, arg_type);
}
return check_nullable_argument(cx, arg_name, arg_type, GI_TYPE_TAG_ERROR,
flags, arg);
}
bool gjs_value_to_gdk_atom_gi_argument(JSContext* cx, JS::HandleValue value,
GIArgument* arg, const char* arg_name,
GjsArgumentType arg_type) {
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type interface",
arg_name, gjs_debug_value(value).c_str());
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "gtype of INTERFACE is GdkAtom");
return value_to_gdk_atom_gi_argument_internal(cx, value, arg, arg_name,
arg_type);
}
// Convert a JS value to GIArgument, specifically for arguments with type tag
// GI_TYPE_TAG_INTERFACE.
bool gjs_value_to_interface_gi_argument(JSContext* cx, JS::HandleValue value,
const GI::BaseInfo interface_info,
GITransfer transfer, GIArgument* arg,
const char* arg_name,
GjsArgumentType arg_type,
GjsArgumentFlags flags) {
if (auto reg_info = interface_info.as<GI::InfoTag::REGISTERED_TYPE>();
reg_info && reg_info->is_gdk_atom()) {
return gjs_value_to_gdk_atom_gi_argument(cx, value, arg, arg_name,
arg_type);
}
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type interface",
arg_name, gjs_debug_value(value).c_str());
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
struct_info && struct_info->is_foreign()) {
return gjs_struct_foreign_convert_to_gi_argument(
cx, value, *struct_info, arg_name, arg_type, transfer, flags, arg);
}
if (!value_to_interface_gi_argument_internal(cx, value, interface_info,
transfer, arg, arg_name,
arg_type, flags))
return false;
if (interface_info.is_enum_or_flags())
return true;
return check_nullable_argument(cx, arg_name, arg_type,
GI_TYPE_TAG_INTERFACE, flags, arg);
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool basic_array_to_linked_list(
JSContext* cx, JS::HandleValue value, GITypeTag element_tag,
const char* arg_name, GjsArgumentType arg_type, T** list_p) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use gjs_array_to_g_list() for lists containing non-basic types");
constexpr GITypeTag list_tag =
std::is_same_v<T, GList> ? GI_TYPE_TAG_GLIST : GI_TYPE_TAG_GSLIST;
// While a list can be NULL in C, that means empty array in JavaScript, it
// doesn't mean null in JavaScript.
if (!value.isObject())
return false;
const GjsAtoms& atoms = GjsContextPrivate::atoms(cx);
JS::RootedObject array_obj(cx, &value.toObject());
bool found_length;
if (!JS_HasPropertyById(cx, array_obj, atoms.length(), &found_length))
return false;
if (!found_length) {
return throw_invalid_argument_tag(cx, value, list_tag, arg_name,
arg_type);
}
uint32_t length;
if (!gjs_object_require_converted_property(cx, array_obj, nullptr,
atoms.length(), &length)) {
return throw_invalid_argument_tag(cx, value, list_tag, arg_name,
arg_type);
}
JS::RootedObject array{cx, value.toObjectOrNull()};
JS::RootedValue elem{cx};
T* list = nullptr;
for (size_t i = 0; i < length; ++i) {
GIArgument elem_arg = {0};
elem = JS::UndefinedValue();
if (!JS_GetElement(cx, array, i, &elem)) {
gjs_throw(cx, "Missing array element %zu", i);
return false;
}
if (!gjs_value_to_basic_gi_argument(cx, elem, element_tag, &elem_arg,
arg_name, GJS_ARGUMENT_LIST_ELEMENT,
GjsArgumentFlags::NONE)) {
return false;
}
void* hash_pointer =
gi_type_tag_hash_pointer_from_argument(element_tag, &elem_arg);
if constexpr (std::is_same_v<T, GList>)
list = g_list_prepend(list, hash_pointer);
else if constexpr (std::is_same_v<T, GSList>)
list = g_slist_prepend(list, hash_pointer);
}
if constexpr (std::is_same_v<T, GList>)
list = g_list_reverse(list);
else if constexpr (std::is_same_v<T, GSList>)
list = g_slist_reverse(list);
*list_p = list;
return true;
}
bool gjs_value_to_basic_glist_gi_argument(JSContext* cx, JS::HandleValue value,
GITypeTag element_tag,
GIArgument* arg, const char* arg_name,
GjsArgumentType arg_type) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use gjs_array_to_g_list() for lists containing non-basic types");
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type glist",
arg_name, gjs_debug_value(value).c_str());
return basic_array_to_linked_list(cx, value, element_tag, arg_name,
arg_type, &gjs_arg_member<GList*>(arg));
}
bool gjs_value_to_basic_gslist_gi_argument(JSContext* cx, JS::HandleValue value,
GITypeTag element_tag,
GIArgument* arg,
const char* arg_name,
GjsArgumentType arg_type) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use gjs_array_to_g_list() for lists containing non-basic types");
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type gslist",
arg_name, gjs_debug_value(value).c_str());
return basic_array_to_linked_list(cx, value, element_tag, arg_name,
arg_type, &gjs_arg_member<GSList*>(arg));
}
bool gjs_value_to_basic_ghash_gi_argument(
JSContext* cx, JS::HandleValue value, GITypeTag key_tag,
GITypeTag value_tag, GITransfer transfer, GIArgument* arg,
const char* arg_name, GjsArgumentType arg_type, GjsArgumentFlags flags) {
g_assert(GI_TYPE_TAG_IS_BASIC(key_tag) &&
"use gjs_object_to_g_hash() for hashes with non-basic key types");
g_assert(
GI_TYPE_TAG_IS_BASIC(value_tag) &&
"use gjs_object_to_g_hash() for hashes with non-basic value types");
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type ghash",
arg_name, gjs_debug_value(value).c_str());
if (value.isNull()) {
if (!(flags & GjsArgumentFlags::MAY_BE_NULL)) {
return throw_invalid_argument_tag(cx, value, GI_TYPE_TAG_GHASH,
arg_name, arg_type);
}
gjs_arg_set(arg, nullptr);
return true;
}
if (!value.isObject()) {
return throw_invalid_argument_tag(cx, value, GI_TYPE_TAG_GHASH,
arg_name, arg_type);
}
if (transfer == GI_TRANSFER_CONTAINER) {
if (Gjs::basic_type_needs_release(key_tag) ||
Gjs::basic_type_needs_release(value_tag)) {
// See comment in gjs_value_to_g_hash()
gjs_throw(cx, "Container transfer for in parameters not supported");
return false;
}
transfer = GI_TRANSFER_NOTHING;
}
JS::RootedObject props{cx, &value.toObject()};
JS::Rooted<JS::IdVector> ids{cx, cx};
if (!JS_Enumerate(cx, props, &ids))
return false;
Gjs::AutoPointer<GHashTable, GHashTable, g_hash_table_destroy> result{
create_hash_table_for_key_type(key_tag)};
JS::RootedValue v_key{cx}, v_val{cx};
JS::RootedId cur_id{cx};
for (size_t id_ix = 0, id_len = ids.length(); id_ix < id_len; ++id_ix) {
cur_id = ids[id_ix];
void* key_ptr;
void* val_ptr;
GIArgument val_arg = {0};
if (!JS_IdToValue(cx, cur_id, &v_key) ||
// Type check key type.
!value_to_ghashtable_key(cx, v_key, key_tag, &key_ptr) ||
!JS_GetPropertyById(cx, props, cur_id, &v_val) ||
// Type check and convert value to a C type
!gjs_value_to_basic_gi_argument(cx, v_val, value_tag, &val_arg,
nullptr, GJS_ARGUMENT_HASH_ELEMENT,
GjsArgumentFlags::MAY_BE_NULL))
return false;
// Use heap-allocated values for types that don't fit in a pointer
if (value_tag == GI_TYPE_TAG_INT64) {
val_ptr = heap_value_new_from_arg<int64_t>(&val_arg);
} else if (value_tag == GI_TYPE_TAG_UINT64) {
val_ptr = heap_value_new_from_arg<uint64_t>(&val_arg);
} else if (value_tag == GI_TYPE_TAG_FLOAT) {
val_ptr = heap_value_new_from_arg<float>(&val_arg);
} else if (value_tag == GI_TYPE_TAG_DOUBLE) {
val_ptr = heap_value_new_from_arg<double>(&val_arg);
} else {
// Other types are simply stuffed inside the pointer
val_ptr =
gi_type_tag_hash_pointer_from_argument(value_tag, &val_arg);
}
g_hash_table_insert(result, key_ptr, val_ptr);
}
gjs_arg_set(arg, result.release());
return true;
}
bool gjs_value_to_basic_array_gi_argument(JSContext* cx, JS::HandleValue value,
GITypeTag element_tag,
GIArrayType array_type,
GIArgument* arg, const char* arg_name,
GjsArgumentType arg_type,
GjsArgumentFlags flags) {
Gjs::AutoPointer<void> data;
size_t length;
if (!gjs_array_to_basic_explicit_array(cx, value, element_tag, arg_name,
arg_type, flags, data.out(),
&length)) {
return false;
}
if (array_type == GI_ARRAY_TYPE_C) {
gjs_arg_set(arg, data.release());
} else if (array_type == GI_ARRAY_TYPE_ARRAY) {
GArray* array = garray_new_for_basic_type(length, element_tag);
if (data)
g_array_append_vals(array, data, length);
gjs_arg_set(arg, array);
} else if (array_type == GI_ARRAY_TYPE_BYTE_ARRAY) {
return gjs_value_to_byte_array_gi_argument(cx, value, arg, arg_name,
flags);
} else if (array_type == GI_ARRAY_TYPE_PTR_ARRAY) {
GPtrArray* array = g_ptr_array_sized_new(length);
g_ptr_array_set_size(array, length);
if (data)
memcpy(array->pdata, data, sizeof(void*) * length);
gjs_arg_set(arg, array);
}
return true;
}
bool gjs_value_to_byte_array_gi_argument(JSContext* cx, JS::HandleValue value,
GIArgument* arg, const char* arg_name,
GjsArgumentFlags flags) {
// First, let's handle the case where we're passed an instance of
// Uint8Array and it needs to be marshalled to GByteArray.
if (value.isObject()) {
JSObject* bytearray_obj = &value.toObject();
if (JS_IsUint8Array(bytearray_obj)) {
gjs_arg_set(arg, gjs_byte_array_get_byte_array(bytearray_obj));
return true;
}
}
Gjs::AutoPointer<void> data;
size_t length;
if (!gjs_array_to_basic_explicit_array(cx, value, GI_TYPE_TAG_UINT8,
arg_name, GJS_ARGUMENT_ARGUMENT,
flags, data.out(), &length)) {
return false;
}
GByteArray* byte_array = g_byte_array_sized_new(length);
if (data)
g_byte_array_append(byte_array, data.as<const uint8_t>(), length);
gjs_arg_set(arg, byte_array);
return true;
}
bool gjs_value_to_gi_argument(JSContext* context, JS::HandleValue value,
const GI::TypeInfo type_info,
const char* arg_name, GjsArgumentType arg_type,
GITransfer transfer, GjsArgumentFlags flags,
GIArgument* arg) {
GITypeTag type_tag = type_info.tag();
if (type_info.is_basic()) {
return gjs_value_to_basic_gi_argument(context, value, type_tag, arg,
arg_name, arg_type, flags);
}
if (type_tag == GI_TYPE_TAG_ERROR) {
return gjs_value_to_gerror_gi_argument(context, value, transfer, arg,
arg_name, arg_type, flags);
}
if (type_tag == GI_TYPE_TAG_INTERFACE) {
GI::AutoBaseInfo interface_info{type_info.interface()};
return gjs_value_to_interface_gi_argument(context, value,
interface_info, transfer, arg,
arg_name, arg_type, flags);
}
if (type_tag == GI_TYPE_TAG_GLIST || type_tag == GI_TYPE_TAG_GSLIST) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
if (type_tag == GI_TYPE_TAG_GLIST)
return gjs_value_to_basic_glist_gi_argument(
context, value, element_type.tag(), arg, arg_name,
arg_type);
return gjs_value_to_basic_gslist_gi_argument(
context, value, element_type.tag(), arg, arg_name, arg_type);
}
// else, fall through to generic marshaller
} else if (type_tag == GI_TYPE_TAG_GHASH) {
GI::AutoTypeInfo key_type{type_info.key_type()};
GI::AutoTypeInfo value_type{type_info.value_type()};
if (key_type.is_basic() && value_type.is_basic()) {
return gjs_value_to_basic_ghash_gi_argument(
context, value, key_type.tag(), value_type.tag(), transfer, arg,
arg_name, arg_type, flags);
}
// else, fall through to generic marshaller
} else if (type_tag == GI_TYPE_TAG_ARRAY) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
return gjs_value_to_basic_array_gi_argument(
context, value, element_type.tag(), type_info.array_type(), arg,
arg_name, arg_type, flags);
}
// else, fall through to generic marshaller
}
gjs_debug_marshal(
GJS_DEBUG_GFUNCTION,
"Converting argument '%s' JS value %s to GIArgument type %s", arg_name,
gjs_debug_value(value).c_str(), gi_type_tag_to_string(type_tag));
switch (type_tag) {
case GI_TYPE_TAG_VOID:
g_assert(type_info.is_pointer() &&
"non-pointers should be handled by "
"gjs_value_to_basic_gi_argument()");
// void pointer; cannot marshal. Pass null to C if argument is nullable.
gjs_arg_unset(arg);
return check_nullable_argument(context, arg_name, arg_type, type_tag,
flags, arg);
case GI_TYPE_TAG_GLIST:
return gjs_array_to_g_list(context, value, type_info, transfer,
arg_name, arg_type,
&gjs_arg_member<GList*>(arg));
case GI_TYPE_TAG_GSLIST:
return gjs_array_to_g_list(context, value, type_info, transfer,
arg_name, arg_type,
&gjs_arg_member<GSList*>(arg));
case GI_TYPE_TAG_GHASH:
if (value.isNull()) {
gjs_arg_set(arg, nullptr);
if (!(flags & GjsArgumentFlags::MAY_BE_NULL)) {
throw_invalid_argument(context, value, type_info, arg_name,
arg_type);
return false;
}
} else if (!value.isObject()) {
throw_invalid_argument(context, value, type_info, arg_name,
arg_type);
return false;
} else {
GHashTable *ghash;
JS::RootedObject props(context, &value.toObject());
if (!gjs_object_to_g_hash(context, props, type_info, transfer,
&ghash)) {
return false;
}
gjs_arg_set(arg, ghash);
}
break;
case GI_TYPE_TAG_ARRAY: {
Gjs::AutoPointer<void> data;
size_t length;
GIArrayType array_type = type_info.array_type();
if (!gjs_array_to_explicit_array(context, value, type_info, arg_name,
arg_type, transfer, flags, data.out(),
&length)) {
return false;
}
GI::AutoTypeInfo element_type{type_info.element_type()};
if (array_type == GI_ARRAY_TYPE_C) {
gjs_arg_set(arg, data.release());
} else if (array_type == GI_ARRAY_TYPE_ARRAY) {
GArray* array = garray_new_for_storage_type(
length, element_type.storage_type(), element_type);
if (data)
g_array_append_vals(array, data, length);
gjs_arg_set(arg, array);
} else if (array_type == GI_ARRAY_TYPE_BYTE_ARRAY) {
// handled in gjs_value_to_basic_array_gi_argument()
g_assert_not_reached();
} else if (array_type == GI_ARRAY_TYPE_PTR_ARRAY) {
GPtrArray *array = g_ptr_array_sized_new(length);
g_ptr_array_set_size(array, length);
if (data)
memcpy(array->pdata, data, sizeof(void*) * length);
gjs_arg_set(arg, array);
}
break;
}
default:
// basic types handled in gjs_value_to_basic_gi_argument(), ERROR
// handled in gjs_value_to_gerror_gi_argument(), and INTERFACE handled
// in gjs_value_to_interface_gi_argument()
g_warning("Unhandled type %s for JavaScript to GIArgument conversion",
gi_type_tag_to_string(type_tag));
throw_invalid_argument(context, value, type_info, arg_name, arg_type);
return false;
}
return true;
}
bool gjs_value_to_callback_out_arg(JSContext* cx, JS::HandleValue value,
const GI::ArgInfo arg_info,
GIArgument* arg) {
g_assert((arg_info.direction() == GI_DIRECTION_OUT ||
arg_info.direction() == GI_DIRECTION_INOUT) &&
"gjs_value_to_callback_out_arg does not handle in arguments.");
GjsArgumentFlags flags = GjsArgumentFlags::NONE;
GI::StackTypeInfo type_info;
arg_info.load_type(&type_info);
// If the argument is optional and we're passed nullptr,
// ignore the GJS value.
if (arg_info.is_optional() && !arg)
return true;
// Otherwise, throw an error to prevent a segfault.
if (!arg) {
gjs_throw(cx, "Return value %s is not optional but was passed NULL",
arg_info.name());
return false;
}
if (arg_info.may_be_null())
flags |= GjsArgumentFlags::MAY_BE_NULL;
if (arg_info.caller_allocates())
flags |= GjsArgumentFlags::CALLER_ALLOCATES;
return gjs_value_to_gi_argument(
cx, value, type_info, arg_info.name(),
(arg_info.is_return_value() ? GJS_ARGUMENT_RETURN_VALUE
: GJS_ARGUMENT_ARGUMENT),
arg_info.ownership_transfer(), flags, arg);
}
///// "FROM" MARSHALLERS ///////////////////////////////////////////////////////
// These marshaller functions are responsible for converting C values returned
// from a C function call, usually stored in a GIArgument, back to JS values.
bool gjs_value_from_basic_gi_argument(JSContext* cx,
JS::MutableHandleValue value_out,
GITypeTag type_tag, GIArgument* arg) {
g_assert(GI_TYPE_TAG_IS_BASIC(type_tag) &&
"use gjs_value_from_gi_argument() for non-basic types");
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument %s to JS::Value",
gi_type_tag_to_string(type_tag));
switch (type_tag) {
case GI_TYPE_TAG_VOID:
// Pointers are handled in gjs_value_from_gi_argument(), and would
// set null instead
value_out.setUndefined();
return true;
case GI_TYPE_TAG_BOOLEAN:
value_out.setBoolean(gjs_arg_get<bool>(arg));
return true;
case GI_TYPE_TAG_INT32:
value_out.setInt32(gjs_arg_get<int32_t>(arg));
return true;
case GI_TYPE_TAG_UINT32:
value_out.setNumber(gjs_arg_get<uint32_t>(arg));
return true;
case GI_TYPE_TAG_INT64:
value_out.setNumber(gjs_arg_get_maybe_rounded<int64_t>(arg));
return true;
case GI_TYPE_TAG_UINT64:
value_out.setNumber(gjs_arg_get_maybe_rounded<uint64_t>(arg));
return true;
case GI_TYPE_TAG_UINT16:
value_out.setInt32(gjs_arg_get<uint16_t>(arg));
return true;
case GI_TYPE_TAG_INT16:
value_out.setInt32(gjs_arg_get<int16_t>(arg));
return true;
case GI_TYPE_TAG_UINT8:
value_out.setInt32(gjs_arg_get<uint8_t>(arg));
return true;
case GI_TYPE_TAG_INT8:
value_out.setInt32(gjs_arg_get<int8_t>(arg));
return true;
case GI_TYPE_TAG_FLOAT:
value_out.setNumber(JS::CanonicalizeNaN(gjs_arg_get<float>(arg)));
return true;
case GI_TYPE_TAG_DOUBLE:
value_out.setNumber(JS::CanonicalizeNaN(gjs_arg_get<double>(arg)));
return true;
case GI_TYPE_TAG_GTYPE: {
GType gtype = gjs_arg_get<Gjs::Tag::GType>(arg);
if (gtype == 0) {
value_out.setNull();
return true;
}
JSObject* obj = gjs_gtype_create_gtype_wrapper(cx, gtype);
if (!obj)
return false;
value_out.setObject(*obj);
return true;
}
case GI_TYPE_TAG_UNICHAR: {
char32_t value = gjs_arg_get<char32_t>(arg);
// Preserve the bidirectional mapping between 0 and ""
if (value == 0) {
value_out.set(JS_GetEmptyStringValue(cx));
return true;
} else if (!g_unichar_validate(value)) {
gjs_throw(cx, "Invalid unicode codepoint %" G_GUINT32_FORMAT,
value);
return false;
}
char utf8[7];
int bytes = g_unichar_to_utf8(value, utf8);
return gjs_string_from_utf8_n(cx, utf8, bytes, value_out);
}
case GI_TYPE_TAG_FILENAME:
case GI_TYPE_TAG_UTF8: {
const char* str = gjs_arg_get<const char*>(arg);
if (!str) {
value_out.setNull();
return true;
}
if (type_tag == GI_TYPE_TAG_FILENAME)
return gjs_string_from_filename(cx, str, -1, value_out);
return gjs_string_from_utf8(cx, str, value_out);
}
default:
// this function handles only basic types
g_return_val_if_reached(false);
}
}
bool gjs_array_from_strv(JSContext* cx, JS::MutableHandleValue value_out,
const char** strv) {
// We treat a NULL strv as an empty array, since this function should always
// set an array value when returning true. Another alternative would be
// value_out.setNull(), but clients would need to always check for both an
// empty array and null if that was the case.
JS::RootedValueVector elems{cx};
for (size_t i = 0; strv && strv[i]; i++) {
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_string_from_utf8(cx, strv[i], elems[i]))
return false;
}
JSObject* obj = JS::NewArrayObject(cx, elems);
if (!obj)
return false;
value_out.setObject(*obj);
return true;
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool gjs_array_from_g_list(
JSContext* cx, JS::MutableHandleValue value_p, const GI::TypeInfo type_info,
GITransfer transfer, T* list) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
JS::RootedValueVector elems(cx);
GI::AutoTypeInfo element_type{type_info.element_type()};
GIArgument arg;
for (size_t i = 0; list; list = list->next, ++i) {
element_type.argument_from_hash_pointer(list->data, &arg);
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_value_from_gi_argument(cx, elems[i], element_type,
GJS_ARGUMENT_LIST_ELEMENT, transfer,
&arg))
return false;
}
JSObject* obj = JS::NewArrayObject(cx, elems);
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
template <typename TAG>
GJS_JSAPI_RETURN_CONVENTION static bool fill_vector_from_basic_c_array(
JSContext* cx, JS::MutableHandleValueVector elems, GITypeTag element_tag,
GIArgument* arg, void* array, size_t length) {
using T = Gjs::Tag::RealT<TAG>;
for (size_t i = 0; i < length; i++) {
gjs_arg_set<TAG>(arg, *(static_cast<T*>(array) + i));
if (!gjs_value_from_basic_gi_argument(cx, elems[i], element_tag, arg))
return false;
}
return true;
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool fill_vector_from_carray(
JSContext* cx, JS::RootedValueVector& elems, // NOLINT(runtime/references)
const GI::TypeInfo element_type, GIArgument* arg, void* array,
size_t length, GITransfer transfer = GI_TRANSFER_EVERYTHING) {
for (size_t i = 0; i < length; i++) {
gjs_arg_set<T>(arg, *(static_cast<Gjs::Tag::RealT<T>*>(array) + i));
if (!gjs_value_from_gi_argument(cx, elems[i], element_type,
GJS_ARGUMENT_ARRAY_ELEMENT, transfer,
arg))
return false;
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_from_basic_c_array_internal(
JSContext* cx, JS::MutableHandleValue value_out, GITypeTag element_tag,
size_t length, void* contents) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag));
// Special case array(uint8)
if (element_tag == GI_TYPE_TAG_UINT8) {
JSObject* u8array = gjs_byte_array_from_data_copy(cx, length, contents);
if (!u8array)
return false;
value_out.setObject(*u8array);
return true;
}
// Special case array(unichar) to be a string in JS
if (element_tag == GI_TYPE_TAG_UNICHAR) {
return gjs_string_from_ucs4(cx, static_cast<gunichar*>(contents),
length, value_out);
}
// a null array pointer takes precedence over whatever `length` says
if (!contents) {
JSObject* array = JS::NewArrayObject(cx, 0);
if (!array)
return false;
value_out.setObject(*array);
return true;
}
JS::RootedValueVector elems{cx};
if (!elems.resize(length)) {
JS_ReportOutOfMemory(cx);
return false;
}
GIArgument arg;
switch (element_tag) {
// Special cases handled above
case GI_TYPE_TAG_UINT8:
case GI_TYPE_TAG_UNICHAR:
g_assert_not_reached();
case GI_TYPE_TAG_BOOLEAN:
if (!fill_vector_from_basic_c_array<Gjs::Tag::GBoolean>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_INT8:
if (!fill_vector_from_basic_c_array<int8_t>(cx, &elems, element_tag,
&arg, contents, length))
return false;
break;
case GI_TYPE_TAG_UINT16:
if (!fill_vector_from_basic_c_array<uint16_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_INT16:
if (!fill_vector_from_basic_c_array<int16_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_UINT32:
if (!fill_vector_from_basic_c_array<uint32_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_INT32:
if (!fill_vector_from_basic_c_array<int32_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_UINT64:
if (!fill_vector_from_basic_c_array<uint64_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_INT64:
if (!fill_vector_from_basic_c_array<int64_t>(
cx, &elems, element_tag, &arg, contents, length))
return false;
break;
case GI_TYPE_TAG_FLOAT:
if (!fill_vector_from_basic_c_array<float>(cx, &elems, element_tag,
&arg, contents, length))
return false;
break;
case GI_TYPE_TAG_DOUBLE:
if (!fill_vector_from_basic_c_array<double>(cx, &elems, element_tag,
&arg, contents, length))
return false;
break;
case GI_TYPE_TAG_GTYPE:
case GI_TYPE_TAG_UTF8:
case GI_TYPE_TAG_FILENAME:
if (!fill_vector_from_basic_c_array<void*>(cx, &elems, element_tag,
&arg, contents, length))
return false;
break;
case GI_TYPE_TAG_VOID:
gjs_throw(cx, "Unknown Array element-type %d", element_tag);
return false;
default:
g_assert_not_reached();
}
JSObject* array = JS::NewArrayObject(cx, elems);
if (!array)
return false;
value_out.setObject(*array);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_from_carray_internal(JSContext* context,
JS::MutableHandleValue value_p,
GIArrayType array_type,
const GI::TypeInfo element_type,
GITransfer transfer, size_t length,
void* array) {
GITypeTag element_tag = element_type.tag();
if (GI_TYPE_TAG_IS_BASIC(element_tag)) {
return gjs_array_from_basic_c_array_internal(
context, value_p, element_tag, length, array);
}
// a null array pointer takes precedence over whatever `length` says
if (!array) {
JSObject* jsarray = JS::NewArrayObject(context, 0);
if (!jsarray)
return false;
value_p.setObject(*jsarray);
return true;
}
JS::RootedValueVector elems(context);
if (!elems.resize(length)) {
JS_ReportOutOfMemory(context);
return false;
}
GIArgument arg;
switch (element_tag) {
case GI_TYPE_TAG_INTERFACE: {
GI::AutoBaseInfo interface_info{element_type.interface()};
GITypeTag storage_element_type = element_type.storage_type();
if (array_type != GI_ARRAY_TYPE_PTR_ARRAY &&
(interface_info.is_struct() || interface_info.is_union() ||
interface_info.is_enum_or_flags()) &&
!element_type.is_pointer()) {
size_t element_size;
if (auto union_info = interface_info.as<GI::InfoTag::UNION>()) {
element_size = union_info->size();
} else if (auto struct_info =
interface_info.as<GI::InfoTag::STRUCT>()) {
element_size = struct_info->size();
} else {
auto storage =
interface_info.as<GI::InfoTag::ENUM>()->storage_type();
element_size = basic_type_element_size(storage);
}
for (size_t i = 0; i < length; i++) {
auto value = static_cast<char*>(array) + (element_size * i);
// use the storage tag instead of element tag to handle
// enums and flags
set_arg_from_carray_element(&arg, storage_element_type,
value);
if (!gjs_value_from_gi_argument(
context, elems[i], element_type,
GJS_ARGUMENT_ARRAY_ELEMENT, transfer, &arg))
return false;
}
break;
}
}
/* fallthrough */
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:
if (!fill_vector_from_carray<void*>(context, elems, element_type,
&arg, array, length, transfer))
return false;
break;
default:
// Basic types handled above
gjs_throw(context, "Unknown Array element-type %s",
element_type.display_string());
return false;
}
JSObject* obj = JS::NewArrayObject(context, elems);
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_from_fixed_size_array(JSContext* cx,
JS::MutableHandleValue value_p,
const GI::TypeInfo type_info,
GITransfer transfer, void* array) {
Maybe<size_t> length = type_info.array_fixed_size();
g_assert(length);
return gjs_array_from_carray_internal(cx, value_p, type_info.array_type(),
type_info.element_type(), transfer,
*length, array);
}
bool gjs_value_from_explicit_array(JSContext* cx,
JS::MutableHandleValue value_p,
const GI::TypeInfo type_info,
GITransfer transfer, GIArgument* arg,
size_t length) {
return gjs_array_from_carray_internal(cx, value_p, type_info.array_type(),
type_info.element_type(), transfer,
length, gjs_arg_get<void*>(arg));
}
bool gjs_value_from_basic_explicit_array(JSContext* cx,
JS::MutableHandleValue value_out,
GITypeTag element_tag, GIArgument* arg,
size_t length) {
return gjs_array_from_basic_c_array_internal(
cx, value_out, element_tag, length, gjs_arg_get<void*>(arg));
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_from_boxed_array(JSContext* cx,
JS::MutableHandleValue value_p,
GIArrayType array_type,
const GI::TypeInfo element_type,
GITransfer transfer, GIArgument* arg) {
GArray *array;
GPtrArray *ptr_array;
gpointer data = NULL;
gsize length = 0;
if (!gjs_arg_get<void*>(arg)) {
value_p.setNull();
return true;
}
switch(array_type) {
case GI_ARRAY_TYPE_BYTE_ARRAY:
/* GByteArray is just a typedef for GArray internally */
case GI_ARRAY_TYPE_ARRAY:
array = gjs_arg_get<GArray*>(arg);
data = array->data;
length = array->len;
break;
case GI_ARRAY_TYPE_PTR_ARRAY:
ptr_array = gjs_arg_get<GPtrArray*>(arg);
data = ptr_array->pdata;
length = ptr_array->len;
break;
case GI_ARRAY_TYPE_C: // already checked in gjs_value_from_gi_argument()
default:
g_assert_not_reached();
}
return gjs_array_from_carray_internal(cx, value_p, array_type, element_type,
transfer, length, data);
}
GJS_JSAPI_RETURN_CONVENTION
bool gjs_array_from_g_value_array(JSContext* cx, JS::MutableHandleValue value_p,
const GI::TypeInfo element_type,
GITransfer transfer, const GValue* gvalue) {
void* data = nullptr;
size_t length = 0;
GIArrayType array_type;
GType value_gtype = G_VALUE_TYPE(gvalue);
// GByteArray is just a typedef for GArray internally
if (g_type_is_a(value_gtype, G_TYPE_BYTE_ARRAY) ||
g_type_is_a(value_gtype, G_TYPE_ARRAY)) {
array_type = g_type_is_a(value_gtype, G_TYPE_BYTE_ARRAY)
? GI_ARRAY_TYPE_BYTE_ARRAY
: GI_ARRAY_TYPE_ARRAY;
auto* array = Gjs::gvalue_get<GArray*>(gvalue);
data = array->data;
length = array->len;
} else if (g_type_is_a(value_gtype, G_TYPE_PTR_ARRAY)) {
array_type = GI_ARRAY_TYPE_PTR_ARRAY;
auto* ptr_array = Gjs::gvalue_get<GPtrArray*>(gvalue);
data = ptr_array->pdata;
length = ptr_array->len;
} else {
g_assert_not_reached();
gjs_throw(cx, "%s is not an array type", g_type_name(value_gtype));
return false;
}
return gjs_array_from_carray_internal(cx, value_p, array_type, element_type,
transfer, length, data);
}
template <typename TAG>
GJS_JSAPI_RETURN_CONVENTION static bool
fill_vector_from_basic_zero_terminated_c_array(
JSContext* cx, JS::MutableHandleValueVector elems, GITypeTag element_tag,
GIArgument* arg, void* c_array) {
using T = Gjs::Tag::RealT<TAG>;
T* array = static_cast<T*>(c_array);
for (size_t ix = 0; array[ix]; ix++) {
gjs_arg_set<TAG>(arg, array[ix]);
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_value_from_basic_gi_argument(cx, elems[ix], element_tag, arg))
return false;
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION static bool
fill_vector_from_zero_terminated_pointer_carray(
JSContext* cx, JS::RootedValueVector& elems, // NOLINT(runtime/references)
const GI::TypeInfo param_info, GIArgument* arg, void* c_array,
GITransfer transfer = GI_TRANSFER_EVERYTHING) {
void** array = static_cast<void**>(c_array);
for (size_t i = 0;; i++) {
if (!array[i])
break;
gjs_arg_set(arg, array[i]);
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_value_from_gi_argument(cx, elems[i], param_info,
GJS_ARGUMENT_ARRAY_ELEMENT, transfer,
arg))
return false;
}
return true;
}
GJS_JSAPI_RETURN_CONVENTION static bool fill_vector_from_zero_terminated_non_pointer_carray(
JSContext* cx, JS::RootedValueVector& elems, // NOLINT(runtime/references)
const GI::TypeInfo param_info, GIArgument* arg, size_t element_size,
void* c_array, GITransfer transfer = GI_TRANSFER_EVERYTHING) {
uint8_t* element_start = reinterpret_cast<uint8_t*>(c_array);
for (size_t i = 0;; i++) {
if (*element_start == 0 &&
memcmp(element_start, element_start + 1, element_size - 1) == 0)
break;
gjs_arg_set(arg, element_start);
element_start += element_size;
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_value_from_gi_argument(cx, elems[i], param_info,
GJS_ARGUMENT_ARRAY_ELEMENT, transfer,
arg))
return false;
}
return true;
}
bool gjs_array_from_basic_zero_terminated_array(
JSContext* cx, JS::MutableHandleValue value_out, GITypeTag element_tag,
void* c_array) {
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag) &&
"Use gjs_array_from_zero_terminated_c_array for non-basic types");
if (!c_array) {
// OK, but no conversion to do
value_out.setNull();
return true;
}
// Special case array(uint8_t)
if (element_tag == GI_TYPE_TAG_UINT8) {
size_t length = strlen(static_cast<char*>(c_array));
JSObject* byte_array =
gjs_byte_array_from_data_copy(cx, length, c_array);
if (!byte_array)
return false;
value_out.setObject(*byte_array);
return true;
}
// Special case array(gunichar) to JS string
if (element_tag == GI_TYPE_TAG_UNICHAR) {
return gjs_string_from_ucs4(cx, static_cast<gunichar*>(c_array), -1,
value_out);
}
JS::RootedValueVector elems{cx};
GIArgument arg;
switch (element_tag) {
case GI_TYPE_TAG_INT8:
if (!fill_vector_from_basic_zero_terminated_c_array<int8_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_UINT16:
if (!fill_vector_from_basic_zero_terminated_c_array<uint16_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_INT16:
if (!fill_vector_from_basic_zero_terminated_c_array<int16_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_UINT32:
if (!fill_vector_from_basic_zero_terminated_c_array<uint32_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_INT32:
if (!fill_vector_from_basic_zero_terminated_c_array<int32_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_UINT64:
if (!fill_vector_from_basic_zero_terminated_c_array<uint64_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_INT64:
if (!fill_vector_from_basic_zero_terminated_c_array<int64_t>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_FLOAT:
if (!fill_vector_from_basic_zero_terminated_c_array<float>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_DOUBLE:
if (!fill_vector_from_basic_zero_terminated_c_array<double>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
case GI_TYPE_TAG_GTYPE:
case GI_TYPE_TAG_UTF8:
case GI_TYPE_TAG_FILENAME:
if (!fill_vector_from_basic_zero_terminated_c_array<void*>(
cx, &elems, element_tag, &arg, c_array))
return false;
break;
// Boolean zero-terminated array makes no sense, because false is also
// zero
case GI_TYPE_TAG_BOOLEAN:
gjs_throw(cx, "Boolean zero-terminated array not supported");
return false;
case GI_TYPE_TAG_VOID:
gjs_throw(cx, "Unknown element-type 'void'");
return false;
default:
// UINT8 and UNICHAR are special cases handled above
g_assert_not_reached();
}
JSObject* array = JS::NewArrayObject(cx, elems);
if (!array)
return false;
value_out.setObject(*array);
return true;
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_array_from_zero_terminated_c_array(
JSContext* context, JS::MutableHandleValue value_p,
const GI::TypeInfo element_type, GITransfer transfer, void* c_array) {
GITypeTag element_tag = element_type.tag();
if (element_type.is_basic()) {
return gjs_array_from_basic_zero_terminated_array(context, value_p,
element_tag, c_array);
}
JS::RootedValueVector elems(context);
GIArgument arg;
switch (element_tag) {
case GI_TYPE_TAG_INTERFACE: {
GI::AutoBaseInfo interface_info{element_type.interface()};
auto reg_info = interface_info.as<GI::InfoTag::REGISTERED_TYPE>();
bool element_is_pointer = element_type.is_pointer();
bool is_struct = reg_info->is_struct();
if (!element_is_pointer && is_struct) {
auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
size_t element_size = struct_info->size();
if (!fill_vector_from_zero_terminated_non_pointer_carray(
context, elems, element_type, &arg, element_size,
c_array))
return false;
break;
}
[[fallthrough]];
}
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:
if (!fill_vector_from_zero_terminated_pointer_carray(
context, elems, element_type, &arg, c_array, transfer))
return false;
break;
default:
// Handled in gjs_array_from_basic_zero_terminated_c_array()
gjs_throw(context, "Unknown element-type %s",
element_type.display_string());
return false;
}
JSObject* obj = JS::NewArrayObject(context, elems);
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
bool gjs_object_from_g_hash(JSContext* context, JS::MutableHandleValue value_p,
const GI::TypeInfo key_type,
const GI::TypeInfo val_type, GITransfer transfer,
GHashTable* hash) {
GHashTableIter iter;
g_assert((!GI_TYPE_TAG_IS_BASIC(key_type.tag()) ||
!GI_TYPE_TAG_IS_BASIC(val_type.tag())) &&
"use gjs_value_from_basic_ghash() instead");
// a NULL hash table becomes a null JS value
if (hash==NULL) {
value_p.setNull();
return true;
}
JS::RootedObject obj(context, JS_NewPlainObject(context));
if (!obj)
return false;
value_p.setObject(*obj);
JS::RootedValue keyjs(context), valjs(context);
JS::RootedString keystr(context);
g_hash_table_iter_init(&iter, hash);
void* key_pointer;
void* val_pointer;
GIArgument keyarg, valarg;
while (g_hash_table_iter_next(&iter, &key_pointer, &val_pointer)) {
key_type.argument_from_hash_pointer(key_pointer, &keyarg);
if (!gjs_value_from_gi_argument(context, &keyjs, key_type,
GJS_ARGUMENT_HASH_ELEMENT, transfer,
&keyarg))
return false;
JS::RootedId key{context};
if (!JS_ValueToId(context, keyjs, &key))
return false;
val_type.argument_from_hash_pointer(val_pointer, &valarg);
if (!gjs_value_from_gi_argument(context, &valjs, val_type,
GJS_ARGUMENT_HASH_ELEMENT, transfer,
&valarg) ||
!JS_DefinePropertyById(context, obj, key, valjs, JSPROP_ENUMERATE))
return false;
}
return true;
}
bool gjs_value_from_basic_fixed_size_array_gi_argument(
JSContext* cx, JS::MutableHandleValue value_out, GITypeTag element_tag,
size_t fixed_size, GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument fixed array of %s to JS::Value",
gi_type_tag_to_string(element_tag));
void* c_array = gjs_arg_get<void*>(arg);
if (!c_array) {
// OK, but no conversion to do
value_out.setNull();
return true;
}
return gjs_array_from_basic_c_array_internal(cx, value_out, element_tag,
fixed_size, c_array);
}
bool gjs_value_from_byte_array_gi_argument(JSContext* cx,
JS::MutableHandleValue value_out,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument byte array to JS::Value");
auto* byte_array = gjs_arg_get<GByteArray*>(arg);
if (!byte_array) {
value_out.setNull();
return true;
}
JSObject* u8array = gjs_byte_array_from_byte_array(cx, byte_array);
if (!u8array)
return false;
value_out.setObject(*u8array);
return true;
}
bool gjs_value_from_basic_garray_gi_argument(JSContext* cx,
JS::MutableHandleValue value_out,
GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument GArray of %s to JS::Value",
gi_type_tag_to_string(element_tag));
auto* garray = gjs_arg_get<GArray*>(arg);
if (!garray) {
value_out.setNull();
return true;
}
return gjs_array_from_basic_c_array_internal(cx, value_out, element_tag,
garray->len, garray->data);
}
bool gjs_value_from_basic_gptrarray_gi_argument(
JSContext* cx, JS::MutableHandleValue value_out, GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument GPtrArray of %s to JS::Value",
gi_type_tag_to_string(element_tag));
auto* ptr_array = gjs_arg_get<GPtrArray*>(arg);
if (!ptr_array) {
value_out.setNull();
return true;
}
return gjs_array_from_basic_c_array_internal(
cx, value_out, element_tag, ptr_array->len, ptr_array->pdata);
}
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool array_from_basic_linked_list(
JSContext* cx, JS::MutableHandleValue value_out, GITypeTag element_tag,
T* list) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
g_assert(
GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use gjs_array_from_g_list() for lists containing non-basic types");
GIArgument arg;
JS::RootedValueVector elems{cx};
for (size_t i = 0; list; list = list->next, ++i) {
// for basic types, type tag == storage type
gi_type_tag_argument_from_hash_pointer(element_tag, list->data, &arg);
if (!elems.growBy(1)) {
JS_ReportOutOfMemory(cx);
return false;
}
if (!gjs_value_from_basic_gi_argument(cx, elems[i], element_tag, &arg))
return false;
}
JS::RootedObject obj{cx, JS::NewArrayObject(cx, elems)};
if (!obj)
return false;
value_out.setObject(*obj);
return true;
}
bool gjs_array_from_basic_glist_gi_argument(JSContext* cx,
JS::MutableHandleValue value_out,
GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GArgument glist to JS::Value");
return array_from_basic_linked_list(cx, value_out, element_tag,
gjs_arg_get<GList*>(arg));
}
bool gjs_array_from_basic_gslist_gi_argument(JSContext* cx,
JS::MutableHandleValue value_out,
GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GArgument gslist to JS::Value");
return array_from_basic_linked_list(cx, value_out, element_tag,
gjs_arg_get<GSList*>(arg));
}
bool gjs_value_from_basic_ghash(JSContext* cx, JS::MutableHandleValue value_out,
GITypeTag key_tag, GITypeTag value_tag,
GHashTable* hash) {
g_assert(
GI_TYPE_TAG_IS_BASIC(key_tag) &&
"use gjs_object_from_g_hash() for hashes with non-basic key types");
g_assert(
GI_TYPE_TAG_IS_BASIC(value_tag) &&
"use gjs_object_from_g_hash() for hashes with non-basic value types");
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument ghash to JS::Value");
// a NULL hash table becomes a null JS value
if (!hash) {
value_out.setNull();
return true;
}
JS::RootedObject obj{cx, JS_NewPlainObject(cx)};
if (!obj)
return false;
JS::RootedValue v_key{cx}, v_val{cx};
JS::RootedId key{cx};
GIArgument key_arg, value_arg;
GHashTableIter iter;
void* key_pointer;
void* val_pointer;
g_hash_table_iter_init(&iter, hash);
while (g_hash_table_iter_next(&iter, &key_pointer, &val_pointer)) {
gi_type_tag_argument_from_hash_pointer(key_tag, key_pointer, &key_arg);
gi_type_tag_argument_from_hash_pointer(value_tag, val_pointer,
&value_arg);
if (!gjs_value_from_basic_gi_argument(cx, &v_key, key_tag, &key_arg) ||
!JS_ValueToId(cx, v_key, &key) ||
!gjs_value_from_basic_gi_argument(cx, &v_val, value_tag,
&value_arg) ||
!JS_DefinePropertyById(cx, obj, key, v_val, JSPROP_ENUMERATE))
return false;
}
value_out.setObject(*obj);
return true;
}
bool gjs_value_from_gi_argument(JSContext* context,
JS::MutableHandleValue value_p,
const GI::TypeInfo type_info,
GjsArgumentType argument_type,
GITransfer transfer, GIArgument* arg) {
GITypeTag type_tag = type_info.tag();
if (type_info.is_basic()) {
return gjs_value_from_basic_gi_argument(context, value_p, type_tag,
arg);
}
if (type_tag == GI_TYPE_TAG_GLIST) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
return gjs_array_from_basic_glist_gi_argument(
context, value_p, element_type.tag(), arg);
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_GSLIST) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
return gjs_array_from_basic_gslist_gi_argument(
context, value_p, element_type.tag(), arg);
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_GHASH) {
GI::AutoTypeInfo key_type{type_info.key_type()};
GI::AutoTypeInfo value_type{type_info.value_type()};
if (key_type.is_basic() && value_type.is_basic()) {
return gjs_value_from_basic_ghash(context, value_p, key_type.tag(),
value_type.tag(),
gjs_arg_get<GHashTable*>(arg));
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_ARRAY) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
switch (type_info.array_type()) {
case GI_ARRAY_TYPE_C: {
if (type_info.is_zero_terminated()) {
return gjs_array_from_basic_zero_terminated_array(
context, value_p, element_type.tag(),
gjs_arg_get<void*>(arg));
}
Maybe<size_t> fixed_size = type_info.array_fixed_size();
g_assert(fixed_size &&
"arrays with length param handled in "
"gjs_value_from_basic_explicit_array()");
return gjs_value_from_basic_fixed_size_array_gi_argument(
context, value_p, element_type.tag(), *fixed_size, arg);
}
case GI_ARRAY_TYPE_BYTE_ARRAY:
return gjs_value_from_byte_array_gi_argument(context,
value_p, arg);
case GI_ARRAY_TYPE_ARRAY:
return gjs_value_from_basic_garray_gi_argument(
context, value_p, element_type.tag(), arg);
case GI_ARRAY_TYPE_PTR_ARRAY:
return gjs_value_from_basic_gptrarray_gi_argument(
context, value_p, element_type.tag(), arg);
}
}
// else fall through to generic marshaller
}
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Converting GIArgument %s to JS::Value",
gi_type_tag_to_string(type_tag));
switch (type_tag) {
case GI_TYPE_TAG_VOID:
g_assert(type_info.is_pointer() &&
"non-pointers should be handled by "
"gjs_value_from_basic_gi_argument()");
// If the argument is a pointer, convert to null to match our
// in handling.
value_p.setNull();
return true;
case GI_TYPE_TAG_ERROR: {
GError* ptr = gjs_arg_get<GError*>(arg);
if (!ptr) {
value_p.setNull();
return true;
}
JSObject* obj = ErrorInstance::object_for_c_ptr(context, ptr);
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
case GI_TYPE_TAG_INTERFACE:
{
GI::AutoBaseInfo interface_info{type_info.interface()};
if (interface_info.is_unresolved()) {
gjs_throw(context, "Unable to resolve arg type '%s'",
interface_info.name());
return false;
}
// Enum/Flags are aren't pointer types, unlike the other interface
// subtypes
if (auto enum_info = interface_info.as<GI::InfoTag::ENUM>()) {
int64_t value_int64 =
enum_info->enum_from_int(gjs_arg_get<Gjs::Tag::Enum>(arg));
if (interface_info.is_flags()) {
GType gtype = enum_info->gtype();
if (gtype != G_TYPE_NONE) {
// Check to make sure 32 bit flag
if (static_cast<uint32_t>(value_int64) != value_int64) {
gjs_throw(context,
"0x%" PRIx64
" is not a valid value for flags %s",
value_int64, g_type_name(gtype));
return false;
}
// Pass only valid values
Gjs::AutoTypeClass<GFlagsClass> gflags_class{gtype};
value_int64 &= gflags_class->mask;
}
} else {
if (!_gjs_enum_value_is_valid(context, enum_info.value(),
value_int64))
return false;
}
value_p.setNumber(static_cast<double>(value_int64));
return true;
}
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
struct_info && struct_info->is_foreign()) {
return gjs_struct_foreign_convert_from_gi_argument(
context, value_p, struct_info.value(), arg);
}
/* Everything else is a pointer type, NULL is the easy case */
if (!gjs_arg_get<void*>(arg)) {
value_p.setNull();
return true;
}
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
struct_info && struct_info->is_gtype_struct()) {
/* XXX: here we make the implicit assumption that GTypeClass is the same
as GTypeInterface. This is true for the GType field, which is what we
use, but not for the rest of the structure!
*/
GType gtype = G_TYPE_FROM_CLASS(gjs_arg_get<GTypeClass*>(arg));
if (g_type_is_a(gtype, G_TYPE_INTERFACE)) {
return gjs_lookup_interface_constructor(context, gtype,
value_p);
}
return gjs_lookup_object_constructor(context, gtype, value_p);
}
GType gtype =
interface_info.as<GI::InfoTag::REGISTERED_TYPE>()->gtype();
if (G_TYPE_IS_INSTANTIATABLE(gtype) ||
G_TYPE_IS_INTERFACE(gtype))
gtype = G_TYPE_FROM_INSTANCE(gjs_arg_get<GTypeInstance*>(arg));
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"gtype of INTERFACE is %s", g_type_name(gtype));
/* Test GValue and GError before Struct, or it will be handled as the latter */
if (g_type_is_a(gtype, G_TYPE_VALUE)) {
return gjs_value_from_g_value(context, value_p,
gjs_arg_get<const GValue*>(arg));
}
if (g_type_is_a(gtype, G_TYPE_ERROR)) {
JSObject* obj = ErrorInstance::object_for_c_ptr(
context, gjs_arg_get<GError*>(arg));
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>()) {
if (struct_info->is_gdk_atom()) {
GI::AutoFunctionInfo atom_name_fun{
struct_info->method("name").value()};
GIArgument atom_name_ret;
Gjs::GErrorResult<> result =
atom_name_fun.invoke({{*arg}}, {}, &atom_name_ret);
if (result.isErr()) {
gjs_throw(context, "Failed to call gdk_atom_name(): %s",
result.inspectErr()->message);
return false;
}
Gjs::AutoChar name{gjs_arg_get<char*>(&atom_name_ret)};
if (g_strcmp0("NONE", name) == 0) {
value_p.setNull();
return true;
}
return gjs_string_from_utf8(context, name, value_p);
}
JSObject *obj;
if (gtype == G_TYPE_VARIANT) {
transfer = GI_TRANSFER_EVERYTHING;
} else if (transfer == GI_TRANSFER_CONTAINER) {
switch (argument_type) {
case GJS_ARGUMENT_ARRAY_ELEMENT:
case GJS_ARGUMENT_LIST_ELEMENT:
case GJS_ARGUMENT_HASH_ELEMENT:
transfer = GI_TRANSFER_EVERYTHING;
default:
break;
}
}
if (transfer == GI_TRANSFER_EVERYTHING)
obj = BoxedInstance::new_for_c_struct(
context, struct_info.value(), gjs_arg_get<void*>(arg));
else
obj = BoxedInstance::new_for_c_struct(
context, struct_info.value(), gjs_arg_get<void*>(arg),
BoxedInstance::NoCopy{});
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
if (auto union_info = interface_info.as<GI::InfoTag::UNION>()) {
JSObject* obj = UnionInstance::new_for_c_union(
context, union_info.value(), gjs_arg_get<void*>(arg));
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
if (g_type_is_a(gtype, G_TYPE_OBJECT)) {
g_assert(gjs_arg_get<void*>(arg) &&
"Null arg is already handled above");
return ObjectInstance::set_value_from_gobject(
context, gjs_arg_get<GObject*>(arg), value_p);
}
if (g_type_is_a(gtype, G_TYPE_BOXED) ||
g_type_is_a(gtype, G_TYPE_ENUM) ||
g_type_is_a(gtype, G_TYPE_FLAGS)) {
/* Should have been handled above */
gjs_throw(context,
"Type %s registered for unexpected interface_type %s",
g_type_name(gtype), interface_info.type_string());
return false;
}
if (g_type_is_a(gtype, G_TYPE_PARAM)) {
JSObject* obj = gjs_param_from_g_param(
context, G_PARAM_SPEC(gjs_arg_get<GParamSpec*>(arg)));
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
if (gtype == G_TYPE_NONE) {
gjs_throw(context,
"Unexpected unregistered type packing GIArgument "
"into JS::Value");
return false;
}
if (G_TYPE_IS_INSTANTIATABLE(gtype) || G_TYPE_IS_INTERFACE(gtype)) {
JSObject* obj = FundamentalInstance::object_for_c_ptr(
context, gjs_arg_get<void*>(arg));
if (!obj)
return false;
value_p.setObject(*obj);
return true;
}
gjs_throw(context,
"Unhandled GType %s packing GIArgument into JS::Value",
g_type_name(gtype));
return false;
}
case GI_TYPE_TAG_ARRAY:
if (!gjs_arg_get<void*>(arg)) {
value_p.setNull();
return true;
}
if (type_info.array_type() == GI_ARRAY_TYPE_C) {
if (type_info.is_zero_terminated()) {
return gjs_array_from_zero_terminated_c_array(
context, value_p, type_info.element_type(), transfer,
gjs_arg_get<void*>(arg));
} else {
/* arrays with length are handled outside of this function */
g_assert(!type_info.array_length_index() &&
"Use gjs_value_from_explicit_array() for arrays with "
"length param");
return gjs_array_from_fixed_size_array(context, value_p,
type_info, transfer,
gjs_arg_get<void*>(arg));
}
} else if (type_info.array_type() == GI_ARRAY_TYPE_BYTE_ARRAY) {
auto* byte_array = gjs_arg_get<GByteArray*>(arg);
JSObject* array =
gjs_byte_array_from_byte_array(context, byte_array);
if (!array) {
gjs_throw(context,
"Couldn't convert GByteArray to a Uint8Array");
return false;
}
value_p.setObject(*array);
} else {
// this assumes the array type is GArray or GPtrArray
return gjs_array_from_boxed_array(
context, value_p, type_info.array_type(),
type_info.element_type(), transfer, arg);
}
break;
case GI_TYPE_TAG_GLIST:
return gjs_array_from_g_list(context, value_p, type_info, transfer,
gjs_arg_get<GList*>(arg));
case GI_TYPE_TAG_GSLIST:
return gjs_array_from_g_list(context, value_p, type_info, transfer,
gjs_arg_get<GSList*>(arg));
case GI_TYPE_TAG_GHASH:
return gjs_object_from_g_hash(context, value_p, type_info.key_type(),
type_info.value_type(), transfer,
gjs_arg_get<GHashTable*>(arg));
default:
// basic types handled in gjs_value_from_basic_gi_argument()
g_warning("Unhandled type %s converting GIArgument to JavaScript",
gi_type_tag_to_string(type_tag));
return false;
}
return true;
}
///// RELEASE MARSHALLERS //////////////////////////////////////////////////////
// These marshaller function are responsible for releasing the values stored in
// GIArgument after a C function call succeeds or fails.
template <typename T>
GJS_JSAPI_RETURN_CONVENTION static bool gjs_g_arg_release_g_list(
JSContext* cx, GITransfer transfer, const GI::TypeInfo type_info,
GjsArgumentFlags flags, GIArgument* arg) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
Gjs::SmartPointer<T> list{gjs_arg_steal<T*>(arg)};
if (transfer == GI_TRANSFER_CONTAINER)
return true;
GIArgument elem;
GI::AutoTypeInfo element_type{type_info.element_type()};
for (T* l = list; l; l = l->next) {
gjs_arg_set(&elem, l->data);
if (!gjs_g_arg_release_internal(
cx, transfer, element_type, element_type.tag(),
GJS_ARGUMENT_LIST_ELEMENT, flags, &elem))
return false;
}
return true;
}
struct GHR_closure {
JSContext *context;
GI::AutoTypeInfo key_type, val_type;
GITransfer transfer;
GjsArgumentFlags flags;
bool failed;
};
static gboolean
gjs_ghr_helper(gpointer key, gpointer val, gpointer user_data) {
GHR_closure *c = (GHR_closure *) user_data;
GITypeTag key_tag = c->key_type.tag();
GITypeTag val_tag = c->val_type.tag();
g_assert(
(!GI_TYPE_TAG_IS_BASIC(key_tag) || !GI_TYPE_TAG_IS_BASIC(val_tag)) &&
"use basic_ghash_release() instead");
GIArgument key_arg, val_arg;
gjs_arg_set(&key_arg, key);
gjs_arg_set(&val_arg, val);
if (!gjs_g_arg_release_internal(c->context, c->transfer, c->key_type,
key_tag, GJS_ARGUMENT_HASH_ELEMENT,
c->flags, &key_arg))
c->failed = true;
switch (val_tag) {
case GI_TYPE_TAG_DOUBLE:
case GI_TYPE_TAG_FLOAT:
case GI_TYPE_TAG_INT64:
case GI_TYPE_TAG_UINT64:
g_clear_pointer(&gjs_arg_member<void*>(&val_arg), g_free);
break;
default:
if (!gjs_g_arg_release_internal(
c->context, c->transfer, c->val_type, val_tag,
GJS_ARGUMENT_HASH_ELEMENT, c->flags, &val_arg))
c->failed = true;
}
return true;
}
enum class ArrayReleaseType {
EXPLICIT_LENGTH,
ZERO_TERMINATED,
};
template <ArrayReleaseType release_type>
static inline void release_basic_array_internal(GITypeTag element_tag,
Maybe<size_t> length,
void** array) {
if (!Gjs::basic_type_needs_release(element_tag))
return;
for (size_t ix = 0;; ix++) {
if constexpr (release_type == ArrayReleaseType::ZERO_TERMINATED) {
if (!array[ix])
break;
}
if constexpr (release_type == ArrayReleaseType::EXPLICIT_LENGTH) {
if (ix == *length)
break;
}
g_free(array[ix]);
}
}
template <ArrayReleaseType release_type = ArrayReleaseType::EXPLICIT_LENGTH>
static inline bool gjs_gi_argument_release_array_internal(
JSContext* cx, GITransfer element_transfer, GjsArgumentFlags flags,
const GI::TypeInfo element_type, Maybe<size_t> length, GIArgument* arg) {
Gjs::AutoPointer<uint8_t, void, g_free> arg_array{
gjs_arg_steal<uint8_t*>(arg)};
if (!arg_array)
return true;
if (element_transfer != GI_TRANSFER_EVERYTHING)
return true;
if (element_type.is_basic()) {
release_basic_array_internal<release_type>(element_type.tag(), length,
arg_array.as<void*>());
return true;
}
if constexpr (release_type == ArrayReleaseType::EXPLICIT_LENGTH) {
if (*length == 0)
return true;
}
if (flags & GjsArgumentFlags::ARG_IN &&
!type_needs_release(element_type, element_type.tag()))
return true;
if (flags & GjsArgumentFlags::ARG_OUT &&
!type_needs_out_release(element_type, element_type.tag()))
return true;
GITypeTag type_tag = element_type.tag();
size_t element_size = gjs_type_get_element_size(type_tag, element_type);
if G_UNLIKELY (element_size == 0)
return true;
bool is_pointer = element_type.is_pointer();
for (size_t i = 0;; i++) {
GIArgument elem;
auto* element_start = &arg_array[i * element_size];
auto* pointer =
is_pointer ? *reinterpret_cast<uint8_t**>(element_start) : nullptr;
if constexpr (release_type == ArrayReleaseType::ZERO_TERMINATED) {
if (is_pointer) {
if (!pointer)
break;
} else if (*element_start == 0 &&
memcmp(element_start, element_start + 1,
element_size - 1) == 0) {
break;
}
}
gjs_arg_set(&elem, is_pointer ? pointer : element_start);
JS::AutoSaveExceptionState saved_exc(cx);
if (!gjs_g_arg_release_internal(cx, element_transfer, element_type,
type_tag, GJS_ARGUMENT_ARRAY_ELEMENT,
flags, &elem)) {
return false;
}
if constexpr (release_type == ArrayReleaseType::EXPLICIT_LENGTH) {
if (i == *length - 1)
break;
}
}
return true;
}
/* We need to handle GI_TRANSFER_NOTHING differently for out parameters
* (free nothing) and for in parameters (free any temporaries we've
* allocated
*/
constexpr static bool is_transfer_in_nothing(GITransfer transfer,
GjsArgumentFlags flags) {
return (transfer == GI_TRANSFER_NOTHING) && (flags & GjsArgumentFlags::ARG_IN);
}
static void release_basic_type_internal(GITypeTag type_tag, GIArgument* arg) {
if (is_string_type(type_tag))
g_clear_pointer(&gjs_arg_member<char*>(arg), g_free);
}
template <typename T>
static void basic_linked_list_release(GITransfer transfer,
GITypeTag element_tag, GIArgument* arg) {
static_assert(std::is_same_v<T, GList> || std::is_same_v<T, GSList>);
g_assert(GI_TYPE_TAG_IS_BASIC(element_tag) &&
"use gjs_g_arg_release_g_list() for lists with non-basic types");
Gjs::SmartPointer<T> list = gjs_arg_steal<T*>(arg);
if (transfer == GI_TRANSFER_CONTAINER)
return;
GIArgument elem;
for (T* l = list; l; l = l->next) {
gjs_arg_set(&elem, l->data);
release_basic_type_internal(element_tag, &elem);
}
}
void gjs_gi_argument_release_basic_glist(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "Releasing GIArgument GList");
basic_linked_list_release<GList>(transfer, element_tag, arg);
}
void gjs_gi_argument_release_basic_gslist(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "Releasing GIArgument GSList");
basic_linked_list_release<GSList>(transfer, element_tag, arg);
}
void gjs_gi_argument_release_basic_ghash(GITransfer transfer, GITypeTag key_tag,
GITypeTag value_tag, GIArgument* arg) {
g_assert(GI_TYPE_TAG_IS_BASIC(key_tag) && GI_TYPE_TAG_IS_BASIC(value_tag));
if (!gjs_arg_get<GHashTable*>(arg))
return;
Gjs::AutoPointer<GHashTable, GHashTable, g_hash_table_destroy> hash_table{
gjs_arg_steal<GHashTable*>(arg)};
if (transfer == GI_TRANSFER_CONTAINER) {
g_hash_table_remove_all(hash_table);
} else {
std::array<GITypeTag, 2> data{key_tag, value_tag};
g_hash_table_foreach_steal(
hash_table,
[](void* key, void* val, void* user_data) -> gboolean {
auto* tags = static_cast<std::array<GITypeTag, 2>*>(user_data);
GITypeTag key_tag = (*tags)[0], value_tag = (*tags)[1];
GIArgument key_arg, val_arg;
gjs_arg_set(&key_arg, key);
gjs_arg_set(&val_arg, val);
release_basic_type_internal(key_tag, &key_arg);
switch (value_tag) {
case GI_TYPE_TAG_DOUBLE:
case GI_TYPE_TAG_FLOAT:
case GI_TYPE_TAG_INT64:
case GI_TYPE_TAG_UINT64:
g_clear_pointer(&gjs_arg_member<void*>(&val_arg),
g_free);
break;
default:
release_basic_type_internal(value_tag, &val_arg);
}
return true;
},
&data);
}
}
void gjs_gi_argument_release_basic_c_array(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
if (!gjs_arg_get<void*>(arg))
return;
if (is_string_type(element_tag) && transfer != GI_TRANSFER_CONTAINER)
g_clear_pointer(&gjs_arg_member<GStrv>(arg), g_strfreev);
else
g_clear_pointer(&gjs_arg_member<void*>(arg), g_free);
}
void gjs_gi_argument_release_basic_c_array(GITransfer transfer,
GITypeTag element_tag, size_t length,
GIArgument* arg) {
if (!gjs_arg_get<void*>(arg))
return;
Gjs::AutoPointer<void*, void, g_free> array{gjs_arg_steal<void**>(arg)};
if (!is_string_type(element_tag) || transfer == GI_TRANSFER_CONTAINER)
return;
for (size_t ix = 0; ix < length; ix++)
g_free(array[ix]);
}
void gjs_gi_argument_release_basic_garray(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
if (!gjs_arg_get<void*>(arg))
return;
Gjs::AutoPointer<GArray, GArray, g_array_unref> array{
gjs_arg_steal<GArray*>(arg)};
if (transfer == GI_TRANSFER_CONTAINER || !is_string_type(element_tag))
return;
for (size_t ix = 0; ix < array->len; ix++)
g_free(g_array_index(array, char*, ix));
}
void gjs_gi_argument_release_byte_array(GIArgument* arg) {
if (!gjs_arg_get<void*>(arg))
return;
g_clear_pointer(&gjs_arg_member<GByteArray*>(arg), g_byte_array_unref);
}
void gjs_gi_argument_release_basic_gptrarray(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
if (!gjs_arg_get<void*>(arg))
return;
Gjs::AutoPointer<GPtrArray, GPtrArray, g_ptr_array_unref> array{
gjs_arg_steal<GPtrArray*>(arg)};
if (transfer == GI_TRANSFER_CONTAINER || !is_string_type(element_tag))
return;
g_ptr_array_foreach(
array, [](void* ptr, void*) { g_free(ptr); }, nullptr);
}
GJS_JSAPI_RETURN_CONVENTION
static bool gjs_g_arg_release_internal(
JSContext* context, GITransfer transfer, const GI::TypeInfo type_info,
GITypeTag type_tag, [[maybe_unused]] GjsArgumentType argument_type,
GjsArgumentFlags flags, GIArgument* arg) {
g_assert(transfer != GI_TRANSFER_NOTHING ||
flags != GjsArgumentFlags::NONE);
if (type_info.is_basic()) {
release_basic_type_internal(type_tag, arg);
return true;
}
if (type_tag == GI_TYPE_TAG_GLIST) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
basic_linked_list_release<GList>(transfer, element_type.tag(), arg);
return true;
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_GSLIST) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
basic_linked_list_release<GSList>(transfer, element_type.tag(),
arg);
return true;
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_GHASH) {
GI::AutoTypeInfo key_type{type_info.key_type()};
GI::AutoTypeInfo value_type{type_info.value_type()};
if (key_type.is_basic() && value_type.is_basic()) {
gjs_gi_argument_release_basic_ghash(transfer, key_type.tag(),
value_type.tag(), arg);
return true;
}
// else fall through to generic marshaller
}
if (type_tag == GI_TYPE_TAG_ARRAY) {
GI::AutoTypeInfo element_type{type_info.element_type()};
if (element_type.is_basic()) {
switch (type_info.array_type()) {
case GI_ARRAY_TYPE_C:
gjs_gi_argument_release_basic_c_array(
transfer, element_type.tag(), arg);
return true;
case GI_ARRAY_TYPE_ARRAY:
gjs_gi_argument_release_basic_garray(
transfer, element_type.tag(), arg);
return true;
case GI_ARRAY_TYPE_BYTE_ARRAY:
gjs_gi_argument_release_byte_array(arg);
return true;
case GI_ARRAY_TYPE_PTR_ARRAY:
gjs_gi_argument_release_basic_gptrarray(
transfer, element_type.tag(), arg);
return true;
default:
g_assert_not_reached();
}
}
// else fall through to generic marshaller
}
switch (type_tag) {
case GI_TYPE_TAG_VOID:
g_assert(type_info.is_pointer() &&
"non-pointer should be handled by "
"release_basic_type_internal()");
break;
case GI_TYPE_TAG_ERROR:
if (!is_transfer_in_nothing(transfer, flags))
g_clear_error(&gjs_arg_member<GError*>(arg));
break;
case GI_TYPE_TAG_INTERFACE:
{
GI::AutoBaseInfo interface_info{type_info.interface()};
if (auto struct_info = interface_info.as<GI::InfoTag::STRUCT>();
struct_info && struct_info->is_foreign())
return gjs_struct_foreign_release_gi_argument(
context, transfer, struct_info.value(), arg);
if (interface_info.is_enum_or_flags())
return true; // enum and flags
/* Anything else is a pointer */
if (!gjs_arg_get<void*>(arg))
return true;
GType gtype =
interface_info.as<GI::InfoTag::REGISTERED_TYPE>()->gtype();
if (G_TYPE_IS_INSTANTIATABLE(gtype) ||
G_TYPE_IS_INTERFACE(gtype))
gtype = G_TYPE_FROM_INSTANCE(gjs_arg_get<GTypeInstance*>(arg));
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"gtype of INTERFACE is %s", g_type_name(gtype));
// In gjs_value_from_gi_argument we handle Struct/Union types
// without a registered GType, but here we are specifically handling
// a GIArgument that *owns* its value, and that is nonsensical for
// such types, so we don't have to worry about it.
if (g_type_is_a(gtype, G_TYPE_OBJECT)) {
if (!is_transfer_in_nothing(transfer, flags))
g_clear_object(&gjs_arg_member<GObject*>(arg));
} else if (g_type_is_a(gtype, G_TYPE_PARAM)) {
if (!is_transfer_in_nothing(transfer, flags))
g_clear_pointer(&gjs_arg_member<GParamSpec*>(arg),
g_param_spec_unref);
} else if (g_type_is_a(gtype, G_TYPE_CLOSURE)) {
g_clear_pointer(&gjs_arg_member<GClosure*>(arg),
g_closure_unref);
} else if (g_type_is_a(gtype, G_TYPE_VALUE)) {
/* G_TYPE_VALUE is-a G_TYPE_BOXED, but we special case it */
if (type_info.is_pointer())
g_boxed_free(gtype, gjs_arg_steal<void*>(arg));
else
g_clear_pointer(&gjs_arg_member<GValue*>(arg),
g_value_unset);
} else if (g_type_is_a(gtype, G_TYPE_BOXED)) {
if (!is_transfer_in_nothing(transfer, flags))
g_boxed_free(gtype, gjs_arg_steal<void*>(arg));
} else if (g_type_is_a(gtype, G_TYPE_VARIANT)) {
if (!is_transfer_in_nothing(transfer, flags))
g_clear_pointer(&gjs_arg_member<GVariant*>(arg),
g_variant_unref);
} else if (gtype == G_TYPE_NONE) {
if (!is_transfer_in_nothing(transfer, flags)) {
gjs_throw(context,
"Don't know how to release GIArgument: not an "
"object or boxed type");
return false;
}
} else if (G_TYPE_IS_INSTANTIATABLE(gtype)) {
if (!is_transfer_in_nothing(transfer, flags)) {
auto* priv =
FundamentalPrototype::for_gtype(context, gtype);
priv->call_unref_function(gjs_arg_steal<void*>(arg));
}
} else {
gjs_throw(context, "Unhandled GType %s releasing GIArgument",
g_type_name(gtype));
return false;
}
return true;
}
case GI_TYPE_TAG_ARRAY:
{
GIArrayType array_type = type_info.array_type();
if (!gjs_arg_get<void*>(arg)) {
/* OK */
} else if (array_type == GI_ARRAY_TYPE_C) {
GI::AutoTypeInfo element_type{type_info.element_type()};
switch (element_type.tag()) {
case GI_TYPE_TAG_INTERFACE:
if (!element_type.is_pointer()) {
GI::AutoBaseInfo interface_info{element_type.interface()};
if (interface_info.is_struct() ||
interface_info.is_union()) {
g_clear_pointer(&gjs_arg_member<void*>(arg), g_free);
break;
}
}
[[fallthrough]];
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_ARRAY:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_ERROR: {
GITransfer element_transfer = transfer;
if (argument_type != GJS_ARGUMENT_ARGUMENT &&
transfer != GI_TRANSFER_EVERYTHING)
element_transfer = GI_TRANSFER_NOTHING;
if (type_info.is_zero_terminated()) {
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::ZERO_TERMINATED>(
context, element_transfer,
flags | GjsArgumentFlags::ARG_OUT, element_type, {},
arg);
} else {
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::EXPLICIT_LENGTH>(
context, element_transfer,
flags | GjsArgumentFlags::ARG_OUT, element_type,
type_info.array_fixed_size(), arg);
}
}
default:
// basic types handled above
gjs_throw(context,
"Releasing a C array with explicit length, that was nested"
"inside another container. This is not supported (and will leak)");
return false;
}
} else if (array_type == GI_ARRAY_TYPE_ARRAY) {
GI::AutoTypeInfo element_type = type_info.element_type();
GITypeTag element_tag = element_type.tag();
switch (element_tag) {
case GI_TYPE_TAG_ARRAY:
case GI_TYPE_TAG_INTERFACE:
case GI_TYPE_TAG_GLIST:
case GI_TYPE_TAG_GSLIST:
case GI_TYPE_TAG_GHASH:
case GI_TYPE_TAG_ERROR: {
Gjs::AutoPointer<GArray, GArray, g_array_unref> array{
gjs_arg_steal<GArray*>(arg)};
if (transfer != GI_TRANSFER_CONTAINER &&
type_needs_out_release(element_type, element_tag)) {
guint i;
for (i = 0; i < array->len; i++) {
GIArgument arg_iter;
gjs_arg_set(&arg_iter,
g_array_index(array, gpointer, i));
if (!gjs_g_arg_release_internal(
context, transfer, element_type, element_tag,
GJS_ARGUMENT_ARRAY_ELEMENT, flags, &arg_iter))
return false;
}
}
break;
}
default:
// basic types handled above
gjs_throw(context,
"Don't know how to release GArray element-type %d",
element_tag);
return false;
}
} else if (array_type == GI_ARRAY_TYPE_PTR_ARRAY) {
GI::AutoTypeInfo element_type{type_info.element_type()};
Gjs::AutoPointer<GPtrArray, GPtrArray, g_ptr_array_unref> array{
gjs_arg_steal<GPtrArray*>(arg)};
if (transfer != GI_TRANSFER_CONTAINER) {
guint i;
for (i = 0; i < array->len; i++) {
GIArgument arg_iter;
gjs_arg_set(&arg_iter, g_ptr_array_index(array, i));
if (!gjs_gi_argument_release(
context, transfer, element_type, flags, &arg_iter))
return false;
}
}
} else {
// GI_ARRAY_TYPE_BYTEARRAY handled above; other values unknown
g_assert_not_reached();
}
break;
}
case GI_TYPE_TAG_GLIST:
return gjs_g_arg_release_g_list<GList>(context, transfer, type_info,
flags, arg);
case GI_TYPE_TAG_GSLIST:
return gjs_g_arg_release_g_list<GSList>(context, transfer, type_info,
flags, arg);
case GI_TYPE_TAG_GHASH:
if (gjs_arg_get<GHashTable*>(arg)) {
Gjs::AutoPointer<GHashTable, GHashTable, g_hash_table_destroy>
hash_table{gjs_arg_steal<GHashTable*>(arg)};
if (transfer == GI_TRANSFER_CONTAINER)
g_hash_table_remove_all(hash_table);
else {
GHR_closure c = {context,
type_info.key_type(),
type_info.value_type(),
transfer,
flags,
false};
g_hash_table_foreach_steal(hash_table, gjs_ghr_helper, &c);
if (c.failed)
return false;
}
}
break;
default:
// basic types should have been handled in release_basic_type_internal()
g_warning("Unhandled type %s releasing GIArgument",
gi_type_tag_to_string(type_tag));
return false;
}
return true;
}
bool gjs_gi_argument_release(JSContext* cx, GITransfer transfer,
const GI::TypeInfo type_info,
GjsArgumentFlags flags, GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING &&
!is_transfer_in_nothing(transfer, flags))
return true;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument %s out param or return value",
type_info.type_string());
return gjs_g_arg_release_internal(cx, transfer, type_info, type_info.tag(),
GJS_ARGUMENT_ARGUMENT, flags, arg);
}
void gjs_gi_argument_release_basic(GITransfer transfer, GITypeTag type_tag,
GjsArgumentFlags flags, GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING &&
!is_transfer_in_nothing(transfer, flags))
return;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument %s out param or return value",
gi_type_tag_to_string(type_tag));
release_basic_type_internal(type_tag, arg);
}
bool gjs_gi_argument_release_in_arg(JSContext* cx, GITransfer transfer,
const GI::TypeInfo type_info,
GjsArgumentFlags flags, GIArgument* arg) {
/* GI_TRANSFER_EVERYTHING: we don't own the argument anymore.
* GI_TRANSFER_CONTAINER:
* - non-containers: treated as GI_TRANSFER_EVERYTHING
* - containers: See FIXME in gjs_array_to_g_list(); currently
* an error and we won't get here.
*/
if (transfer != GI_TRANSFER_NOTHING)
return true;
GITypeTag tag = type_info.tag();
gjs_debug_marshal(GJS_DEBUG_GFUNCTION, "Releasing GIArgument %s in param",
type_info.type_string());
if (!type_needs_release(type_info, tag))
return true;
return gjs_g_arg_release_internal(cx, transfer, type_info, tag,
GJS_ARGUMENT_ARGUMENT, flags, arg);
}
void gjs_gi_argument_release_basic_in_array(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
if (transfer != GI_TRANSFER_NOTHING)
return;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument basic C array in param");
if (is_string_type(element_tag) && transfer != GI_TRANSFER_CONTAINER)
g_clear_pointer(&gjs_arg_member<GStrv>(arg), g_strfreev);
else
g_clear_pointer(&gjs_arg_member<void*>(arg), g_free);
}
void gjs_gi_argument_release_basic_in_array(GITransfer transfer,
GITypeTag element_tag,
size_t length, GIArgument* arg) {
if (transfer != GI_TRANSFER_NOTHING)
return;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument basic C array in param");
Gjs::AutoPointer<void*, void, g_free> array{gjs_arg_steal<void**>(arg)};
if (!is_string_type(element_tag))
return;
for (size_t ix = 0; ix < length; ix++)
g_free(array[ix]);
}
bool gjs_gi_argument_release_in_array(JSContext* cx, GITransfer transfer,
const GI::TypeInfo type_info,
size_t length, GIArgument* arg) {
if (transfer != GI_TRANSFER_NOTHING)
return true;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array in param");
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::EXPLICIT_LENGTH>(
cx, GI_TRANSFER_EVERYTHING, GjsArgumentFlags::ARG_IN,
type_info.element_type(), Some(length), arg);
}
bool gjs_gi_argument_release_in_array(JSContext* cx, GITransfer transfer,
const GI::TypeInfo type_info,
GIArgument* arg) {
if (transfer != GI_TRANSFER_NOTHING)
return true;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array in param");
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::ZERO_TERMINATED>(cx, GI_TRANSFER_EVERYTHING,
GjsArgumentFlags::ARG_IN,
type_info.element_type(), {}, arg);
}
void gjs_gi_argument_release_basic_out_array(GITransfer transfer,
GITypeTag element_tag,
GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING)
return;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array out param");
if (is_string_type(element_tag) && transfer != GI_TRANSFER_CONTAINER)
g_clear_pointer(&gjs_arg_member<GStrv>(arg), g_strfreev);
else
g_clear_pointer(&gjs_arg_member<void*>(arg), g_free);
}
void gjs_gi_argument_release_basic_out_array(GITransfer transfer,
GITypeTag element_tag,
size_t length, GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING)
return;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array out param");
Gjs::AutoPointer<void*, void, g_free> array{gjs_arg_steal<void**>(arg)};
if (transfer == GI_TRANSFER_CONTAINER || !is_string_type(element_tag))
return;
for (size_t ix = 0; ix < length; ix++)
g_free(array[ix]);
}
bool gjs_gi_argument_release_out_array(JSContext* cx, GITransfer transfer,
const GI::TypeInfo type_info,
size_t length, GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING)
return true;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array out param");
GITransfer element_transfer = transfer == GI_TRANSFER_CONTAINER
? GI_TRANSFER_NOTHING
: GI_TRANSFER_EVERYTHING;
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::EXPLICIT_LENGTH>(
cx, element_transfer, GjsArgumentFlags::ARG_OUT,
type_info.element_type(), Some(length), arg);
}
bool gjs_gi_argument_release_out_array(JSContext* context, GITransfer transfer,
const GI::TypeInfo type_info,
GIArgument* arg) {
if (transfer == GI_TRANSFER_NOTHING)
return true;
gjs_debug_marshal(GJS_DEBUG_GFUNCTION,
"Releasing GIArgument array out param");
GITransfer element_transfer = transfer == GI_TRANSFER_CONTAINER
? GI_TRANSFER_NOTHING
: GI_TRANSFER_EVERYTHING;
return gjs_gi_argument_release_array_internal<
ArrayReleaseType::ZERO_TERMINATED>(context, element_transfer,
GjsArgumentFlags::ARG_OUT,
type_info.element_type(), {}, arg);
}
|