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
|
/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup creator
*/
#ifndef WITH_PYTHON_MODULE
# include <cerrno>
# include <cstdlib>
# include <cstring>
# include "MEM_guardedalloc.h"
# include "CLG_log.h"
# ifdef WIN32
# include "BLI_winstuff.h"
# endif
# include "BLI_args.h"
# include "BLI_dynstr.h"
# include "BLI_fileops.h"
# include "BLI_listbase.h"
# include "BLI_path_utils.hh"
# include "BLI_string.h"
# include "BLI_string_utf8.h"
# include "BLI_system.h"
# include "BLI_threads.h"
# include "BLI_utildefines.h"
# ifndef NDEBUG
# include "BLI_mempool.h"
# endif
# include "BKE_appdir.hh"
# include "BKE_blender_cli_command.hh"
# include "BKE_blender_version.h"
# include "BKE_blendfile.hh"
# include "BKE_context.hh"
# include "BKE_global.hh"
# include "BKE_image_format.hh"
# include "BKE_lib_id.hh"
# include "BKE_main.hh"
# include "BKE_report.hh"
# include "BKE_scene.hh"
# include "BKE_sound.h"
# include "GPU_capabilities.hh"
# include "GPU_context.hh"
# ifdef WITH_PYTHON
# include "BPY_extern_python.hh"
# include "BPY_extern_run.hh"
# endif
# include "RE_engine.h"
# include "RE_pipeline.h"
# include "WM_api.hh"
# ifdef WITH_LIBMV
# include "libmv-capi.h"
# endif
# ifdef WITH_CYCLES_LOGGING
# include "CCL_api.h"
# endif
# include "DEG_depsgraph.hh"
# include "WM_types.hh"
# include "creator_intern.h" /* Own include. */
/* -------------------------------------------------------------------- */
/** \name Build Defines
* \{ */
/**
* Support extracting arguments for all platforms (for documentation purposes).
* These names match the upper case defines.
*/
struct BuildDefs {
bool win32;
bool with_cycles;
bool with_cycles_logging;
bool with_ffmpeg;
bool with_freestyle;
bool with_libmv;
bool with_ocio;
bool with_renderdoc;
bool with_xr_openxr;
};
static void build_defs_init(BuildDefs *build_defs, bool force_all)
{
if (force_all) {
bool *var_end = (bool *)(build_defs + 1);
for (bool *var = (bool *)build_defs; var < var_end; var++) {
*var = true;
}
return;
}
memset(build_defs, 0x0, sizeof(*build_defs));
# ifdef WIN32
build_defs->win32 = true;
# endif
# ifdef WITH_CYCLES
build_defs->with_cycles = true;
# endif
# ifdef WITH_CYCLES_LOGGING
build_defs->with_cycles_logging = true;
# endif
# ifdef WITH_FFMPEG
build_defs->with_ffmpeg = true;
# endif
# ifdef WITH_FREESTYLE
build_defs->with_freestyle = true;
# endif
# ifdef WITH_LIBMV
build_defs->with_libmv = true;
# endif
# ifdef WITH_OCIO
build_defs->with_ocio = true;
# endif
# ifdef WITH_RENDERDOC
build_defs->with_renderdoc = true;
# endif
# ifdef WITH_XR_OPENXR
build_defs->with_xr_openxr = true;
# endif
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Utility String Parsing
* \{ */
static bool parse_int_relative(const char *str,
const char *str_end_test,
int pos,
int neg,
int *r_value,
const char **r_err_msg)
{
char *str_end = nullptr;
long value;
errno = 0;
switch (*str) {
case '+':
value = pos + strtol(str + 1, &str_end, 10);
break;
case '-':
value = (neg - strtol(str + 1, &str_end, 10)) + 1;
break;
default:
value = strtol(str, &str_end, 10);
break;
}
if (*str_end != '\0' && (str_end != str_end_test)) {
static const char *msg = "not a number";
*r_err_msg = msg;
return false;
}
if ((errno == ERANGE) || ((value < INT_MIN) || (value > INT_MAX))) {
static const char *msg = "exceeds range";
*r_err_msg = msg;
return false;
}
*r_value = int(value);
return true;
}
static const char *parse_int_range_sep_search(const char *str, const char *str_end_test)
{
const char *str_end_range = nullptr;
if (str_end_test) {
str_end_range = static_cast<const char *>(memchr(str, '.', (str_end_test - str) - 1));
if (str_end_range && (str_end_range[1] != '.')) {
str_end_range = nullptr;
}
}
else {
str_end_range = strstr(str, "..");
if (str_end_range && (str_end_range[2] == '\0')) {
str_end_range = nullptr;
}
}
return str_end_range;
}
/**
* Parse a number as a range, eg: `1..4`.
*
* The \a str_end_range argument is a result of #parse_int_range_sep_search.
*/
static bool parse_int_range_relative(const char *str,
const char *str_end_range,
const char *str_end_test,
int pos,
int neg,
int r_value_range[2],
const char **r_err_msg)
{
if (parse_int_relative(str, str_end_range, pos, neg, &r_value_range[0], r_err_msg) &&
parse_int_relative(str_end_range + 2, str_end_test, pos, neg, &r_value_range[1], r_err_msg))
{
return true;
}
return false;
}
static bool parse_int_relative_clamp(const char *str,
const char *str_end_test,
int pos,
int neg,
int min,
int max,
int *r_value,
const char **r_err_msg)
{
if (parse_int_relative(str, str_end_test, pos, neg, r_value, r_err_msg)) {
CLAMP(*r_value, min, max);
return true;
}
return false;
}
static bool parse_int_range_relative_clamp(const char *str,
const char *str_end_range,
const char *str_end_test,
int pos,
int neg,
int min,
int max,
int r_value_range[2],
const char **r_err_msg)
{
if (parse_int_range_relative(
str, str_end_range, str_end_test, pos, neg, r_value_range, r_err_msg))
{
CLAMP(r_value_range[0], min, max);
CLAMP(r_value_range[1], min, max);
return true;
}
return false;
}
/**
* No clamping, fails with any number outside the range.
*/
static bool parse_int_strict_range(const char *str,
const char *str_end_test,
const int min,
const int max,
int *r_value,
const char **r_err_msg)
{
char *str_end = nullptr;
long value;
errno = 0;
value = strtol(str, &str_end, 10);
if (*str_end != '\0' && (str_end != str_end_test)) {
static const char *msg = "not a number";
*r_err_msg = msg;
return false;
}
if ((errno == ERANGE) || ((value < min) || (value > max))) {
static const char *msg = "exceeds range";
*r_err_msg = msg;
return false;
}
*r_value = int(value);
return true;
}
static bool parse_int(const char *str,
const char *str_end_test,
int *r_value,
const char **r_err_msg)
{
return parse_int_strict_range(str, str_end_test, INT_MIN, INT_MAX, r_value, r_err_msg);
}
static bool parse_int_clamp(const char *str,
const char *str_end_test,
int min,
int max,
int *r_value,
const char **r_err_msg)
{
if (parse_int(str, str_end_test, r_value, r_err_msg)) {
CLAMP(*r_value, min, max);
return true;
}
return false;
}
# if 0
/**
* Version of #parse_int_relative_clamp
* that parses a comma separated list of numbers.
*/
static int *parse_int_relative_clamp_n(
const char *str, int pos, int neg, int min, int max, int *r_value_len, const char **r_err_msg)
{
const char sep = ',';
int len = 1;
for (int i = 0; str[i]; i++) {
if (str[i] == sep) {
len++;
}
}
int *values = MEM_mallocN(sizeof(*values) * len, __func__);
int i = 0;
while (true) {
const char *str_end = strchr(str, sep);
if (ELEM(*str, sep, '\0')) {
static const char *msg = "incorrect comma use";
*r_err_msg = msg;
goto fail;
}
else if (parse_int_relative_clamp(str, str_end, pos, neg, min, max, &values[i], r_err_msg)) {
i++;
}
else {
goto fail; /* Error message already set. */
}
if (str_end) { /* Next. */
str = str_end + 1;
}
else { /* Finished. */
break;
}
}
*r_value_len = i;
return values;
fail:
MEM_freeN(values);
return nullptr;
}
# endif
/**
* Version of #parse_int_relative_clamp & #parse_int_range_relative_clamp
* that parses a comma separated list of numbers.
*
* \note single values are evaluated as a range with matching start/end.
*/
static int (*parse_int_range_relative_clamp_n(const char *str,
int pos,
int neg,
int min,
int max,
int *r_value_len,
const char **r_err_msg))[2]
{
const char sep = ',';
int len = 1;
for (int i = 0; str[i]; i++) {
if (str[i] == sep) {
len++;
}
}
int(*values)[2] = static_cast<int(*)[2]>(MEM_mallocN(sizeof(*values) * len, __func__));
int i = 0;
while (true) {
const char *str_end_range;
const char *str_end = strchr(str, sep);
if (ELEM(*str, sep, '\0')) {
static const char *msg = "incorrect comma use";
*r_err_msg = msg;
goto fail;
}
else if ((str_end_range = parse_int_range_sep_search(str, str_end)) ?
parse_int_range_relative_clamp(
str, str_end_range, str_end, pos, neg, min, max, values[i], r_err_msg) :
parse_int_relative_clamp(
str, str_end, pos, neg, min, max, &values[i][0], r_err_msg))
{
if (str_end_range == nullptr) {
values[i][1] = values[i][0];
}
i++;
}
else {
goto fail; /* Error message already set. */
}
if (str_end) { /* Next. */
str = str_end + 1;
}
else { /* Finished. */
break;
}
}
*r_value_len = i;
return values;
fail:
MEM_freeN(values);
return nullptr;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Deferred Argument Handling
*
* Support executing an argument running instead of #WM_main which is deferred.
* Needed for arguments which are handled early but require sub-systems
* (Python in particular) * to be initialized.
* \{ */
/* When the deferred argument is handled on Windows the `argv` will have been freed,
* see `USE_WIN32_UNICODE_ARGS` in `creator.cc`. */
# ifdef WIN32
static char **argv_duplicate(const char **argv, int argc)
{
char **argv_copy = static_cast<char **>(MEM_mallocN(sizeof(*argv_copy) * argc, __func__));
for (int i = 0; i < argc; i++) {
argv_copy[i] = BLI_strdup(argv[i]);
}
return argv_copy;
}
static void argv_free(char **argv, int argc)
{
for (int i = 0; i < argc; i++) {
MEM_freeN(argv[i]);
}
MEM_freeN(argv);
}
# endif /* !WIN32 */
struct BA_ArgCallback_Deferred {
BA_ArgCallback func;
int argc;
const char **argv;
void *data;
/** Return-code. */
int exit_code;
};
static bool main_arg_deferred_is_set()
{
return app_state.main_arg_deferred != nullptr;
}
static void main_arg_deferred_setup(BA_ArgCallback func, int argc, const char **argv, void *data)
{
BLI_assert(app_state.main_arg_deferred == nullptr);
BA_ArgCallback_Deferred *d = static_cast<BA_ArgCallback_Deferred *>(
MEM_callocN(sizeof(*d), __func__));
d->func = func;
d->argc = argc;
d->argv = argv;
d->data = data;
d->exit_code = 0;
# ifdef WIN32
d->argv = const_cast<const char **>(argv_duplicate(d->argv, d->argc));
# endif
app_state.main_arg_deferred = d;
}
void main_arg_deferred_free()
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
app_state.main_arg_deferred = nullptr;
# ifdef WIN32
argv_free(const_cast<char **>(d->argv), d->argc);
# endif
MEM_freeN(d);
}
static void main_arg_deferred_exit_code_set(int exit_code)
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
BLI_assert(d != nullptr);
d->exit_code = exit_code;
}
int main_arg_deferred_handle()
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
d->func(d->argc, d->argv, d->data);
return d->exit_code;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Utilities Python Context Macro (#BPY_CTX_SETUP)
* \{ */
# ifdef WITH_PYTHON
struct BlendePyContextStore {
wmWindowManager *wm;
Scene *scene;
wmWindow *win;
bool has_win;
};
static void arg_py_context_backup(bContext *C, BlendePyContextStore *c_py)
{
c_py->wm = CTX_wm_manager(C);
c_py->scene = CTX_data_scene(C);
c_py->has_win = c_py->wm && !BLI_listbase_is_empty(&c_py->wm->windows);
if (c_py->has_win) {
c_py->win = CTX_wm_window(C);
CTX_wm_window_set(C, static_cast<wmWindow *>(c_py->wm->windows.first));
}
else {
/* NOTE: this should never happen, although it may be possible when loading
* `.blend` files without windowing data. Whatever the case, it shouldn't crash,
* although typical scripts that accesses the context is not expected to work usefully. */
c_py->win = nullptr;
fprintf(stderr, "Python script running with missing context data.\n");
}
}
static void arg_py_context_restore(bContext *C, BlendePyContextStore *c_py)
{
/* Script may load a file, check old data is valid before using. */
if (c_py->has_win) {
if ((c_py->win == nullptr) || ((BLI_findindex(&G_MAIN->wm, c_py->wm) != -1) &&
(BLI_findindex(&c_py->wm->windows, c_py->win) != -1)))
{
CTX_wm_window_set(C, c_py->win);
}
}
if ((c_py->scene == nullptr) || BLI_findindex(&G_MAIN->scenes, c_py->scene) != -1) {
CTX_data_scene_set(C, c_py->scene);
}
}
/* Macro for context setup/reset. */
# define BPY_CTX_SETUP(_cmd) \
{ \
BlendePyContextStore py_c; \
arg_py_context_backup(C, &py_c); \
{ \
_cmd; \
} \
arg_py_context_restore(C, &py_c); \
} \
((void)0)
# endif /* WITH_PYTHON */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Handle Argument Callbacks
*
* \note Doc strings here are used in differently:
*
* - The `--help` message.
* - The man page (for Unix systems),
* see: `doc/manpage/blender.1.py`
* - Parsed and extracted for the manual,
* which converts our ad-hoc formatting to reStructuredText.
* see: https://docs.blender.org/manual/en/dev/advanced/command_line.html
*
* \{ */
static void print_version_full()
{
printf("Blender %s\n", BKE_blender_version_string());
# ifdef BUILD_DATE
printf("\tbuild date: %s\n", build_date);
printf("\tbuild time: %s\n", build_time);
printf("\tbuild commit date: %s\n", build_commit_date);
printf("\tbuild commit time: %s\n", build_commit_time);
printf("\tbuild hash: %s\n", build_hash);
printf("\tbuild branch: %s\n", build_branch);
printf("\tbuild platform: %s\n", build_platform);
printf("\tbuild type: %s\n", build_type);
printf("\tbuild c flags: %s\n", build_cflags);
printf("\tbuild c++ flags: %s\n", build_cxxflags);
printf("\tbuild link flags: %s\n", build_linkflags);
printf("\tbuild system: %s\n", build_system);
# endif
}
static void print_version_short()
{
# ifdef BUILD_DATE
/* NOTE: We include built time since sometimes we need to tell broken from
* working built of the same hash. */
printf("Blender %s (hash %s built %s %s)\n",
BKE_blender_version_string(),
build_hash,
build_date,
build_time);
# else
printf("Blender %s\n", BKE_blender_version_string());
# endif
}
static const char arg_handle_print_version_doc[] =
"\n\t"
"Print Blender version and exit.";
static int arg_handle_print_version(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
print_version_full();
exit(EXIT_SUCCESS);
BLI_assert_unreachable();
return 0;
}
static void print_help(bArgs *ba, bool all)
{
BuildDefs defs;
build_defs_init(&defs, all);
/* All printing must go via `PRINT` macro. */
# define printf __ERROR__
# define PRINT(...) BLI_args_printf(ba, __VA_ARGS__)
PRINT("Blender %s\n", BKE_blender_version_string());
PRINT("Usage: blender [args ...] [file] [args ...]\n");
PRINT("\n");
PRINT("Render Options:\n");
BLI_args_print_arg_doc(ba, "--background");
BLI_args_print_arg_doc(ba, "--render-anim");
BLI_args_print_arg_doc(ba, "--scene");
BLI_args_print_arg_doc(ba, "--render-frame");
BLI_args_print_arg_doc(ba, "--frame-start");
BLI_args_print_arg_doc(ba, "--frame-end");
BLI_args_print_arg_doc(ba, "--frame-jump");
BLI_args_print_arg_doc(ba, "--render-output");
BLI_args_print_arg_doc(ba, "--engine");
BLI_args_print_arg_doc(ba, "--threads");
if (defs.with_cycles) {
PRINT("Cycles Render Options:\n");
PRINT("\tCycles add-on options must be specified following a double dash.\n");
PRINT("\n");
PRINT("--cycles-device <device>\n");
PRINT("\tSet the device used for rendering.\n");
PRINT("\tValid options are: 'CPU' 'CUDA' 'OPTIX' 'HIP' 'ONEAPI' 'METAL'.\n");
PRINT("\n");
PRINT("\tAppend +CPU to a GPU device to render on both CPU and GPU.\n");
PRINT("\n");
PRINT("\tExample:\n");
PRINT("\t# blender -b file.blend -f 20 -- --cycles-device OPTIX\n");
PRINT("--cycles-print-stats\n");
PRINT("\tLog statistics about render memory and time usage.\n");
}
PRINT("\n");
PRINT("Format Options:\n");
BLI_args_print_arg_doc(ba, "--render-format");
BLI_args_print_arg_doc(ba, "--use-extension");
PRINT("\n");
PRINT("Animation Playback Options:\n");
BLI_args_print_arg_doc(ba, "-a");
PRINT("\n");
PRINT("Window Options:\n");
BLI_args_print_arg_doc(ba, "--window-border");
BLI_args_print_arg_doc(ba, "--window-fullscreen");
BLI_args_print_arg_doc(ba, "--window-geometry");
BLI_args_print_arg_doc(ba, "--window-maximized");
BLI_args_print_arg_doc(ba, "--start-console");
BLI_args_print_arg_doc(ba, "--no-native-pixels");
BLI_args_print_arg_doc(ba, "--no-window-focus");
PRINT("\n");
PRINT("Python Options:\n");
BLI_args_print_arg_doc(ba, "--enable-autoexec");
BLI_args_print_arg_doc(ba, "--disable-autoexec");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--python");
BLI_args_print_arg_doc(ba, "--python-text");
BLI_args_print_arg_doc(ba, "--python-expr");
BLI_args_print_arg_doc(ba, "--python-console");
BLI_args_print_arg_doc(ba, "--python-exit-code");
BLI_args_print_arg_doc(ba, "--python-use-system-env");
BLI_args_print_arg_doc(ba, "--addons");
PRINT("\n");
PRINT("Network Options:\n");
BLI_args_print_arg_doc(ba, "--online-mode");
BLI_args_print_arg_doc(ba, "--offline-mode");
PRINT("\n");
PRINT("Logging Options:\n");
BLI_args_print_arg_doc(ba, "--log");
BLI_args_print_arg_doc(ba, "--log-level");
BLI_args_print_arg_doc(ba, "--log-show-basename");
BLI_args_print_arg_doc(ba, "--log-show-backtrace");
BLI_args_print_arg_doc(ba, "--log-show-timestamp");
BLI_args_print_arg_doc(ba, "--log-file");
PRINT("\n");
PRINT("Debug Options:\n");
BLI_args_print_arg_doc(ba, "--debug");
BLI_args_print_arg_doc(ba, "--debug-value");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--debug-events");
if (defs.with_ffmpeg) {
BLI_args_print_arg_doc(ba, "--debug-ffmpeg");
}
BLI_args_print_arg_doc(ba, "--debug-handlers");
if (defs.with_libmv) {
BLI_args_print_arg_doc(ba, "--debug-libmv");
}
if (defs.with_cycles_logging) {
BLI_args_print_arg_doc(ba, "--debug-cycles");
}
BLI_args_print_arg_doc(ba, "--debug-memory");
BLI_args_print_arg_doc(ba, "--debug-jobs");
BLI_args_print_arg_doc(ba, "--debug-python");
BLI_args_print_arg_doc(ba, "--debug-depsgraph");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-eval");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-build");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-tag");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-no-threads");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-time");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-pretty");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-uid");
BLI_args_print_arg_doc(ba, "--debug-ghost");
BLI_args_print_arg_doc(ba, "--debug-wintab");
BLI_args_print_arg_doc(ba, "--debug-gpu");
BLI_args_print_arg_doc(ba, "--debug-gpu-force-workarounds");
BLI_args_print_arg_doc(ba, "--debug-gpu-compile-shaders");
if (defs.with_renderdoc) {
BLI_args_print_arg_doc(ba, "--debug-gpu-scope-capture");
BLI_args_print_arg_doc(ba, "--debug-gpu-renderdoc");
}
BLI_args_print_arg_doc(ba, "--debug-wm");
if (defs.with_xr_openxr) {
BLI_args_print_arg_doc(ba, "--debug-xr");
BLI_args_print_arg_doc(ba, "--debug-xr-time");
}
BLI_args_print_arg_doc(ba, "--debug-all");
BLI_args_print_arg_doc(ba, "--debug-io");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--debug-fpe");
BLI_args_print_arg_doc(ba, "--debug-exit-on-error");
if (defs.with_freestyle) {
BLI_args_print_arg_doc(ba, "--debug-freestyle");
}
BLI_args_print_arg_doc(ba, "--disable-crash-handler");
BLI_args_print_arg_doc(ba, "--disable-abort-handler");
BLI_args_print_arg_doc(ba, "--verbose");
BLI_args_print_arg_doc(ba, "--quiet");
PRINT("\n");
PRINT("GPU Options:\n");
BLI_args_print_arg_doc(ba, "--gpu-backend");
# ifdef WITH_OPENGL_BACKEND
BLI_args_print_arg_doc(ba, "--gpu-compilation-subprocesses");
# endif
PRINT("\n");
PRINT("Misc Options:\n");
BLI_args_print_arg_doc(ba, "--open-last");
BLI_args_print_arg_doc(ba, "--app-template");
BLI_args_print_arg_doc(ba, "--factory-startup");
BLI_args_print_arg_doc(ba, "--enable-event-simulate");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--env-system-datafiles");
BLI_args_print_arg_doc(ba, "--env-system-scripts");
BLI_args_print_arg_doc(ba, "--env-system-extensions");
BLI_args_print_arg_doc(ba, "--env-system-python");
PRINT("\n");
BLI_args_print_arg_doc(ba, "-noaudio");
BLI_args_print_arg_doc(ba, "-setaudio");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--command");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--help");
BLI_args_print_arg_doc(ba, "/?");
/* WIN32 only (ignored for non-WIN32). */
BLI_args_print_arg_doc(ba, "--register");
BLI_args_print_arg_doc(ba, "--register-allusers");
BLI_args_print_arg_doc(ba, "--unregister");
BLI_args_print_arg_doc(ba, "--unregister-allusers");
BLI_args_print_arg_doc(ba, "--version");
BLI_args_print_arg_doc(ba, "--");
// PRINT("\n");
// PRINT("Experimental Features:\n");
/* Other options _must_ be last (anything not handled will show here).
*
* Note that it's good practice for this to remain empty,
* nevertheless print if any exist. */
if (BLI_args_has_other_doc(ba)) {
PRINT("\n");
PRINT("Other Options:\n");
BLI_args_print_other_doc(ba);
}
PRINT("\n");
PRINT("Argument Parsing:\n");
PRINT("\tArguments must be separated by white space, eg:\n");
PRINT("\t# blender -ba test.blend\n");
PRINT("\t...will exit since '-ba' is an unknown argument.\n");
PRINT("\n");
PRINT("Argument Order:\n");
PRINT("\tArguments are executed in the order they are given. eg:\n");
PRINT("\t# blender --background test.blend --render-frame 1 --render-output \"/tmp\"\n");
PRINT(
"\t...will not render to '/tmp' because '--render-frame 1' renders before the output path "
"is set.\n");
PRINT("\t# blender --background --render-output /tmp test.blend --render-frame 1\n");
PRINT(
"\t...will not render to '/tmp' because loading the blend-file overwrites the render output "
"that was set.\n");
PRINT("\t# blender --background test.blend --render-output /tmp --render-frame 1\n");
PRINT("\t...works as expected.\n");
PRINT("\n");
PRINT("Environment Variables:\n");
PRINT(" $BLENDER_USER_RESOURCES Replace default directory of all user files.\n");
PRINT(" Other 'BLENDER_USER_*' variables override when set.\n");
PRINT(" $BLENDER_USER_CONFIG Directory for user configuration files.\n");
PRINT(" $BLENDER_USER_SCRIPTS Directory for user scripts.\n");
PRINT(" $BLENDER_USER_EXTENSIONS Directory for user extensions.\n");
PRINT(" $BLENDER_USER_DATAFILES Directory for user data files (icons, translations, ..).\n");
PRINT("\n");
PRINT(" $BLENDER_SYSTEM_RESOURCES Replace default directory of all bundled resource files.\n");
PRINT(" $BLENDER_SYSTEM_SCRIPTS Directory to add more bundled scripts.\n");
PRINT(" $BLENDER_SYSTEM_EXTENSIONS Directory for system extensions repository.\n");
PRINT(" $BLENDER_SYSTEM_DATAFILES Directory to replace bundled datafiles.\n");
PRINT(" $BLENDER_SYSTEM_PYTHON Directory to replace bundled Python libraries.\n");
if (defs.with_ocio) {
PRINT(" $OCIO Path to override the OpenColorIO configuration file.\n");
}
if (defs.win32 || all) {
PRINT(" $TEMP Store temporary files here (MS-Windows).\n");
}
if (!defs.win32 || all) {
/* NOTE: while `TMP` checked, don't include here as it's non-standard & may be removed. */
PRINT(" $TMPDIR Store temporary files here (UNIX Systems).\n");
}
PRINT(
" The path must reference an existing directory "
"or it will be ignored.\n");
# undef printf
# undef PRINT
}
ATTR_PRINTF_FORMAT(2, 0)
static void help_print_ds_fn(void *ds_v, const char *format, va_list args)
{
DynStr *ds = static_cast<DynStr *>(ds_v);
BLI_dynstr_vappendf(ds, format, args);
}
static char *main_args_help_as_string(bool all)
{
DynStr *ds = BLI_dynstr_new();
{
bArgs *ba = BLI_args_create(0, nullptr);
main_args_setup(nullptr, ba, all);
BLI_args_print_fn_set(ba, help_print_ds_fn, ds);
print_help(ba, all);
BLI_args_destroy(ba);
}
char *buf = BLI_dynstr_get_cstring(ds);
BLI_dynstr_free(ds);
return buf;
}
static const char arg_handle_print_help_doc[] =
"\n\t"
"Print this help text and exit.";
static const char arg_handle_print_help_doc_win32[] =
"\n\t"
"Print this help text and exit (Windows only).";
static int arg_handle_print_help(int /*argc*/, const char ** /*argv*/, void *data)
{
bArgs *ba = (bArgs *)data;
print_help(ba, false);
exit(EXIT_SUCCESS);
BLI_assert_unreachable();
return 0;
}
static const char arg_handle_arguments_end_doc[] =
"\n\t"
"End option processing, following arguments passed unchanged. Access via Python's "
"'sys.argv'.";
static int arg_handle_arguments_end(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
return -1;
}
/* Only to give help message. */
# ifdef WITH_PYTHON_SECURITY /* Default. */
# define PY_ENABLE_AUTO ""
# define PY_DISABLE_AUTO ", (default)"
# else
# define PY_ENABLE_AUTO ", (default, non-standard compilation option)"
# define PY_DISABLE_AUTO ""
# endif
static const char arg_handle_python_set_doc_enable[] =
"\n\t"
"Enable automatic Python script execution" PY_ENABLE_AUTO ".";
static const char arg_handle_python_set_doc_disable[] =
"\n\t"
"Disable automatic Python script execution "
"(Python-drivers & startup scripts)" PY_DISABLE_AUTO ".";
# undef PY_ENABLE_AUTO
# undef PY_DISABLE_AUTO
static int arg_handle_python_set(int /*argc*/, const char ** /*argv*/, void *data)
{
if (bool(data)) {
G.f |= G_FLAG_SCRIPT_AUTOEXEC;
}
else {
G.f &= ~G_FLAG_SCRIPT_AUTOEXEC;
}
G.f |= G_FLAG_SCRIPT_OVERRIDE_PREF;
return 0;
}
static const char arg_handle_internet_allow_set_doc_online[] =
"\n\t"
"Allow internet access, overriding the preference.";
static const char arg_handle_internet_allow_set_doc_offline[] =
"\n\t"
"Disallow internet access, overriding the preference.";
static int arg_handle_internet_allow_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.f &= ~G_FLAG_INTERNET_OVERRIDE_PREF_ANY;
if (bool(data)) {
G.f |= G_FLAG_INTERNET_ALLOW;
G.f |= G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE;
}
else {
G.f &= ~G_FLAG_INTERNET_ALLOW;
G.f |= G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE;
}
return 0;
}
static const char arg_handle_crash_handler_disable_doc[] =
"\n\t"
"Disable the crash handler.";
static int arg_handle_crash_handler_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
app_state.signal.use_crash_handler = false;
return 0;
}
static const char arg_handle_abort_handler_disable_doc[] =
"\n\t"
"Disable the abort handler.";
static int arg_handle_abort_handler_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
app_state.signal.use_abort_handler = false;
return 0;
}
static void clog_abort_on_error_callback(void *fp)
{
BLI_system_backtrace(static_cast<FILE *>(fp));
fflush(static_cast<FILE *>(fp));
abort();
}
static const char arg_handle_debug_exit_on_error_doc[] =
"\n\t"
"Immediately exit when internal errors are detected.";
static int arg_handle_debug_exit_on_error(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
MEM_enable_fail_on_memleak();
CLG_error_fn_set(clog_abort_on_error_callback);
return 0;
}
static const char arg_handle_quiet_set_doc[] =
"\n\t"
"Suppress status printing (warnings & errors are still printed).";
static int arg_handle_quiet_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.quiet = true;
return 0;
}
/** Shared by `--background` & `--command`. */
static void background_mode_set()
{
G.background = true;
/* Background Mode Defaults:
*
* In general background mode should strive to match the behavior of running
* Blender inside a graphical session, any exception to this should have a well
* justified reason and be noted in the doc-string. */
/* NOTE(@ideasman42): While there is no requirement for sound to be disabled in background-mode,
* the use case for playing audio in background mode is enough of a special-case
* that users who wish to do this can explicitly enable audio in background mode.
* While the down sides for connecting to an audio device aren't terrible they include:
* - Listing Blender as an active application which may output audio.
* - Unnecessary overhead running an operation in background mode or ...
* - Having to remember to include `-noaudio` with batch operations.
* - A quiet but audible click when Blender starts & configures its audio device.
*/
BKE_sound_force_device("None");
}
static const char arg_handle_background_mode_set_doc[] =
"\n"
"\tRun in background (often used for UI-less rendering).\n"
"\n"
"\tThe audio device is disabled in background-mode by default\n"
"\tand can be re-enabled by passing in '-setaudo Default' afterwards.";
static int arg_handle_background_mode_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
if (!G.quiet) {
print_version_short();
}
background_mode_set();
return 0;
}
static const char arg_handle_command_set_doc[] =
"<command>\n"
"\tRun a command which consumes all remaining arguments.\n"
"\tUse '-c help' to list all other commands.\n"
"\tPass '--help' after the command to see its help text.\n"
"\n"
"\tThis implies '--background' mode.";
static int arg_handle_command_set(int argc, const char **argv, void *data)
{
if (!main_arg_deferred_is_set()) {
if (argc < 2) {
fprintf(stderr, "%s requires at least one argument\n", argv[0]);
exit(EXIT_FAILURE);
BLI_assert_unreachable();
}
/* Application "info" messages get in the way of command line output, suppress them. */
G.quiet = true;
background_mode_set();
main_arg_deferred_setup(arg_handle_command_set, argc, argv, data);
}
else {
bContext *C = static_cast<bContext *>(data);
const char *id = argv[1];
int exit_code;
if (STREQ(id, "help")) {
BKE_blender_cli_command_print_help();
exit_code = EXIT_SUCCESS;
}
else {
exit_code = BKE_blender_cli_command_exec(C, id, argc - 2, argv + 2);
}
main_arg_deferred_exit_code_set(exit_code);
}
/* Consume remaining arguments. */
return argc - 1;
}
static const char arg_handle_log_level_set_doc[] =
"<level>\n"
"\tSet the logging verbosity level (higher for more details) defaults to 1,\n"
"\tuse -1 to log all levels.";
static int arg_handle_log_level_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log-level";
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_clamp(argv[1], nullptr, -1, INT_MAX, &G.log.level, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
if (G.log.level == -1) {
G.log.level = INT_MAX;
}
CLG_level_set(G.log.level);
}
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
return 0;
}
static const char arg_handle_log_show_basename_set_doc[] =
"\n\t"
"Only show file name in output (not the leading path).";
static int arg_handle_log_show_basename_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
CLG_output_use_basename_set(true);
return 0;
}
static const char arg_handle_log_show_backtrace_set_doc[] =
"\n\t"
"Show a back trace for each log message (debug builds only).";
static int arg_handle_log_show_backtrace_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
/* Ensure types don't become incompatible. */
void (*fn)(FILE *fp) = BLI_system_backtrace;
CLG_backtrace_fn_set((void (*)(void *))fn);
return 0;
}
static const char arg_handle_log_show_timestamp_set_doc[] =
"\n\t"
"Show a timestamp for each log message in seconds since start.";
static int arg_handle_log_show_timestamp_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
CLG_output_use_timestamp_set(true);
return 0;
}
static const char arg_handle_log_file_set_doc[] =
"<filepath>\n"
"\tSet a file to output the log to.";
static int arg_handle_log_file_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log-file";
if (argc > 1) {
errno = 0;
FILE *fp = BLI_fopen(argv[1], "w");
if (fp == nullptr) {
const char *err_msg = errno ? strerror(errno) : "unknown";
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
if (UNLIKELY(G.log.file != nullptr)) {
fclose(static_cast<FILE *>(G.log.file));
}
G.log.file = fp;
CLG_output_set(G.log.file);
}
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
return 0;
}
static const char arg_handle_log_set_doc[] =
"<match>\n"
"\tEnable logging categories, taking a single comma separated argument.\n"
"\tMultiple categories can be matched using a '.*' suffix,\n"
"\tso '--log \"wm.*\"' logs every kind of window-manager message.\n"
"\tSub-string can be matched using a '*' prefix and suffix,\n"
"\tso '--log \"*undo*\"' logs every kind of undo-related message.\n"
"\tUse \"^\" prefix to ignore, so '--log \"*,^wm.operator.*\"' logs all except for "
"'wm.operators.*'\n"
"\tUse \"*\" to log everything.";
static int arg_handle_log_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log";
if (argc > 1) {
const char *str_step = argv[1];
while (*str_step) {
const char *str_step_end = strchr(str_step, ',');
int str_step_len = str_step_end ? (str_step_end - str_step) : strlen(str_step);
if (str_step[0] == '^') {
CLG_type_filter_exclude(str_step + 1, str_step_len - 1);
}
else {
CLG_type_filter_include(str_step, str_step_len);
}
if (str_step_end) {
/* Typically only be one, but don't fail on multiple. */
while (*str_step_end == ',') {
str_step_end++;
}
str_step = str_step_end;
}
else {
break;
}
}
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
return 0;
}
static const char arg_handle_debug_mode_set_doc[] =
"\n"
"\tTurn debugging on.\n"
"\n"
"\t* Enables memory error detection\n"
"\t* Disables mouse grab (to interact with a debugger in some cases)\n"
"\t* Keeps Python's 'sys.stdin' rather than setting it to None";
static int arg_handle_debug_mode_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.debug |= G_DEBUG;
printf("Blender %s\n", BKE_blender_version_string());
MEM_set_memory_debug();
# ifndef NDEBUG
BLI_mempool_set_memory_debug();
# endif
# ifdef WITH_BUILDINFO
printf("Build: %s %s %s %s\n", build_date, build_time, build_platform, build_type);
# endif
BLI_args_print(static_cast<bArgs *>(data));
return 0;
}
static const char arg_handle_debug_mode_generic_set_doc_ffmpeg[] =
"\n\t"
"Enable debug messages from FFmpeg library.";
static const char arg_handle_debug_mode_generic_set_doc_freestyle[] =
"\n\t"
"Enable debug messages for Freestyle.";
static const char arg_handle_debug_mode_generic_set_doc_python[] =
"\n\t"
"Enable debug messages for Python.";
static const char arg_handle_debug_mode_generic_set_doc_events[] =
"\n\t"
"Enable debug messages for the event system.";
static const char arg_handle_debug_mode_generic_set_doc_handlers[] =
"\n\t"
"Enable debug messages for event handling.";
static const char arg_handle_debug_mode_generic_set_doc_wm[] =
"\n\t"
"Enable debug messages for the window manager, shows all operators in search, shows "
"keymap errors.";
static const char arg_handle_debug_mode_generic_set_doc_ghost[] =
"\n\t"
"Enable debug messages for Ghost (Linux only).";
static const char arg_handle_debug_mode_generic_set_doc_wintab[] =
"\n\t"
"Enable debug messages for Wintab.";
static const char arg_handle_debug_mode_generic_set_doc_xr[] =
"\n\t"
"Enable debug messages for virtual reality contexts.\n"
"\tEnables the OpenXR API validation layer, (OpenXR) debug messages and general information "
"prints.";
static const char arg_handle_debug_mode_generic_set_doc_xr_time[] =
"\n\t"
"Enable debug messages for virtual reality frame rendering times.";
static const char arg_handle_debug_mode_generic_set_doc_jobs[] =
"\n\t"
"Enable time profiling for background jobs.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph[] =
"\n\t"
"Enable all debug messages from dependency graph.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_build[] =
"\n\t"
"Enable debug messages from dependency graph related on graph construction.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_tag[] =
"\n\t"
"Enable debug messages from dependency graph related on tagging.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_time[] =
"\n\t"
"Enable debug messages from dependency graph related on timing.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_eval[] =
"\n\t"
"Enable debug messages from dependency graph related on evaluation.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_no_threads[] =
"\n\t"
"Switch dependency graph to a single threaded evaluation.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_pretty[] =
"\n\t"
"Enable colors for dependency graph debug messages.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_uid[] =
"\n\t"
"Verify validness of session-wide identifiers assigned to ID data-blocks.";
static const char arg_handle_debug_mode_generic_set_doc_gpu_force_workarounds[] =
"\n\t"
"Enable workarounds for typical GPU issues and disable all GPU extensions.";
static int arg_handle_debug_mode_generic_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.debug |= POINTER_AS_INT(data);
return 0;
}
static const char arg_handle_debug_mode_io_doc[] =
"\n\t"
"Enable debug messages for I/O (Collada, ...).";
static int arg_handle_debug_mode_io(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.debug |= G_DEBUG_IO;
return 0;
}
static const char arg_handle_debug_mode_all_doc[] =
"\n\t"
"Enable all debug messages.";
static int arg_handle_debug_mode_all(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.debug |= G_DEBUG_ALL;
# ifdef WITH_LIBMV
libmv_startDebugLogging();
# endif
# ifdef WITH_CYCLES_LOGGING
CCL_start_debug_logging();
# endif
return 0;
}
static const char arg_handle_debug_mode_libmv_doc[] =
"\n\t"
"Enable debug messages from libmv library.";
static int arg_handle_debug_mode_libmv(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
# ifdef WITH_LIBMV
libmv_startDebugLogging();
# endif
return 0;
}
static const char arg_handle_debug_mode_cycles_doc[] =
"\n\t"
"Enable debug messages from Cycles.";
static int arg_handle_debug_mode_cycles(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
# ifdef WITH_CYCLES_LOGGING
CCL_start_debug_logging();
# endif
return 0;
}
static const char arg_handle_debug_mode_memory_set_doc[] =
"\n\t"
"Enable fully guarded memory allocation and debugging.";
static int arg_handle_debug_mode_memory_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
MEM_set_memory_debug();
return 0;
}
static const char arg_handle_debug_value_set_doc[] =
"<value>\n"
"\tSet debug value of <value> on startup.";
static int arg_handle_debug_value_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--debug-value";
if (argc > 1) {
const char *err_msg = nullptr;
int value;
if (!parse_int(argv[1], nullptr, &value, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
return 1;
}
G.debug_value = value;
return 1;
}
fprintf(stderr, "\nError: you must specify debug value to set.\n");
return 0;
}
static const char arg_handle_debug_gpu_set_doc[] =
"\n"
"\tEnable GPU debug context and information for OpenGL 4.3+.";
static int arg_handle_debug_gpu_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
/* Also enable logging because that how gl errors are reported. */
const char *gpu_filter = "gpu.*";
CLG_type_filter_include(gpu_filter, strlen(gpu_filter));
G.debug |= G_DEBUG_GPU;
return 0;
}
static const char arg_handle_debug_gpu_compile_shaders_set_doc[] =
"\n"
"\tCompile all statically defined shaders to test platform compatibility.";
static int arg_handle_debug_gpu_compile_shaders_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
G.debug |= G_DEBUG_GPU_COMPILE_SHADERS;
return 0;
}
static const char arg_handle_debug_gpu_scope_capture_set_doc[] =
"\n"
"\tCapture the GPU commands issued inside the give scope name.";
static int arg_handle_debug_gpu_scope_capture_set(int argc, const char **argv, void * /*data*/)
{
if (argc > 1) {
STRNCPY(G.gpu_debug_scope_name, argv[1]);
return 1;
}
fprintf(stderr, "\nError: you must specify a scope name to capture.\n");
return 0;
}
static const char arg_handle_debug_gpu_renderdoc_set_doc[] =
"\n"
"\tEnable RenderDoc integration for GPU frame grabbing and debugging.";
static int arg_handle_debug_gpu_renderdoc_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
# ifdef WITH_RENDERDOC
G.debug |= G_DEBUG_GPU_RENDERDOC | G_DEBUG_GPU;
# endif
return 0;
}
static const char arg_handle_gpu_backend_set_doc_all[] =
"\n"
"\tForce to use a specific GPU backend. Valid options: "
"'vulkan' (experimental), "
"'metal', "
"'opengl'.";
static const char arg_handle_gpu_backend_set_doc[] =
"\n"
"\tForce to use a specific GPU backend. Valid options: "
# ifdef WITH_OPENGL_BACKEND
"'opengl'"
# endif
# ifdef WITH_METAL_BACKEND
"'metal'"
# endif
# ifdef WITH_VULKAN_BACKEND
# if defined(WITH_OPENGL_BACKEND) || defined(WITH_METAL_BACKEND)
" or "
# endif
"'vulkan' (experimental)"
# endif
".";
static int arg_handle_gpu_backend_set(int argc, const char **argv, void * /*data*/)
{
if (argc == 0) {
fprintf(stderr, "\nError: GPU backend must follow '--gpu-backend'.\n");
return 0;
}
const char *backends_supported[3] = {nullptr};
int backends_supported_num = 0;
eGPUBackendType gpu_backend = GPU_BACKEND_NONE;
/* NOLINTBEGIN: bugprone-assignment-in-if-condition */
if (false) {
/* Just a dummy if to make the following ifdef blocks work. */
}
# ifdef WITH_OPENGL_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "opengl"))) {
gpu_backend = GPU_BACKEND_OPENGL;
}
# endif
# ifdef WITH_VULKAN_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "vulkan"))) {
gpu_backend = GPU_BACKEND_VULKAN;
}
# endif
# ifdef WITH_METAL_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "metal"))) {
gpu_backend = GPU_BACKEND_METAL;
}
# endif
else {
fprintf(stderr, "\nError: Unrecognized GPU backend for '--gpu-backend', expected one of [");
for (int i = 0; i < backends_supported_num; i++) {
fprintf(stderr, (i + 1 != backends_supported_num) ? "%s, " : "%s", backends_supported[i]);
}
fprintf(stderr, "].\n");
return 0;
}
/* NOLINTEND: bugprone-assignment-in-if-condition */
GPU_backend_type_selection_set_override(gpu_backend);
return 1;
}
# ifdef WITH_OPENGL_BACKEND
static const char arg_handle_gpu_compilation_subprocesses_set_doc[] =
"\n"
"\tOverride the Max Compilation Subprocesses setting (OpenGL only).";
static int arg_handle_gpu_compilation_subprocesses_set(int argc,
const char **argv,
void * /*data*/)
{
const char *arg_id = "--gpu-compilation-subprocesses";
const int min = 0, max = BLI_system_thread_count();
if (argc > 1) {
const char *err_msg = nullptr;
int subprocesses;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &subprocesses, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 0;
}
GPU_compilation_subprocess_override_set(subprocesses);
return 1;
}
fprintf(stderr,
"\nError: you must specify a number of subprocesses in [%d..%d] '%s'.\n",
min,
max,
arg_id);
return 0;
}
# endif
static const char arg_handle_debug_fpe_set_doc[] =
"\n\t"
"Enable floating-point exceptions.";
static int arg_handle_debug_fpe_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
main_signal_setup_fpe();
return 0;
}
static const char arg_handle_app_template_doc[] =
"<template>\n"
"\tSet the application template (matching the directory name), use 'default' for none.";
static int arg_handle_app_template(int argc, const char **argv, void * /*data*/)
{
if (argc > 1) {
const char *app_template = STREQ(argv[1], "default") ? "" : argv[1];
WM_init_state_app_template_set(app_template);
return 1;
}
fprintf(stderr, "\nError: App template must follow '--app-template'.\n");
return 0;
}
static const char arg_handle_factory_startup_set_doc[] =
"\n\t"
"Skip reading the '" BLENDER_STARTUP_FILE "' in the users home directory.";
static int arg_handle_factory_startup_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.factory_startup = true;
G.f |= G_FLAG_USERPREF_NO_SAVE_ON_EXIT;
return 0;
}
static const char arg_handle_enable_event_simulate_doc[] =
"\n\t"
"Enable event simulation testing feature 'bpy.types.Window.event_simulate'.";
static int arg_handle_enable_event_simulate(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.f |= G_FLAG_EVENT_SIMULATE;
return 0;
}
static const char arg_handle_env_system_set_doc_datafiles[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_DATAFILES) " environment variable.";
static const char arg_handle_env_system_set_doc_scripts[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_SCRIPTS) " environment variable.";
static const char arg_handle_env_system_set_doc_python[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_PYTHON) " environment variable.";
static const char arg_handle_env_system_set_doc_extensions[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_EXTENSIONS) " environment variable.";
static int arg_handle_env_system_set(int argc, const char **argv, void * /*data*/)
{
/* `--env-system-scripts` -> `BLENDER_SYSTEM_SCRIPTS` */
char env[64] = "BLENDER";
char *ch_dst = env + 7; /* Skip `BLENDER`. */
const char *ch_src = argv[0] + 5; /* Skip `--env`. */
if (argc < 2) {
fprintf(stderr, "%s requires one argument\n", argv[0]);
exit(EXIT_FAILURE);
BLI_assert_unreachable();
}
for (; *ch_src; ch_src++, ch_dst++) {
*ch_dst = (*ch_src == '-') ? '_' : (*ch_src) - 32; /* Inline #toupper(). */
}
*ch_dst = '\0';
BLI_setenv(env, argv[1]);
return 1;
}
static const char arg_handle_playback_mode_doc[] =
"<options> <file(s)>\n"
"\tInstead of showing Blender's user interface, this runs Blender as an animation player,\n"
"\tto view movies and image sequences rendered in Blender (ignored if '-b' is set).\n"
"\n"
"\tPlayback Arguments:\n"
"\n"
"\t-p <sx> <sy>\n"
"\t\tOpen with lower left corner at <sx>, <sy>.\n"
"\t-m\n"
"\t\tRead from disk (Do not buffer).\n"
"\t-f <fps> <fps_base>\n"
"\t\tSpecify FPS to start with.\n"
"\t-j <frame>\n"
"\t\tSet frame step to <frame>.\n"
"\t-s <frame>\n"
"\t\tPlay from <frame>.\n"
"\t-e <frame>\n"
"\t\tPlay until <frame>.\n"
"\t-c <cache_memory>\n"
"\t\tAmount of memory in megabytes to allow for caching images during playback.\n"
"\t\tZero disables (clamping to a fixed number of frames instead).";
static int arg_handle_playback_mode(int argc, const char **argv, void * /*data*/)
{
/* Ignore the animation player if `-b` was given first. */
if (G.background == 0) {
/* Skip this argument (`-a`). */
WM_main_playanim(argc - 1, argv + 1);
exit(EXIT_SUCCESS);
}
return -2;
}
static const char arg_handle_window_geometry_doc[] =
"<sx> <sy> <w> <h>\n"
"\tOpen with lower left corner at <sx>, <sy> and width and height as <w>, <h>.";
static int arg_handle_window_geometry(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "-p / --window-geometry";
int params[4], i;
if (argc < 5) {
fprintf(stderr, "Error: requires four arguments '%s'\n", arg_id);
exit(1);
}
for (i = 0; i < 4; i++) {
const char *err_msg = nullptr;
if (!parse_int(argv[i + 1], nullptr, ¶ms[i], &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
exit(1);
}
}
WM_init_state_size_set(UNPACK4(params));
return 4;
}
static const char arg_handle_native_pixels_set_doc[] =
"\n\t"
"Do not use native pixel size, for high resolution displays (MacBook 'Retina').";
static int arg_handle_native_pixels_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_native_pixels(false);
return 0;
}
static const char arg_handle_with_borders_doc[] =
"\n\t"
"Force opening with borders.";
static int arg_handle_with_borders(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_normal_set();
return 0;
}
static const char arg_handle_without_borders_doc[] =
"\n\t"
"Force opening in full-screen mode.";
static int arg_handle_without_borders(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_fullscreen_set();
return 0;
}
static const char arg_handle_window_maximized_doc[] =
"\n\t"
"Force opening maximized.";
static int arg_handle_window_maximized(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_maximized_set();
return 0;
}
static const char arg_handle_no_window_focus_doc[] =
"\n\t"
"Open behind other windows and without taking focus.";
static int arg_handle_no_window_focus(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_window_focus_set(false);
return 0;
}
static const char arg_handle_start_with_console_doc[] =
"\n\t"
"Start with the console window open (ignored if '-b' is set), (Windows only).";
static int arg_handle_start_with_console(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_start_with_console_set(true);
return 0;
}
static bool arg_handle_extension_registration(const bool do_register, const bool all_users)
{
/* Logic runs in #main_args_handle_registration. */
# ifdef WIN32
/* This process has been launched with the permissions needed
* to register or unregister, so just do it now and then exit. */
if (do_register) {
BLI_windows_register_blend_extension(all_users);
}
else {
BLI_windows_unregister_blend_extension(all_users);
}
TerminateProcess(GetCurrentProcess(), 0);
return true;
# else
char *error_msg = nullptr;
bool result = WM_platform_associate_set(do_register, all_users, &error_msg);
if (error_msg) {
fprintf(stderr, "Error: %s\n", error_msg);
MEM_freeN(error_msg);
}
return result;
# endif
}
static const char arg_handle_register_extension_doc[] =
"\n\t"
"Register blend-file extension for current user, then exit (Windows & Linux only).";
static int arg_handle_register_extension(int argc, const char **argv, void *data)
{
G.quiet = true;
background_mode_set();
# if !(defined(WIN32) && defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_register_extension, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(true, false);
return argc - 1;
}
static const char arg_handle_register_extension_all_doc[] =
"\n\t"
"Register blend-file extension for all users, then exit (Windows & Linux only).";
static int arg_handle_register_extension_all(int argc, const char **argv, void *data)
{
G.quiet = true;
background_mode_set();
# if !(defined(WIN32) && defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_register_extension_all, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(true, true);
return argc - 1;
}
static const char arg_handle_unregister_extension_doc[] =
"\n\t"
"Unregister blend-file extension for current user, then exit (Windows & Linux only).";
static int arg_handle_unregister_extension(int argc, const char **argv, void *data)
{
G.quiet = true;
background_mode_set();
# if !(defined(WIN32) && defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_unregister_extension, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(false, false);
return 0;
}
static const char arg_handle_unregister_extension_all_doc[] =
"\n\t"
"Unregister blend-file extension for all users, then exit (Windows & Linux only).";
static int arg_handle_unregister_extension_all(int argc, const char **argv, void *data)
{
G.quiet = true;
background_mode_set();
# if !(defined(WIN32) && defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_unregister_extension_all, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(false, true);
return 0;
}
static const char arg_handle_audio_disable_doc[] =
"\n\t"
"Force sound system to None.";
static int arg_handle_audio_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
BKE_sound_force_device("None");
return 0;
}
static const char arg_handle_audio_set_doc[] =
"\n\t"
"Force sound system to a specific device.\n"
"\t'None' 'Default' 'SDL' 'OpenAL' 'CoreAudio' 'JACK' 'PulseAudio' 'WASAPI'.";
static int arg_handle_audio_set(int argc, const char **argv, void * /*data*/)
{
if (argc < 1) {
fprintf(stderr, "-setaudio requires one argument\n");
exit(1);
}
const char *device = argv[1];
if (STREQ(device, "Default")) {
/* Unset any forced device. */
device = nullptr;
}
BKE_sound_force_device(device);
return 1;
}
static const char arg_handle_output_set_doc[] =
"<path>\n"
"\tSet the render path and file name.\n"
"\tUse '//' at the start of the path to render relative to the blend-file.\n"
"\n"
"\tThe '#' characters are replaced by the frame number, and used to define zero padding.\n"
"\n"
"\t* 'animation_##_test.png' becomes 'animation_01_test.png'\n"
"\t* 'test-######.png' becomes 'test-000001.png'\n"
"\n"
"\tWhen the filename does not contain '#', the suffix '####' is added to the filename.\n"
"\n"
"\tThe frame number will be added at the end of the filename, eg:\n"
"\t# blender -b animation.blend -o //render_ -F PNG -x 1 -a\n"
"\t'//render_' becomes '//render_####', writing frames as '//render_0001.png'";
static int arg_handle_output_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
Scene *scene = CTX_data_scene(C);
if (scene) {
STRNCPY(scene->r.pic, argv[1]);
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr, "\nError: no blend loaded. cannot use '-o / --render-output'.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a path after '-o / --render-output'.\n");
return 0;
}
static const char arg_handle_engine_set_doc[] =
"<engine>\n"
"\tSpecify the render engine.\n"
"\tUse '-E help' to list available engines.";
static int arg_handle_engine_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc >= 2) {
if (STREQ(argv[1], "help")) {
printf("Blender Engine Listing:\n");
LISTBASE_FOREACH (RenderEngineType *, type, &R_engines) {
printf("\t%s\n", type->idname);
}
exit(0);
}
else {
Scene *scene = CTX_data_scene(C);
if (scene) {
if (BLI_findstring(&R_engines, argv[1], offsetof(RenderEngineType, idname))) {
STRNCPY_UTF8(scene->r.engine, argv[1]);
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr, "\nError: engine not found '%s'\n", argv[1]);
exit(1);
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-E / --engine' is after a blend is loaded.\n");
}
}
return 1;
}
fprintf(stderr, "\nEngine not specified, give 'help' for a list of available engines.\n");
return 0;
}
static const char arg_handle_image_type_set_doc[] =
"<format>\n"
"\tSet the render format.\n"
"\tValid options are:\n"
"\t'TGA' 'RAWTGA' 'JPEG' 'IRIS' 'AVIRAW' 'AVIJPEG' 'PNG' 'BMP' 'HDR' 'TIFF'.\n"
"\n"
"\tFormats that can be compiled into Blender, not available on all systems:\n"
"\t'OPEN_EXR' 'OPEN_EXR_MULTILAYER' 'FFMPEG' 'CINEON' 'DPX' 'JP2' 'WEBP'.";
static int arg_handle_image_type_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
const char *imtype = argv[1];
Scene *scene = CTX_data_scene(C);
if (scene) {
const char imtype_new = BKE_imtype_from_arg(imtype);
if (imtype_new == R_IMF_IMTYPE_INVALID) {
fprintf(stderr,
"\nError: Format from '-F / --render-format' not known or not compiled in this "
"release.\n");
}
else {
scene->r.im_format.imtype = imtype_new;
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-F / --render-format' is after the blend is loaded.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a format after '-F / --render-format'.\n");
return 0;
}
static const char arg_handle_threads_set_doc[] =
"<threads>\n"
"\tUse amount of <threads> for rendering and other operations\n"
"\t[1-" STRINGIFY(BLENDER_MAX_THREADS) "], 0 to use the systems processor count.";
static int arg_handle_threads_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "-t / --threads";
const int min = 0, max = BLENDER_MAX_THREADS;
if (argc > 1) {
const char *err_msg = nullptr;
int threads;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &threads, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 1;
}
BLI_system_num_threads_override_set(threads);
return 1;
}
fprintf(stderr,
"\nError: you must specify a number of threads in [%d..%d] '%s'.\n",
min,
max,
arg_id);
return 0;
}
static const char arg_handle_verbosity_set_doc[] =
"<verbose>\n"
"\tSet the logging verbosity level for debug messages that support it.";
static int arg_handle_verbosity_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--verbose";
if (argc > 1) {
const char *err_msg = nullptr;
int level;
if (!parse_int(argv[1], nullptr, &level, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
# ifdef WITH_LIBMV
libmv_setLoggingVerbosity(level);
# elif defined(WITH_CYCLES_LOGGING)
CCL_logging_verbosity_set(level);
# else
(void)level;
# endif
return 1;
}
fprintf(stderr, "\nError: you must specify a verbosity level.\n");
return 0;
}
static const char arg_handle_extension_set_doc[] =
"<bool>\n"
"\tSet option to add the file extension to the end of the file.";
static int arg_handle_extension_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argv[1][0] == '0') {
scene->r.scemode &= ~R_EXTENSION;
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else if (argv[1][0] == '1') {
scene->r.scemode |= R_EXTENSION;
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr,
"\nError: Use '-x 1 / -x 0' To set the extension option or '--use-extension'\n");
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-o ' is after '-x '.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a path after '- '.\n");
return 0;
}
static const char arg_handle_render_frame_doc[] =
"<frame>\n"
"\tRender frame <frame> and save it.\n"
"\n"
"\t* +<frame> start frame relative, -<frame> end frame relative.\n"
"\t* A comma separated list of frames can also be used (no spaces).\n"
"\t* A range of frames can be expressed using '..' separator between the first and last "
"frames (inclusive).\n";
static int arg_handle_render_frame(int argc, const char **argv, void *data)
{
const char *arg_id = "-f / --render-frame";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
Main *bmain = CTX_data_main(C);
if (argc > 1) {
const char *err_msg = nullptr;
Render *re;
ReportList reports;
int(*frame_range_arr)[2], frames_range_len;
if ((frame_range_arr = parse_int_range_relative_clamp_n(argv[1],
scene->r.sfra,
scene->r.efra,
MINAFRAME,
MAXFRAME,
&frames_range_len,
&err_msg)) == nullptr)
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
return 1;
}
re = RE_NewSceneRender(scene);
BKE_reports_init(&reports, RPT_STORE);
RE_SetReports(re, &reports);
for (int i = 0; i < frames_range_len; i++) {
/* We could pass in frame ranges,
* but prefer having exact behavior as passing in multiple frames. */
if ((frame_range_arr[i][0] <= frame_range_arr[i][1]) == 0) {
fprintf(stderr, "\nWarning: negative range ignored '%s %s'.\n", arg_id, argv[1]);
}
for (int frame = frame_range_arr[i][0]; frame <= frame_range_arr[i][1]; frame++) {
RE_RenderAnim(re, bmain, scene, nullptr, nullptr, frame, frame, scene->r.frame_step);
}
}
RE_SetReports(re, nullptr);
BKE_reports_free(&reports);
MEM_freeN(frame_range_arr);
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_render_animation_doc[] =
"\n\t"
"Render frames from start to end (inclusive).";
static int arg_handle_render_animation(int /*argc*/, const char ** /*argv*/, void *data)
{
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
Main *bmain = CTX_data_main(C);
Render *re = RE_NewSceneRender(scene);
ReportList reports;
BKE_reports_init(&reports, RPT_STORE);
RE_SetReports(re, &reports);
RE_RenderAnim(
re, bmain, scene, nullptr, nullptr, scene->r.sfra, scene->r.efra, scene->r.frame_step);
RE_SetReports(re, nullptr);
BKE_reports_free(&reports);
}
else {
fprintf(stderr, "\nError: no blend loaded. cannot use '-a'.\n");
}
return 0;
}
static const char arg_handle_scene_set_doc[] =
"<name>\n"
"\tSet the active scene <name> for rendering.";
static int arg_handle_scene_set(int argc, const char **argv, void *data)
{
if (argc > 1) {
bContext *C = static_cast<bContext *>(data);
Scene *scene = BKE_scene_set_name(CTX_data_main(C), argv[1]);
if (scene) {
CTX_data_scene_set(C, scene);
/* Set the scene of the first window, see: #55991,
* otherwise scripts that run later won't get this scene back from the context. */
wmWindow *win = CTX_wm_window(C);
if (win == nullptr) {
win = static_cast<wmWindow *>(CTX_wm_manager(C)->windows.first);
}
if (win != nullptr) {
WM_window_set_active_scene(CTX_data_main(C), C, win, scene);
}
}
return 1;
}
fprintf(stderr, "\nError: Scene name must follow '-S / --scene'.\n");
return 0;
}
static const char arg_handle_frame_start_set_doc[] =
"<frame>\n"
"\tSet start to frame <frame>, supports +/- for relative frames too.";
static int arg_handle_frame_start_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-s / --frame-start";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_relative_clamp(argv[1],
nullptr,
scene->r.sfra,
scene->r.sfra - 1,
MINAFRAME,
MAXFRAME,
&scene->r.sfra,
&err_msg))
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_frame_end_set_doc[] =
"<frame>\n"
"\tSet end to frame <frame>, supports +/- for relative frames too.";
static int arg_handle_frame_end_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-e / --frame-end";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_relative_clamp(argv[1],
nullptr,
scene->r.efra,
scene->r.efra - 1,
MINAFRAME,
MAXFRAME,
&scene->r.efra,
&err_msg))
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_frame_skip_set_doc[] =
"<frames>\n"
"\tSet number of frames to step forward after each rendered frame.";
static int arg_handle_frame_skip_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-j / --frame-jump";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_clamp(argv[1], nullptr, 1, MAXFRAME, &scene->r.frame_step, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: number of frames to step must follow '%s'.\n", arg_id);
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_python_file_run_doc[] =
"<filepath>\n"
"\tRun the given Python script file.";
static int arg_handle_python_file_run(int argc, const char **argv, void *data)
{
# ifdef WITH_PYTHON
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
/* Make the path absolute because its needed for relative linked blends to be found. */
char filepath[FILE_MAX];
STRNCPY(filepath, argv[1]);
BLI_path_canonicalize_native(filepath, sizeof(filepath));
bool ok;
BPY_CTX_SETUP(ok = BPY_run_filepath(C, filepath, nullptr));
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, file: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
return 1;
}
fprintf(stderr, "\nError: you must specify a filepath after '%s'.\n", argv[0]);
return 0;
# else
UNUSED_VARS(argc, argv, data);
fprintf(stderr, "This Blender was built without Python support\n");
return 0;
# endif /* WITH_PYTHON */
}
static const char arg_handle_python_text_run_doc[] =
"<name>\n"
"\tRun the given Python script text block.";
static int arg_handle_python_text_run(int argc, const char **argv, void *data)
{
# ifdef WITH_PYTHON
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
Main *bmain = CTX_data_main(C);
/* Make the path absolute because its needed for relative linked blends to be found. */
Text *text = (Text *)BKE_libblock_find_name(bmain, ID_TXT, argv[1]);
bool ok;
if (text) {
BPY_CTX_SETUP(ok = BPY_run_text(C, text, nullptr, false));
}
else {
fprintf(stderr, "\nError: text block not found %s.\n", argv[1]);
ok = false;
}
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, text: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
return 1;
}
fprintf(stderr, "\nError: you must specify a text block after '%s'.\n", argv[0]);
return 0;
# else
UNUSED_VARS(argc, argv, data);
fprintf(stderr, "This Blender was built without Python support\n");
return 0;
# endif /* WITH_PYTHON */
}
static const char arg_handle_python_expr_run_doc[] =
"<expression>\n"
"\tRun the given expression as a Python script.";
static int arg_handle_python_expr_run(int argc, const char **argv, void *data)
{
# ifdef WITH_PYTHON
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
bool ok;
BPY_CTX_SETUP(ok = BPY_run_string_exec(C, nullptr, argv[1]));
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, expr: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
return 1;
}
fprintf(stderr, "\nError: you must specify a Python expression after '%s'.\n", argv[0]);
return 0;
# else
UNUSED_VARS(argc, argv, data);
fprintf(stderr, "This Blender was built without Python support\n");
return 0;
# endif /* WITH_PYTHON */
}
static const char arg_handle_python_console_run_doc[] =
"\n\t"
"Run Blender with an interactive console.";
static int arg_handle_python_console_run(int /*argc*/, const char ** /*argv*/, void *data)
{
# ifdef WITH_PYTHON
bContext *C = static_cast<bContext *>(data);
const char *imports[] = {"code", nullptr};
BPY_CTX_SETUP(BPY_run_string_eval(C, imports, "code.interact()"));
return 0;
# else
UNUSED_VARS(argv, data);
fprintf(stderr, "This Blender was built without python support\n");
return 0;
# endif /* WITH_PYTHON */
}
static const char arg_handle_python_exit_code_set_doc[] =
"<code>\n"
"\tSet the exit-code in [0..255] to exit if a Python exception is raised\n"
"\t(only for scripts executed from the command line), zero disables.";
static int arg_handle_python_exit_code_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--python-exit-code";
if (argc > 1) {
const char *err_msg = nullptr;
const int min = 0, max = 255;
int exit_code;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &exit_code, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 1;
}
app_state.exit_code_on_error.python = uchar(exit_code);
return 1;
}
fprintf(stderr, "\nError: you must specify an exit code number '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_python_use_system_env_set_doc[] =
"\n\t"
"Allow Python to use system environment variables such as 'PYTHONPATH' and the user "
"site-packages directory.";
static int arg_handle_python_use_system_env_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
# ifdef WITH_PYTHON
BPY_python_use_system_env();
# endif
return 0;
}
static const char arg_handle_addons_set_doc[] =
"<addon(s)>\n"
"\tComma separated list (no spaces) of add-ons to enable in addition to any default add-ons.";
static int arg_handle_addons_set(int argc, const char **argv, void *data)
{
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
# ifdef WITH_PYTHON
const char script_str[] =
"from _bpy_internal.addons.cli import set_from_cli\n"
"set_from_cli('%s')";
const int slen = strlen(argv[1]) + (sizeof(script_str) - 2);
char *str = static_cast<char *>(malloc(slen));
bContext *C = static_cast<bContext *>(data);
BLI_snprintf(str, slen, script_str, argv[1]);
BLI_assert(strlen(str) + 1 == slen);
BPY_CTX_SETUP(BPY_run_string_exec(C, nullptr, str));
free(str);
# else
UNUSED_VARS(argv, data);
# endif /* WITH_PYTHON */
return 1;
}
fprintf(stderr, "\nError: you must specify a comma separated list after '--addons'.\n");
return 0;
}
/**
* Implementation for #arg_handle_load_last_file, also used by `--open-last`.
* \return true on success.
*/
static bool handle_load_file(bContext *C, const char *filepath_arg, const bool load_empty_file)
{
/* Make the path absolute because its needed for relative linked blends to be found. */
char filepath[FILE_MAX];
STRNCPY(filepath, filepath_arg);
BLI_path_canonicalize_native(filepath, sizeof(filepath));
/* Load the file. */
ReportList reports;
BKE_reports_init(&reports, RPT_PRINT);
WM_file_autoexec_init(filepath);
const bool success = WM_file_read(C, filepath, &reports);
BKE_reports_free(&reports);
if (success) {
if (G.background) {
/* Ensure we use 'C->data.scene' for background render. */
CTX_wm_window_set(C, nullptr);
}
}
else {
/* Failed to load file, stop processing arguments if running in background mode. */
if (G.background) {
/* Set `is_break` if running in the background mode so
* blender will return non-zero exit code which then
* could be used in automated script to control how
* good or bad things are. */
G.is_break = true;
return false;
}
const char *error_msg_generic = "file could not be loaded";
const char *error_msg = nullptr;
if (load_empty_file == false) {
error_msg = error_msg_generic;
}
else if (BLI_exists(filepath)) {
/* When a file is found but can't be loaded, handling it as a new file
* could cause it to be unintentionally overwritten (data loss).
* Further this is almost certainly not that a user would expect or want.
* If they do, they can delete the file beforehand. */
error_msg = error_msg_generic;
}
else if (!BKE_blendfile_extension_check(filepath)) {
/* Unrelated arguments should not be treated as new blend files. */
error_msg = "argument has no '.blend' file extension, not using as new file";
}
if (error_msg) {
fprintf(stderr, "Error: %s, exiting! %s\n", error_msg, filepath);
WM_exit(C, EXIT_FAILURE);
/* Unreachable, return for clarity. */
return false;
}
/* Behave as if a file was loaded, calling "Save" will write to the `filepath` from the CLI.
*
* WARNING: The path referenced may be incorrect, no attempt is made to validate the path
* here or check that writing to it will work. If the users enters the path of a directory
* that doesn't exist (for e.g.) saving will fail.
* Attempting to create the file at this point is possible but likely to cause more
* trouble than it's worth (what with network drives), removable devices ... etc. */
STRNCPY(G_MAIN->filepath, filepath);
printf("... opened default scene instead; saving will write to: %s\n", filepath);
}
return true;
}
int main_args_handle_load_file(int /*argc*/, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
const char *filepath = argv[0];
/* NOTE: we could skip these, but so far we always tried to load these files. */
if (argv[0][0] == '-') {
fprintf(stderr, "unknown argument, loading as file: %s\n", filepath);
}
if (!handle_load_file(C, filepath, true)) {
return -1;
}
return 0;
}
static const char arg_handle_load_last_file_doc[] =
"\n\t"
"Open the most recently opened blend file, instead of the default startup file.";
static int arg_handle_load_last_file(int /*argc*/, const char ** /*argv*/, void *data)
{
if (BLI_listbase_is_empty(&G.recent_files)) {
fprintf(stderr, "Warning: no recent files known, opening default startup file instead.\n");
return -1;
}
bContext *C = static_cast<bContext *>(data);
const RecentFile *recent_file = static_cast<const RecentFile *>(G.recent_files.first);
if (!handle_load_file(C, recent_file->filepath, false)) {
return -1;
}
return 0;
}
void main_args_setup(bContext *C, bArgs *ba, bool all)
{
/** Expand the doc-string from the function. */
# define CB(a) a##_doc, a
/** A version of `CB` that expands an additional suffix. */
# define CB_EX(a, b) a##_doc_##b, a
/** A version of `CB` that uses `all`, needed when the doc-string depends on build options. */
# define CB_ALL(a) (all ? a##_doc_all : a##_doc), a
BuildDefs defs;
build_defs_init(&defs, all);
/* end argument processing after -- */
BLI_args_pass_set(ba, -1);
BLI_args_add(ba, "--", nullptr, CB(arg_handle_arguments_end), nullptr);
/* Pass: Environment Setup
*
* It's important these run before any initialization is done, since they set up
* the environment used to access data-files, which are be used when initializing
* sub-systems such as color management. */
BLI_args_pass_set(ba, ARG_PASS_ENVIRONMENT);
BLI_args_add(
ba, nullptr, "--python-use-system-env", CB(arg_handle_python_use_system_env_set), nullptr);
/* Note that we could add used environment variables too. */
BLI_args_add(
ba, nullptr, "--env-system-datafiles", CB_EX(arg_handle_env_system_set, datafiles), nullptr);
BLI_args_add(
ba, nullptr, "--env-system-scripts", CB_EX(arg_handle_env_system_set, scripts), nullptr);
BLI_args_add(
ba, nullptr, "--env-system-python", CB_EX(arg_handle_env_system_set, python), nullptr);
BLI_args_add(ba,
nullptr,
"--env-system-extensions",
CB_EX(arg_handle_env_system_set, extensions),
nullptr);
BLI_args_add(ba, "-t", "--threads", CB(arg_handle_threads_set), nullptr);
/* Include in the environment pass so it's possible display errors initializing subsystems,
* especially `bpy.appdir` since it's useful to show errors finding paths on startup. */
BLI_args_add(ba, nullptr, "--log", CB(arg_handle_log_set), ba);
BLI_args_add(ba, nullptr, "--log-level", CB(arg_handle_log_level_set), ba);
BLI_args_add(ba, nullptr, "--log-show-basename", CB(arg_handle_log_show_basename_set), ba);
BLI_args_add(ba, nullptr, "--log-show-backtrace", CB(arg_handle_log_show_backtrace_set), ba);
BLI_args_add(ba, nullptr, "--log-show-timestamp", CB(arg_handle_log_show_timestamp_set), ba);
BLI_args_add(ba, nullptr, "--log-file", CB(arg_handle_log_file_set), ba);
/* GPU backend selection should be part of #ARG_PASS_ENVIRONMENT for correct GPU context
* selection for animation player. */
BLI_args_add(ba, nullptr, "--gpu-backend", CB_ALL(arg_handle_gpu_backend_set), nullptr);
# ifdef WITH_OPENGL_BACKEND
BLI_args_add(ba,
nullptr,
"--gpu-compilation-subprocesses",
CB(arg_handle_gpu_compilation_subprocesses_set),
nullptr);
# endif
/* Pass: Background Mode & Settings
*
* Also and commands that exit after usage. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS);
BLI_args_add(ba, "-h", "--help", CB(arg_handle_print_help), ba);
/* MS-Windows only. */
BLI_args_add(ba, "/?", nullptr, CB_EX(arg_handle_print_help, win32), ba);
BLI_args_add(ba, "-v", "--version", CB(arg_handle_print_version), nullptr);
BLI_args_add(ba, "-y", "--enable-autoexec", CB_EX(arg_handle_python_set, enable), (void *)true);
BLI_args_add(
ba, "-Y", "--disable-autoexec", CB_EX(arg_handle_python_set, disable), (void *)false);
BLI_args_add(
ba, nullptr, "--offline-mode", CB_EX(arg_handle_internet_allow_set, offline), (void *)false);
BLI_args_add(
ba, nullptr, "--online-mode", CB_EX(arg_handle_internet_allow_set, online), (void *)true);
BLI_args_add(
ba, nullptr, "--disable-crash-handler", CB(arg_handle_crash_handler_disable), nullptr);
BLI_args_add(
ba, nullptr, "--disable-abort-handler", CB(arg_handle_abort_handler_disable), nullptr);
BLI_args_add(ba, "-q", "--quiet", CB(arg_handle_quiet_set), nullptr);
BLI_args_add(ba, "-b", "--background", CB(arg_handle_background_mode_set), nullptr);
/* Command implies background mode (defers execution). */
BLI_args_add(ba, "-c", "--command", CB(arg_handle_command_set), C);
BLI_args_add(ba, "-a", nullptr, CB(arg_handle_playback_mode), nullptr);
BLI_args_add(ba, "-d", "--debug", CB(arg_handle_debug_mode_set), ba);
if (defs.with_ffmpeg) {
BLI_args_add(ba,
nullptr,
"--debug-ffmpeg",
CB_EX(arg_handle_debug_mode_generic_set, ffmpeg),
(void *)G_DEBUG_FFMPEG);
}
if (defs.with_freestyle) {
BLI_args_add(ba,
nullptr,
"--debug-freestyle",
CB_EX(arg_handle_debug_mode_generic_set, freestyle),
(void *)G_DEBUG_FREESTYLE);
}
BLI_args_add(ba,
nullptr,
"--debug-python",
CB_EX(arg_handle_debug_mode_generic_set, python),
(void *)G_DEBUG_PYTHON);
BLI_args_add(ba,
nullptr,
"--debug-events",
CB_EX(arg_handle_debug_mode_generic_set, events),
(void *)G_DEBUG_EVENTS);
BLI_args_add(ba,
nullptr,
"--debug-handlers",
CB_EX(arg_handle_debug_mode_generic_set, handlers),
(void *)G_DEBUG_HANDLERS);
BLI_args_add(
ba, nullptr, "--debug-wm", CB_EX(arg_handle_debug_mode_generic_set, wm), (void *)G_DEBUG_WM);
if (defs.with_xr_openxr) {
BLI_args_add(ba,
nullptr,
"--debug-xr",
CB_EX(arg_handle_debug_mode_generic_set, xr),
(void *)G_DEBUG_XR);
BLI_args_add(ba,
nullptr,
"--debug-xr-time",
CB_EX(arg_handle_debug_mode_generic_set, xr_time),
(void *)G_DEBUG_XR_TIME);
}
BLI_args_add(ba,
nullptr,
"--debug-ghost",
CB_EX(arg_handle_debug_mode_generic_set, ghost),
(void *)G_DEBUG_GHOST);
BLI_args_add(ba,
nullptr,
"--debug-wintab",
CB_EX(arg_handle_debug_mode_generic_set, wintab),
(void *)G_DEBUG_WINTAB);
BLI_args_add(ba, nullptr, "--debug-all", CB(arg_handle_debug_mode_all), nullptr);
BLI_args_add(ba, nullptr, "--debug-io", CB(arg_handle_debug_mode_io), nullptr);
BLI_args_add(ba, nullptr, "--debug-fpe", CB(arg_handle_debug_fpe_set), nullptr);
if (defs.with_libmv) {
BLI_args_add(ba, nullptr, "--debug-libmv", CB(arg_handle_debug_mode_libmv), nullptr);
}
if (defs.with_cycles_logging) {
BLI_args_add(ba, nullptr, "--debug-cycles", CB(arg_handle_debug_mode_cycles), nullptr);
}
BLI_args_add(ba, nullptr, "--debug-memory", CB(arg_handle_debug_mode_memory_set), nullptr);
BLI_args_add(ba, nullptr, "--debug-value", CB(arg_handle_debug_value_set), nullptr);
BLI_args_add(ba,
nullptr,
"--debug-jobs",
CB_EX(arg_handle_debug_mode_generic_set, jobs),
(void *)G_DEBUG_JOBS);
BLI_args_add(ba, nullptr, "--debug-gpu", CB(arg_handle_debug_gpu_set), nullptr);
BLI_args_add(ba,
nullptr,
"--debug-gpu-compile-shaders",
CB(arg_handle_debug_gpu_compile_shaders_set),
nullptr);
if (defs.with_renderdoc) {
BLI_args_add(ba,
nullptr,
"--debug-gpu-scope-capture",
CB(arg_handle_debug_gpu_scope_capture_set),
nullptr);
BLI_args_add(
ba, nullptr, "--debug-gpu-renderdoc", CB(arg_handle_debug_gpu_renderdoc_set), nullptr);
}
BLI_args_add(ba,
nullptr,
"--debug-depsgraph",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph),
(void *)G_DEBUG_DEPSGRAPH);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-build",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_build),
(void *)G_DEBUG_DEPSGRAPH_BUILD);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-eval",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_eval),
(void *)G_DEBUG_DEPSGRAPH_EVAL);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-tag",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_tag),
(void *)G_DEBUG_DEPSGRAPH_TAG);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-time",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_time),
(void *)G_DEBUG_DEPSGRAPH_TIME);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-no-threads",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_no_threads),
(void *)G_DEBUG_DEPSGRAPH_NO_THREADS);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-pretty",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_pretty),
(void *)G_DEBUG_DEPSGRAPH_PRETTY);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-uid",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_uid),
(void *)G_DEBUG_DEPSGRAPH_UID);
BLI_args_add(ba,
nullptr,
"--debug-gpu-force-workarounds",
CB_EX(arg_handle_debug_mode_generic_set, gpu_force_workarounds),
(void *)G_DEBUG_GPU_FORCE_WORKAROUNDS);
BLI_args_add(ba, nullptr, "--debug-exit-on-error", CB(arg_handle_debug_exit_on_error), nullptr);
BLI_args_add(ba, nullptr, "--verbose", CB(arg_handle_verbosity_set), nullptr);
BLI_args_add(ba, nullptr, "--app-template", CB(arg_handle_app_template), nullptr);
BLI_args_add(ba, nullptr, "--factory-startup", CB(arg_handle_factory_startup_set), nullptr);
BLI_args_add(
ba, nullptr, "--enable-event-simulate", CB(arg_handle_enable_event_simulate), nullptr);
/* Pass: Custom Window Stuff. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS_GUI);
BLI_args_add(ba, "-p", "--window-geometry", CB(arg_handle_window_geometry), nullptr);
BLI_args_add(ba, "-w", "--window-border", CB(arg_handle_with_borders), nullptr);
BLI_args_add(ba, "-W", "--window-fullscreen", CB(arg_handle_without_borders), nullptr);
BLI_args_add(ba, "-M", "--window-maximized", CB(arg_handle_window_maximized), nullptr);
BLI_args_add(ba, nullptr, "--no-window-focus", CB(arg_handle_no_window_focus), nullptr);
BLI_args_add(ba, "-con", "--start-console", CB(arg_handle_start_with_console), nullptr);
BLI_args_add(ba, "-r", "--register", CB(arg_handle_register_extension), nullptr);
BLI_args_add(ba, nullptr, "--register-allusers", CB(arg_handle_register_extension_all), nullptr);
BLI_args_add(ba, nullptr, "--unregister", CB(arg_handle_unregister_extension), nullptr);
BLI_args_add(
ba, nullptr, "--unregister-allusers", CB(arg_handle_unregister_extension_all), nullptr);
BLI_args_add(ba, nullptr, "--no-native-pixels", CB(arg_handle_native_pixels_set), ba);
/* Pass: Disabling Things & Forcing Settings. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS_FORCE);
BLI_args_add_case(ba, "-noaudio", 1, nullptr, 0, CB(arg_handle_audio_disable), nullptr);
BLI_args_add_case(ba, "-setaudio", 1, nullptr, 0, CB(arg_handle_audio_set), nullptr);
/* Pass: Processing Arguments. */
/* NOTE: Use #WM_exit for these callbacks, not `exit()`
* so temporary files are properly cleaned up. */
BLI_args_pass_set(ba, ARG_PASS_FINAL);
BLI_args_add(ba, "-f", "--render-frame", CB(arg_handle_render_frame), C);
BLI_args_add(ba, "-a", "--render-anim", CB(arg_handle_render_animation), C);
BLI_args_add(ba, "-S", "--scene", CB(arg_handle_scene_set), C);
BLI_args_add(ba, "-s", "--frame-start", CB(arg_handle_frame_start_set), C);
BLI_args_add(ba, "-e", "--frame-end", CB(arg_handle_frame_end_set), C);
BLI_args_add(ba, "-j", "--frame-jump", CB(arg_handle_frame_skip_set), C);
BLI_args_add(ba, "-P", "--python", CB(arg_handle_python_file_run), C);
BLI_args_add(ba, nullptr, "--python-text", CB(arg_handle_python_text_run), C);
BLI_args_add(ba, nullptr, "--python-expr", CB(arg_handle_python_expr_run), C);
BLI_args_add(ba, nullptr, "--python-console", CB(arg_handle_python_console_run), C);
BLI_args_add(ba, nullptr, "--python-exit-code", CB(arg_handle_python_exit_code_set), nullptr);
BLI_args_add(ba, nullptr, "--addons", CB(arg_handle_addons_set), C);
BLI_args_add(ba, "-o", "--render-output", CB(arg_handle_output_set), C);
BLI_args_add(ba, "-E", "--engine", CB(arg_handle_engine_set), C);
BLI_args_add(ba, "-F", "--render-format", CB(arg_handle_image_type_set), C);
BLI_args_add(ba, "-x", "--use-extension", CB(arg_handle_extension_set), C);
BLI_args_add(ba, nullptr, "--open-last", CB(arg_handle_load_last_file), C);
# undef CB
# undef CB_EX
# undef CB_ALL
# ifdef WITH_PYTHON
/* Use for Python to extract help text (Python can't call directly - bad-level call). */
BPY_python_app_help_text_fn = main_args_help_as_string;
# else
/* Quiet unused function warning. */
(void)main_args_help_as_string;
# endif
}
/** \} */
#endif /* !WITH_PYTHON_MODULE */
|