1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626
|
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <qdebug.h>
#include "qplatformdefs.h"
#include "qsettings.h"
#include "qsettings_p.h"
#include "qcache.h"
#include "qfile.h"
#include "qdir.h"
#include "qfileinfo.h"
#include "qmutex.h"
#include "private/qlocking_p.h"
#include "qlibraryinfo.h"
#include "qtemporaryfile.h"
#include "qstandardpaths.h"
#include <qdatastream.h>
#if QT_CONFIG(textcodec)
# include "qtextcodec.h"
#endif
#ifndef QT_NO_GEOM_VARIANT
#include "qsize.h"
#include "qpoint.h"
#include "qrect.h"
#endif // !QT_NO_GEOM_VARIANT
#ifndef QT_BUILD_QMAKE
# include "qcoreapplication.h"
#endif
#ifndef QT_BOOTSTRAPPED
#include "qsavefile.h"
#include "qlockfile.h"
#endif
#ifdef Q_OS_VXWORKS
# include <ioLib.h>
#endif
#include <algorithm>
#include <stdlib.h>
#ifdef Q_OS_WIN // for homedirpath reading from registry
# include <qt_windows.h>
# ifndef Q_OS_WINRT
# include <shlobj.h>
# endif
#endif
#ifdef Q_OS_WINRT
#include <wrl.h>
#include <windows.foundation.h>
#include <windows.storage.h>
using namespace Microsoft::WRL;
using namespace Microsoft::WRL::Wrappers;
using namespace ABI::Windows::Foundation;
using namespace ABI::Windows::Storage;
#endif
#if defined(Q_OS_UNIX) && !defined(Q_OS_MAC) && !defined(Q_OS_ANDROID)
#define Q_XDG_PLATFORM
#endif
#if !defined(QT_NO_STANDARDPATHS) && (defined(Q_XDG_PLATFORM) || defined(QT_PLATFORM_UIKIT))
#define QSETTINGS_USE_QSTANDARDPATHS
#endif
// ************************************************************************
// QConfFile
/*
QConfFile objects are explicitly shared within the application.
This ensures that modification to the settings done through one
QSettings object are immediately reflected in other setting
objects of the same application.
*/
QT_BEGIN_NAMESPACE
struct QConfFileCustomFormat
{
QString extension;
QSettings::ReadFunc readFunc;
QSettings::WriteFunc writeFunc;
Qt::CaseSensitivity caseSensitivity;
};
Q_DECLARE_TYPEINFO(QConfFileCustomFormat, Q_MOVABLE_TYPE);
typedef QHash<QString, QConfFile *> ConfFileHash;
typedef QCache<QString, QConfFile> ConfFileCache;
namespace {
struct Path
{
// Note: Defining constructors explicitly because of buggy C++11
// implementation in MSVC (uniform initialization).
Path() {}
Path(const QString & p, bool ud) : path(p), userDefined(ud) {}
QString path;
bool userDefined; //!< true - user defined, overridden by setPath
};
}
typedef QHash<int, Path> PathHash;
typedef QVector<QConfFileCustomFormat> CustomFormatVector;
Q_GLOBAL_STATIC(ConfFileHash, usedHashFunc)
Q_GLOBAL_STATIC(ConfFileCache, unusedCacheFunc)
Q_GLOBAL_STATIC(PathHash, pathHashFunc)
Q_GLOBAL_STATIC(CustomFormatVector, customFormatVectorFunc)
static QBasicMutex settingsGlobalMutex;
static QSettings::Format globalDefaultFormat = QSettings::NativeFormat;
QConfFile::QConfFile(const QString &fileName, bool _userPerms)
: name(fileName), size(0), ref(1), userPerms(_userPerms)
{
usedHashFunc()->insert(name, this);
}
QConfFile::~QConfFile()
{
if (usedHashFunc())
usedHashFunc()->remove(name);
}
ParsedSettingsMap QConfFile::mergedKeyMap() const
{
ParsedSettingsMap result = originalKeys;
ParsedSettingsMap::const_iterator i;
for (i = removedKeys.begin(); i != removedKeys.end(); ++i)
result.remove(i.key());
for (i = addedKeys.begin(); i != addedKeys.end(); ++i)
result.insert(i.key(), i.value());
return result;
}
bool QConfFile::isWritable() const
{
QFileInfo fileInfo(name);
#ifndef QT_NO_TEMPORARYFILE
if (fileInfo.exists()) {
#endif
QFile file(name);
return file.open(QFile::ReadWrite);
#ifndef QT_NO_TEMPORARYFILE
} else {
// Create the directories to the file.
QDir dir(fileInfo.absolutePath());
if (!dir.exists()) {
if (!dir.mkpath(dir.absolutePath()))
return false;
}
// we use a temporary file to avoid race conditions
QTemporaryFile file(name);
return file.open();
}
#endif
}
QConfFile *QConfFile::fromName(const QString &fileName, bool _userPerms)
{
QString absPath = QFileInfo(fileName).absoluteFilePath();
ConfFileHash *usedHash = usedHashFunc();
ConfFileCache *unusedCache = unusedCacheFunc();
QConfFile *confFile = nullptr;
const auto locker = qt_scoped_lock(settingsGlobalMutex);
if (!(confFile = usedHash->value(absPath))) {
if ((confFile = unusedCache->take(absPath)))
usedHash->insert(absPath, confFile);
}
if (confFile) {
confFile->ref.ref();
return confFile;
}
return new QConfFile(absPath, _userPerms);
}
void QConfFile::clearCache()
{
const auto locker = qt_scoped_lock(settingsGlobalMutex);
unusedCacheFunc()->clear();
}
// ************************************************************************
// QSettingsPrivate
QSettingsPrivate::QSettingsPrivate(QSettings::Format format)
: format(format), scope(QSettings::UserScope /* nothing better to put */), iniCodec(nullptr), fallbacks(true),
pendingChanges(false), status(QSettings::NoError)
{
}
QSettingsPrivate::QSettingsPrivate(QSettings::Format format, QSettings::Scope scope,
const QString &organization, const QString &application)
: format(format), scope(scope), organizationName(organization), applicationName(application),
iniCodec(nullptr), fallbacks(true), pendingChanges(false), status(QSettings::NoError)
{
}
QSettingsPrivate::~QSettingsPrivate()
{
}
QString QSettingsPrivate::actualKey(const QString &key) const
{
QString n = normalizedKey(key);
Q_ASSERT_X(!n.isEmpty(), "QSettings", "empty key");
return groupPrefix + n;
}
/*
Returns a string that never starts nor ends with a slash (or an
empty string). Examples:
"foo" becomes "foo"
"/foo//bar///" becomes "foo/bar"
"///" becomes ""
This function is optimized to avoid a QString deep copy in the
common case where the key is already normalized.
*/
QString QSettingsPrivate::normalizedKey(const QString &key)
{
QString result = key;
int i = 0;
while (i < result.size()) {
while (result.at(i) == QLatin1Char('/')) {
result.remove(i, 1);
if (i == result.size())
goto after_loop;
}
while (result.at(i) != QLatin1Char('/')) {
++i;
if (i == result.size())
return result;
}
++i; // leave the slash alone
}
after_loop:
if (!result.isEmpty())
result.truncate(i - 1); // remove the trailing slash
return result;
}
// see also qsettings_win.cpp, qsettings_winrt.cpp and qsettings_mac.cpp
#if !defined(Q_OS_WIN) && !defined(Q_OS_MAC) && !defined(Q_OS_WASM)
QSettingsPrivate *QSettingsPrivate::create(QSettings::Format format, QSettings::Scope scope,
const QString &organization, const QString &application)
{
return new QConfFileSettingsPrivate(format, scope, organization, application);
}
#endif
#if !defined(Q_OS_WIN)
QSettingsPrivate *QSettingsPrivate::create(const QString &fileName, QSettings::Format format)
{
return new QConfFileSettingsPrivate(fileName, format);
}
#endif
void QSettingsPrivate::processChild(QStringRef key, ChildSpec spec, QStringList &result)
{
if (spec != AllKeys) {
int slashPos = key.indexOf(QLatin1Char('/'));
if (slashPos == -1) {
if (spec != ChildKeys)
return;
} else {
if (spec != ChildGroups)
return;
key.truncate(slashPos);
}
}
result.append(key.toString());
}
void QSettingsPrivate::beginGroupOrArray(const QSettingsGroup &group)
{
groupStack.push(group);
const QString name = group.name();
if (!name.isEmpty())
groupPrefix += name + QLatin1Char('/');
}
/*
We only set an error if there isn't one set already. This way the user always gets the
first error that occurred. We always allow clearing errors.
*/
void QSettingsPrivate::setStatus(QSettings::Status status) const
{
if (status == QSettings::NoError || this->status == QSettings::NoError)
this->status = status;
}
void QSettingsPrivate::update()
{
flush();
pendingChanges = false;
}
void QSettingsPrivate::requestUpdate()
{
if (!pendingChanges) {
pendingChanges = true;
#ifndef QT_NO_QOBJECT
Q_Q(QSettings);
QCoreApplication::postEvent(q, new QEvent(QEvent::UpdateRequest));
#else
update();
#endif
}
}
QStringList QSettingsPrivate::variantListToStringList(const QVariantList &l)
{
QStringList result;
result.reserve(l.count());
QVariantList::const_iterator it = l.constBegin();
for (; it != l.constEnd(); ++it)
result.append(variantToString(*it));
return result;
}
QVariant QSettingsPrivate::stringListToVariantList(const QStringList &l)
{
QStringList outStringList = l;
for (int i = 0; i < outStringList.count(); ++i) {
const QString &str = outStringList.at(i);
if (str.startsWith(QLatin1Char('@'))) {
if (str.length() >= 2 && str.at(1) == QLatin1Char('@')) {
outStringList[i].remove(0, 1);
} else {
QVariantList variantList;
const int stringCount = l.count();
variantList.reserve(stringCount);
for (int j = 0; j < stringCount; ++j)
variantList.append(stringToVariant(l.at(j)));
return variantList;
}
}
}
return outStringList;
}
QString QSettingsPrivate::variantToString(const QVariant &v)
{
QString result;
switch (v.userType()) {
case QMetaType::UnknownType:
result = QLatin1String("@Invalid()");
break;
case QMetaType::QByteArray: {
QByteArray a = v.toByteArray();
result = QLatin1String("@ByteArray(")
+ QLatin1String(a.constData(), a.size())
+ QLatin1Char(')');
break;
}
case QMetaType::QString:
case QMetaType::LongLong:
case QMetaType::ULongLong:
case QMetaType::Int:
case QMetaType::UInt:
case QMetaType::Bool:
case QMetaType::Double:
case QMetaType::QKeySequence: {
result = v.toString();
if (result.contains(QChar::Null))
result = QLatin1String("@String(") + result + QLatin1Char(')');
else if (result.startsWith(QLatin1Char('@')))
result.prepend(QLatin1Char('@'));
break;
}
#ifndef QT_NO_GEOM_VARIANT
case QMetaType::QRect: {
QRect r = qvariant_cast<QRect>(v);
result = QString::asprintf("@Rect(%d %d %d %d)", r.x(), r.y(), r.width(), r.height());
break;
}
case QMetaType::QSize: {
QSize s = qvariant_cast<QSize>(v);
result = QString::asprintf("@Size(%d %d)", s.width(), s.height());
break;
}
case QMetaType::QPoint: {
QPoint p = qvariant_cast<QPoint>(v);
result = QString::asprintf("@Point(%d %d)", p.x(), p.y());
break;
}
#endif // !QT_NO_GEOM_VARIANT
default: {
#ifndef QT_NO_DATASTREAM
QDataStream::Version version;
const char *typeSpec;
if (v.userType() == QMetaType::QDateTime) {
version = QDataStream::Qt_5_6;
typeSpec = "@DateTime(";
} else {
version = QDataStream::Qt_4_0;
typeSpec = "@Variant(";
}
QByteArray a;
{
QDataStream s(&a, QIODevice::WriteOnly);
s.setVersion(version);
s << v;
}
result = QLatin1String(typeSpec)
+ QLatin1String(a.constData(), a.size())
+ QLatin1Char(')');
#else
Q_ASSERT(!"QSettings: Cannot save custom types without QDataStream support");
#endif
break;
}
}
return result;
}
QVariant QSettingsPrivate::stringToVariant(const QString &s)
{
if (s.startsWith(QLatin1Char('@'))) {
if (s.endsWith(QLatin1Char(')'))) {
if (s.startsWith(QLatin1String("@ByteArray("))) {
return QVariant(s.midRef(11, s.size() - 12).toLatin1());
} else if (s.startsWith(QLatin1String("@String("))) {
return QVariant(s.midRef(8, s.size() - 9).toString());
} else if (s.startsWith(QLatin1String("@Variant("))
|| s.startsWith(QLatin1String("@DateTime("))) {
#ifndef QT_NO_DATASTREAM
QDataStream::Version version;
int offset;
if (s.at(1) == QLatin1Char('D')) {
version = QDataStream::Qt_5_6;
offset = 10;
} else {
version = QDataStream::Qt_4_0;
offset = 9;
}
QByteArray a = s.midRef(offset).toLatin1();
QDataStream stream(&a, QIODevice::ReadOnly);
stream.setVersion(version);
QVariant result;
stream >> result;
return result;
#else
Q_ASSERT(!"QSettings: Cannot load custom types without QDataStream support");
#endif
#ifndef QT_NO_GEOM_VARIANT
} else if (s.startsWith(QLatin1String("@Rect("))) {
QStringList args = QSettingsPrivate::splitArgs(s, 5);
if (args.size() == 4)
return QVariant(QRect(args[0].toInt(), args[1].toInt(), args[2].toInt(), args[3].toInt()));
} else if (s.startsWith(QLatin1String("@Size("))) {
QStringList args = QSettingsPrivate::splitArgs(s, 5);
if (args.size() == 2)
return QVariant(QSize(args[0].toInt(), args[1].toInt()));
} else if (s.startsWith(QLatin1String("@Point("))) {
QStringList args = QSettingsPrivate::splitArgs(s, 6);
if (args.size() == 2)
return QVariant(QPoint(args[0].toInt(), args[1].toInt()));
#endif
} else if (s == QLatin1String("@Invalid()")) {
return QVariant();
}
}
if (s.startsWith(QLatin1String("@@")))
return QVariant(s.mid(1));
}
return QVariant(s);
}
static const char hexDigits[] = "0123456789ABCDEF";
void QSettingsPrivate::iniEscapedKey(const QString &key, QByteArray &result)
{
result.reserve(result.length() + key.length() * 3 / 2);
for (int i = 0; i < key.size(); ++i) {
uint ch = key.at(i).unicode();
if (ch == '/') {
result += '\\';
} else if ((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') || (ch >= '0' && ch <= '9')
|| ch == '_' || ch == '-' || ch == '.') {
result += (char)ch;
} else if (ch <= 0xFF) {
result += '%';
result += hexDigits[ch / 16];
result += hexDigits[ch % 16];
} else {
result += "%U";
QByteArray hexCode;
for (int i = 0; i < 4; ++i) {
hexCode.prepend(hexDigits[ch % 16]);
ch >>= 4;
}
result += hexCode;
}
}
}
bool QSettingsPrivate::iniUnescapedKey(const QByteArray &key, int from, int to, QString &result)
{
bool lowercaseOnly = true;
int i = from;
result.reserve(result.length() + (to - from));
while (i < to) {
int ch = (uchar)key.at(i);
if (ch == '\\') {
result += QLatin1Char('/');
++i;
continue;
}
if (ch != '%' || i == to - 1) {
if (uint(ch - 'A') <= 'Z' - 'A') // only for ASCII
lowercaseOnly = false;
result += QLatin1Char(ch);
++i;
continue;
}
int numDigits = 2;
int firstDigitPos = i + 1;
ch = key.at(i + 1);
if (ch == 'U') {
++firstDigitPos;
numDigits = 4;
}
if (firstDigitPos + numDigits > to) {
result += QLatin1Char('%');
// ### missing U
++i;
continue;
}
bool ok;
ch = key.mid(firstDigitPos, numDigits).toInt(&ok, 16);
if (!ok) {
result += QLatin1Char('%');
// ### missing U
++i;
continue;
}
QChar qch(ch);
if (qch.isUpper())
lowercaseOnly = false;
result += qch;
i = firstDigitPos + numDigits;
}
return lowercaseOnly;
}
void QSettingsPrivate::iniEscapedString(const QString &str, QByteArray &result, QTextCodec *codec)
{
bool needsQuotes = false;
bool escapeNextIfDigit = false;
bool useCodec = codec && !str.startsWith(QLatin1String("@ByteArray("))
&& !str.startsWith(QLatin1String("@Variant("))
&& !str.startsWith(QLatin1String("@DateTime("));
int i;
int startPos = result.size();
result.reserve(startPos + str.size() * 3 / 2);
const QChar *unicode = str.unicode();
for (i = 0; i < str.size(); ++i) {
uint ch = unicode[i].unicode();
if (ch == ';' || ch == ',' || ch == '=')
needsQuotes = true;
if (escapeNextIfDigit
&& ((ch >= '0' && ch <= '9')
|| (ch >= 'a' && ch <= 'f')
|| (ch >= 'A' && ch <= 'F'))) {
result += "\\x" + QByteArray::number(ch, 16);
continue;
}
escapeNextIfDigit = false;
switch (ch) {
case '\0':
result += "\\0";
escapeNextIfDigit = true;
break;
case '\a':
result += "\\a";
break;
case '\b':
result += "\\b";
break;
case '\f':
result += "\\f";
break;
case '\n':
result += "\\n";
break;
case '\r':
result += "\\r";
break;
case '\t':
result += "\\t";
break;
case '\v':
result += "\\v";
break;
case '"':
case '\\':
result += '\\';
result += (char)ch;
break;
default:
if (ch <= 0x1F || (ch >= 0x7F && !useCodec)) {
result += "\\x" + QByteArray::number(ch, 16);
escapeNextIfDigit = true;
#if QT_CONFIG(textcodec)
} else if (useCodec) {
// slow
result += codec->fromUnicode(&unicode[i], 1);
#endif
} else {
result += (char)ch;
}
}
}
if (needsQuotes
|| (startPos < result.size() && (result.at(startPos) == ' '
|| result.at(result.size() - 1) == ' '))) {
result.insert(startPos, '"');
result += '"';
}
}
inline static void iniChopTrailingSpaces(QString &str, int limit)
{
int n = str.size() - 1;
QChar ch;
while (n >= limit && ((ch = str.at(n)) == QLatin1Char(' ') || ch == QLatin1Char('\t')))
str.truncate(n--);
}
void QSettingsPrivate::iniEscapedStringList(const QStringList &strs, QByteArray &result, QTextCodec *codec)
{
if (strs.isEmpty()) {
/*
We need to distinguish between empty lists and one-item
lists that contain an empty string. Ideally, we'd have a
@EmptyList() symbol but that would break compatibility
with Qt 4.0. @Invalid() stands for QVariant(), and
QVariant().toStringList() returns an empty QStringList,
so we're in good shape.
*/
result += "@Invalid()";
} else {
for (int i = 0; i < strs.size(); ++i) {
if (i != 0)
result += ", ";
iniEscapedString(strs.at(i), result, codec);
}
}
}
bool QSettingsPrivate::iniUnescapedStringList(const QByteArray &str, int from, int to,
QString &stringResult, QStringList &stringListResult,
QTextCodec *codec)
{
static const char escapeCodes[][2] =
{
{ 'a', '\a' },
{ 'b', '\b' },
{ 'f', '\f' },
{ 'n', '\n' },
{ 'r', '\r' },
{ 't', '\t' },
{ 'v', '\v' },
{ '"', '"' },
{ '?', '?' },
{ '\'', '\'' },
{ '\\', '\\' }
};
bool isStringList = false;
bool inQuotedString = false;
bool currentValueIsQuoted = false;
char16_t escapeVal = 0;
int i = from;
char ch;
StSkipSpaces:
while (i < to && ((ch = str.at(i)) == ' ' || ch == '\t'))
++i;
// fallthrough
StNormal:
int chopLimit = stringResult.length();
while (i < to) {
switch (str.at(i)) {
case '\\':
++i;
if (i >= to)
goto end;
ch = str.at(i++);
for (const auto &escapeCode : escapeCodes) {
if (ch == escapeCode[0]) {
stringResult += QLatin1Char(escapeCode[1]);
goto StNormal;
}
}
if (ch == 'x') {
escapeVal = 0;
if (i >= to)
goto end;
ch = str.at(i);
if ((ch >= '0' && ch <= '9') || (ch >= 'A' && ch <= 'F') || (ch >= 'a' && ch <= 'f'))
goto StHexEscape;
} else if (ch >= '0' && ch <= '7') {
escapeVal = ch - '0';
goto StOctEscape;
} else if (ch == '\n' || ch == '\r') {
if (i < to) {
char ch2 = str.at(i);
// \n, \r, \r\n, and \n\r are legitimate line terminators in INI files
if ((ch2 == '\n' || ch2 == '\r') && ch2 != ch)
++i;
}
} else {
// the character is skipped
}
chopLimit = stringResult.length();
break;
case '"':
++i;
currentValueIsQuoted = true;
inQuotedString = !inQuotedString;
if (!inQuotedString)
goto StSkipSpaces;
break;
case ',':
if (!inQuotedString) {
if (!currentValueIsQuoted)
iniChopTrailingSpaces(stringResult, chopLimit);
if (!isStringList) {
isStringList = true;
stringListResult.clear();
stringResult.squeeze();
}
stringListResult.append(stringResult);
stringResult.clear();
currentValueIsQuoted = false;
++i;
goto StSkipSpaces;
}
Q_FALLTHROUGH();
default: {
int j = i + 1;
while (j < to) {
ch = str.at(j);
if (ch == '\\' || ch == '"' || ch == ',')
break;
++j;
}
#if !QT_CONFIG(textcodec)
Q_UNUSED(codec)
#else
if (codec) {
stringResult += codec->toUnicode(str.constData() + i, j - i);
} else
#endif
{
int n = stringResult.size();
stringResult.resize(n + (j - i));
QChar *resultData = stringResult.data() + n;
for (int k = i; k < j; ++k)
*resultData++ = QLatin1Char(str.at(k));
}
i = j;
}
}
}
if (!currentValueIsQuoted)
iniChopTrailingSpaces(stringResult, chopLimit);
goto end;
StHexEscape:
if (i >= to) {
stringResult += QChar(escapeVal);
goto end;
}
ch = str.at(i);
if (ch >= 'a')
ch -= 'a' - 'A';
if ((ch >= '0' && ch <= '9') || (ch >= 'A' && ch <= 'F')) {
escapeVal <<= 4;
escapeVal += strchr(hexDigits, ch) - hexDigits;
++i;
goto StHexEscape;
} else {
stringResult += QChar(escapeVal);
goto StNormal;
}
StOctEscape:
if (i >= to) {
stringResult += QChar(escapeVal);
goto end;
}
ch = str.at(i);
if (ch >= '0' && ch <= '7') {
escapeVal <<= 3;
escapeVal += ch - '0';
++i;
goto StOctEscape;
} else {
stringResult += QChar(escapeVal);
goto StNormal;
}
end:
if (isStringList)
stringListResult.append(stringResult);
return isStringList;
}
QStringList QSettingsPrivate::splitArgs(const QString &s, int idx)
{
int l = s.length();
Q_ASSERT(l > 0);
Q_ASSERT(s.at(idx) == QLatin1Char('('));
Q_ASSERT(s.at(l - 1) == QLatin1Char(')'));
QStringList result;
QString item;
for (++idx; idx < l; ++idx) {
QChar c = s.at(idx);
if (c == QLatin1Char(')')) {
Q_ASSERT(idx == l - 1);
result.append(item);
} else if (c == QLatin1Char(' ')) {
result.append(item);
item.clear();
} else {
item.append(c);
}
}
return result;
}
// ************************************************************************
// QConfFileSettingsPrivate
void QConfFileSettingsPrivate::initFormat()
{
extension = (format == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini");
readFunc = nullptr;
writeFunc = nullptr;
#if defined(Q_OS_MAC)
caseSensitivity = (format == QSettings::NativeFormat) ? Qt::CaseSensitive : IniCaseSensitivity;
#else
caseSensitivity = IniCaseSensitivity;
#endif
if (format > QSettings::IniFormat) {
const auto locker = qt_scoped_lock(settingsGlobalMutex);
const CustomFormatVector *customFormatVector = customFormatVectorFunc();
int i = (int)format - (int)QSettings::CustomFormat1;
if (i >= 0 && i < customFormatVector->size()) {
QConfFileCustomFormat info = customFormatVector->at(i);
extension = info.extension;
readFunc = info.readFunc;
writeFunc = info.writeFunc;
caseSensitivity = info.caseSensitivity;
}
}
}
void QConfFileSettingsPrivate::initAccess()
{
if (!confFiles.isEmpty()) {
if (format > QSettings::IniFormat) {
if (!readFunc)
setStatus(QSettings::AccessError);
}
}
sync(); // loads the files the first time
}
#if defined(Q_OS_WIN) && !defined(Q_OS_WINRT)
static QString windowsConfigPath(const KNOWNFOLDERID &type)
{
QString result;
PWSTR path = nullptr;
if (SHGetKnownFolderPath(type, KF_FLAG_DONT_VERIFY, NULL, &path) == S_OK) {
result = QString::fromWCharArray(path);
CoTaskMemFree(path);
}
if (result.isEmpty()) {
if (type == FOLDERID_ProgramData) {
result = QLatin1String("C:\\temp\\qt-common");
} else if (type == FOLDERID_RoamingAppData) {
result = QLatin1String("C:\\temp\\qt-user");
}
}
return result;
}
#elif defined(Q_OS_WINRT) // Q_OS_WIN && !Q_OS_WINRT
enum ConfigPathType {
ConfigPath_CommonAppData,
ConfigPath_UserAppData
};
static QString windowsConfigPath(ConfigPathType type)
{
static QString result;
while (result.isEmpty()) {
ComPtr<IApplicationDataStatics> applicationDataStatics;
if (FAILED(GetActivationFactory(HString::MakeReference(RuntimeClass_Windows_Storage_ApplicationData).Get(), &applicationDataStatics)))
return result;
ComPtr<IApplicationData> applicationData;
if (FAILED(applicationDataStatics->get_Current(&applicationData)))
return result;
ComPtr<IStorageFolder> localFolder;
if (FAILED(applicationData->get_LocalFolder(&localFolder)))
return result;
ComPtr<IStorageItem> localFolderItem;
if (FAILED(localFolder.As(&localFolderItem)))
return result;
HString path;
if (FAILED(localFolderItem->get_Path(path.GetAddressOf())))
return result;
result = QString::fromWCharArray(path.GetRawBuffer(nullptr));
}
switch (type) {
case ConfigPath_CommonAppData:
return result + QLatin1String("\\qt-common");
case ConfigPath_UserAppData:
return result + QLatin1String("\\qt-user");
}
return result;
}
#endif // Q_OS_WINRT
static inline int pathHashKey(QSettings::Format format, QSettings::Scope scope)
{
return int((uint(format) << 1) | uint(scope == QSettings::SystemScope));
}
#ifndef Q_OS_WIN
static QString make_user_path()
{
static Q_CONSTEXPR QChar sep = QLatin1Char('/');
#ifndef QSETTINGS_USE_QSTANDARDPATHS
// Non XDG platforms (OS X, iOS, Android...) have used this code path erroneously
// for some time now. Moving away from that would require migrating existing settings.
QByteArray env = qgetenv("XDG_CONFIG_HOME");
if (env.isEmpty()) {
return QDir::homePath() + QLatin1String("/.config/");
} else if (env.startsWith('/')) {
return QFile::decodeName(env) + sep;
} else {
return QDir::homePath() + sep + QFile::decodeName(env) + sep;
}
#else
// When using a proper XDG platform, use QStandardPaths rather than the above hand-written code;
// it makes the use of test mode from unit tests possible.
// Ideally all platforms should use this, but see above for the migration issue.
return QStandardPaths::writableLocation(QStandardPaths::GenericConfigLocation) + sep;
#endif
}
#endif // !Q_OS_WIN
static std::unique_lock<QBasicMutex> initDefaultPaths(std::unique_lock<QBasicMutex> locker)
{
PathHash *pathHash = pathHashFunc();
locker.unlock();
/*
QLibraryInfo::location() uses QSettings, so in order to
avoid a dead-lock, we can't hold the global mutex while
calling it.
*/
QString systemPath = QLibraryInfo::location(QLibraryInfo::SettingsPath) + QLatin1Char('/');
locker.lock();
if (pathHash->isEmpty()) {
/*
Lazy initialization of pathHash. We initialize the
IniFormat paths and (on Unix) the NativeFormat paths.
(The NativeFormat paths are not configurable for the
Windows registry and the Mac CFPreferences.)
*/
#ifdef Q_OS_WIN
# ifdef Q_OS_WINRT
const QString roamingAppDataFolder = windowsConfigPath(ConfigPath_UserAppData);
const QString programDataFolder = windowsConfigPath(ConfigPath_CommonAppData);
# else
const QString roamingAppDataFolder = windowsConfigPath(FOLDERID_RoamingAppData);
const QString programDataFolder = windowsConfigPath(FOLDERID_ProgramData);
# endif
pathHash->insert(pathHashKey(QSettings::IniFormat, QSettings::UserScope),
Path(roamingAppDataFolder + QDir::separator(), false));
pathHash->insert(pathHashKey(QSettings::IniFormat, QSettings::SystemScope),
Path(programDataFolder + QDir::separator(), false));
#else
const QString userPath = make_user_path();
pathHash->insert(pathHashKey(QSettings::IniFormat, QSettings::UserScope), Path(userPath, false));
pathHash->insert(pathHashKey(QSettings::IniFormat, QSettings::SystemScope), Path(systemPath, false));
#ifndef Q_OS_MAC
pathHash->insert(pathHashKey(QSettings::NativeFormat, QSettings::UserScope), Path(userPath, false));
pathHash->insert(pathHashKey(QSettings::NativeFormat, QSettings::SystemScope), Path(systemPath, false));
#endif
#endif // Q_OS_WIN
}
return locker;
}
static Path getPath(QSettings::Format format, QSettings::Scope scope)
{
Q_ASSERT((int)QSettings::NativeFormat == 0);
Q_ASSERT((int)QSettings::IniFormat == 1);
auto locker = qt_unique_lock(settingsGlobalMutex);
PathHash *pathHash = pathHashFunc();
if (pathHash->isEmpty())
locker = initDefaultPaths(std::move(locker));
Path result = pathHash->value(pathHashKey(format, scope));
if (!result.path.isEmpty())
return result;
// fall back on INI path
return pathHash->value(pathHashKey(QSettings::IniFormat, scope));
}
#if defined(QT_BUILD_INTERNAL) && defined(Q_XDG_PLATFORM) && !defined(QT_NO_STANDARDPATHS)
// Note: Suitable only for autotests.
void Q_AUTOTEST_EXPORT clearDefaultPaths()
{
const auto locker = qt_scoped_lock(settingsGlobalMutex);
pathHashFunc()->clear();
}
#endif // QT_BUILD_INTERNAL && Q_XDG_PLATFORM && !QT_NO_STANDARDPATHS
QConfFileSettingsPrivate::QConfFileSettingsPrivate(QSettings::Format format,
QSettings::Scope scope,
const QString &organization,
const QString &application)
: QSettingsPrivate(format, scope, organization, application),
nextPosition(0x40000000) // big positive number
{
initFormat();
QString org = organization;
if (org.isEmpty()) {
setStatus(QSettings::AccessError);
org = QLatin1String("Unknown Organization");
}
QString appFile = org + QDir::separator() + application + extension;
QString orgFile = org + extension;
if (scope == QSettings::UserScope) {
Path userPath = getPath(format, QSettings::UserScope);
if (!application.isEmpty())
confFiles.append(QConfFile::fromName(userPath.path + appFile, true));
confFiles.append(QConfFile::fromName(userPath.path + orgFile, true));
}
Path systemPath = getPath(format, QSettings::SystemScope);
#if defined(Q_XDG_PLATFORM) && !defined(QT_NO_STANDARDPATHS)
// check if the systemPath wasn't overridden by QSettings::setPath()
if (!systemPath.userDefined) {
// Note: We can't use QStandardPaths::locateAll() as we need all the
// possible files (not just the existing ones) and there is no way
// to exclude user specific (XDG_CONFIG_HOME) directory from the search.
QStringList dirs = QStandardPaths::standardLocations(QStandardPaths::GenericConfigLocation);
// remove the QStandardLocation::writableLocation() (XDG_CONFIG_HOME)
if (!dirs.isEmpty())
dirs.takeFirst();
QStringList paths;
if (!application.isEmpty()) {
paths.reserve(dirs.size() * 2);
for (const auto &dir : qAsConst(dirs))
paths.append(dir + QLatin1Char('/') + appFile);
} else {
paths.reserve(dirs.size());
}
for (const auto &dir : qAsConst(dirs))
paths.append(dir + QLatin1Char('/') + orgFile);
// Note: No check for existence of files is done intentionaly.
for (const auto &path : qAsConst(paths))
confFiles.append(QConfFile::fromName(path, false));
} else
#endif // Q_XDG_PLATFORM && !QT_NO_STANDARDPATHS
{
if (!application.isEmpty())
confFiles.append(QConfFile::fromName(systemPath.path + appFile, false));
confFiles.append(QConfFile::fromName(systemPath.path + orgFile, false));
}
#ifndef Q_OS_WASM // wasm needs to delay access until after file sync
initAccess();
#endif
}
QConfFileSettingsPrivate::QConfFileSettingsPrivate(const QString &fileName,
QSettings::Format format)
: QSettingsPrivate(format),
nextPosition(0x40000000) // big positive number
{
initFormat();
confFiles.append(QConfFile::fromName(fileName, true));
initAccess();
}
QConfFileSettingsPrivate::~QConfFileSettingsPrivate()
{
const auto locker = qt_scoped_lock(settingsGlobalMutex);
ConfFileHash *usedHash = usedHashFunc();
ConfFileCache *unusedCache = unusedCacheFunc();
for (auto conf_file : qAsConst(confFiles)) {
if (!conf_file->ref.deref()) {
if (conf_file->size == 0) {
delete conf_file;
} else {
if (usedHash)
usedHash->remove(conf_file->name);
if (unusedCache) {
QT_TRY {
// compute a better size?
unusedCache->insert(conf_file->name, conf_file,
10 + (conf_file->originalKeys.size() / 4));
} QT_CATCH(...) {
// out of memory. Do not cache the file.
delete conf_file;
}
} else {
// unusedCache is gone - delete the entry to prevent a memory leak
delete conf_file;
}
}
}
}
}
void QConfFileSettingsPrivate::remove(const QString &key)
{
if (confFiles.isEmpty())
return;
// Note: First config file is always the most specific.
QConfFile *confFile = confFiles.at(0);
QSettingsKey theKey(key, caseSensitivity);
QSettingsKey prefix(key + QLatin1Char('/'), caseSensitivity);
const auto locker = qt_scoped_lock(confFile->mutex);
ensureSectionParsed(confFile, theKey);
ensureSectionParsed(confFile, prefix);
ParsedSettingsMap::iterator i = confFile->addedKeys.lowerBound(prefix);
while (i != confFile->addedKeys.end() && i.key().startsWith(prefix))
i = confFile->addedKeys.erase(i);
confFile->addedKeys.remove(theKey);
ParsedSettingsMap::const_iterator j = const_cast<const ParsedSettingsMap *>(&confFile->originalKeys)->lowerBound(prefix);
while (j != confFile->originalKeys.constEnd() && j.key().startsWith(prefix)) {
confFile->removedKeys.insert(j.key(), QVariant());
++j;
}
if (confFile->originalKeys.contains(theKey))
confFile->removedKeys.insert(theKey, QVariant());
}
void QConfFileSettingsPrivate::set(const QString &key, const QVariant &value)
{
if (confFiles.isEmpty())
return;
// Note: First config file is always the most specific.
QConfFile *confFile = confFiles.at(0);
QSettingsKey theKey(key, caseSensitivity, nextPosition++);
const auto locker = qt_scoped_lock(confFile->mutex);
confFile->removedKeys.remove(theKey);
confFile->addedKeys.insert(theKey, value);
}
bool QConfFileSettingsPrivate::get(const QString &key, QVariant *value) const
{
QSettingsKey theKey(key, caseSensitivity);
ParsedSettingsMap::const_iterator j;
bool found = false;
for (auto confFile : qAsConst(confFiles)) {
const auto locker = qt_scoped_lock(confFile->mutex);
if (!confFile->addedKeys.isEmpty()) {
j = confFile->addedKeys.constFind(theKey);
found = (j != confFile->addedKeys.constEnd());
}
if (!found) {
ensureSectionParsed(confFile, theKey);
j = confFile->originalKeys.constFind(theKey);
found = (j != confFile->originalKeys.constEnd()
&& !confFile->removedKeys.contains(theKey));
}
if (found && value)
*value = *j;
if (found)
return true;
if (!fallbacks)
break;
}
return false;
}
QStringList QConfFileSettingsPrivate::children(const QString &prefix, ChildSpec spec) const
{
QStringList result;
ParsedSettingsMap::const_iterator j;
QSettingsKey thePrefix(prefix, caseSensitivity);
int startPos = prefix.size();
for (auto confFile : qAsConst(confFiles)) {
const auto locker = qt_scoped_lock(confFile->mutex);
if (thePrefix.isEmpty())
ensureAllSectionsParsed(confFile);
else
ensureSectionParsed(confFile, thePrefix);
j = const_cast<const ParsedSettingsMap *>(
&confFile->originalKeys)->lowerBound( thePrefix);
while (j != confFile->originalKeys.constEnd() && j.key().startsWith(thePrefix)) {
if (!confFile->removedKeys.contains(j.key()))
processChild(j.key().originalCaseKey().midRef(startPos), spec, result);
++j;
}
j = const_cast<const ParsedSettingsMap *>(
&confFile->addedKeys)->lowerBound(thePrefix);
while (j != confFile->addedKeys.constEnd() && j.key().startsWith(thePrefix)) {
processChild(j.key().originalCaseKey().midRef(startPos), spec, result);
++j;
}
if (!fallbacks)
break;
}
std::sort(result.begin(), result.end());
result.erase(std::unique(result.begin(), result.end()),
result.end());
return result;
}
void QConfFileSettingsPrivate::clear()
{
if (confFiles.isEmpty())
return;
// Note: First config file is always the most specific.
QConfFile *confFile = confFiles.at(0);
const auto locker = qt_scoped_lock(confFile->mutex);
ensureAllSectionsParsed(confFile);
confFile->addedKeys.clear();
confFile->removedKeys = confFile->originalKeys;
}
void QConfFileSettingsPrivate::sync()
{
// people probably won't be checking the status a whole lot, so in case of
// error we just try to go on and make the best of it
for (auto confFile : qAsConst(confFiles)) {
const auto locker = qt_scoped_lock(confFile->mutex);
syncConfFile(confFile);
}
}
void QConfFileSettingsPrivate::flush()
{
sync();
}
QString QConfFileSettingsPrivate::fileName() const
{
if (confFiles.isEmpty())
return QString();
// Note: First config file is always the most specific.
return confFiles.at(0)->name;
}
bool QConfFileSettingsPrivate::isWritable() const
{
if (format > QSettings::IniFormat && !writeFunc)
return false;
if (confFiles.isEmpty())
return false;
return confFiles.at(0)->isWritable();
}
void QConfFileSettingsPrivate::syncConfFile(QConfFile *confFile)
{
bool readOnly = confFile->addedKeys.isEmpty() && confFile->removedKeys.isEmpty();
/*
We can often optimize the read-only case, if the file on disk
hasn't changed.
*/
if (readOnly && confFile->size > 0) {
QFileInfo fileInfo(confFile->name);
if (confFile->size == fileInfo.size() && confFile->timeStamp == fileInfo.lastModified())
return;
}
if (!readOnly && !confFile->isWritable()) {
setStatus(QSettings::AccessError);
return;
}
#ifndef QT_BOOTSTRAPPED
/*
Use a lockfile in order to protect us against other QSettings instances
trying to write the same settings at the same time.
We only need to lock if we are actually writing as only concurrent writes are a problem.
Concurrent read and write are not a problem because the writing operation is atomic.
*/
QLockFile lockFile(confFile->name + QLatin1String(".lock"));
if (!readOnly && !lockFile.lock() && atomicSyncOnly) {
setStatus(QSettings::AccessError);
return;
}
#endif
/*
We hold the lock. Let's reread the file if it has changed
since last time we read it.
*/
QFileInfo fileInfo(confFile->name);
bool mustReadFile = true;
bool createFile = !fileInfo.exists();
if (!readOnly)
mustReadFile = (confFile->size != fileInfo.size()
|| (confFile->size != 0 && confFile->timeStamp != fileInfo.lastModified()));
if (mustReadFile) {
confFile->unparsedIniSections.clear();
confFile->originalKeys.clear();
QFile file(confFile->name);
if (!createFile && !file.open(QFile::ReadOnly)) {
setStatus(QSettings::AccessError);
return;
}
/*
Files that we can't read (because of permissions or
because they don't exist) are treated as empty files.
*/
if (file.isReadable() && file.size() != 0) {
bool ok = false;
#ifdef Q_OS_MAC
if (format == QSettings::NativeFormat) {
QByteArray data = file.readAll();
ok = readPlistFile(data, &confFile->originalKeys);
} else
#endif
if (format <= QSettings::IniFormat) {
QByteArray data = file.readAll();
ok = readIniFile(data, &confFile->unparsedIniSections);
} else if (readFunc) {
QSettings::SettingsMap tempNewKeys;
ok = readFunc(file, tempNewKeys);
if (ok) {
QSettings::SettingsMap::const_iterator i = tempNewKeys.constBegin();
while (i != tempNewKeys.constEnd()) {
confFile->originalKeys.insert(QSettingsKey(i.key(), caseSensitivity),
i.value());
++i;
}
}
}
if (!ok)
setStatus(QSettings::FormatError);
}
confFile->size = fileInfo.size();
confFile->timeStamp = fileInfo.lastModified();
}
/*
We also need to save the file. We still hold the file lock,
so everything is under control.
*/
if (!readOnly) {
bool ok = false;
ensureAllSectionsParsed(confFile);
ParsedSettingsMap mergedKeys = confFile->mergedKeyMap();
#if !defined(QT_BOOTSTRAPPED) && QT_CONFIG(temporaryfile)
QSaveFile sf(confFile->name);
sf.setDirectWriteFallback(!atomicSyncOnly);
#else
QFile sf(confFile->name);
#endif
if (!sf.open(QIODevice::WriteOnly)) {
setStatus(QSettings::AccessError);
return;
}
#ifdef Q_OS_MAC
if (format == QSettings::NativeFormat) {
ok = writePlistFile(sf, mergedKeys);
} else
#endif
if (format <= QSettings::IniFormat) {
ok = writeIniFile(sf, mergedKeys);
} else if (writeFunc) {
QSettings::SettingsMap tempOriginalKeys;
ParsedSettingsMap::const_iterator i = mergedKeys.constBegin();
while (i != mergedKeys.constEnd()) {
tempOriginalKeys.insert(i.key(), i.value());
++i;
}
ok = writeFunc(sf, tempOriginalKeys);
}
#if !defined(QT_BOOTSTRAPPED) && QT_CONFIG(temporaryfile)
if (ok)
ok = sf.commit();
#endif
if (ok) {
confFile->unparsedIniSections.clear();
confFile->originalKeys = mergedKeys;
confFile->addedKeys.clear();
confFile->removedKeys.clear();
QFileInfo fileInfo(confFile->name);
confFile->size = fileInfo.size();
confFile->timeStamp = fileInfo.lastModified();
// If we have created the file, apply the file perms
if (createFile) {
QFile::Permissions perms = fileInfo.permissions() | QFile::ReadOwner | QFile::WriteOwner;
if (!confFile->userPerms)
perms |= QFile::ReadGroup | QFile::ReadOther;
QFile(confFile->name).setPermissions(perms);
}
} else {
setStatus(QSettings::AccessError);
}
}
}
enum { Space = 0x1, Special = 0x2 };
static const char charTraits[256] =
{
// Space: '\t', '\n', '\r', ' '
// Special: '\n', '\r', '"', ';', '=', '\\'
0, 0, 0, 0, 0, 0, 0, 0, 0, Space, Space | Special, 0, 0, Space | Special, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
Space, 0, Special, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, Special, 0, Special, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, Special, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
};
bool QConfFileSettingsPrivate::readIniLine(const QByteArray &data, int &dataPos,
int &lineStart, int &lineLen, int &equalsPos)
{
int dataLen = data.length();
bool inQuotes = false;
equalsPos = -1;
lineStart = dataPos;
while (lineStart < dataLen && (charTraits[uint(uchar(data.at(lineStart)))] & Space))
++lineStart;
int i = lineStart;
while (i < dataLen) {
char ch = data.at(i);
while (!(charTraits[uchar(ch)] & Special)) {
if (++i == dataLen)
goto break_out_of_outer_loop;
ch = data.at(i);
}
++i;
if (ch == '=') {
if (!inQuotes && equalsPos == -1)
equalsPos = i - 1;
} else if (ch == '\n' || ch == '\r') {
if (i == lineStart + 1) {
++lineStart;
} else if (!inQuotes) {
--i;
goto break_out_of_outer_loop;
}
} else if (ch == '\\') {
if (i < dataLen) {
char ch = data.at(i++);
if (i < dataLen) {
char ch2 = data.at(i);
// \n, \r, \r\n, and \n\r are legitimate line terminators in INI files
if ((ch == '\n' && ch2 == '\r') || (ch == '\r' && ch2 == '\n'))
++i;
}
}
} else if (ch == '"') {
inQuotes = !inQuotes;
} else {
Q_ASSERT(ch == ';');
if (i == lineStart + 1) {
while (i < dataLen && (((ch = data.at(i)) != '\n') && ch != '\r'))
++i;
while (i < dataLen && charTraits[uchar(data.at(i))] & Space)
++i;
lineStart = i;
} else if (!inQuotes) {
--i;
goto break_out_of_outer_loop;
}
}
}
break_out_of_outer_loop:
dataPos = i;
lineLen = i - lineStart;
return lineLen > 0;
}
/*
Returns \c false on parse error. However, as many keys are read as
possible, so if the user doesn't check the status he will get the
most out of the file anyway.
*/
bool QConfFileSettingsPrivate::readIniFile(const QByteArray &data,
UnparsedSettingsMap *unparsedIniSections)
{
#define FLUSH_CURRENT_SECTION() \
{ \
QByteArray §ionData = (*unparsedIniSections)[QSettingsKey(currentSection, \
IniCaseSensitivity, \
sectionPosition)]; \
if (!sectionData.isEmpty()) \
sectionData.append('\n'); \
sectionData += data.mid(currentSectionStart, lineStart - currentSectionStart); \
sectionPosition = ++position; \
}
QString currentSection;
int currentSectionStart = 0;
int dataPos = 0;
int lineStart;
int lineLen;
int equalsPos;
int position = 0;
int sectionPosition = 0;
bool ok = true;
// detect utf8 BOM
const uchar *dd = (const uchar *)data.constData();
if (data.size() >= 3 && dd[0] == 0xef && dd[1] == 0xbb && dd[2] == 0xbf) {
#if QT_CONFIG(textcodec)
iniCodec = QTextCodec::codecForName("UTF-8");
#else
ok = false;
#endif
dataPos = 3;
}
while (readIniLine(data, dataPos, lineStart, lineLen, equalsPos)) {
char ch = data.at(lineStart);
if (ch == '[') {
FLUSH_CURRENT_SECTION();
// this is a section
QByteArray iniSection;
int idx = data.indexOf(']', lineStart);
if (idx == -1 || idx >= lineStart + lineLen) {
ok = false;
iniSection = data.mid(lineStart + 1, lineLen - 1);
} else {
iniSection = data.mid(lineStart + 1, idx - lineStart - 1);
}
iniSection = iniSection.trimmed();
if (iniSection.compare("general", Qt::CaseInsensitive) == 0) {
currentSection.clear();
} else {
if (iniSection.compare("%general", Qt::CaseInsensitive) == 0) {
currentSection = QLatin1String(iniSection.constData() + 1);
} else {
currentSection.clear();
iniUnescapedKey(iniSection, 0, iniSection.size(), currentSection);
}
currentSection += QLatin1Char('/');
}
currentSectionStart = dataPos;
}
++position;
}
Q_ASSERT(lineStart == data.length());
FLUSH_CURRENT_SECTION();
return ok;
#undef FLUSH_CURRENT_SECTION
}
bool QConfFileSettingsPrivate::readIniSection(const QSettingsKey §ion, const QByteArray &data,
ParsedSettingsMap *settingsMap, QTextCodec *codec)
{
QStringList strListValue;
bool sectionIsLowercase = (section == section.originalCaseKey());
int equalsPos;
bool ok = true;
int dataPos = 0;
int lineStart;
int lineLen;
int position = section.originalKeyPosition();
while (readIniLine(data, dataPos, lineStart, lineLen, equalsPos)) {
char ch = data.at(lineStart);
Q_ASSERT(ch != '[');
if (equalsPos == -1) {
if (ch != ';')
ok = false;
continue;
}
int keyEnd = equalsPos;
while (keyEnd > lineStart && ((ch = data.at(keyEnd - 1)) == ' ' || ch == '\t'))
--keyEnd;
int valueStart = equalsPos + 1;
QString key = section.originalCaseKey();
bool keyIsLowercase = (iniUnescapedKey(data, lineStart, keyEnd, key) && sectionIsLowercase);
QString strValue;
strValue.reserve(lineLen - (valueStart - lineStart));
bool isStringList = iniUnescapedStringList(data, valueStart, lineStart + lineLen,
strValue, strListValue, codec);
QVariant variant;
if (isStringList) {
variant = stringListToVariantList(strListValue);
} else {
variant = stringToVariant(strValue);
}
/*
We try to avoid the expensive toLower() call in
QSettingsKey by passing Qt::CaseSensitive when the
key is already in lowercase.
*/
settingsMap->insert(QSettingsKey(key, keyIsLowercase ? Qt::CaseSensitive
: IniCaseSensitivity,
position),
variant);
++position;
}
return ok;
}
class QSettingsIniKey : public QString
{
public:
inline QSettingsIniKey() : position(-1) {}
inline QSettingsIniKey(const QString &str, int pos = -1) : QString(str), position(pos) {}
int position;
};
Q_DECLARE_TYPEINFO(QSettingsIniKey, Q_MOVABLE_TYPE);
static bool operator<(const QSettingsIniKey &k1, const QSettingsIniKey &k2)
{
if (k1.position != k2.position)
return k1.position < k2.position;
return static_cast<const QString &>(k1) < static_cast<const QString &>(k2);
}
typedef QMap<QSettingsIniKey, QVariant> IniKeyMap;
struct QSettingsIniSection
{
int position;
IniKeyMap keyMap;
inline QSettingsIniSection() : position(-1) {}
};
Q_DECLARE_TYPEINFO(QSettingsIniSection, Q_MOVABLE_TYPE);
typedef QMap<QString, QSettingsIniSection> IniMap;
/*
This would be more straightforward if we didn't try to remember the original
key order in the .ini file, but we do.
*/
bool QConfFileSettingsPrivate::writeIniFile(QIODevice &device, const ParsedSettingsMap &map)
{
IniMap iniMap;
IniMap::const_iterator i;
#ifdef Q_OS_WIN
const char * const eol = "\r\n";
#else
const char eol = '\n';
#endif
for (ParsedSettingsMap::const_iterator j = map.constBegin(); j != map.constEnd(); ++j) {
QString section;
QSettingsIniKey key(j.key().originalCaseKey(), j.key().originalKeyPosition());
int slashPos;
if ((slashPos = key.indexOf(QLatin1Char('/'))) != -1) {
section = key.left(slashPos);
key.remove(0, slashPos + 1);
}
QSettingsIniSection &iniSection = iniMap[section];
// -1 means infinity
if (uint(key.position) < uint(iniSection.position))
iniSection.position = key.position;
iniSection.keyMap[key] = j.value();
}
const int sectionCount = iniMap.size();
QVector<QSettingsIniKey> sections;
sections.reserve(sectionCount);
for (i = iniMap.constBegin(); i != iniMap.constEnd(); ++i)
sections.append(QSettingsIniKey(i.key(), i.value().position));
std::sort(sections.begin(), sections.end());
bool writeError = false;
for (int j = 0; !writeError && j < sectionCount; ++j) {
i = iniMap.constFind(sections.at(j));
Q_ASSERT(i != iniMap.constEnd());
QByteArray realSection;
iniEscapedKey(i.key(), realSection);
if (realSection.isEmpty()) {
realSection = "[General]";
} else if (realSection.compare("general", Qt::CaseInsensitive) == 0) {
realSection = "[%General]";
} else {
realSection.prepend('[');
realSection.append(']');
}
if (j != 0)
realSection.prepend(eol);
realSection += eol;
device.write(realSection);
const IniKeyMap &ents = i.value().keyMap;
for (IniKeyMap::const_iterator j = ents.constBegin(); j != ents.constEnd(); ++j) {
QByteArray block;
iniEscapedKey(j.key(), block);
block += '=';
const QVariant &value = j.value();
/*
The size() != 1 trick is necessary because
QVariant(QString("foo")).toList() returns an empty
list, not a list containing "foo".
*/
if (value.userType() == QMetaType::QStringList
|| (value.userType() == QMetaType::QVariantList && value.toList().size() != 1)) {
iniEscapedStringList(variantListToStringList(value.toList()), block, iniCodec);
} else {
iniEscapedString(variantToString(value), block, iniCodec);
}
block += eol;
if (device.write(block) == -1) {
writeError = true;
break;
}
}
}
return !writeError;
}
void QConfFileSettingsPrivate::ensureAllSectionsParsed(QConfFile *confFile) const
{
UnparsedSettingsMap::const_iterator i = confFile->unparsedIniSections.constBegin();
const UnparsedSettingsMap::const_iterator end = confFile->unparsedIniSections.constEnd();
for (; i != end; ++i) {
if (!QConfFileSettingsPrivate::readIniSection(i.key(), i.value(), &confFile->originalKeys, iniCodec))
setStatus(QSettings::FormatError);
}
confFile->unparsedIniSections.clear();
}
void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
const QSettingsKey &key) const
{
if (confFile->unparsedIniSections.isEmpty())
return;
UnparsedSettingsMap::iterator i;
int indexOfSlash = key.indexOf(QLatin1Char('/'));
if (indexOfSlash != -1) {
i = confFile->unparsedIniSections.upperBound(key);
if (i == confFile->unparsedIniSections.begin())
return;
--i;
if (i.key().isEmpty() || !key.startsWith(i.key()))
return;
} else {
i = confFile->unparsedIniSections.begin();
if (i == confFile->unparsedIniSections.end() || !i.key().isEmpty())
return;
}
if (!QConfFileSettingsPrivate::readIniSection(i.key(), i.value(), &confFile->originalKeys, iniCodec))
setStatus(QSettings::FormatError);
confFile->unparsedIniSections.erase(i);
}
/*!
\class QSettings
\inmodule QtCore
\brief The QSettings class provides persistent platform-independent application settings.
\ingroup io
\reentrant
Users normally expect an application to remember its settings
(window sizes and positions, options, etc.) across sessions. This
information is often stored in the system registry on Windows,
and in property list files on \macos and iOS. On Unix systems, in the
absence of a standard, many applications (including the KDE
applications) use INI text files.
QSettings is an abstraction around these technologies, enabling
you to save and restore application settings in a portable
manner. It also supports \l{registerFormat()}{custom storage
formats}.
QSettings's API is based on QVariant, allowing you to save
most value-based types, such as QString, QRect, and QImage,
with the minimum of effort.
If all you need is a non-persistent memory-based structure,
consider using QMap<QString, QVariant> instead.
\tableofcontents section1
\section1 Basic Usage
When creating a QSettings object, you must pass the name of your
company or organization as well as the name of your application.
For example, if your product is called Star Runner and your
company is called MySoft, you would construct the QSettings
object as follows:
\snippet settings/settings.cpp 0
QSettings objects can be created either on the stack or on
the heap (i.e. using \c new). Constructing and destroying a
QSettings object is very fast.
If you use QSettings from many places in your application, you
might want to specify the organization name and the application
name using QCoreApplication::setOrganizationName() and
QCoreApplication::setApplicationName(), and then use the default
QSettings constructor:
\snippet settings/settings.cpp 1
\snippet settings/settings.cpp 2
\snippet settings/settings.cpp 3
\dots
\snippet settings/settings.cpp 4
(Here, we also specify the organization's Internet domain. When
the Internet domain is set, it is used on \macos and iOS instead of the
organization name, since \macos and iOS applications conventionally use
Internet domains to identify themselves. If no domain is set, a
fake domain is derived from the organization name. See the
\l{Platform-Specific Notes} below for details.)
QSettings stores settings. Each setting consists of a QString
that specifies the setting's name (the \e key) and a QVariant
that stores the data associated with the key. To write a setting,
use setValue(). For example:
\snippet settings/settings.cpp 5
If there already exists a setting with the same key, the existing
value is overwritten by the new value. For efficiency, the
changes may not be saved to permanent storage immediately. (You
can always call sync() to commit your changes.)
You can get a setting's value back using value():
\snippet settings/settings.cpp 6
If there is no setting with the specified name, QSettings
returns a null QVariant (which can be converted to the integer 0).
You can specify another default value by passing a second
argument to value():
\snippet settings/settings.cpp 7
To test whether a given key exists, call contains(). To remove
the setting associated with a key, call remove(). To obtain the
list of all keys, call allKeys(). To remove all keys, call
clear().
\section1 QVariant and GUI Types
Because QVariant is part of the Qt Core module, it cannot provide
conversion functions to data types such as QColor, QImage, and
QPixmap, which are part of Qt GUI. In other words, there is no
\c toColor(), \c toImage(), or \c toPixmap() functions in QVariant.
Instead, you can use the QVariant::value() template function.
For example:
\snippet code/src_corelib_io_qsettings.cpp 0
The inverse conversion (e.g., from QColor to QVariant) is
automatic for all data types supported by QVariant, including
GUI-related types:
\snippet code/src_corelib_io_qsettings.cpp 1
Custom types registered using qRegisterMetaType() and
qRegisterMetaTypeStreamOperators() can be stored using QSettings.
\section1 Section and Key Syntax
Setting keys can contain any Unicode characters. The Windows
registry and INI files use case-insensitive keys, whereas the
CFPreferences API on \macos and iOS uses case-sensitive keys. To
avoid portability problems, follow these simple rules:
\list 1
\li Always refer to the same key using the same case. For example,
if you refer to a key as "text fonts" in one place in your
code, don't refer to it as "Text Fonts" somewhere else.
\li Avoid key names that are identical except for the case. For
example, if you have a key called "MainWindow", don't try to
save another key as "mainwindow".
\li Do not use slashes ('/' and '\\') in section or key names; the
backslash character is used to separate sub keys (see below). On
windows '\\' are converted by QSettings to '/', which makes
them identical.
\endlist
You can form hierarchical keys using the '/' character as a
separator, similar to Unix file paths. For example:
\snippet settings/settings.cpp 8
\snippet settings/settings.cpp 9
\snippet settings/settings.cpp 10
If you want to save or restore many settings with the same
prefix, you can specify the prefix using beginGroup() and call
endGroup() at the end. Here's the same example again, but this
time using the group mechanism:
\snippet settings/settings.cpp 11
\codeline
\snippet settings/settings.cpp 12
If a group is set using beginGroup(), the behavior of most
functions changes consequently. Groups can be set recursively.
In addition to groups, QSettings also supports an "array"
concept. See beginReadArray() and beginWriteArray() for details.
\section1 Fallback Mechanism
Let's assume that you have created a QSettings object with the
organization name MySoft and the application name Star Runner.
When you look up a value, up to four locations are searched in
that order:
\list 1
\li a user-specific location for the Star Runner application
\li a user-specific location for all applications by MySoft
\li a system-wide location for the Star Runner application
\li a system-wide location for all applications by MySoft
\endlist
(See \l{Platform-Specific Notes} below for information on what
these locations are on the different platforms supported by Qt.)
If a key cannot be found in the first location, the search goes
on in the second location, and so on. This enables you to store
system-wide or organization-wide settings and to override them on
a per-user or per-application basis. To turn off this mechanism,
call setFallbacksEnabled(false).
Although keys from all four locations are available for reading,
only the first file (the user-specific location for the
application at hand) is accessible for writing. To write to any
of the other files, omit the application name and/or specify
QSettings::SystemScope (as opposed to QSettings::UserScope, the
default).
Let's see with an example:
\snippet settings/settings.cpp 13
\snippet settings/settings.cpp 14
The table below summarizes which QSettings objects access
which location. "\b{X}" means that the location is the main
location associated to the QSettings object and is used both
for reading and for writing; "o" means that the location is used
as a fallback when reading.
\table
\header \li Locations \li \c{obj1} \li \c{obj2} \li \c{obj3} \li \c{obj4}
\row \li 1. User, Application \li \b{X} \li \li \li
\row \li 2. User, Organization \li o \li \b{X} \li \li
\row \li 3. System, Application \li o \li \li \b{X} \li
\row \li 4. System, Organization \li o \li o \li o \li \b{X}
\endtable
The beauty of this mechanism is that it works on all platforms
supported by Qt and that it still gives you a lot of flexibility,
without requiring you to specify any file names or registry
paths.
If you want to use INI files on all platforms instead of the
native API, you can pass QSettings::IniFormat as the first
argument to the QSettings constructor, followed by the scope, the
organization name, and the application name:
\snippet settings/settings.cpp 15
Note that INI files lose the distinction between numeric data and the
strings used to encode them, so values written as numbers shall be read back
as QString. The numeric value can be recovered using \l QString::toInt(), \l
QString::toDouble() and related functions.
The \l{tools/settingseditor}{Settings Editor} example lets you
experiment with different settings location and with fallbacks
turned on or off.
\section1 Restoring the State of a GUI Application
QSettings is often used to store the state of a GUI
application. The following example illustrates how to use QSettings
to save and restore the geometry of an application's main window.
\snippet settings/settings.cpp 16
\codeline
\snippet settings/settings.cpp 17
See \l{Window Geometry} for a discussion on why it is better to
call QWidget::resize() and QWidget::move() rather than QWidget::setGeometry()
to restore a window's geometry.
The \c readSettings() and \c writeSettings() functions must be
called from the main window's constructor and close event handler
as follows:
\snippet settings/settings.cpp 18
\dots
\snippet settings/settings.cpp 19
\snippet settings/settings.cpp 20
\codeline
\snippet settings/settings.cpp 21
See the \l{mainwindows/application}{Application} example for a
self-contained example that uses QSettings.
\section1 Accessing Settings from Multiple Threads or Processes Simultaneously
QSettings is \l{reentrant}. This means that you can use
distinct QSettings object in different threads
simultaneously. This guarantee stands even when the QSettings
objects refer to the same files on disk (or to the same entries
in the system registry). If a setting is modified through one
QSettings object, the change will immediately be visible in
any other QSettings objects that operate on the same location
and that live in the same process.
QSettings can safely be used from different processes (which can
be different instances of your application running at the same
time or different applications altogether) to read and write to
the same system locations, provided certain conditions are met. For
QSettings::IniFormat, it uses advisory file locking and a smart merging
algorithm to ensure data integrity. The condition for that to work is that
the writeable configuration file must be a regular file and must reside in
a directory that the current user can create new, temporary files in. If
that is not the case, then one must use setAtomicSyncRequired() to turn the
safety off.
Note that sync() imports changes made by other processes (in addition to
writing the changes from this QSettings).
\section1 Platform-Specific Notes
\section2 Locations Where Application Settings Are Stored
As mentioned in the \l{Fallback Mechanism} section, QSettings
stores settings for an application in up to four locations,
depending on whether the settings are user-specific or
system-wide and whether the settings are application-specific
or organization-wide. For simplicity, we're assuming the
organization is called MySoft and the application is called Star
Runner.
On Unix systems, if the file format is NativeFormat, the
following files are used by default:
\list 1
\li \c{$HOME/.config/MySoft/Star Runner.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.conf})
\li \c{$HOME/.config/MySoft.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.conf})
\li for each directory <dir> in $XDG_CONFIG_DIRS: \c{<dir>/MySoft/Star Runner.conf}
\li for each directory <dir> in $XDG_CONFIG_DIRS: \c{<dir>/MySoft.conf}
\endlist
\note If XDG_CONFIG_DIRS is unset, the default value of \c{/etc/xdg} is used.
On \macos and iOS, if the file format is NativeFormat, these files are used by
default:
\list 1
\li \c{$HOME/Library/Preferences/com.MySoft.Star Runner.plist}
\li \c{$HOME/Library/Preferences/com.MySoft.plist}
\li \c{/Library/Preferences/com.MySoft.Star Runner.plist}
\li \c{/Library/Preferences/com.MySoft.plist}
\endlist
On Windows, NativeFormat settings are stored in the following
registry paths:
\list 1
\li \c{HKEY_CURRENT_USER\Software\MySoft\Star Runner}
\li \c{HKEY_CURRENT_USER\Software\MySoft\OrganizationDefaults}
\li \c{HKEY_LOCAL_MACHINE\Software\MySoft\Star Runner}
\li \c{HKEY_LOCAL_MACHINE\Software\MySoft\OrganizationDefaults}
\endlist
\note On Windows, for 32-bit programs running in WOW64 mode, settings are
stored in the following registry path:
\c{HKEY_LOCAL_MACHINE\Software\WOW6432node}.
If the file format is NativeFormat, this is "Settings/MySoft/Star Runner.conf"
in the application's home directory.
If the file format is IniFormat, the following files are
used on Unix, \macos, and iOS:
\list 1
\li \c{$HOME/.config/MySoft/Star Runner.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.ini})
\li \c{$HOME/.config/MySoft.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.ini})
\li for each directory <dir> in $XDG_CONFIG_DIRS: \c{<dir>/MySoft/Star Runner.ini}
\li for each directory <dir> in $XDG_CONFIG_DIRS: \c{<dir>/MySoft.ini}
\endlist
\note If XDG_CONFIG_DIRS is unset, the default value of \c{/etc/xdg} is used.
On Windows, the following files are used:
\list 1
\li \c{FOLDERID_RoamingAppData\MySoft\Star Runner.ini}
\li \c{FOLDERID_RoamingAppData\MySoft.ini}
\li \c{FOLDERID_ProgramData\MySoft\Star Runner.ini}
\li \c{FOLDERID_ProgramData\MySoft.ini}
\endlist
The identifiers prefixed by \c{FOLDERID_} are special item ID lists to be passed
to the Win32 API function \c{SHGetKnownFolderPath()} to obtain the
corresponding path.
\c{FOLDERID_RoamingAppData} usually points to \tt{C:\\Users\\\e{User Name}\\AppData\\Roaming},
also shown by the environment variable \c{%APPDATA%}.
\c{FOLDERID_ProgramData} usually points to \tt{C:\\ProgramData}.
If the file format is IniFormat, this is "Settings/MySoft/Star Runner.ini"
in the application's home directory.
The paths for the \c .ini and \c .conf files can be changed using
setPath(). On Unix, \macos, and iOS the user can override them by
setting the \c XDG_CONFIG_HOME environment variable; see
setPath() for details.
\section2 Accessing INI and .plist Files Directly
Sometimes you do want to access settings stored in a specific
file or registry path. On all platforms, if you want to read an
INI file directly, you can use the QSettings constructor that
takes a file name as first argument and pass QSettings::IniFormat
as second argument. For example:
\snippet code/src_corelib_io_qsettings.cpp 2
You can then use the QSettings object to read and write settings
in the file.
On \macos and iOS, you can access property list \c .plist files by passing
QSettings::NativeFormat as second argument. For example:
\snippet code/src_corelib_io_qsettings.cpp 3
\section2 Accessing the Windows Registry Directly
On Windows, QSettings lets you access settings that have been
written with QSettings (or settings in a supported format, e.g., string
data) in the system registry. This is done by constructing a QSettings
object with a path in the registry and QSettings::NativeFormat.
For example:
\snippet code/src_corelib_io_qsettings.cpp 4
All the registry entries that appear under the specified path can
be read or written through the QSettings object as usual (using
forward slashes instead of backslashes). For example:
\snippet code/src_corelib_io_qsettings.cpp 5
Note that the backslash character is, as mentioned, used by
QSettings to separate subkeys. As a result, you cannot read or
write windows registry entries that contain slashes or
backslashes; you should use a native windows API if you need to do
so.
\section2 Accessing Common Registry Settings on Windows
On Windows, it is possible for a key to have both a value and subkeys.
Its default value is accessed by using "Default" or "." in
place of a subkey:
\snippet code/src_corelib_io_qsettings.cpp 6
On other platforms than Windows, "Default" and "." would be
treated as regular subkeys.
\section2 Platform Limitations
While QSettings attempts to smooth over the differences between
the different supported platforms, there are still a few
differences that you should be aware of when porting your
application:
\list
\li The Windows system registry has the following limitations: A
subkey may not exceed 255 characters, an entry's value may
not exceed 16,383 characters, and all the values of a key may
not exceed 65,535 characters. One way to work around these
limitations is to store the settings using the IniFormat
instead of the NativeFormat.
\li On Windows, when the Windows system registry is used, QSettings
does not preserve the original type of the value. Therefore,
the type of the value might change when a new value is set. For
example, a value with type \c REG_EXPAND_SZ will change to \c REG_SZ.
\li On \macos and iOS, allKeys() will return some extra keys for global
settings that apply to all applications. These keys can be
read using value() but cannot be changed, only shadowed.
Calling setFallbacksEnabled(false) will hide these global
settings.
\li On \macos and iOS, the CFPreferences API used by QSettings expects
Internet domain names rather than organization names. To
provide a uniform API, QSettings derives a fake domain name
from the organization name (unless the organization name
already is a domain name, e.g. OpenOffice.org). The algorithm
appends ".com" to the company name and replaces spaces and
other illegal characters with hyphens. If you want to specify
a different domain name, call
QCoreApplication::setOrganizationDomain(),
QCoreApplication::setOrganizationName(), and
QCoreApplication::setApplicationName() in your \c main()
function and then use the default QSettings constructor.
Another solution is to use preprocessor directives, for
example:
\snippet code/src_corelib_io_qsettings.cpp 7
\li On \macos, permissions to access settings not belonging to the
current user (i.e. SystemScope) have changed with 10.7 (Lion). Prior to
that version, users having admin rights could access these. For 10.7 and
10.8 (Mountain Lion), only root can. However, 10.9 (Mavericks) changes
that rule again but only for the native format (plist files).
\endlist
\sa QVariant, QSessionManager, {Settings Editor Example}, {Application Example}
*/
/*! \enum QSettings::Status
The following status values are possible:
\value NoError No error occurred.
\value AccessError An access error occurred (e.g. trying to write to a read-only file).
\value FormatError A format error occurred (e.g. loading a malformed INI file).
\sa status()
*/
/*! \enum QSettings::Format
This enum type specifies the storage format used by QSettings.
\value NativeFormat Store the settings using the most
appropriate storage format for the platform.
On Windows, this means the system registry;
on \macos and iOS, this means the CFPreferences
API; on Unix, this means textual
configuration files in INI format.
\value Registry32Format Windows only: Explicitly access the 32-bit system registry
from a 64-bit application running on 64-bit Windows.
On 32-bit Windows or from a 32-bit application on 64-bit Windows,
this works the same as specifying NativeFormat.
This enum value was added in Qt 5.7.
\value Registry64Format Windows only: Explicitly access the 64-bit system registry
from a 32-bit application running on 64-bit Windows.
On 32-bit Windows or from a 64-bit application on 64-bit Windows,
this works the same as specifying NativeFormat.
This enum value was added in Qt 5.7.
\value IniFormat Store the settings in INI files. Note that INI files
lose the distinction between numeric data and the
strings used to encode them, so values written as
numbers shall be read back as QString.
\value InvalidFormat Special value returned by registerFormat().
\omitvalue CustomFormat1
\omitvalue CustomFormat2
\omitvalue CustomFormat3
\omitvalue CustomFormat4
\omitvalue CustomFormat5
\omitvalue CustomFormat6
\omitvalue CustomFormat7
\omitvalue CustomFormat8
\omitvalue CustomFormat9
\omitvalue CustomFormat10
\omitvalue CustomFormat11
\omitvalue CustomFormat12
\omitvalue CustomFormat13
\omitvalue CustomFormat14
\omitvalue CustomFormat15
\omitvalue CustomFormat16
On Unix, NativeFormat and IniFormat mean the same thing, except
that the file extension is different (\c .conf for NativeFormat,
\c .ini for IniFormat).
The INI file format is a Windows file format that Qt supports on
all platforms. In the absence of an INI standard, we try to
follow what Microsoft does, with the following exceptions:
\list
\li If you store types that QVariant can't convert to QString
(e.g., QPoint, QRect, and QSize), Qt uses an \c{@}-based
syntax to encode the type. For example:
\snippet code/src_corelib_io_qsettings.cpp 8
To minimize compatibility issues, any \c @ that doesn't
appear at the first position in the value or that isn't
followed by a Qt type (\c Point, \c Rect, \c Size, etc.) is
treated as a normal character.
\li Although backslash is a special character in INI files, most
Windows applications don't escape backslashes (\c{\}) in file
paths:
\snippet code/src_corelib_io_qsettings.cpp 9
QSettings always treats backslash as a special character and
provides no API for reading or writing such entries.
\li The INI file format has severe restrictions on the syntax of
a key. Qt works around this by using \c % as an escape
character in keys. In addition, if you save a top-level
setting (a key with no slashes in it, e.g., "someKey"), it
will appear in the INI file's "General" section. To avoid
overwriting other keys, if you save something using a key
such as "General/someKey", the key will be located in the
"%General" section, \e not in the "General" section.
\li Following the philosophy that we should be liberal in what
we accept and conservative in what we generate, QSettings
will accept Latin-1 encoded INI files, but generate pure
ASCII files, where non-ASCII values are encoded using standard
INI escape sequences. To make the INI files more readable (but
potentially less compatible), call setIniCodec().
\endlist
\sa registerFormat(), setPath()
*/
/*! \enum QSettings::Scope
This enum specifies whether settings are user-specific or shared
by all users of the same system.
\value UserScope Store settings in a location specific to the
current user (e.g., in the user's home
directory).
\value SystemScope Store settings in a global location, so that
all users on the same machine access the same
set of settings.
\sa setPath()
*/
#ifndef QT_NO_QOBJECT
/*!
Constructs a QSettings object for accessing settings of the
application called \a application from the organization called \a
organization, and with parent \a parent.
Example:
\snippet code/src_corelib_io_qsettings.cpp 10
The scope is set to QSettings::UserScope, and the format is
set to QSettings::NativeFormat (i.e. calling setDefaultFormat()
before calling this constructor has no effect).
\sa setDefaultFormat(), {Fallback Mechanism}
*/
QSettings::QSettings(const QString &organization, const QString &application, QObject *parent)
: QObject(*QSettingsPrivate::create(NativeFormat, UserScope, organization, application),
parent)
{
}
/*!
Constructs a QSettings object for accessing settings of the
application called \a application from the organization called \a
organization, and with parent \a parent.
If \a scope is QSettings::UserScope, the QSettings object searches
user-specific settings first, before it searches system-wide
settings as a fallback. If \a scope is QSettings::SystemScope, the
QSettings object ignores user-specific settings and provides
access to system-wide settings.
The storage format is set to QSettings::NativeFormat (i.e. calling
setDefaultFormat() before calling this constructor has no effect).
If no application name is given, the QSettings object will
only access the organization-wide \l{Fallback Mechanism}{locations}.
\sa setDefaultFormat()
*/
QSettings::QSettings(Scope scope, const QString &organization, const QString &application,
QObject *parent)
: QObject(*QSettingsPrivate::create(NativeFormat, scope, organization, application), parent)
{
}
/*!
Constructs a QSettings object for accessing settings of the
application called \a application from the organization called
\a organization, and with parent \a parent.
If \a scope is QSettings::UserScope, the QSettings object searches
user-specific settings first, before it searches system-wide
settings as a fallback. If \a scope is
QSettings::SystemScope, the QSettings object ignores user-specific
settings and provides access to system-wide settings.
If \a format is QSettings::NativeFormat, the native API is used for
storing settings. If \a format is QSettings::IniFormat, the INI format
is used.
If no application name is given, the QSettings object will
only access the organization-wide \l{Fallback Mechanism}{locations}.
*/
QSettings::QSettings(Format format, Scope scope, const QString &organization,
const QString &application, QObject *parent)
: QObject(*QSettingsPrivate::create(format, scope, organization, application), parent)
{
}
/*!
Constructs a QSettings object for accessing the settings
stored in the file called \a fileName, with parent \a parent. If
the file doesn't already exist, it is created.
If \a format is QSettings::NativeFormat, the meaning of \a
fileName depends on the platform. On Unix, \a fileName is the
name of an INI file. On \macos and iOS, \a fileName is the name of a
\c .plist file. On Windows, \a fileName is a path in the system
registry.
If \a format is QSettings::IniFormat, \a fileName is the name of an INI
file.
\warning This function is provided for convenience. It works well for
accessing INI or \c .plist files generated by Qt, but might fail on some
syntaxes found in such files originated by other programs. In particular,
be aware of the following limitations:
\list
\li QSettings provides no way of reading INI "path" entries, i.e., entries
with unescaped slash characters. (This is because these entries are
ambiguous and cannot be resolved automatically.)
\li In INI files, QSettings uses the \c @ character as a metacharacter in some
contexts, to encode Qt-specific data types (e.g., \c @Rect), and might
therefore misinterpret it when it occurs in pure INI files.
\endlist
\sa fileName()
*/
QSettings::QSettings(const QString &fileName, Format format, QObject *parent)
: QObject(*QSettingsPrivate::create(fileName, format), parent)
{
}
/*!
Constructs a QSettings object for accessing settings of the
application and organization set previously with a call to
QCoreApplication::setOrganizationName(),
QCoreApplication::setOrganizationDomain(), and
QCoreApplication::setApplicationName().
The scope is QSettings::UserScope and the format is
defaultFormat() (QSettings::NativeFormat by default).
Use setDefaultFormat() before calling this constructor
to change the default format used by this constructor.
The code
\snippet code/src_corelib_io_qsettings.cpp 11
is equivalent to
\snippet code/src_corelib_io_qsettings.cpp 12
If QCoreApplication::setOrganizationName() and
QCoreApplication::setApplicationName() has not been previously
called, the QSettings object will not be able to read or write
any settings, and status() will return AccessError.
You should supply both the domain (used by default on \macos and iOS) and
the name (used by default elsewhere), although the code will cope if you
supply only one, which will then be used (on all platforms), at odds with
the usual naming of the file on platforms for which it isn't the default.
\sa QCoreApplication::setOrganizationName(),
QCoreApplication::setOrganizationDomain(),
QCoreApplication::setApplicationName(),
setDefaultFormat()
*/
QSettings::QSettings(QObject *parent)
: QSettings(UserScope, parent)
{
}
/*!
\since 5.13
Constructs a QSettings object in the same way as
QSettings(QObject *parent) but with the given \a scope.
\sa QSettings(QObject *parent)
*/
QSettings::QSettings(Scope scope, QObject *parent)
: QObject(*QSettingsPrivate::create(globalDefaultFormat, scope,
#ifdef Q_OS_DARWIN
QCoreApplication::organizationDomain().isEmpty()
? QCoreApplication::organizationName()
: QCoreApplication::organizationDomain()
#else
QCoreApplication::organizationName().isEmpty()
? QCoreApplication::organizationDomain()
: QCoreApplication::organizationName()
#endif
, QCoreApplication::applicationName()),
parent)
{
}
#else
QSettings::QSettings(const QString &organization, const QString &application)
: d_ptr(QSettingsPrivate::create(globalDefaultFormat, QSettings::UserScope, organization, application))
{
d_ptr->q_ptr = this;
}
QSettings::QSettings(Scope scope, const QString &organization, const QString &application)
: d_ptr(QSettingsPrivate::create(globalDefaultFormat, scope, organization, application))
{
d_ptr->q_ptr = this;
}
QSettings::QSettings(Format format, Scope scope, const QString &organization,
const QString &application)
: d_ptr(QSettingsPrivate::create(format, scope, organization, application))
{
d_ptr->q_ptr = this;
}
QSettings::QSettings(const QString &fileName, Format format)
: d_ptr(QSettingsPrivate::create(fileName, format))
{
d_ptr->q_ptr = this;
}
# ifndef QT_BUILD_QMAKE
QSettings::QSettings(Scope scope)
: d_ptr(QSettingsPrivate::create(globalDefaultFormat, scope,
# ifdef Q_OS_DARWIN
QCoreApplication::organizationDomain().isEmpty()
? QCoreApplication::organizationName()
: QCoreApplication::organizationDomain()
# else
QCoreApplication::organizationName().isEmpty()
? QCoreApplication::organizationDomain()
: QCoreApplication::organizationName()
# endif
, QCoreApplication::applicationName())
)
{
d_ptr->q_ptr = this;
}
# endif
#endif
/*!
Destroys the QSettings object.
Any unsaved changes will eventually be written to permanent
storage.
\sa sync()
*/
QSettings::~QSettings()
{
Q_D(QSettings);
if (d->pendingChanges) {
QT_TRY {
d->flush();
} QT_CATCH(...) {
; // ok. then don't flush but at least don't throw in the destructor
}
}
}
/*!
Removes all entries in the primary location associated to this
QSettings object.
Entries in fallback locations are not removed.
If you only want to remove the entries in the current group(),
use remove("") instead.
\sa remove(), setFallbacksEnabled()
*/
void QSettings::clear()
{
Q_D(QSettings);
d->clear();
d->requestUpdate();
}
/*!
Writes any unsaved changes to permanent storage, and reloads any
settings that have been changed in the meantime by another
application.
This function is called automatically from QSettings's destructor and
by the event loop at regular intervals, so you normally don't need to
call it yourself.
\sa status()
*/
void QSettings::sync()
{
Q_D(QSettings);
d->sync();
d->pendingChanges = false;
}
/*!
Returns the path where settings written using this QSettings
object are stored.
On Windows, if the format is QSettings::NativeFormat, the return value
is a system registry path, not a file path.
\sa isWritable(), format()
*/
QString QSettings::fileName() const
{
Q_D(const QSettings);
return d->fileName();
}
/*!
\since 4.4
Returns the format used for storing the settings.
\sa defaultFormat(), fileName(), scope(), organizationName(), applicationName()
*/
QSettings::Format QSettings::format() const
{
Q_D(const QSettings);
return d->format;
}
/*!
\since 4.4
Returns the scope used for storing the settings.
\sa format(), organizationName(), applicationName()
*/
QSettings::Scope QSettings::scope() const
{
Q_D(const QSettings);
return d->scope;
}
/*!
\since 4.4
Returns the organization name used for storing the settings.
\sa QCoreApplication::organizationName(), format(), scope(), applicationName()
*/
QString QSettings::organizationName() const
{
Q_D(const QSettings);
return d->organizationName;
}
/*!
\since 4.4
Returns the application name used for storing the settings.
\sa QCoreApplication::applicationName(), format(), scope(), organizationName()
*/
QString QSettings::applicationName() const
{
Q_D(const QSettings);
return d->applicationName;
}
#if QT_CONFIG(textcodec)
/*!
\since 4.5
Sets the codec for accessing INI files (including \c .conf files on Unix)
to \a codec. The codec is used for decoding any data that is read from
the INI file, and for encoding any data that is written to the file. By
default, no codec is used, and non-ASCII characters are encoded using
standard INI escape sequences.
\warning The codec must be set immediately after creating the QSettings
object, before accessing any data.
\sa iniCodec()
*/
void QSettings::setIniCodec(QTextCodec *codec)
{
Q_D(QSettings);
d->iniCodec = codec;
}
/*!
\since 4.5
\overload
Sets the codec for accessing INI files (including \c .conf files on Unix)
to the QTextCodec for the encoding specified by \a codecName. Common
values for \c codecName include "ISO 8859-1", "UTF-8", and "UTF-16".
If the encoding isn't recognized, nothing happens.
\sa QTextCodec::codecForName()
*/
void QSettings::setIniCodec(const char *codecName)
{
Q_D(QSettings);
if (QTextCodec *codec = QTextCodec::codecForName(codecName))
d->iniCodec = codec;
}
/*!
\since 4.5
Returns the codec that is used for accessing INI files. By default,
no codec is used, so \nullptr is returned.
*/
QTextCodec *QSettings::iniCodec() const
{
Q_D(const QSettings);
return d->iniCodec;
}
#endif // textcodec
/*!
Returns a status code indicating the first error that was met by
QSettings, or QSettings::NoError if no error occurred.
Be aware that QSettings delays performing some operations. For this
reason, you might want to call sync() to ensure that the data stored
in QSettings is written to disk before calling status().
\sa sync()
*/
QSettings::Status QSettings::status() const
{
Q_D(const QSettings);
return d->status;
}
/*!
\since 5.10
Returns \c true if QSettings is only allowed to perform atomic saving and
reloading (synchronization) of the settings. Returns \c false if it is
allowed to save the settings contents directly to the configuration file.
The default is \c true.
\sa setAtomicSyncRequired(), QSaveFile
*/
bool QSettings::isAtomicSyncRequired() const
{
Q_D(const QSettings);
return d->atomicSyncOnly;
}
/*!
\since 5.10
Configures whether QSettings is required to perform atomic saving and
reloading (synchronization) of the settings. If the \a enable argument is
\c true (the default), sync() will only perform synchronization operations
that are atomic. If this is not possible, sync() will fail and status()
will be an error condition.
Setting this property to \c false will allow QSettings to write directly to
the configuration file and ignore any errors trying to lock it against
other processes trying to write at the same time. Because of the potential
for corruption, this option should be used with care, but is required in
certain conditions, like a QSettings::IniFormat configuration file that
exists in an otherwise non-writeable directory or NTFS Alternate Data
Streams.
See \l QSaveFile for more information on the feature.
\sa isAtomicSyncRequired(), QSaveFile
*/
void QSettings::setAtomicSyncRequired(bool enable)
{
Q_D(QSettings);
d->atomicSyncOnly = enable;
}
/*!
Appends \a prefix to the current group.
The current group is automatically prepended to all keys
specified to QSettings. In addition, query functions such as
childGroups(), childKeys(), and allKeys() are based on the group.
By default, no group is set.
Groups are useful to avoid typing in the same setting paths over
and over. For example:
\snippet code/src_corelib_io_qsettings.cpp 13
This will set the value of three settings:
\list
\li \c mainwindow/size
\li \c mainwindow/fullScreen
\li \c outputpanel/visible
\endlist
Call endGroup() to reset the current group to what it was before
the corresponding beginGroup() call. Groups can be nested.
\sa endGroup(), group()
*/
void QSettings::beginGroup(const QString &prefix)
{
Q_D(QSettings);
d->beginGroupOrArray(QSettingsGroup(d->normalizedKey(prefix)));
}
/*!
Resets the group to what it was before the corresponding
beginGroup() call.
Example:
\snippet code/src_corelib_io_qsettings.cpp 14
\sa beginGroup(), group()
*/
void QSettings::endGroup()
{
Q_D(QSettings);
if (d->groupStack.isEmpty()) {
qWarning("QSettings::endGroup: No matching beginGroup()");
return;
}
QSettingsGroup group = d->groupStack.pop();
int len = group.toString().size();
if (len > 0)
d->groupPrefix.truncate(d->groupPrefix.size() - (len + 1));
if (group.isArray())
qWarning("QSettings::endGroup: Expected endArray() instead");
}
/*!
Returns the current group.
\sa beginGroup(), endGroup()
*/
QString QSettings::group() const
{
Q_D(const QSettings);
return d->groupPrefix.left(d->groupPrefix.size() - 1);
}
/*!
Adds \a prefix to the current group and starts reading from an
array. Returns the size of the array.
Example:
\snippet code/src_corelib_io_qsettings.cpp 15
Use beginWriteArray() to write the array in the first place.
\sa beginWriteArray(), endArray(), setArrayIndex()
*/
int QSettings::beginReadArray(const QString &prefix)
{
Q_D(QSettings);
d->beginGroupOrArray(QSettingsGroup(d->normalizedKey(prefix), false));
return value(QLatin1String("size")).toInt();
}
/*!
Adds \a prefix to the current group and starts writing an array
of size \a size. If \a size is -1 (the default), it is automatically
determined based on the indexes of the entries written.
If you have many occurrences of a certain set of keys, you can
use arrays to make your life easier. For example, let's suppose
that you want to save a variable-length list of user names and
passwords. You could then write:
\snippet code/src_corelib_io_qsettings.cpp 16
The generated keys will have the form
\list
\li \c logins/size
\li \c logins/1/userName
\li \c logins/1/password
\li \c logins/2/userName
\li \c logins/2/password
\li \c logins/3/userName
\li \c logins/3/password
\li ...
\endlist
To read back an array, use beginReadArray().
\sa beginReadArray(), endArray(), setArrayIndex()
*/
void QSettings::beginWriteArray(const QString &prefix, int size)
{
Q_D(QSettings);
d->beginGroupOrArray(QSettingsGroup(d->normalizedKey(prefix), size < 0));
if (size < 0)
remove(QLatin1String("size"));
else
setValue(QLatin1String("size"), size);
}
/*!
Closes the array that was started using beginReadArray() or
beginWriteArray().
\sa beginReadArray(), beginWriteArray()
*/
void QSettings::endArray()
{
Q_D(QSettings);
if (d->groupStack.isEmpty()) {
qWarning("QSettings::endArray: No matching beginArray()");
return;
}
QSettingsGroup group = d->groupStack.top();
int len = group.toString().size();
d->groupStack.pop();
if (len > 0)
d->groupPrefix.truncate(d->groupPrefix.size() - (len + 1));
if (group.arraySizeGuess() != -1)
setValue(group.name() + QLatin1String("/size"), group.arraySizeGuess());
if (!group.isArray())
qWarning("QSettings::endArray: Expected endGroup() instead");
}
/*!
Sets the current array index to \a i. Calls to functions such as
setValue(), value(), remove(), and contains() will operate on the
array entry at that index.
You must call beginReadArray() or beginWriteArray() before you
can call this function.
*/
void QSettings::setArrayIndex(int i)
{
Q_D(QSettings);
if (d->groupStack.isEmpty() || !d->groupStack.top().isArray()) {
qWarning("QSettings::setArrayIndex: Missing beginArray()");
return;
}
QSettingsGroup &top = d->groupStack.top();
int len = top.toString().size();
top.setArrayIndex(qMax(i, 0));
d->groupPrefix.replace(d->groupPrefix.size() - len - 1, len, top.toString());
}
/*!
Returns a list of all keys, including subkeys, that can be read
using the QSettings object.
Example:
\snippet code/src_corelib_io_qsettings.cpp 17
If a group is set using beginGroup(), only the keys in the group
are returned, without the group prefix:
\snippet code/src_corelib_io_qsettings.cpp 18
\sa childGroups(), childKeys()
*/
QStringList QSettings::allKeys() const
{
Q_D(const QSettings);
return d->children(d->groupPrefix, QSettingsPrivate::AllKeys);
}
/*!
Returns a list of all top-level keys that can be read using the
QSettings object.
Example:
\snippet code/src_corelib_io_qsettings.cpp 19
If a group is set using beginGroup(), the top-level keys in that
group are returned, without the group prefix:
\snippet code/src_corelib_io_qsettings.cpp 20
You can navigate through the entire setting hierarchy using
childKeys() and childGroups() recursively.
\sa childGroups(), allKeys()
*/
QStringList QSettings::childKeys() const
{
Q_D(const QSettings);
return d->children(d->groupPrefix, QSettingsPrivate::ChildKeys);
}
/*!
Returns a list of all key top-level groups that contain keys that
can be read using the QSettings object.
Example:
\snippet code/src_corelib_io_qsettings.cpp 21
If a group is set using beginGroup(), the first-level keys in
that group are returned, without the group prefix.
\snippet code/src_corelib_io_qsettings.cpp 22
You can navigate through the entire setting hierarchy using
childKeys() and childGroups() recursively.
\sa childKeys(), allKeys()
*/
QStringList QSettings::childGroups() const
{
Q_D(const QSettings);
return d->children(d->groupPrefix, QSettingsPrivate::ChildGroups);
}
/*!
Returns \c true if settings can be written using this QSettings
object; returns \c false otherwise.
One reason why isWritable() might return false is if
QSettings operates on a read-only file.
\warning This function is not perfectly reliable, because the
file permissions can change at any time.
\sa fileName(), status(), sync()
*/
bool QSettings::isWritable() const
{
Q_D(const QSettings);
return d->isWritable();
}
/*!
Sets the value of setting \a key to \a value. If the \a key already
exists, the previous value is overwritten.
Note that the Windows registry and INI files use case-insensitive
keys, whereas the CFPreferences API on \macos and iOS uses
case-sensitive keys. To avoid portability problems, see the
\l{Section and Key Syntax} rules.
Example:
\snippet code/src_corelib_io_qsettings.cpp 23
\sa value(), remove(), contains()
*/
void QSettings::setValue(const QString &key, const QVariant &value)
{
Q_D(QSettings);
if (key.isEmpty()) {
qWarning("QSettings::setValue: Empty key passed");
return;
}
QString k = d->actualKey(key);
d->set(k, value);
d->requestUpdate();
}
/*!
Removes the setting \a key and any sub-settings of \a key.
Example:
\snippet code/src_corelib_io_qsettings.cpp 24
Be aware that if one of the fallback locations contains a setting
with the same key, that setting will be visible after calling
remove().
If \a key is an empty string, all keys in the current group() are
removed. For example:
\snippet code/src_corelib_io_qsettings.cpp 25
Note that the Windows registry and INI files use case-insensitive
keys, whereas the CFPreferences API on \macos and iOS uses
case-sensitive keys. To avoid portability problems, see the
\l{Section and Key Syntax} rules.
\sa setValue(), value(), contains()
*/
void QSettings::remove(const QString &key)
{
Q_D(QSettings);
/*
We cannot use actualKey(), because remove() supports empty
keys. The code is also tricky because of slash handling.
*/
QString theKey = d->normalizedKey(key);
if (theKey.isEmpty())
theKey = group();
else
theKey.prepend(d->groupPrefix);
if (theKey.isEmpty()) {
d->clear();
} else {
d->remove(theKey);
}
d->requestUpdate();
}
/*!
Returns \c true if there exists a setting called \a key; returns
false otherwise.
If a group is set using beginGroup(), \a key is taken to be
relative to that group.
Note that the Windows registry and INI files use case-insensitive
keys, whereas the CFPreferences API on \macos and iOS uses
case-sensitive keys. To avoid portability problems, see the
\l{Section and Key Syntax} rules.
\sa value(), setValue()
*/
bool QSettings::contains(const QString &key) const
{
Q_D(const QSettings);
QString k = d->actualKey(key);
return d->get(k, nullptr);
}
/*!
Sets whether fallbacks are enabled to \a b.
By default, fallbacks are enabled.
\sa fallbacksEnabled()
*/
void QSettings::setFallbacksEnabled(bool b)
{
Q_D(QSettings);
d->fallbacks = !!b;
}
/*!
Returns \c true if fallbacks are enabled; returns \c false otherwise.
By default, fallbacks are enabled.
\sa setFallbacksEnabled()
*/
bool QSettings::fallbacksEnabled() const
{
Q_D(const QSettings);
return d->fallbacks;
}
#ifndef QT_NO_QOBJECT
/*!
\reimp
*/
bool QSettings::event(QEvent *event)
{
Q_D(QSettings);
if (event->type() == QEvent::UpdateRequest) {
d->update();
return true;
}
return QObject::event(event);
}
#endif
/*!
Returns the value for setting \a key. If the setting doesn't
exist, returns \a defaultValue.
If no default value is specified, a default QVariant is
returned.
Note that the Windows registry and INI files use case-insensitive
keys, whereas the CFPreferences API on \macos and iOS uses
case-sensitive keys. To avoid portability problems, see the
\l{Section and Key Syntax} rules.
Example:
\snippet code/src_corelib_io_qsettings.cpp 26
\sa setValue(), contains(), remove()
*/
QVariant QSettings::value(const QString &key, const QVariant &defaultValue) const
{
Q_D(const QSettings);
if (key.isEmpty()) {
qWarning("QSettings::value: Empty key passed");
return QVariant();
}
QVariant result = defaultValue;
QString k = d->actualKey(key);
d->get(k, &result);
return result;
}
/*!
\since 4.4
Sets the default file format to the given \a format, which is used
for storing settings for the QSettings(QObject *) constructor.
If no default format is set, QSettings::NativeFormat is used. See
the documentation for the QSettings constructor you are using to
see if that constructor will ignore this function.
\sa format()
*/
void QSettings::setDefaultFormat(Format format)
{
globalDefaultFormat = format;
}
/*!
\since 4.4
Returns default file format used for storing settings for the QSettings(QObject *) constructor.
If no default format is set, QSettings::NativeFormat is used.
\sa format()
*/
QSettings::Format QSettings::defaultFormat()
{
return globalDefaultFormat;
}
#if QT_DEPRECATED_SINCE(5, 13)
/*!
\obsolete
Use setPath() instead.
\oldcode
setSystemIniPath(path);
\newcode
setPath(QSettings::NativeFormat, QSettings::SystemScope, path);
setPath(QSettings::IniFormat, QSettings::SystemScope, path);
\endcode
*/
void QSettings::setSystemIniPath(const QString &dir)
{
setPath(IniFormat, SystemScope, dir);
#if !defined(Q_OS_WIN) && !defined(Q_OS_MAC)
setPath(NativeFormat, SystemScope, dir);
#endif
}
/*!
\obsolete
Use setPath() instead.
*/
void QSettings::setUserIniPath(const QString &dir)
{
setPath(IniFormat, UserScope, dir);
#if !defined(Q_OS_WIN) && !defined(Q_OS_MAC)
setPath(NativeFormat, UserScope, dir);
#endif
}
#endif
/*!
\since 4.1
Sets the path used for storing settings for the given \a format
and \a scope, to \a path. The \a format can be a custom format.
The table below summarizes the default values:
\table
\header \li Platform \li Format \li Scope \li Path
\row \li{1,2} Windows \li{1,2} IniFormat \li UserScope \li \c FOLDERID_RoamingAppData
\row \li SystemScope \li \c FOLDERID_ProgramData
\row \li{1,2} Unix \li{1,2} NativeFormat, IniFormat \li UserScope \li \c $HOME/.config
\row \li SystemScope \li \c /etc/xdg
\row \li{1,2} Qt for Embedded Linux \li{1,2} NativeFormat, IniFormat \li UserScope \li \c $HOME/Settings
\row \li SystemScope \li \c /etc/xdg
\row \li{1,2} \macos and iOS \li{1,2} IniFormat \li UserScope \li \c $HOME/.config
\row \li SystemScope \li \c /etc/xdg
\endtable
The default UserScope paths on Unix, \macos, and iOS (\c
$HOME/.config or $HOME/Settings) can be overridden by the user by setting the
\c XDG_CONFIG_HOME environment variable. The default SystemScope
paths on Unix, \macos, and iOS (\c /etc/xdg) can be overridden when
building the Qt library using the \c configure script's \c
-sysconfdir flag (see QLibraryInfo for details).
Setting the NativeFormat paths on Windows, \macos, and iOS has no
effect.
\warning This function doesn't affect existing QSettings objects.
\sa registerFormat()
*/
void QSettings::setPath(Format format, Scope scope, const QString &path)
{
auto locker = qt_unique_lock(settingsGlobalMutex);
PathHash *pathHash = pathHashFunc();
if (pathHash->isEmpty())
locker = initDefaultPaths(std::move(locker));
pathHash->insert(pathHashKey(format, scope), Path(path + QDir::separator(), true));
}
/*!
\typedef QSettings::SettingsMap
Typedef for QMap<QString, QVariant>.
\sa registerFormat()
*/
/*!
\typedef QSettings::ReadFunc
Typedef for a pointer to a function with the following signature:
\snippet code/src_corelib_io_qsettings.cpp 27
\c ReadFunc is used in \c registerFormat() as a pointer to a function
that reads a set of key/value pairs. \c ReadFunc should read all the
options in one pass, and return all the settings in the \c SettingsMap
container, which is initially empty.
\sa WriteFunc, registerFormat()
*/
/*!
\typedef QSettings::WriteFunc
Typedef for a pointer to a function with the following signature:
\snippet code/src_corelib_io_qsettings.cpp 28
\c WriteFunc is used in \c registerFormat() as a pointer to a function
that writes a set of key/value pairs. \c WriteFunc is only called once,
so you need to output the settings in one go.
\sa ReadFunc, registerFormat()
*/
/*!
\since 4.1
\threadsafe
Registers a custom storage format. On success, returns a special
Format value that can then be passed to the QSettings constructor.
On failure, returns InvalidFormat.
The \a extension is the file
extension associated to the format (without the '.').
The \a readFunc and \a writeFunc parameters are pointers to
functions that read and write a set of key/value pairs. The
QIODevice parameter to the read and write functions is always
opened in binary mode (i.e., without the QIODevice::Text flag).
The \a caseSensitivity parameter specifies whether keys are case
sensitive or not. This makes a difference when looking up values
using QSettings. The default is case sensitive.
By default, if you use one of the constructors that work in terms
of an organization name and an application name, the file system
locations used are the same as for IniFormat. Use setPath() to
specify other locations.
Example:
\snippet code/src_corelib_io_qsettings.cpp 29
\sa setPath()
*/
QSettings::Format QSettings::registerFormat(const QString &extension, ReadFunc readFunc,
WriteFunc writeFunc,
Qt::CaseSensitivity caseSensitivity)
{
#ifdef QT_QSETTINGS_ALWAYS_CASE_SENSITIVE_AND_FORGET_ORIGINAL_KEY_ORDER
Q_ASSERT(caseSensitivity == Qt::CaseSensitive);
#endif
const auto locker = qt_scoped_lock(settingsGlobalMutex);
CustomFormatVector *customFormatVector = customFormatVectorFunc();
int index = customFormatVector->size();
if (index == 16) // the QSettings::Format enum has room for 16 custom formats
return QSettings::InvalidFormat;
QConfFileCustomFormat info;
info.extension = QLatin1Char('.') + extension;
info.readFunc = readFunc;
info.writeFunc = writeFunc;
info.caseSensitivity = caseSensitivity;
customFormatVector->append(info);
return QSettings::Format((int)QSettings::CustomFormat1 + index);
}
QT_END_NAMESPACE
#ifndef QT_BOOTSTRAPPED
#include "moc_qsettings.cpp"
#endif
|