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
|
/* GLIB - Library of useful routines for C programming
* Copyright (C) 1995-1998 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GLib Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GLib Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GLib at ftp://ftp.gtk.org/pub/gtk/.
*/
/*
* MT safe for the unix part, FIXME: make the win32 part MT safe as well.
*/
#include "config.h"
#include "gutils.h"
#include "gutilsprivate.h"
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <locale.h>
#include <string.h>
#include <ctype.h> /* For tolower() */
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#ifdef G_OS_UNIX
#include <pwd.h>
#include <sys/utsname.h>
#include <unistd.h>
#endif
#include <sys/types.h>
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#ifdef HAVE_CRT_EXTERNS_H
#include <crt_externs.h> /* for _NSGetEnviron */
#endif
#ifdef HAVE_SYS_AUXV_H
#include <sys/auxv.h>
#endif
#include "glib-init.h"
#include "glib-private.h"
#include "genviron.h"
#include "gfileutils.h"
#include "ggettext.h"
#include "ghash.h"
#include "gthread.h"
#include "gtestutils.h"
#include "gunicode.h"
#include "gstrfuncs.h"
#include "garray.h"
#include "glibintl.h"
#include "gstdio.h"
#include "gquark.h"
#ifdef G_PLATFORM_WIN32
#include "gconvert.h"
#include "gwin32.h"
#endif
#ifdef G_PLATFORM_WIN32
# include <windows.h>
# ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
# define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
# define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
# endif
# include <lmcons.h> /* For UNLEN */
#endif /* G_PLATFORM_WIN32 */
#ifdef G_OS_WIN32
# include <direct.h>
# include <shlobj.h>
# include <process.h>
#endif
#ifdef HAVE_CODESET
#include <langinfo.h>
#endif
/**
* g_memmove:
* @dest: the destination address to copy the bytes to.
* @src: the source address to copy the bytes from.
* @len: the number of bytes to copy.
*
* Copies a block of memory @len bytes long, from @src to @dest.
* The source and destination areas may overlap.
*
* Deprecated:2.40: Just use memmove().
*/
#ifdef G_OS_WIN32
#undef g_atexit
#endif
/**
* g_atexit:
* @func: (scope async): the function to call on normal program termination.
*
* Specifies a function to be called at normal program termination.
*
* Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
* macro that maps to a call to the atexit() function in the C
* library. This means that in case the code that calls g_atexit(),
* i.e. atexit(), is in a DLL, the function will be called when the
* DLL is detached from the program. This typically makes more sense
* than that the function is called when the GLib DLL is detached,
* which happened earlier when g_atexit() was a function in the GLib
* DLL.
*
* The behaviour of atexit() in the context of dynamically loaded
* modules is not formally specified and varies wildly.
*
* On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
* loaded module which is unloaded before the program terminates might
* well cause a crash at program exit.
*
* Some POSIX systems implement atexit() like Windows, and have each
* dynamically loaded module maintain an own atexit chain that is
* called when the module is unloaded.
*
* On other POSIX systems, before a dynamically loaded module is
* unloaded, the registered atexit functions (if any) residing in that
* module are called, regardless where the code that registered them
* resided. This is presumably the most robust approach.
*
* As can be seen from the above, for portability it's best to avoid
* calling g_atexit() (or atexit()) except in the main executable of a
* program.
*
* Deprecated:2.32: It is best to avoid g_atexit().
*/
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
void
g_atexit (GVoidFunc func)
{
gint result;
int errsv;
result = atexit ((void (*)(void)) func);
errsv = errno;
if (result)
{
g_error ("Could not register atexit() function: %s",
g_strerror (errsv));
}
}
G_GNUC_END_IGNORE_DEPRECATIONS
/* Based on execvp() from GNU Libc.
* Some of this code is cut-and-pasted into gspawn.c
*/
static gchar*
my_strchrnul (const gchar *str,
gchar c)
{
gchar *p = (gchar*)str;
while (*p && (*p != c))
++p;
return p;
}
#ifdef G_OS_WIN32
static gchar *inner_find_program_in_path (const gchar *program);
gchar*
g_find_program_in_path (const gchar *program)
{
const gchar *last_dot = strrchr (program, '.');
if (last_dot == NULL ||
strchr (last_dot, '\\') != NULL ||
strchr (last_dot, '/') != NULL)
{
const size_t program_length = strlen (program);
gchar *pathext = g_build_path (";",
".exe;.cmd;.bat;.com",
g_getenv ("PATHEXT"),
NULL);
gchar *p;
gchar *decorated_program;
gchar *retval;
p = pathext;
do
{
gchar *q = my_strchrnul (p, ';');
decorated_program = g_malloc (program_length + (q-p) + 1);
memcpy (decorated_program, program, program_length);
memcpy (decorated_program+program_length, p, q-p);
decorated_program [program_length + (q-p)] = '\0';
retval = inner_find_program_in_path (decorated_program);
g_free (decorated_program);
if (retval != NULL)
{
g_free (pathext);
return retval;
}
p = q;
} while (*p++ != '\0');
g_free (pathext);
return NULL;
}
else
return inner_find_program_in_path (program);
}
#endif
/**
* g_find_program_in_path:
* @program: (type filename): a program name in the GLib file name encoding
*
* Locates the first executable named @program in the user's path, in the
* same way that execvp() would locate it. Returns an allocated string
* with the absolute path name, or %NULL if the program is not found in
* the path. If @program is already an absolute path, returns a copy of
* @program if @program exists and is executable, and %NULL otherwise.
*
* On Windows, if @program does not have a file type suffix, tries
* with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
* the `PATHEXT` environment variable.
*
* On Windows, it looks for the file in the same way as CreateProcess()
* would. This means first in the directory where the executing
* program was loaded from, then in the current directory, then in the
* Windows 32-bit system directory, then in the Windows directory, and
* finally in the directories in the `PATH` environment variable. If
* the program is found, the return value contains the full name
* including the type suffix.
*
* Returns: (type filename) (transfer full) (nullable): a newly-allocated
* string with the absolute path, or %NULL
**/
#ifdef G_OS_WIN32
static gchar *
inner_find_program_in_path (const gchar *program)
#else
gchar*
g_find_program_in_path (const gchar *program)
#endif
{
return g_find_program_for_path (program, NULL, NULL);
}
/**
* g_find_program_for_path:
* @program: (type filename): a program name in the GLib file name encoding
* @path: (type filename) (nullable): the current dir where to search program
* @working_dir: (type filename) (nullable): the working dir where to search
* program
*
* Locates the first executable named @program in @path, in the
* same way that execvp() would locate it. Returns an allocated string
* with the absolute path name (taking in account the @working_dir), or
* %NULL if the program is not found in @path. If @program is already an
* absolute path, returns a copy of @program if @program exists and is
* executable, and %NULL otherwise.
*
* On Windows, if @path is %NULL, it looks for the file in the same way as
* CreateProcess() would. This means first in the directory where the
* executing program was loaded from, then in the current directory, then in
* the Windows 32-bit system directory, then in the Windows directory, and
* finally in the directories in the `PATH` environment variable. If
* the program is found, the return value contains the full name
* including the type suffix.
*
* Returns: (type filename) (transfer full) (nullable): a newly-allocated
* string with the absolute path, or %NULL
* Since: 2.76
**/
char *
g_find_program_for_path (const char *program,
const char *path,
const char *working_dir)
{
const char *original_path = path;
const char *original_program = program;
char *program_path = NULL;
const gchar *p;
gchar *name, *freeme;
#ifdef G_OS_WIN32
const gchar *path_copy;
gchar *filename = NULL, *appdir = NULL;
gchar *sysdir = NULL, *windir = NULL;
int n;
wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
wwindir[MAXPATHLEN];
#endif
gsize len;
gsize pathlen;
g_return_val_if_fail (program != NULL, NULL);
/* Use the working dir as program path if provided */
if (working_dir && !g_path_is_absolute (program))
{
program_path = g_build_filename (working_dir, program, NULL);
program = program_path;
}
/* If it is an absolute path, or a relative path including subdirectories,
* don't look in PATH.
*/
if (g_path_is_absolute (program)
|| strchr (original_program, G_DIR_SEPARATOR) != NULL
#ifdef G_OS_WIN32
|| strchr (original_program, '/') != NULL
#endif
)
{
if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
!g_file_test (program, G_FILE_TEST_IS_DIR))
{
gchar *out = NULL;
if (g_path_is_absolute (program))
{
out = g_strdup (program);
}
else
{
char *cwd = g_get_current_dir ();
out = g_build_filename (cwd, program, NULL);
g_free (cwd);
}
g_free (program_path);
return g_steal_pointer (&out);
}
else
{
g_clear_pointer (&program_path, g_free);
if (g_path_is_absolute (original_program))
return NULL;
}
}
program = original_program;
if G_LIKELY (original_path == NULL)
path = g_getenv ("PATH");
else
path = original_path;
#if defined(G_OS_UNIX)
if (path == NULL)
{
/* There is no 'PATH' in the environment. The default
* search path in GNU libc is the current directory followed by
* the path 'confstr' returns for '_CS_PATH'.
*/
/* In GLib we put . last, for security, and don't use the
* unportable confstr(); UNIX98 does not actually specify
* what to search if PATH is unset. POSIX may, dunno.
*/
path = "/bin:/usr/bin:.";
}
#else
if G_LIKELY (original_path == NULL)
{
n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
if (n > 0 && n < MAXPATHLEN)
filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
if (n > 0 && n < MAXPATHLEN)
sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
if (n > 0 && n < MAXPATHLEN)
windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
if (filename)
{
appdir = g_path_get_dirname (filename);
g_free (filename);
}
path = g_strdup (path);
if (windir)
{
const gchar *tem = path;
path = g_strconcat (windir, ";", path, NULL);
g_free ((gchar *) tem);
g_free (windir);
}
if (sysdir)
{
const gchar *tem = path;
path = g_strconcat (sysdir, ";", path, NULL);
g_free ((gchar *) tem);
g_free (sysdir);
}
{
const gchar *tem = path;
path = g_strconcat (".;", path, NULL);
g_free ((gchar *) tem);
}
if (appdir)
{
const gchar *tem = path;
path = g_strconcat (appdir, ";", path, NULL);
g_free ((gchar *) tem);
g_free (appdir);
}
path_copy = path;
}
else
{
path_copy = g_strdup (path);
}
#endif
len = strlen (program) + 1;
pathlen = strlen (path);
freeme = name = g_malloc (pathlen + len + 1);
/* Copy the file name at the top, including '\0' */
memcpy (name + pathlen + 1, program, len);
name = name + pathlen;
/* And add the slash before the filename */
*name = G_DIR_SEPARATOR;
p = path;
do
{
char *startp;
char *startp_path = NULL;
path = p;
p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
if (p == path)
/* Two adjacent colons, or a colon at the beginning or the end
* of 'PATH' means to search the current directory.
*/
startp = name + 1;
else
startp = memcpy (name - (p - path), path, p - path);
/* Use the working dir as program path if provided */
if (working_dir && !g_path_is_absolute (startp))
{
startp_path = g_build_filename (working_dir, startp, NULL);
startp = startp_path;
}
if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
!g_file_test (startp, G_FILE_TEST_IS_DIR))
{
gchar *ret;
if (g_path_is_absolute (startp)) {
ret = g_strdup (startp);
} else {
gchar *cwd = NULL;
cwd = g_get_current_dir ();
ret = g_build_filename (cwd, startp, NULL);
g_free (cwd);
}
g_free (program_path);
g_free (startp_path);
g_free (freeme);
#ifdef G_OS_WIN32
g_free ((gchar *) path_copy);
#endif
return ret;
}
g_free (startp_path);
}
while (*p++ != '\0');
g_free (program_path);
g_free (freeme);
#ifdef G_OS_WIN32
g_free ((gchar *) path_copy);
#endif
return NULL;
}
/* The functions below are defined this way for compatibility reasons.
* See the note in gutils.h.
*/
/**
* g_bit_nth_lsf:
* @mask: a #gulong containing flags
* @nth_bit: the index of the bit to start the search from
*
* Find the position of the first bit set in @mask, searching
* from (but not including) @nth_bit upwards. Bits are numbered
* from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
* usually). To start searching from the 0th bit, set @nth_bit to -1.
*
* Returns: the index of the first bit set which is higher than @nth_bit, or -1
* if no higher bits are set
*/
gint
(g_bit_nth_lsf) (gulong mask,
gint nth_bit)
{
return g_bit_nth_lsf_impl (mask, nth_bit);
}
/**
* g_bit_nth_msf:
* @mask: a #gulong containing flags
* @nth_bit: the index of the bit to start the search from
*
* Find the position of the first bit set in @mask, searching
* from (but not including) @nth_bit downwards. Bits are numbered
* from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
* usually). To start searching from the last bit, set @nth_bit to
* -1 or GLIB_SIZEOF_LONG * 8.
*
* Returns: the index of the first bit set which is lower than @nth_bit, or -1
* if no lower bits are set
*/
gint
(g_bit_nth_msf) (gulong mask,
gint nth_bit)
{
return g_bit_nth_msf_impl (mask, nth_bit);
}
/**
* g_bit_storage:
* @number: a #guint
*
* Gets the number of bits used to hold @number,
* e.g. if @number is 4, 3 bits are needed.
*
* Returns: the number of bits used to hold @number
*/
guint
(g_bit_storage) (gulong number)
{
return g_bit_storage_impl (number);
}
G_LOCK_DEFINE_STATIC (g_utils_global);
typedef struct
{
gchar *user_name;
gchar *real_name;
gchar *home_dir;
} UserDatabaseEntry;
/* These must all be read/written with @g_utils_global held. */
static gchar *g_user_data_dir = NULL;
static gchar **g_system_data_dirs = NULL;
static gchar *g_user_cache_dir = NULL;
static gchar *g_user_config_dir = NULL;
static gchar *g_user_state_dir = NULL;
static gchar *g_user_runtime_dir = NULL;
static gchar **g_system_config_dirs = NULL;
static gchar **g_user_special_dirs = NULL;
static gchar *g_tmp_dir = NULL;
/* fifteen minutes of fame for everybody */
#define G_USER_DIRS_EXPIRE 15 * 60
#ifdef G_OS_WIN32
static gchar *
get_special_folder (REFKNOWNFOLDERID known_folder_guid_ptr)
{
wchar_t *wcp = NULL;
gchar *result = NULL;
HRESULT hr;
hr = SHGetKnownFolderPath (known_folder_guid_ptr, 0, NULL, &wcp);
if (SUCCEEDED (hr))
result = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
CoTaskMemFree (wcp);
return result;
}
static char *
get_windows_directory_root (void)
{
wchar_t wwindowsdir[MAX_PATH];
if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
{
/* Usually X:\Windows, but in terminal server environments
* might be an UNC path, AFAIK.
*/
char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
char *p;
if (windowsdir == NULL)
return g_strdup ("C:\\");
p = (char *) g_path_skip_root (windowsdir);
if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
p--;
*p = '\0';
return windowsdir;
}
else
return g_strdup ("C:\\");
}
#endif
/* HOLDS: g_utils_global_lock */
static UserDatabaseEntry *
g_get_user_database_entry (void)
{
static UserDatabaseEntry *entry;
if (g_once_init_enter_pointer (&entry))
{
static UserDatabaseEntry e;
#ifdef G_OS_UNIX
{
struct passwd *pw = NULL;
gpointer buffer = NULL;
gint error;
const char *logname;
# if defined (HAVE_GETPWUID_R)
struct passwd pwd;
# ifdef _SC_GETPW_R_SIZE_MAX
/* This returns the maximum length */
glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
if (bufsize < 0)
bufsize = 64;
# else /* _SC_GETPW_R_SIZE_MAX */
glong bufsize = 64;
# endif /* _SC_GETPW_R_SIZE_MAX */
logname = g_getenv ("LOGNAME");
do
{
g_free (buffer);
/* we allocate 6 extra bytes to work around a bug in
* Mac OS < 10.3. See #156446
*/
buffer = g_malloc (bufsize + 6);
errno = 0;
if (logname) {
error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
if (!pw || (pw->pw_uid != getuid ())) {
/* LOGNAME is lying, fall back to looking up the uid */
error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
}
} else {
error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
}
error = error < 0 ? errno : error;
if (!pw)
{
/* we bail out prematurely if the user id can't be found
* (should be pretty rare case actually), or if the buffer
* should be sufficiently big and lookups are still not
* successful.
*/
if (error == 0 || error == ENOENT)
{
g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
(gulong) getuid ());
break;
}
if (bufsize > 32 * 1024)
{
g_warning ("getpwuid_r(): failed due to: %s.",
g_strerror (error));
break;
}
bufsize *= 2;
}
}
while (!pw);
# endif /* HAVE_GETPWUID_R */
if (!pw)
{
pw = getpwuid (getuid ());
}
if (pw)
{
e.user_name = g_strdup (pw->pw_name);
#ifndef __BIONIC__
if (pw->pw_gecos && *pw->pw_gecos != '\0' && pw->pw_name)
{
gchar **gecos_fields;
gchar **name_parts;
gchar *uppercase_pw_name;
/* split the gecos field and substitute '&' */
gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
name_parts = g_strsplit (gecos_fields[0], "&", 0);
uppercase_pw_name = g_strdup (pw->pw_name);
uppercase_pw_name[0] = g_ascii_toupper (uppercase_pw_name[0]);
e.real_name = g_strjoinv (uppercase_pw_name, name_parts);
g_strfreev (gecos_fields);
g_strfreev (name_parts);
g_free (uppercase_pw_name);
}
#endif
if (!e.home_dir)
e.home_dir = g_strdup (pw->pw_dir);
}
g_free (buffer);
}
#endif /* G_OS_UNIX */
#ifdef G_OS_WIN32
{
guint len = UNLEN+1;
wchar_t buffer[UNLEN+1];
if (GetUserNameW (buffer, (LPDWORD) &len))
{
e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
e.real_name = g_strdup (e.user_name);
}
}
#endif /* G_OS_WIN32 */
if (!e.user_name)
e.user_name = g_strdup ("somebody");
if (!e.real_name)
e.real_name = g_strdup ("Unknown");
g_once_init_leave_pointer (&entry, &e);
}
return entry;
}
/**
* g_get_user_name:
*
* Gets the user name of the current user. The encoding of the returned
* string is system-defined. On UNIX, it might be the preferred file name
* encoding, or something else, and there is no guarantee that it is even
* consistent on a machine. On Windows, it is always UTF-8.
*
* Returns: (type filename) (transfer none): the user name of the current user.
*/
const gchar *
g_get_user_name (void)
{
UserDatabaseEntry *entry;
entry = g_get_user_database_entry ();
return entry->user_name;
}
/**
* g_get_real_name:
*
* Gets the real name of the user. This usually comes from the user's
* entry in the `passwd` file. The encoding of the returned string is
* system-defined. (On Windows, it is, however, always UTF-8.) If the
* real user name cannot be determined, the string "Unknown" is
* returned.
*
* Returns: (type filename) (transfer none): the user's real name.
*/
const gchar *
g_get_real_name (void)
{
UserDatabaseEntry *entry;
entry = g_get_user_database_entry ();
return entry->real_name;
}
/* Protected by @g_utils_global_lock. */
static gchar *g_home_dir = NULL; /* (owned) (nullable before initialised) */
static gchar *
g_build_home_dir (void)
{
gchar *home_dir;
/* We first check HOME and use it if it is set */
home_dir = g_strdup (g_getenv ("HOME"));
#ifdef G_OS_WIN32
/* Only believe HOME if it is an absolute path and exists.
*
* We only do this check on Windows for a couple of reasons.
* Historically, we only did it there because we used to ignore $HOME
* on UNIX. There are concerns about enabling it now on UNIX because
* of things like autofs. In short, if the user has a bogus value in
* $HOME then they get what they pay for...
*/
if (home_dir != NULL)
{
if (!(g_path_is_absolute (home_dir) &&
g_file_test (home_dir, G_FILE_TEST_IS_DIR)))
g_clear_pointer (&home_dir, g_free);
}
/* In case HOME is Unix-style (it happens), convert it to
* Windows style.
*/
if (home_dir != NULL)
{
gchar *p;
while ((p = strchr (home_dir, '/')) != NULL)
*p = '\\';
}
if (home_dir == NULL)
{
/* USERPROFILE is probably the closest equivalent to $HOME? */
if (g_getenv ("USERPROFILE") != NULL)
home_dir = g_strdup (g_getenv ("USERPROFILE"));
}
if (home_dir == NULL)
home_dir = get_special_folder (&FOLDERID_Profile);
if (home_dir == NULL)
home_dir = get_windows_directory_root ();
#endif /* G_OS_WIN32 */
if (home_dir == NULL)
{
/* If we didn't get it from any of those methods, we will have
* to read the user database entry.
*/
UserDatabaseEntry *entry = g_get_user_database_entry ();
home_dir = g_strdup (entry->home_dir);
}
/* If we have been denied access to /etc/passwd (for example, by an
* overly-zealous LSM), make up a junk value. The return value at this
* point is explicitly documented as ‘undefined’. */
if (home_dir == NULL)
{
g_warning ("Could not find home directory: $HOME is not set, and "
"user database could not be read.");
home_dir = g_strdup ("/");
}
return g_steal_pointer (&home_dir);
}
static const gchar *
g_get_home_dir_unlocked (void)
{
if (g_home_dir == NULL)
g_home_dir = g_build_home_dir ();
return g_home_dir;
}
/**
* g_get_home_dir:
*
* Gets the current user's home directory.
*
* As with most UNIX tools, this function will return the value of the
* `HOME` environment variable if it is set to an existing absolute path
* name, falling back to the `passwd` file in the case that it is unset.
*
* If the path given in `HOME` is non-absolute, does not exist, or is
* not a directory, the result is undefined.
*
* Before version 2.36 this function would ignore the `HOME` environment
* variable, taking the value from the `passwd` database instead. This was
* changed to increase the compatibility of GLib with other programs (and
* the XDG basedir specification) and to increase testability of programs
* based on GLib (by making it easier to run them from test frameworks).
*
* If your program has a strong requirement for either the new or the
* old behaviour (and if you don't wish to increase your GLib
* dependency to ensure that the new behaviour is in effect) then you
* should either directly check the `HOME` environment variable yourself
* or unset it before calling any functions in GLib.
*
* Returns: (type filename) (transfer none): the current user's home directory
*/
const gchar *
g_get_home_dir (void)
{
const gchar *home_dir;
G_LOCK (g_utils_global);
home_dir = g_get_home_dir_unlocked ();
G_UNLOCK (g_utils_global);
return home_dir;
}
void
_g_unset_cached_tmp_dir (void)
{
G_LOCK (g_utils_global);
/* We have to leak the old value, as user code could be retaining pointers
* to it. */
g_ignore_leak (g_tmp_dir);
g_tmp_dir = NULL;
G_UNLOCK (g_utils_global);
}
/**
* g_get_tmp_dir:
*
* Gets the directory to use for temporary files.
*
* On UNIX, this is taken from the `TMPDIR` environment variable.
* If the variable is not set, `P_tmpdir` is
* used, as defined by the system C library. Failing that, a
* hard-coded default of "/tmp" is returned.
*
* On Windows, the `TEMP` environment variable is used, with the
* root directory of the Windows installation (eg: "C:\") used
* as a default.
*
* The encoding of the returned string is system-defined. On Windows,
* it is always UTF-8. The return value is never %NULL or the empty
* string.
*
* Returns: (type filename) (transfer none): the directory to use for temporary files.
*/
const gchar *
g_get_tmp_dir (void)
{
G_LOCK (g_utils_global);
if (g_tmp_dir == NULL)
{
gchar *tmp;
tmp = g_strdup (g_getenv ("G_TEST_TMPDIR"));
if (tmp == NULL || *tmp == '\0')
{
g_free (tmp);
tmp = g_strdup (g_getenv (
#ifdef G_OS_WIN32
"TEMP"
#else /* G_OS_WIN32 */
"TMPDIR"
#endif /* G_OS_WIN32 */
));
}
#ifdef G_OS_WIN32
if (tmp == NULL || *tmp == '\0')
{
g_free (tmp);
tmp = get_windows_directory_root ();
}
#else /* G_OS_WIN32 */
#ifdef P_tmpdir
if (tmp == NULL || *tmp == '\0')
{
gsize k;
g_free (tmp);
tmp = g_strdup (P_tmpdir);
k = strlen (tmp);
if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
tmp[k - 1] = '\0';
}
#endif /* P_tmpdir */
if (tmp == NULL || *tmp == '\0')
{
g_free (tmp);
tmp = g_strdup ("/tmp");
}
#endif /* !G_OS_WIN32 */
g_tmp_dir = g_steal_pointer (&tmp);
}
G_UNLOCK (g_utils_global);
return g_tmp_dir;
}
/**
* g_get_host_name:
*
* Return a name for the machine.
*
* The returned name is not necessarily a fully-qualified domain name,
* or even present in DNS or some other name service at all. It need
* not even be unique on your local network or site, but usually it
* is. Callers should not rely on the return value having any specific
* properties like uniqueness for security purposes. Even if the name
* of the machine is changed while an application is running, the
* return value from this function does not change. The returned
* string is owned by GLib and should not be modified or freed. If no
* name can be determined, a default fixed string "localhost" is
* returned.
*
* The encoding of the returned string is UTF-8.
*
* Returns: (transfer none): the host name of the machine.
*
* Since: 2.8
*/
const gchar *
g_get_host_name (void)
{
static gchar *hostname;
if (g_once_init_enter_pointer (&hostname))
{
gboolean failed;
gchar *utmp = NULL;
#ifndef G_OS_WIN32
gsize size;
/* The number 256 * 256 is taken from the value of _POSIX_HOST_NAME_MAX,
* which is 255. Since we use _POSIX_HOST_NAME_MAX + 1 (= 256) in the
* fallback case, we pick 256 * 256 as the size of the larger buffer here.
* It should be large enough. It doesn't looks reasonable to name a host
* with a string that is longer than 64 KiB.
*/
const gsize size_large = (gsize) 256 * 256;
gchar *tmp;
#ifdef _SC_HOST_NAME_MAX
{
glong max;
max = sysconf (_SC_HOST_NAME_MAX);
if (max > 0 && (gsize) max <= G_MAXSIZE - 1)
size = (gsize) max + 1;
else
#ifdef HOST_NAME_MAX
size = HOST_NAME_MAX + 1;
#else
size = _POSIX_HOST_NAME_MAX + 1;
#endif /* HOST_NAME_MAX */
}
#else
/* Fallback to some reasonable value */
size = 256;
#endif /* _SC_HOST_NAME_MAX */
tmp = g_malloc (size);
failed = (gethostname (tmp, size) == -1);
if (failed && size < size_large)
{
/* Try again with a larger buffer if 'size' may be too small. */
g_free (tmp);
tmp = g_malloc (size_large);
failed = (gethostname (tmp, size_large) == -1);
}
if (failed)
g_clear_pointer (&tmp, g_free);
utmp = tmp;
#else
wchar_t tmp[MAX_COMPUTERNAME_LENGTH + 1];
DWORD size = sizeof (tmp) / sizeof (tmp[0]);
failed = (!GetComputerNameW (tmp, &size));
if (!failed)
utmp = g_utf16_to_utf8 (tmp, size, NULL, NULL, NULL);
if (utmp == NULL)
failed = TRUE;
#endif
g_once_init_leave_pointer (&hostname, failed ? g_strdup ("localhost") : utmp);
}
return hostname;
}
static const gchar *g_prgname = NULL; /* always a quark */
/**
* g_get_prgname:
*
* Gets the name of the program. This name should not be localized,
* in contrast to g_get_application_name().
*
* If you are using #GApplication the program name is set in
* g_application_run(). In case of GDK or GTK it is set in
* gdk_init(), which is called by gtk_init() and the
* #GtkApplication::startup handler. The program name is found by
* taking the last component of @argv[0].
*
* Returns: (nullable) (transfer none): the name of the program,
* or %NULL if it has not been set yet. The returned string belongs
* to GLib and must not be modified or freed.
*/
const gchar*
g_get_prgname (void)
{
return g_atomic_pointer_get (&g_prgname);
}
/**
* g_set_prgname:
* @prgname: the name of the program.
*
* Sets the name of the program. This name should not be localized,
* in contrast to g_set_application_name().
*
* If you are using #GApplication the program name is set in
* g_application_run(). In case of GDK or GTK it is set in
* gdk_init(), which is called by gtk_init() and the
* #GtkApplication::startup handler. By default, the program name is
* found by taking the last component of @argv[0].
*
* Since GLib 2.72, this function can be called multiple times
* and is fully thread safe. Prior to GLib 2.72, this function
* could only be called once per process.
*
* See the [GTK documentation](https://docs.gtk.org/gtk4/migrating-3to4.html#set-a-proper-application-id)
* for requirements on integrating g_set_prgname() with GTK applications.
*/
void
g_set_prgname (const gchar *prgname)
{
prgname = g_intern_string (prgname);
g_atomic_pointer_set (&g_prgname, prgname);
}
/**
* g_set_prgname_once:
* @prgname: the name of the program.
*
* If g_get_prgname() is not set, this is the same as setting
* the name via g_set_prgname() and %TRUE is returned. Otherwise,
* does nothing and returns %FALSE. This is thread-safe.
*
* Returns: whether g_prgname was initialized by the call.
*/
gboolean
g_set_prgname_once (const gchar *prgname)
{
/* if @prgname is NULL, then this has the same effect as calling
* (g_get_prgname()==NULL). */
prgname = g_intern_string (prgname);
return g_atomic_pointer_compare_and_exchange (&g_prgname, NULL, prgname);
}
static gchar *g_application_name = NULL;
/**
* g_get_application_name:
*
* Gets a human-readable name for the application, as set by
* g_set_application_name(). This name should be localized if
* possible, and is intended for display to the user. Contrast with
* g_get_prgname(), which gets a non-localized name. If
* g_set_application_name() has not been called, returns the result of
* g_get_prgname() (which may be %NULL if g_set_prgname() has also not
* been called).
*
* Returns: (transfer none) (nullable): human-readable application
* name. May return %NULL
*
* Since: 2.2
**/
const gchar *
g_get_application_name (void)
{
const char *retval;
retval = g_atomic_pointer_get (&g_application_name);
if (retval)
return retval;
return g_get_prgname ();
}
/**
* g_set_application_name:
* @application_name: localized name of the application
*
* Sets a human-readable name for the application. This name should be
* localized if possible, and is intended for display to the user.
* Contrast with g_set_prgname(), which sets a non-localized name.
* g_set_prgname() will be called automatically by gtk_init(),
* but g_set_application_name() will not.
*
* Note that for thread safety reasons, this function can only
* be called once.
*
* The application name will be used in contexts such as error messages,
* or when displaying an application's name in the task list.
*
* Since: 2.2
**/
void
g_set_application_name (const gchar *application_name)
{
char *name;
g_return_if_fail (application_name);
name = g_strdup (application_name);
if (!g_atomic_pointer_compare_and_exchange (&g_application_name, NULL, name))
{
g_warning ("g_set_application_name() called multiple times");
g_free (name);
}
}
#ifdef G_OS_WIN32
/* For the past versions we can just
* hardcode all the names.
*/
static const struct winver
{
gint major;
gint minor;
gint sp;
const char *version;
const char *spversion;
} versions[] =
{
{6, 2, 0, "8", ""},
{6, 1, 1, "7", " SP1"},
{6, 1, 0, "7", ""},
{6, 0, 2, "Vista", " SP2"},
{6, 0, 1, "Vista", " SP1"},
{6, 0, 0, "Vista", ""},
{5, 1, 3, "XP", " SP3"},
{5, 1, 2, "XP", " SP2"},
{5, 1, 1, "XP", " SP1"},
{5, 1, 0, "XP", ""},
{0, 0, 0, NULL, NULL},
};
static gchar *
get_registry_str (HKEY root_key, const wchar_t *path, const wchar_t *value_name)
{
HKEY key_handle;
DWORD req_value_data_size;
DWORD req_value_data_size2;
LONG status;
DWORD value_type_w;
DWORD value_type_w2;
char *req_value_data;
gchar *result;
status = RegOpenKeyExW (root_key, path, 0, KEY_READ, &key_handle);
if (status != ERROR_SUCCESS)
return NULL;
req_value_data_size = 0;
status = RegQueryValueExW (key_handle,
value_name,
NULL,
&value_type_w,
NULL,
&req_value_data_size);
if (status != ERROR_MORE_DATA && status != ERROR_SUCCESS)
{
RegCloseKey (key_handle);
return NULL;
}
req_value_data = g_malloc (req_value_data_size);
req_value_data_size2 = req_value_data_size;
status = RegQueryValueExW (key_handle,
value_name,
NULL,
&value_type_w2,
(gpointer) req_value_data,
&req_value_data_size2);
result = NULL;
if (status == ERROR_SUCCESS && value_type_w2 == REG_SZ)
result = g_utf16_to_utf8 ((gunichar2 *) req_value_data,
req_value_data_size / sizeof (gunichar2),
NULL,
NULL,
NULL);
g_free (req_value_data);
RegCloseKey (key_handle);
return result;
}
/* Windows 8.1 can be either plain or with Update 1,
* depending on its build number (9200 or 9600).
*/
static gchar *
get_windows_8_1_update (void)
{
gchar *current_build;
gchar *result = NULL;
current_build = get_registry_str (HKEY_LOCAL_MACHINE,
L"SOFTWARE"
L"\\Microsoft"
L"\\Windows NT"
L"\\CurrentVersion",
L"CurrentBuild");
if (current_build != NULL)
{
wchar_t *end;
long build = wcstol ((const wchar_t *) current_build, &end, 10);
if (build <= INT_MAX &&
build >= INT_MIN &&
errno == 0 &&
*end == L'\0')
{
if (build >= 9600)
result = g_strdup ("Update 1");
}
}
g_clear_pointer (¤t_build, g_free);
return result;
}
static gchar *
get_windows_version (gboolean with_windows)
{
GString *version = g_string_new (NULL);
gboolean is_win_server = FALSE;
if (g_win32_check_windows_version (10, 0, 0, G_WIN32_OS_ANY))
{
gchar *win10_release;
gboolean is_win11 = FALSE;
OSVERSIONINFOEXW osinfo;
/* Are we on Windows 2016/2019/2022 Server? */
is_win_server = g_win32_check_windows_version (10, 0, 0, G_WIN32_OS_SERVER);
/*
* This always succeeds if we get here, since the
* g_win32_check_windows_version() already did this!
* We want the OSVERSIONINFOEXW here for more even
* fine-grained versioning items
*/
_g_win32_call_rtl_version (&osinfo);
if (!is_win_server)
{
/*
* Windows 11 is actually Windows 10.0.22000+,
* so look at the build number
*/
is_win11 = (osinfo.dwBuildNumber >= 22000);
}
else
{
/*
* Windows 2022 Server is actually Windows 10.0.20348+,
* Windows 2019 Server is actually Windows 10.0.17763+,
* Windows 2016 Server is actually Windows 10.0.14393+,
* so look at the build number
*/
g_string_append (version, "Server");
if (osinfo.dwBuildNumber >= 20348)
g_string_append (version, " 2022");
else if (osinfo.dwBuildNumber >= 17763)
g_string_append (version, " 2019");
else
g_string_append (version, " 2016");
}
if (is_win11)
g_string_append (version, "11");
else if (!is_win_server)
g_string_append (version, "10");
/* Windows 10/Server 2016+ is identified by its ReleaseId or
* DisplayVersion (since 20H2), such as
* 1511, 1607, 1703, 1709, 1803, 1809 or 1903 etc.
* The first version of Windows 10 has no release number.
*/
win10_release = get_registry_str (HKEY_LOCAL_MACHINE,
L"SOFTWARE"
L"\\Microsoft"
L"\\Windows NT"
L"\\CurrentVersion",
L"ReleaseId");
if (win10_release != NULL)
{
if (g_strcmp0 (win10_release, "2009") != 0)
g_string_append_printf (version, " %s", win10_release);
else
{
g_free (win10_release);
win10_release = get_registry_str (HKEY_LOCAL_MACHINE,
L"SOFTWARE"
L"\\Microsoft"
L"\\Windows NT"
L"\\CurrentVersion",
L"DisplayVersion");
if (win10_release != NULL)
g_string_append_printf (version, " %s", win10_release);
else
g_string_append_printf (version, " 2009");
}
}
g_free (win10_release);
}
else if (g_win32_check_windows_version (6, 3, 0, G_WIN32_OS_ANY))
{
gchar *win81_update;
if (g_win32_check_windows_version (6, 3, 0, G_WIN32_OS_WORKSTATION))
g_string_append (version, "8.1");
else
g_string_append (version, "Server 2012 R2");
win81_update = get_windows_8_1_update ();
if (win81_update != NULL)
g_string_append_printf (version, " %s", win81_update);
g_free (win81_update);
}
else
{
gint i;
for (i = 0; versions[i].major > 0; i++)
{
if (!g_win32_check_windows_version (versions[i].major, versions[i].minor, versions[i].sp, G_WIN32_OS_ANY))
continue;
g_string_append (version, versions[i].version);
if (g_win32_check_windows_version (versions[i].major, versions[i].minor, versions[i].sp, G_WIN32_OS_SERVER))
{
/*
* This condition should now always hold, since Windows
* 7+/Server 2008 R2+ is now required
*/
if (versions[i].major == 6)
{
g_string_append (version, "Server");
if (versions[i].minor == 2)
g_string_append (version, " 2012");
else if (versions[i].minor == 1)
g_string_append (version, " 2008 R2");
else
g_string_append (version, " 2008");
}
}
g_string_append (version, versions[i].spversion);
break;
}
}
if (version->len == 0)
{
g_string_free (version, TRUE);
return NULL;
}
if (with_windows)
g_string_prepend (version, "Windows ");
return g_string_free (version, FALSE);
}
#endif
#if defined (G_OS_UNIX) && !defined (__APPLE__)
static gchar *
get_os_info_from_os_release (const gchar *key_name,
const gchar *buffer)
{
GStrv lines;
gchar *prefix;
size_t i;
gchar *result = NULL;
lines = g_strsplit (buffer, "\n", -1);
prefix = g_strdup_printf ("%s=", key_name);
for (i = 0; lines[i] != NULL; i++)
{
const gchar *line = lines[i];
const gchar *value;
if (g_str_has_prefix (line, prefix))
{
value = line + strlen (prefix);
result = g_shell_unquote (value, NULL);
if (result == NULL)
result = g_strdup (value);
break;
}
}
g_strfreev (lines);
g_free (prefix);
#ifdef __linux__
/* Default values in spec */
if (result == NULL)
{
if (g_str_equal (key_name, G_OS_INFO_KEY_NAME))
return g_strdup ("Linux");
if (g_str_equal (key_name, G_OS_INFO_KEY_ID))
return g_strdup ("linux");
if (g_str_equal (key_name, G_OS_INFO_KEY_PRETTY_NAME))
return g_strdup ("Linux");
}
#endif
return g_steal_pointer (&result);
}
static gchar *
get_os_info_from_uname (const gchar *key_name)
{
struct utsname info;
if (uname (&info) == -1)
return NULL;
if (strcmp (key_name, G_OS_INFO_KEY_NAME) == 0)
return g_strdup (info.sysname);
else if (strcmp (key_name, G_OS_INFO_KEY_VERSION) == 0)
return g_strdup (info.release);
else if (strcmp (key_name, G_OS_INFO_KEY_PRETTY_NAME) == 0)
return g_strdup_printf ("%s %s", info.sysname, info.release);
else if (strcmp (key_name, G_OS_INFO_KEY_ID) == 0)
{
gchar *result = g_ascii_strdown (info.sysname, -1);
g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
return g_steal_pointer (&result);
}
else if (strcmp (key_name, G_OS_INFO_KEY_VERSION_ID) == 0)
{
/* We attempt to convert the version string to the format returned by
* config.guess, which is the script used to generate target triplets
* in GNU autotools. There are a lot of rules in the script. We only
* implement a few rules which are easy to understand here.
*
* config.guess can be found at https://savannah.gnu.org/projects/config.
*/
gchar *result;
if (strcmp (info.sysname, "NetBSD") == 0)
{
/* sed -e 's,[-_].*,,' */
gssize len = G_MAXSSIZE;
const gchar *c;
if ((c = strchr (info.release, '-')) != NULL)
len = MIN (len, c - info.release);
if ((c = strchr (info.release, '_')) != NULL)
len = MIN (len, c - info.release);
if (len == G_MAXSSIZE)
len = -1;
result = g_ascii_strdown (info.release, len);
}
else if (strcmp (info.sysname, "GNU") == 0)
{
/* sed -e 's,/.*$,,' */
gssize len = -1;
const gchar *c = strchr (info.release, '/');
if (c != NULL)
len = c - info.release;
result = g_ascii_strdown (info.release, len);
}
else if (g_str_has_prefix (info.sysname, "GNU/") ||
strcmp (info.sysname, "FreeBSD") == 0 ||
strcmp (info.sysname, "DragonFly") == 0)
{
/* sed -e 's,[-(].*,,' */
gssize len = G_MAXSSIZE;
const gchar *c;
if ((c = strchr (info.release, '-')) != NULL)
len = MIN (len, c - info.release);
if ((c = strchr (info.release, '(')) != NULL)
len = MIN (len, c - info.release);
if (len == G_MAXSSIZE)
len = -1;
result = g_ascii_strdown (info.release, len);
}
else
result = g_ascii_strdown (info.release, -1);
g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
return g_steal_pointer (&result);
}
else
return NULL;
}
#endif /* defined (G_OS_UNIX) && !defined (__APPLE__) */
/**
* g_get_os_info:
* @key_name: a key for the OS info being requested, for example %G_OS_INFO_KEY_NAME.
*
* Get information about the operating system.
*
* On Linux this comes from the `/etc/os-release` file. On other systems, it may
* come from a variety of sources. You can either use the standard key names
* like %G_OS_INFO_KEY_NAME or pass any UTF-8 string key name. For example,
* `/etc/os-release` provides a number of other less commonly used values that may
* be useful. No key is guaranteed to be provided, so the caller should always
* check if the result is %NULL.
*
* Returns: (nullable): The associated value for the requested key or %NULL if
* this information is not provided.
*
* Since: 2.64
**/
gchar *
g_get_os_info (const gchar *key_name)
{
#if defined (__APPLE__)
if (g_strcmp0 (key_name, G_OS_INFO_KEY_NAME) == 0)
return g_strdup ("macOS");
else
return NULL;
#elif defined (G_OS_UNIX)
const gchar * const os_release_files[] = { "/etc/os-release", "/usr/lib/os-release" };
gsize i;
gchar *buffer = NULL;
gchar *result = NULL;
g_return_val_if_fail (key_name != NULL, NULL);
for (i = 0; i < G_N_ELEMENTS (os_release_files); i++)
{
GError *error = NULL;
gboolean file_missing;
if (g_file_get_contents (os_release_files[i], &buffer, NULL, &error))
break;
file_missing = g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT);
g_clear_error (&error);
if (!file_missing)
return NULL;
}
if (buffer != NULL)
result = get_os_info_from_os_release (key_name, buffer);
else
result = get_os_info_from_uname (key_name);
g_free (buffer);
return g_steal_pointer (&result);
#elif defined (G_OS_WIN32)
if (g_strcmp0 (key_name, G_OS_INFO_KEY_NAME) == 0)
return g_strdup ("Windows");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_ID) == 0)
return g_strdup ("windows");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_PRETTY_NAME) == 0)
/* Windows XP SP2 or Windows 10 1903 or Windows 7 Server SP1 */
return get_windows_version (TRUE);
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_VERSION) == 0)
/* XP SP2 or 10 1903 or 7 Server SP1 */
return get_windows_version (FALSE);
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_VERSION_ID) == 0)
{
/* xp_sp2 or 10_1903 or 7_server_sp1 */
gchar *result;
gchar *version = get_windows_version (FALSE);
if (version == NULL)
return NULL;
result = g_ascii_strdown (version, -1);
g_free (version);
return g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
}
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_HOME_URL) == 0)
return g_strdup ("https://microsoft.com/windows/");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_DOCUMENTATION_URL) == 0)
return g_strdup ("https://docs.microsoft.com/");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_SUPPORT_URL) == 0)
return g_strdup ("https://support.microsoft.com/");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_BUG_REPORT_URL) == 0)
return g_strdup ("https://support.microsoft.com/contactus/");
else if (g_strcmp0 (key_name, G_OS_INFO_KEY_PRIVACY_POLICY_URL) == 0)
return g_strdup ("https://privacy.microsoft.com/");
else
return NULL;
#endif
}
/* Set @global_str to a copy of @new_value if it’s currently unset or has a
* different value. If its current value matches @new_value, do nothing. If
* replaced, we have to leak the old value as client code could still have
* pointers to it. */
static void
set_str_if_different (gchar **global_str,
const gchar *type,
const gchar *new_value)
{
if (*global_str == NULL ||
!g_str_equal (new_value, *global_str))
{
g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value);
/* We have to leak the old value, as user code could be retaining pointers
* to it. */
g_ignore_leak (*global_str);
*global_str = g_strdup (new_value);
}
}
static void
set_strv_if_different (gchar ***global_strv,
const gchar *type,
const gchar * const *new_value)
{
if (*global_strv == NULL ||
!g_strv_equal (new_value, (const gchar * const *) *global_strv))
{
gchar *new_value_str = g_strjoinv (":", (gchar **) new_value);
g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value_str);
g_free (new_value_str);
/* We have to leak the old value, as user code could be retaining pointers
* to it. */
g_ignore_strv_leak (*global_strv);
*global_strv = g_strdupv ((gchar **) new_value);
}
}
/*
* g_set_user_dirs:
* @first_dir_type: Type of the first directory to set
* @...: Value to set the first directory to, followed by additional type/value
* pairs, followed by %NULL
*
* Set one or more ‘user’ directories to custom values. This is intended to be
* used by test code (particularly with the %G_TEST_OPTION_ISOLATE_DIRS option)
* to override the values returned by the following functions, so that test
* code can be run without touching an installed system and user data:
*
* - g_get_home_dir() — use type `HOME`, pass a string
* - g_get_user_cache_dir() — use type `XDG_CACHE_HOME`, pass a string
* - g_get_system_config_dirs() — use type `XDG_CONFIG_DIRS`, pass a
* %NULL-terminated string array
* - g_get_user_config_dir() — use type `XDG_CONFIG_HOME`, pass a string
* - g_get_system_data_dirs() — use type `XDG_DATA_DIRS`, pass a
* %NULL-terminated string array
* - g_get_user_data_dir() — use type `XDG_DATA_HOME`, pass a string
* - g_get_user_runtime_dir() — use type `XDG_RUNTIME_DIR`, pass a string
*
* The list must be terminated with a %NULL type. All of the values must be
* non-%NULL — passing %NULL as a value won’t reset a directory. If a reference
* to a directory from the calling environment needs to be kept, copy it before
* the first call to g_set_user_dirs(). g_set_user_dirs() can be called multiple
* times.
*
* Since: 2.60
*/
/*< private > */
void
g_set_user_dirs (const gchar *first_dir_type,
...)
{
va_list args;
const gchar *dir_type;
G_LOCK (g_utils_global);
va_start (args, first_dir_type);
for (dir_type = first_dir_type; dir_type != NULL; dir_type = va_arg (args, const gchar *))
{
gconstpointer dir_value = va_arg (args, gconstpointer);
g_assert (dir_value != NULL);
if (g_str_equal (dir_type, "HOME"))
set_str_if_different (&g_home_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_CACHE_HOME"))
set_str_if_different (&g_user_cache_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_CONFIG_DIRS"))
set_strv_if_different (&g_system_config_dirs, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_CONFIG_HOME"))
set_str_if_different (&g_user_config_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_DATA_DIRS"))
set_strv_if_different (&g_system_data_dirs, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_DATA_HOME"))
set_str_if_different (&g_user_data_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_STATE_HOME"))
set_str_if_different (&g_user_state_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_RUNTIME_DIR"))
set_str_if_different (&g_user_runtime_dir, dir_type, dir_value);
else
g_assert_not_reached ();
}
va_end (args);
G_UNLOCK (g_utils_global);
}
static gchar *
g_build_user_data_dir (void)
{
gchar *data_dir = NULL;
const gchar *data_dir_env = g_getenv ("XDG_DATA_HOME");
if (data_dir_env && data_dir_env[0])
data_dir = g_strdup (data_dir_env);
#ifdef G_OS_WIN32
else
data_dir = get_special_folder (&FOLDERID_LocalAppData);
#endif
if (!data_dir || !data_dir[0])
{
gchar *home_dir = g_build_home_dir ();
g_free (data_dir);
data_dir = g_build_filename (home_dir, ".local", "share", NULL);
g_free (home_dir);
}
return g_steal_pointer (&data_dir);
}
/**
* g_get_user_data_dir:
*
* Returns a base directory in which to access application data such
* as icons that is customized for a particular user.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the directory retrieved will be `XDG_DATA_HOME`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_DATA_HOME`
* is defined. If `XDG_DATA_HOME` is undefined, the folder to use for local (as
* opposed to roaming) application data is used instead. See the
* [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).
* Note that in this case on Windows it will be the same
* as what g_get_user_config_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that must
* not be modified or freed.
*
* Since: 2.6
**/
const gchar *
g_get_user_data_dir (void)
{
const gchar *user_data_dir;
G_LOCK (g_utils_global);
if (g_user_data_dir == NULL)
g_user_data_dir = g_build_user_data_dir ();
user_data_dir = g_user_data_dir;
G_UNLOCK (g_utils_global);
return user_data_dir;
}
static gchar *
g_build_user_config_dir (void)
{
gchar *config_dir = NULL;
const gchar *config_dir_env = g_getenv ("XDG_CONFIG_HOME");
if (config_dir_env && config_dir_env[0])
config_dir = g_strdup (config_dir_env);
#ifdef G_OS_WIN32
else
config_dir = get_special_folder (&FOLDERID_LocalAppData);
#endif
if (!config_dir || !config_dir[0])
{
gchar *home_dir = g_build_home_dir ();
g_free (config_dir);
config_dir = g_build_filename (home_dir, ".config", NULL);
g_free (home_dir);
}
return g_steal_pointer (&config_dir);
}
static const char *
g_get_user_config_dir_unlocked (void)
{
if (g_user_config_dir == NULL)
g_user_config_dir = g_build_user_config_dir ();
return g_user_config_dir;
}
/**
* g_get_user_config_dir:
*
* Returns a base directory in which to store user-specific application
* configuration information such as user preferences and settings.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the directory retrieved will be `XDG_CONFIG_HOME`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_HOME` is defined.
* If `XDG_CONFIG_HOME` is undefined, the folder to use for local (as opposed
* to roaming) application data is used instead. See the
* [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).
* Note that in this case on Windows it will be the same
* as what g_get_user_data_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
* Since: 2.6
**/
const gchar *
g_get_user_config_dir (void)
{
const gchar *user_config_dir;
G_LOCK (g_utils_global);
user_config_dir = g_get_user_config_dir_unlocked ();
G_UNLOCK (g_utils_global);
return user_config_dir;
}
static gchar *
g_build_user_cache_dir (void)
{
gchar *cache_dir = NULL;
const gchar *cache_dir_env = g_getenv ("XDG_CACHE_HOME");
if (cache_dir_env && cache_dir_env[0])
cache_dir = g_strdup (cache_dir_env);
#ifdef G_OS_WIN32
else
cache_dir = get_special_folder (&FOLDERID_InternetCache);
#endif
if (!cache_dir || !cache_dir[0])
{
gchar *home_dir = g_build_home_dir ();
g_free (cache_dir);
cache_dir = g_build_filename (home_dir, ".cache", NULL);
g_free (home_dir);
}
return g_steal_pointer (&cache_dir);
}
/**
* g_get_user_cache_dir:
*
* Returns a base directory in which to store non-essential, cached
* data specific to particular user.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the directory retrieved will be `XDG_CACHE_HOME`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_CACHE_HOME` is defined.
* If `XDG_CACHE_HOME` is undefined, the directory that serves as a common
* repository for temporary Internet files is used instead. A typical path is
* `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`.
* See the [documentation for `FOLDERID_InternetCache`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
* Since: 2.6
**/
const gchar *
g_get_user_cache_dir (void)
{
const gchar *user_cache_dir;
G_LOCK (g_utils_global);
if (g_user_cache_dir == NULL)
g_user_cache_dir = g_build_user_cache_dir ();
user_cache_dir = g_user_cache_dir;
G_UNLOCK (g_utils_global);
return user_cache_dir;
}
static gchar *
g_build_user_state_dir (void)
{
gchar *state_dir = NULL;
const gchar *state_dir_env = g_getenv ("XDG_STATE_HOME");
if (state_dir_env && state_dir_env[0])
state_dir = g_strdup (state_dir_env);
#ifdef G_OS_WIN32
else
state_dir = get_special_folder (&FOLDERID_LocalAppData);
#endif
if (!state_dir || !state_dir[0])
{
gchar *home_dir = g_build_home_dir ();
g_free (state_dir);
state_dir = g_build_filename (home_dir, ".local/state", NULL);
g_free (home_dir);
}
return g_steal_pointer (&state_dir);
}
/**
* g_get_user_state_dir:
*
* Returns a base directory in which to store state files specific to
* particular user.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the directory retrieved will be `XDG_STATE_HOME`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_STATE_HOME` is defined.
* If `XDG_STATE_HOME` is undefined, the folder to use for local (as opposed
* to roaming) application data is used instead. See the
* [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).
* Note that in this case on Windows it will be the same
* as what g_get_user_data_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
*
* Since: 2.72
**/
const gchar *
g_get_user_state_dir (void)
{
const gchar *user_state_dir;
G_LOCK (g_utils_global);
if (g_user_state_dir == NULL)
g_user_state_dir = g_build_user_state_dir ();
user_state_dir = g_user_state_dir;
G_UNLOCK (g_utils_global);
return user_state_dir;
}
static gchar *
g_build_user_runtime_dir (void)
{
gchar *runtime_dir = NULL;
const gchar *runtime_dir_env = g_getenv ("XDG_RUNTIME_DIR");
if (runtime_dir_env && runtime_dir_env[0])
{
runtime_dir = g_strdup (runtime_dir_env);
/* If the XDG_RUNTIME_DIR environment variable is set, we are being told by
* the OS that this directory exists and is appropriately configured
* already.
*/
}
else
{
runtime_dir = g_build_user_cache_dir ();
/* Fallback case: the directory may not yet exist.
*
* The user should be able to rely on the directory existing
* when the function returns. Probably it already does, but
* let's make sure. Just do mkdir() directly since it will be
* no more expensive than a stat() in the case that the
* directory already exists and is a lot easier.
*
* $XDG_CACHE_HOME is probably ~/.cache/ so as long as $HOME
* exists this will work. If the user changed $XDG_CACHE_HOME
* then they can make sure that it exists...
*/
(void) g_mkdir (runtime_dir, 0700);
}
return g_steal_pointer (&runtime_dir);
}
/**
* g_get_user_runtime_dir:
*
* Returns a directory that is unique to the current user on the local
* system.
*
* This is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* This is the directory
* specified in the `XDG_RUNTIME_DIR` environment variable.
* In the case that this variable is not set, we return the value of
* g_get_user_cache_dir(), after verifying that it exists.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename): a string owned by GLib that must not be
* modified or freed.
*
* Since: 2.28
**/
const gchar *
g_get_user_runtime_dir (void)
{
const gchar *user_runtime_dir;
G_LOCK (g_utils_global);
if (g_user_runtime_dir == NULL)
g_user_runtime_dir = g_build_user_runtime_dir ();
user_runtime_dir = g_user_runtime_dir;
G_UNLOCK (g_utils_global);
return user_runtime_dir;
}
#ifdef HAVE_COCOA
/* Implemented in gutils-macos.m */
void load_user_special_dirs_macos (gchar **table);
static void
load_user_special_dirs (void)
{
load_user_special_dirs_macos (g_user_special_dirs);
}
#elif defined(G_OS_WIN32)
static void
load_user_special_dirs (void)
{
g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (&FOLDERID_Desktop);
g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (&FOLDERID_Documents);
g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (&FOLDERID_Downloads);
if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (&FOLDERID_Desktop);
g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (&FOLDERID_Music);
g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (&FOLDERID_Pictures);
g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (&FOLDERID_Public);
if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (&FOLDERID_PublicDocuments);
g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (&FOLDERID_Templates);
g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (&FOLDERID_Videos);
}
#else /* default is unix */
#include "gutilsprivate.c"
/* adapted from xdg-user-dir-lookup.c
*
* Copyright (C) 2007 Red Hat Inc.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
static void
load_user_special_dirs (void)
{
const gchar *config_dir = NULL;
const gchar *home_dir;
gchar *config_file;
gchar *data;
config_dir = g_get_user_config_dir_unlocked ();
config_file = g_build_filename (config_dir,
"user-dirs.dirs",
NULL);
if (!g_file_get_contents (config_file, &data, NULL, NULL))
{
g_free (config_file);
return;
}
home_dir = g_get_home_dir_unlocked ();
load_user_special_dirs_from_string (data, home_dir, g_user_special_dirs);
g_free (data);
g_free (config_file);
}
#endif /* platform-specific load_user_special_dirs implementations */
/**
* g_reload_user_special_dirs_cache:
*
* Resets the cache used for g_get_user_special_dir(), so
* that the latest on-disk version is used. Call this only
* if you just changed the data on disk yourself.
*
* Due to thread safety issues this may cause leaking of strings
* that were previously returned from g_get_user_special_dir()
* that can't be freed. We ensure to only leak the data for
* the directories that actually changed value though.
*
* Since: 2.22
*/
void
g_reload_user_special_dirs_cache (void)
{
int i;
G_LOCK (g_utils_global);
if (g_user_special_dirs != NULL)
{
/* save a copy of the pointer, to check if some memory can be preserved */
char **old_g_user_special_dirs = g_user_special_dirs;
char *old_val;
/* recreate and reload our cache */
g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
load_user_special_dirs ();
/* only leak changed directories */
for (i = 0; i < G_USER_N_DIRECTORIES; i++)
{
old_val = old_g_user_special_dirs[i];
if (g_user_special_dirs[i] == NULL)
{
g_user_special_dirs[i] = old_val;
}
else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
{
/* don't leak */
g_free (g_user_special_dirs[i]);
g_user_special_dirs[i] = old_val;
}
else
g_free (old_val);
}
/* free the old array */
g_free (old_g_user_special_dirs);
}
G_UNLOCK (g_utils_global);
}
/**
* g_get_user_special_dir:
* @directory: the logical id of special directory
*
* Returns the full path of a special directory using its logical id.
*
* On UNIX this is done using the XDG special user directories.
* For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
* falls back to `$HOME/Desktop` when XDG special user directories have
* not been set up.
*
* Depending on the platform, the user might be able to change the path
* of the special directory without requiring the session to restart; GLib
* will not reflect any change once the special directories are loaded.
*
* Returns: (type filename) (nullable): the path to the specified special
* directory, or %NULL if the logical id was not found. The returned string is
* owned by GLib and should not be modified or freed.
*
* Since: 2.14
*/
const gchar *
g_get_user_special_dir (GUserDirectory directory)
{
const gchar *user_special_dir;
g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
directory < G_USER_N_DIRECTORIES, NULL);
G_LOCK (g_utils_global);
if (G_UNLIKELY (g_user_special_dirs == NULL))
{
g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
load_user_special_dirs ();
/* Special-case desktop for historical compatibility */
if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
{
gchar *home_dir = g_build_home_dir ();
g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (home_dir, "Desktop", NULL);
g_free (home_dir);
}
}
user_special_dir = g_user_special_dirs[directory];
G_UNLOCK (g_utils_global);
return user_special_dir;
}
#ifdef G_OS_WIN32
#undef g_get_system_data_dirs
static HMODULE
get_module_for_address (gconstpointer address)
{
/* Holds the g_utils_global lock */
HMODULE hmodule = NULL;
if (!address)
return NULL;
if (!GetModuleHandleExW (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
address, &hmodule))
{
MEMORY_BASIC_INFORMATION mbi;
VirtualQuery (address, &mbi, sizeof (mbi));
hmodule = (HMODULE) mbi.AllocationBase;
}
return hmodule;
}
static gchar *
get_module_share_dir (gconstpointer address)
{
HMODULE hmodule;
gchar *filename;
gchar *retval;
hmodule = get_module_for_address (address);
if (hmodule == NULL)
return NULL;
filename = g_win32_get_package_installation_directory_of_module (hmodule);
retval = g_build_filename (filename, "share", NULL);
g_free (filename);
return retval;
}
static const gchar * const *
g_win32_get_system_data_dirs_for_module_real (void (*address_of_function)(void))
{
GArray *data_dirs;
HMODULE hmodule;
static GHashTable *per_module_data_dirs = NULL;
gchar **retval;
gchar *p;
gchar *exe_root;
hmodule = NULL;
if (address_of_function)
{
G_LOCK (g_utils_global);
hmodule = get_module_for_address (address_of_function);
if (hmodule != NULL)
{
if (per_module_data_dirs == NULL)
per_module_data_dirs = g_hash_table_new (NULL, NULL);
else
{
retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
if (retval != NULL)
{
G_UNLOCK (g_utils_global);
return (const gchar * const *) retval;
}
}
}
}
data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
/* Documents and Settings\All Users\Application Data */
p = get_special_folder (&FOLDERID_ProgramData);
if (p)
g_array_append_val (data_dirs, p);
/* Documents and Settings\All Users\Documents */
p = get_special_folder (&FOLDERID_PublicDocuments);
if (p)
g_array_append_val (data_dirs, p);
/* Using the above subfolders of Documents and Settings perhaps
* makes sense from a Windows perspective.
*
* But looking at the actual use cases of this function in GTK
* and GNOME software, what we really want is the "share"
* subdirectory of the installation directory for the package
* our caller is a part of.
*
* The address_of_function parameter, if non-NULL, points to a
* function in the calling module. Use that to determine that
* module's installation folder, and use its "share" subfolder.
*
* Additionally, also use the "share" subfolder of the installation
* locations of GLib and the .exe file being run.
*
* To guard against none of the above being what is really wanted,
* callers of this function should have Win32-specific code to look
* up their installation folder themselves, and handle a subfolder
* "share" of it in the same way as the folders returned from this
* function.
*/
p = get_module_share_dir (address_of_function);
if (p)
g_array_append_val (data_dirs, p);
if (glib_dll != NULL)
{
gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
p = g_build_filename (glib_root, "share", NULL);
if (p)
g_array_append_val (data_dirs, p);
g_free (glib_root);
}
exe_root = g_win32_get_package_installation_directory_of_module (NULL);
p = g_build_filename (exe_root, "share", NULL);
if (p)
g_array_append_val (data_dirs, p);
g_free (exe_root);
retval = (gchar **) g_array_free (data_dirs, FALSE);
if (address_of_function)
{
if (hmodule != NULL)
g_hash_table_insert (per_module_data_dirs, hmodule, retval);
G_UNLOCK (g_utils_global);
}
return (const gchar * const *) retval;
}
const gchar * const *
g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
{
gboolean should_call_g_get_system_data_dirs;
should_call_g_get_system_data_dirs = TRUE;
/* These checks are the same as the ones that g_build_system_data_dirs() does.
* Please keep them in sync.
*/
G_LOCK (g_utils_global);
if (!g_system_data_dirs)
{
const gchar *data_dirs = g_getenv ("XDG_DATA_DIRS");
if (!data_dirs || !data_dirs[0])
should_call_g_get_system_data_dirs = FALSE;
}
G_UNLOCK (g_utils_global);
/* There is a subtle difference between g_win32_get_system_data_dirs_for_module (NULL),
* which is what GLib code can normally call,
* and g_win32_get_system_data_dirs_for_module (&_g_win32_get_system_data_dirs),
* which is what the inline function used by non-GLib code calls.
* The former gets prefix relative to currently-running executable,
* the latter - relative to the module that calls _g_win32_get_system_data_dirs()
* (disguised as g_get_system_data_dirs()), which could be an executable or
* a DLL that is located somewhere else.
* This is why that inline function in gutils.h exists, and why we can't just
* call g_get_system_data_dirs() from there - because we need to get the address
* local to the non-GLib caller-module.
*/
/*
* g_get_system_data_dirs() will fall back to calling
* g_win32_get_system_data_dirs_for_module_real(NULL) if XDG_DATA_DIRS is NULL
* or an empty string. The checks above ensure that we do not call it in such
* cases and use the address_of_function that we've been given by the inline function.
* The reason we're calling g_get_system_data_dirs /at all/ is to give
* XDG_DATA_DIRS precedence (if it is set).
*/
if (should_call_g_get_system_data_dirs)
return g_get_system_data_dirs ();
return g_win32_get_system_data_dirs_for_module_real (address_of_function);
}
#endif
static gchar **
g_build_system_data_dirs (void)
{
gchar **data_dir_vector = NULL;
gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
/* These checks are the same as the ones that g_win32_get_system_data_dirs_for_module()
* does. Please keep them in sync.
*/
#ifndef G_OS_WIN32
if (!data_dirs || !data_dirs[0])
data_dirs = "/usr/local/share/:/usr/share/";
data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
#else
if (!data_dirs || !data_dirs[0])
data_dir_vector = g_strdupv ((gchar **) g_win32_get_system_data_dirs_for_module_real (NULL));
else
data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
#endif
return g_steal_pointer (&data_dir_vector);
}
/**
* g_get_system_data_dirs:
*
* Returns an ordered list of base directories in which to access
* system-wide application data.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec)
* In this case the list of directories retrieved will be `XDG_DATA_DIRS`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_DATA_DIRS` is defined.
* If `XDG_DATA_DIRS` is undefined,
* the first elements in the list are the Application Data
* and Documents folders for All Users. (These can be determined only
* on Windows 2000 or later and are not present in the list on other
* Windows versions.) See documentation for FOLDERID_ProgramData and
* FOLDERID_PublicDocuments.
*
* Then follows the "share" subfolder in the installation folder for
* the package containing the DLL that calls this function, if it can
* be determined.
*
* Finally the list contains the "share" subfolder in the installation
* folder for GLib, and in the installation folder for the package the
* application's .exe file belongs to.
*
* The installation folders above are determined by looking up the
* folder where the module (DLL or EXE) in question is located. If the
* folder's name is "bin", its parent is used, otherwise the folder
* itself.
*
* Note that on Windows the returned list can vary depending on where
* this function is called.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (array zero-terminated=1) (element-type filename) (transfer none):
* a %NULL-terminated array of strings owned by GLib that must not be
* modified or freed.
*
* Since: 2.6
**/
const gchar * const *
g_get_system_data_dirs (void)
{
const gchar * const *system_data_dirs;
G_LOCK (g_utils_global);
if (g_system_data_dirs == NULL)
g_system_data_dirs = g_build_system_data_dirs ();
system_data_dirs = (const gchar * const *) g_system_data_dirs;
G_UNLOCK (g_utils_global);
return system_data_dirs;
}
static gchar **
g_build_system_config_dirs (void)
{
gchar **conf_dir_vector = NULL;
const gchar *conf_dirs = g_getenv ("XDG_CONFIG_DIRS");
#ifdef G_OS_WIN32
if (conf_dirs)
{
conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
}
else
{
gchar *special_conf_dirs = get_special_folder (&FOLDERID_ProgramData);
if (special_conf_dirs)
conf_dir_vector = g_strsplit (special_conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
else
/* Return empty list */
conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
g_free (special_conf_dirs);
}
#else
if (!conf_dirs || !conf_dirs[0])
conf_dirs = "/etc/xdg";
conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
#endif
return g_steal_pointer (&conf_dir_vector);
}
/**
* g_get_system_config_dirs:
*
* Returns an ordered list of base directories in which to access
* system-wide configuration information.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_DIRS` is defined.
* If `XDG_CONFIG_DIRS` is undefined, the directory that contains application
* data for all users is used instead. A typical path is
* `C:\Documents and Settings\All Users\Application Data`.
* This folder is used for application data
* that is not user specific. For example, an application can store
* a spell-check dictionary, a database of clip art, or a log file in the
* FOLDERID_ProgramData folder. This information will not roam and is available
* to anyone using the computer.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (array zero-terminated=1) (element-type filename) (transfer none):
* a %NULL-terminated array of strings owned by GLib that must not be
* modified or freed.
*
* Since: 2.6
**/
const gchar * const *
g_get_system_config_dirs (void)
{
const gchar * const *system_config_dirs;
G_LOCK (g_utils_global);
if (g_system_config_dirs == NULL)
g_system_config_dirs = g_build_system_config_dirs ();
system_config_dirs = (const gchar * const *) g_system_config_dirs;
G_UNLOCK (g_utils_global);
return system_config_dirs;
}
/**
* g_nullify_pointer:
* @nullify_location: (not nullable): the memory address of the pointer.
*
* Set the pointer at the specified location to %NULL.
**/
void
g_nullify_pointer (gpointer *nullify_location)
{
g_return_if_fail (nullify_location != NULL);
*nullify_location = NULL;
}
#define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
#define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
#define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
#define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
#define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
#define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
#define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
#define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
#define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
#define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
#define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
#define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
/**
* g_format_size:
* @size: a size in bytes
*
* Formats a size (for example the size of a file) into a human readable
* string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
* and are displayed rounded to the nearest tenth. E.g. the file size
* 3292528 bytes will be converted into the string "3.2 MB". The returned string
* is UTF-8, and may use a non-breaking space to separate the number and units,
* to ensure they aren’t separated when line wrapped.
*
* The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
*
* This string should be freed with g_free() when not needed any longer.
*
* See g_format_size_full() for more options about how the size might be
* formatted.
*
* Returns: (transfer full): a newly-allocated formatted string containing
* a human readable file size
*
* Since: 2.30
*/
gchar *
g_format_size (guint64 size)
{
return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
}
/**
* GFormatSizeFlags:
* @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
* @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
* of the returned string. For example, "45.6 kB (45,612 bytes)".
* @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
* suffixes. IEC units should only be used for reporting things with
* a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
* Network and storage sizes should be reported in the normal SI units.
* @G_FORMAT_SIZE_BITS: set the size as a quantity in bits, rather than
* bytes, and return units in bits. For example, ‘Mbit’ rather than ‘MB’.
* @G_FORMAT_SIZE_ONLY_VALUE: return only value, without unit; this should
* not be used together with @G_FORMAT_SIZE_LONG_FORMAT
* nor @G_FORMAT_SIZE_ONLY_UNIT. Since: 2.74
* @G_FORMAT_SIZE_ONLY_UNIT: return only unit, without value; this should
* not be used together with @G_FORMAT_SIZE_LONG_FORMAT
* nor @G_FORMAT_SIZE_ONLY_VALUE. Since: 2.74
*
* Flags to modify the format of the string returned by g_format_size_full().
*/
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
/**
* g_format_size_full:
* @size: a size in bytes
* @flags: #GFormatSizeFlags to modify the output
*
* Formats a size.
*
* This function is similar to g_format_size() but allows for flags
* that modify the output. See #GFormatSizeFlags.
*
* Returns: (transfer full): a newly-allocated formatted string
* containing a human readable file size
*
* Since: 2.30
*/
gchar *
g_format_size_full (guint64 size,
GFormatSizeFlags flags)
{
struct Format
{
guint64 factor;
char string[10];
};
typedef enum
{
FORMAT_BYTES,
FORMAT_BYTES_IEC,
FORMAT_BITS,
FORMAT_BITS_IEC
} FormatIndex;
const struct Format formats[4][6] = {
{
/* Translators: A unit symbol for size formatting, showing for example: "13.0 kB" */
{ KILOBYTE_FACTOR, N_("kB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 MB" */
{ MEGABYTE_FACTOR, N_("MB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 GB" */
{ GIGABYTE_FACTOR, N_("GB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 TB" */
{ TERABYTE_FACTOR, N_("TB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 PB" */
{ PETABYTE_FACTOR, N_("PB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 EB" */
{ EXABYTE_FACTOR, N_("EB") }
},
{
/* Translators: A unit symbol for size formatting, showing for example: "13.0 KiB" */
{ KIBIBYTE_FACTOR, N_("KiB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 MiB" */
{ MEBIBYTE_FACTOR, N_("MiB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 GiB" */
{ GIBIBYTE_FACTOR, N_("GiB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 TiB" */
{ TEBIBYTE_FACTOR, N_("TiB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 PiB" */
{ PEBIBYTE_FACTOR, N_("PiB") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 EiB" */
{ EXBIBYTE_FACTOR, N_("EiB") }
},
{
/* Translators: A unit symbol for size formatting, showing for example: "13.0 kbit" */
{ KILOBYTE_FACTOR, N_("kbit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Mbit" */
{ MEGABYTE_FACTOR, N_("Mbit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Gbit" */
{ GIGABYTE_FACTOR, N_("Gbit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Tbit" */
{ TERABYTE_FACTOR, N_("Tbit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Pbit" */
{ PETABYTE_FACTOR, N_("Pbit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Ebit" */
{ EXABYTE_FACTOR, N_("Ebit") }
},
{
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Kibit" */
{ KIBIBYTE_FACTOR, N_("Kibit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Mibit" */
{ MEBIBYTE_FACTOR, N_("Mibit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Gibit" */
{ GIBIBYTE_FACTOR, N_("Gibit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Tibit" */
{ TEBIBYTE_FACTOR, N_("Tibit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Pibit" */
{ PEBIBYTE_FACTOR, N_("Pibit") },
/* Translators: A unit symbol for size formatting, showing for example: "13.0 Eibit" */
{ EXBIBYTE_FACTOR, N_("Eibit") }
}
};
GString *string;
FormatIndex index;
g_return_val_if_fail ((flags & (G_FORMAT_SIZE_LONG_FORMAT | G_FORMAT_SIZE_ONLY_VALUE)) != (G_FORMAT_SIZE_LONG_FORMAT | G_FORMAT_SIZE_ONLY_VALUE), NULL);
g_return_val_if_fail ((flags & (G_FORMAT_SIZE_LONG_FORMAT | G_FORMAT_SIZE_ONLY_UNIT)) != (G_FORMAT_SIZE_LONG_FORMAT | G_FORMAT_SIZE_ONLY_UNIT), NULL);
g_return_val_if_fail ((flags & (G_FORMAT_SIZE_ONLY_VALUE | G_FORMAT_SIZE_ONLY_UNIT)) != (G_FORMAT_SIZE_ONLY_VALUE | G_FORMAT_SIZE_ONLY_UNIT), NULL);
string = g_string_new (NULL);
switch (flags & ~(G_FORMAT_SIZE_LONG_FORMAT | G_FORMAT_SIZE_ONLY_VALUE | G_FORMAT_SIZE_ONLY_UNIT))
{
case G_FORMAT_SIZE_DEFAULT:
index = FORMAT_BYTES;
break;
case (G_FORMAT_SIZE_DEFAULT | G_FORMAT_SIZE_IEC_UNITS):
index = FORMAT_BYTES_IEC;
break;
case G_FORMAT_SIZE_BITS:
index = FORMAT_BITS;
break;
case (G_FORMAT_SIZE_BITS | G_FORMAT_SIZE_IEC_UNITS):
index = FORMAT_BITS_IEC;
break;
default:
g_assert_not_reached ();
}
if (size < formats[index][0].factor)
{
const char * units;
if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
{
units = g_dngettext (GETTEXT_PACKAGE, "byte", "bytes", (guint) size);
}
else
{
units = g_dngettext (GETTEXT_PACKAGE, "bit", "bits", (guint) size);
}
if ((flags & G_FORMAT_SIZE_ONLY_UNIT) != 0)
g_string_append (string, units);
else if ((flags & G_FORMAT_SIZE_ONLY_VALUE) != 0)
/* Translators: The "%u" is replaced with the size value, like "13"; it could
* be part of "13 bytes", but only the number is requested this time. */
g_string_printf (string, C_("format-size", "%u"), (guint) size);
else
{
/* Translators: The first "%u" is replaced with the value, the "%s" with a unit of the value.
* The order can be changed with "%$2s %$1u". An example: "13 bytes" */
g_string_printf (string, C_("format-size", "%u %s"), (guint) size, units);
}
flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
}
else
{
const gsize n = G_N_ELEMENTS (formats[index]);
const gchar * units;
gdouble value;
gsize i;
/*
* Point the last format (the highest unit) by default
* and then then scan all formats, starting with the 2nd one
* because the 1st is already managed by with the plural form
*/
const struct Format * f = &formats[index][n - 1];
for (i = 1; i < n; i++)
{
if (size < formats[index][i].factor)
{
f = &formats[index][i - 1];
break;
}
}
units = _(f->string);
value = (gdouble) size / (gdouble) f->factor;
if ((flags & G_FORMAT_SIZE_ONLY_UNIT) != 0)
g_string_append (string, units);
else if ((flags & G_FORMAT_SIZE_ONLY_VALUE) != 0)
/* Translators: The "%.1f" is replaced with the size value, like "13.0"; it could
* be part of "13.0 MB", but only the number is requested this time. */
g_string_printf (string, C_("format-size", "%.1f"), value);
else
{
/* Translators: The first "%.1f" is replaced with the value, the "%s" with a unit of the value.
* The order can be changed with "%$2s %$1.1f". Keep the no-break space between the value and
* the unit symbol. An example: "13.0 MB" */
g_string_printf (string, C_("format-size", "%.1f %s"), value, units);
}
}
if (flags & G_FORMAT_SIZE_LONG_FORMAT)
{
/* First problem: we need to use the number of bytes to decide on
* the plural form that is used for display, but the number of
* bytes potentially exceeds the size of a guint (which is what
* ngettext() takes).
*
* From a pragmatic standpoint, it seems that all known languages
* base plural forms on one or both of the following:
*
* - the lowest digits of the number
*
* - if the number if greater than some small value
*
* Here's how we fake it: Draw an arbitrary line at one thousand.
* If the number is below that, then fine. If it is above it,
* then we take the modulus of the number by one thousand (in
* order to keep the lowest digits) and add one thousand to that
* (in order to ensure that 1001 is not treated the same as 1).
*/
guint plural_form = size < 1000 ? size : size % 1000 + 1000;
/* Second problem: we need to translate the string "%u byte/bit" and
* "%u bytes/bits" for pluralisation, but the correct number format to
* use for a gsize is different depending on which architecture
* we're on.
*
* Solution: format the number separately and use "%s bytes/bits" on
* all platforms.
*/
const gchar *translated_format;
gchar *formatted_number;
if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
{
/* Translators: the %s in "%s bytes" will always be replaced by a number. */
translated_format = g_dngettext (GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
}
else
{
/* Translators: the %s in "%s bits" will always be replaced by a number. */
translated_format = g_dngettext (GETTEXT_PACKAGE, "%s bit", "%s bits", plural_form);
}
formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
g_string_append (string, " (");
g_string_append_printf (string, translated_format, formatted_number);
g_free (formatted_number);
g_string_append (string, ")");
}
return g_string_free (string, FALSE);
}
#pragma GCC diagnostic pop
/**
* g_format_size_for_display:
* @size: a size in bytes
*
* Formats a size (for example the size of a file) into a human
* readable string. Sizes are rounded to the nearest size prefix
* (KB, MB, GB) and are displayed rounded to the nearest tenth.
* E.g. the file size 3292528 bytes will be converted into the
* string "3.1 MB".
*
* The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
*
* This string should be freed with g_free() when not needed any longer.
*
* Returns: (transfer full): a newly-allocated formatted string
* containing a human readable file size
*
* Since: 2.16
*
* Deprecated:2.30: This function is broken due to its use of SI
* suffixes to denote IEC units. Use g_format_size() instead.
*/
gchar *
g_format_size_for_display (goffset size)
{
if (size < (goffset) KIBIBYTE_FACTOR)
return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
else
{
gdouble displayed_size;
if (size < (goffset) MEBIBYTE_FACTOR)
{
displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
/* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
* mean 1024 bytes. I am aware that 'KB' is not correct, but it has been preserved for reasons of
* compatibility. Users will not see this string unless a program is using this deprecated function.
* Please translate as literally as possible.
*/
return g_strdup_printf (_("%.1f KB"), displayed_size);
}
else if (size < (goffset) GIBIBYTE_FACTOR)
{
displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
return g_strdup_printf (_("%.1f MB"), displayed_size);
}
else if (size < (goffset) TEBIBYTE_FACTOR)
{
displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
return g_strdup_printf (_("%.1f GB"), displayed_size);
}
else if (size < (goffset) PEBIBYTE_FACTOR)
{
displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
return g_strdup_printf (_("%.1f TB"), displayed_size);
}
else if (size < (goffset) EXBIBYTE_FACTOR)
{
displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
return g_strdup_printf (_("%.1f PB"), displayed_size);
}
else
{
displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
return g_strdup_printf (_("%.1f EB"), displayed_size);
}
}
}
#if defined (G_OS_WIN32) && !defined (_WIN64)
/* Binary compatibility versions. Not for newly compiled code. */
_GLIB_EXTERN const gchar *g_get_user_name_utf8 (void);
_GLIB_EXTERN const gchar *g_get_real_name_utf8 (void);
_GLIB_EXTERN const gchar *g_get_home_dir_utf8 (void);
_GLIB_EXTERN const gchar *g_get_tmp_dir_utf8 (void);
_GLIB_EXTERN gchar *g_find_program_in_path_utf8 (const gchar *program);
gchar *
g_find_program_in_path_utf8 (const gchar *program)
{
return g_find_program_in_path (program);
}
const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
#endif
/* Private API:
*
* Returns %TRUE if the current process was executed as setuid
*/
gboolean
g_check_setuid (void)
{
#if defined(HAVE_SYS_AUXV_H) && defined(HAVE_GETAUXVAL) && defined(AT_SECURE)
unsigned long value;
int errsv;
errno = 0;
value = getauxval (AT_SECURE);
errsv = errno;
if (errsv)
g_error ("getauxval () failed: %s", g_strerror (errsv));
return value;
#elif defined(HAVE_ISSETUGID) && !defined(__ANDROID__)
/* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
/* Android had it in older versions but the new 64 bit ABI does not
* have it anymore, and some versions of the 32 bit ABI neither.
* https://code.google.com/p/android-developer-preview/issues/detail?id=168
*/
return issetugid ();
#elif defined(G_OS_UNIX)
uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
static gsize check_setuid_initialised;
static gboolean is_setuid;
if (g_once_init_enter (&check_setuid_initialised))
{
#ifdef HAVE_GETRESUID
/* These aren't in the header files, so we prototype them here.
*/
int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
if (getresuid (&ruid, &euid, &suid) != 0 ||
getresgid (&rgid, &egid, &sgid) != 0)
#endif /* HAVE_GETRESUID */
{
suid = ruid = getuid ();
sgid = rgid = getgid ();
euid = geteuid ();
egid = getegid ();
}
is_setuid = (ruid != euid || ruid != suid ||
rgid != egid || rgid != sgid);
g_once_init_leave (&check_setuid_initialised, 1);
}
return is_setuid;
#else
return FALSE;
#endif
}
#ifdef G_OS_WIN32
/**
* g_abort:
*
* A wrapper for the POSIX abort() function.
*
* On Windows it is a function that makes extra effort (including a call
* to abort()) to ensure that a debugger-catchable exception is thrown
* before the program terminates.
*
* See your C library manual for more details about abort().
*
* Since: 2.50
*/
void
g_abort (void)
{
/* One call to break the debugger
* We check if a debugger is actually attached to
* avoid a windows error reporting popup window
* when run in a test harness / on CI
*/
if (IsDebuggerPresent ())
DebugBreak ();
/* One call in case CRT changes its abort() behaviour */
abort ();
/* And one call to bind them all and terminate the program for sure */
ExitProcess (127);
}
#endif
|