1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201
#![allow(deprecated)]
// Std
use std::collections::HashMap;
use std::env;
use std::ffi::OsString;
use std::fmt;
use std::io;
use std::ops::Index;
use std::path::Path;
// Third Party
#[cfg(feature = "yaml")]
use yaml_rust::Yaml;
// Internal
use crate::builder::app_settings::{AppFlags, AppSettings};
use crate::builder::arg_settings::ArgSettings;
use crate::builder::{arg::ArgProvider, Arg, ArgGroup, ArgPredicate};
use crate::error::ErrorKind;
use crate::error::Result as ClapResult;
use crate::mkeymap::MKeyMap;
use crate::output::fmt::Stream;
use crate::output::{fmt::Colorizer, Help, HelpWriter, Usage};
use crate::parser::{ArgMatcher, ArgMatches, Parser};
use crate::util::ChildGraph;
use crate::util::{color::ColorChoice, Id, Key};
use crate::PossibleValue;
use crate::{Error, INTERNAL_ERROR_MSG};
#[cfg(debug_assertions)]
use crate::builder::debug_asserts::assert_app;
/// Build a command-line interface.
///
/// This includes defining arguments, subcommands, parser behavior, and help output.
/// Once all configuration is complete,
/// the [`Command::get_matches`] family of methods starts the runtime-parsing
/// process. These methods then return information about the user supplied
/// arguments (or lack thereof).
///
/// When deriving a [`Parser`][crate::Parser], you can use
/// [`CommandFactory::command`][crate::CommandFactory::command] to access the
/// `Command`.
///
/// - [Basic API][crate::App#basic-api]
/// - [Application-wide Settings][crate::App#application-wide-settings]
/// - [Command-specific Settings][crate::App#command-specific-settings]
/// - [Subcommand-specific Settings][crate::App#subcommand-specific-settings]
/// - [Reflection][crate::App#reflection]
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let m = Command::new("My Program")
/// .author("Me, me@mail.com")
/// .version("1.0.2")
/// .about("Explains in brief what the program does")
/// .arg(
/// Arg::new("in_file")
/// )
/// .after_help("Longer explanation to appear after the options when \
/// displaying the help information from --help or -h")
/// .get_matches();
///
/// // Your program logic starts here...
/// ```
/// [`App::get_matches`]: Command::get_matches()
pub type Command<'help> = App<'help>;
/// Deprecated, replaced with [`Command`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.0", note = "Replaced with `Command`")
)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct App<'help> {
id: Id,
name: String,
long_flag: Option<&'help str>,
short_flag: Option<char>,
display_name: Option<String>,
bin_name: Option<String>,
author: Option<&'help str>,
version: Option<&'help str>,
long_version: Option<&'help str>,
about: Option<&'help str>,
long_about: Option<&'help str>,
before_help: Option<&'help str>,
before_long_help: Option<&'help str>,
after_help: Option<&'help str>,
after_long_help: Option<&'help str>,
aliases: Vec<(&'help str, bool)>, // (name, visible)
short_flag_aliases: Vec<(char, bool)>, // (name, visible)
long_flag_aliases: Vec<(&'help str, bool)>, // (name, visible)
usage_str: Option<&'help str>,
usage_name: Option<String>,
help_str: Option<&'help str>,
disp_ord: Option<usize>,
term_w: Option<usize>,
max_w: Option<usize>,
template: Option<&'help str>,
settings: AppFlags,
g_settings: AppFlags,
args: MKeyMap<'help>,
subcommands: Vec<App<'help>>,
replacers: HashMap<&'help str, &'help [&'help str]>,
groups: Vec<ArgGroup<'help>>,
current_help_heading: Option<&'help str>,
current_disp_ord: Option<usize>,
subcommand_value_name: Option<&'help str>,
subcommand_heading: Option<&'help str>,
}
/// # Basic API
impl<'help> App<'help> {
/// Creates a new instance of an `Command`.
///
/// It is common, but not required, to use binary name as the `name`. This
/// name will only be displayed to the user when they request to print
/// version or help and usage information.
///
/// See also [`command!`](crate::command!) and [`crate_name!`](crate::crate_name!).
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("My Program")
/// # ;
/// ```
pub fn new<S: Into<String>>(name: S) -> Self {
/// The actual implementation of `new`, non-generic to save code size.
///
/// If we don't do this rustc will unnecessarily generate multiple versions
/// of this code.
fn new_inner<'help>(name: String) -> App<'help> {
App {
id: Id::from(&*name),
name,
..Default::default()
}
.arg(
Arg::new("help")
.long("help")
.help("Print help information")
.global(true)
.generated(),
)
.arg(
Arg::new("version")
.long("version")
.help("Print version information")
.global(true)
.generated(),
)
}
new_inner(name.into())
}
/// Adds an [argument] to the list of valid possibilities.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, arg, Arg};
/// Command::new("myprog")
/// // Adding a single "flag" argument with a short and help text, using Arg::new()
/// .arg(
/// Arg::new("debug")
/// .short('d')
/// .help("turns on debugging mode")
/// )
/// // Adding a single "option" argument with a short, a long, and help text using the less
/// // verbose Arg::from()
/// .arg(
/// arg!(-c --config <CONFIG> "Optionally sets a config file to use")
/// )
/// # ;
/// ```
/// [argument]: Arg
#[must_use]
pub fn arg<A: Into<Arg<'help>>>(mut self, a: A) -> Self {
let mut arg = a.into();
if let Some(current_disp_ord) = self.current_disp_ord.as_mut() {
if !arg.is_positional() && arg.provider != ArgProvider::Generated {
let current = *current_disp_ord;
arg.disp_ord.set_implicit(current);
*current_disp_ord = current + 1;
}
}
arg.help_heading.get_or_insert(self.current_help_heading);
self.args.push(arg);
self
}
/// Adds multiple [arguments] to the list of valid possibilities.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, arg, Arg};
/// Command::new("myprog")
/// .args(&[
/// arg!("[debug] -d 'turns on debugging info'"),
/// Arg::new("input").help("the input file to use")
/// ])
/// # ;
/// ```
/// [arguments]: Arg
#[must_use]
pub fn args<I, T>(mut self, args: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<Arg<'help>>,
{
let args = args.into_iter();
let (lower, _) = args.size_hint();
self.args.reserve(lower);
for arg in args {
self = self.arg(arg);
}
self
}
/// Allows one to mutate an [`Arg`] after it's been added to a [`Command`].
///
/// This can be useful for modifying the auto-generated help or version arguments.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
///
/// let mut cmd = Command::new("foo")
/// .arg(Arg::new("bar")
/// .short('b'))
/// .mut_arg("bar", |a| a.short('B'));
///
/// let res = cmd.try_get_matches_from_mut(vec!["foo", "-b"]);
///
/// // Since we changed `bar`'s short to "B" this should err as there
/// // is no `-b` anymore, only `-B`
///
/// assert!(res.is_err());
///
/// let res = cmd.try_get_matches_from_mut(vec!["foo", "-B"]);
/// assert!(res.is_ok());
/// ```
#[must_use]
pub fn mut_arg<T, F>(mut self, arg_id: T, f: F) -> Self
where
F: FnOnce(Arg<'help>) -> Arg<'help>,
T: Key + Into<&'help str>,
{
let arg_id: &str = arg_id.into();
let id = Id::from(arg_id);
let mut a = self.args.remove_by_name(&id).unwrap_or_else(|| Arg {
id,
name: arg_id,
..Arg::default()
});
if a.provider == ArgProvider::Generated {
a.provider = ArgProvider::GeneratedMutated;
}
self.args.push(f(a));
self
}
/// Allows one to mutate a [`Command`] after it's been added as a subcommand.
///
/// This can be useful for modifying auto-generated arguments of nested subcommands with
/// [`Command::mut_arg`].
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
///
/// let mut cmd = Command::new("foo")
/// .subcommand(Command::new("bar"))
/// .mut_subcommand("bar", |subcmd| subcmd.disable_help_flag(true));
///
/// let res = cmd.try_get_matches_from_mut(vec!["foo", "bar", "--help"]);
///
/// // Since we disabled the help flag on the "bar" subcommand, this should err.
///
/// assert!(res.is_err());
///
/// let res = cmd.try_get_matches_from_mut(vec!["foo", "bar"]);
/// assert!(res.is_ok());
/// ```
#[must_use]
pub fn mut_subcommand<'a, T, F>(mut self, subcmd_id: T, f: F) -> Self
where
F: FnOnce(App<'help>) -> App<'help>,
T: Into<&'a str>,
{
let subcmd_id: &str = subcmd_id.into();
let id = Id::from(subcmd_id);
let pos = self.subcommands.iter().position(|s| s.id == id);
let subcmd = if let Some(idx) = pos {
self.subcommands.remove(idx)
} else {
App::new(subcmd_id)
};
self.subcommands.push(f(subcmd));
self
}
/// Adds an [`ArgGroup`] to the application.
///
/// [`ArgGroup`]s are a family of related arguments.
/// By placing them in a logical group, you can build easier requirement and exclusion rules.
///
/// Example use cases:
/// - Make an entire [`ArgGroup`] required, meaning that one (and *only*
/// one) argument from that group must be present at runtime.
/// - Name an [`ArgGroup`] as a conflict to another argument.
/// Meaning any of the arguments that belong to that group will cause a failure if present with
/// the conflicting argument.
/// - Ensure exclusion between arguments.
/// - Extract a value from a group instead of determining exactly which argument was used.
///
/// # Examples
///
/// The following example demonstrates using an [`ArgGroup`] to ensure that one, and only one,
/// of the arguments from the specified group is present at runtime.
///
/// ```no_run
/// # use clap::{Command, arg, ArgGroup};
/// Command::new("cmd")
/// .arg(arg!("--set-ver [ver] 'set the version manually'"))
/// .arg(arg!("--major 'auto increase major'"))
/// .arg(arg!("--minor 'auto increase minor'"))
/// .arg(arg!("--patch 'auto increase patch'"))
/// .group(ArgGroup::new("vers")
/// .args(&["set-ver", "major", "minor","patch"])
/// .required(true))
/// # ;
/// ```
#[inline]
#[must_use]
pub fn group<G: Into<ArgGroup<'help>>>(mut self, group: G) -> Self {
self.groups.push(group.into());
self
}
/// Adds multiple [`ArgGroup`]s to the [`Command`] at once.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, arg, ArgGroup};
/// Command::new("cmd")
/// .arg(arg!("--set-ver [ver] 'set the version manually'"))
/// .arg(arg!("--major 'auto increase major'"))
/// .arg(arg!("--minor 'auto increase minor'"))
/// .arg(arg!("--patch 'auto increase patch'"))
/// .arg(arg!("-c [FILE] 'a config file'"))
/// .arg(arg!("-i [IFACE] 'an interface'"))
/// .groups(&[
/// ArgGroup::new("vers")
/// .args(&["set-ver", "major", "minor","patch"])
/// .required(true),
/// ArgGroup::new("input")
/// .args(&["c", "i"])
/// ])
/// # ;
/// ```
#[must_use]
pub fn groups<I, T>(mut self, groups: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<ArgGroup<'help>>,
{
for g in groups.into_iter() {
self = self.group(g.into());
}
self
}
/// Adds a subcommand to the list of valid possibilities.
///
/// Subcommands are effectively sub-[`Command`]s, because they can contain their own arguments,
/// subcommands, version, usage, etc. They also function just like [`Command`]s, in that they get
/// their own auto generated help, version, and usage.
///
/// A subcommand's [`Command::name`] will be used for:
/// - The argument the user passes in
/// - Programmatically looking up the subcommand
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, arg};
/// Command::new("myprog")
/// .subcommand(Command::new("config")
/// .about("Controls configuration features")
/// .arg(arg!("<config> 'Required configuration file to use'")))
/// # ;
/// ```
#[inline]
#[must_use]
pub fn subcommand<S: Into<App<'help>>>(mut self, subcmd: S) -> Self {
self.subcommands.push(subcmd.into());
self
}
/// Adds multiple subcommands to the list of valid possibilities.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg, };
/// # Command::new("myprog")
/// .subcommands( vec![
/// Command::new("config").about("Controls configuration functionality")
/// .arg(Arg::new("config_file")),
/// Command::new("debug").about("Controls debug functionality")])
/// # ;
/// ```
/// [`IntoIterator`]: std::iter::IntoIterator
#[must_use]
pub fn subcommands<I, T>(mut self, subcmds: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<App<'help>>,
{
for subcmd in subcmds.into_iter() {
self.subcommands.push(subcmd.into());
}
self
}
/// Catch problems earlier in the development cycle.
///
/// Most error states are handled as asserts under the assumption they are programming mistake
/// and not something to handle at runtime. Rather than relying on tests (manual or automated)
/// that exhaustively test your CLI to ensure the asserts are evaluated, this will run those
/// asserts in a way convenient for running as a test.
///
/// **Note::** This will not help with asserts in [`ArgMatches`], those will need exhaustive
/// testing of your CLI.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg, ArgAction};
/// fn cmd() -> Command<'static> {
/// Command::new("foo")
/// .arg(
/// Arg::new("bar").short('b').action(ArgAction::SetTrue)
/// )
/// }
///
/// #[test]
/// fn verify_app() {
/// cmd().debug_assert();
/// }
///
/// fn main() {
/// let m = cmd().get_matches_from(vec!["foo", "-b"]);
/// println!("{}", *m.get_one::<bool>("bar").expect("defaulted by clap"));
/// }
/// ```
pub fn debug_assert(mut self) {
self._build_all();
}
/// Custom error message for post-parsing validation
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let mut cmd = Command::new("myprog");
/// let err = cmd.error(ErrorKind::InvalidValue, "Some failure case");
/// ```
pub fn error(&mut self, kind: ErrorKind, message: impl std::fmt::Display) -> Error {
Error::raw(kind, message).format(self)
}
/// Parse [`env::args_os`], exiting on failure.
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let matches = Command::new("myprog")
/// // Args and options go here...
/// .get_matches();
/// ```
/// [`env::args_os`]: std::env::args_os()
/// [`App::try_get_matches_from_mut`]: Command::try_get_matches_from_mut()
#[inline]
pub fn get_matches(self) -> ArgMatches {
self.get_matches_from(&mut env::args_os())
}
/// Parse [`env::args_os`], exiting on failure.
///
/// Like [`App::get_matches`] but doesn't consume the `Command`.
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let mut cmd = Command::new("myprog")
/// // Args and options go here...
/// ;
/// let matches = cmd.get_matches_mut();
/// ```
/// [`env::args_os`]: std::env::args_os()
/// [`App::get_matches`]: Command::get_matches()
pub fn get_matches_mut(&mut self) -> ArgMatches {
self.try_get_matches_from_mut(&mut env::args_os())
.unwrap_or_else(|e| e.exit())
}
/// Parse [`env::args_os`], returning a [`clap::Result`] on failure.
///
/// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are
/// used. It will return a [`clap::Error`], where the [`kind`] is a
/// [`ErrorKind::DisplayHelp`] or [`ErrorKind::DisplayVersion`] respectively. You must call
/// [`Error::exit`] or perform a [`std::process::exit`].
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let matches = Command::new("myprog")
/// // Args and options go here...
/// .try_get_matches()
/// .unwrap_or_else(|e| e.exit());
/// ```
/// [`env::args_os`]: std::env::args_os()
/// [`Error::exit`]: crate::Error::exit()
/// [`std::process::exit`]: std::process::exit()
/// [`clap::Result`]: Result
/// [`clap::Error`]: crate::Error
/// [`kind`]: crate::Error
/// [`ErrorKind::DisplayHelp`]: crate::ErrorKind::DisplayHelp
/// [`ErrorKind::DisplayVersion`]: crate::ErrorKind::DisplayVersion
#[inline]
pub fn try_get_matches(self) -> ClapResult<ArgMatches> {
// Start the parsing
self.try_get_matches_from(&mut env::args_os())
}
/// Parse the specified arguments, exiting on failure.
///
/// **NOTE:** The first argument will be parsed as the binary name unless
/// [`Command::no_binary_name`] is used.
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];
///
/// let matches = Command::new("myprog")
/// // Args and options go here...
/// .get_matches_from(arg_vec);
/// ```
/// [`App::get_matches`]: Command::get_matches()
/// [`clap::Result`]: Result
/// [`Vec`]: std::vec::Vec
pub fn get_matches_from<I, T>(mut self, itr: I) -> ArgMatches
where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
{
self.try_get_matches_from_mut(itr).unwrap_or_else(|e| {
drop(self);
e.exit()
})
}
/// Parse the specified arguments, returning a [`clap::Result`] on failure.
///
/// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are
/// used. It will return a [`clap::Error`], where the [`kind`] is a [`ErrorKind::DisplayHelp`]
/// or [`ErrorKind::DisplayVersion`] respectively. You must call [`Error::exit`] or
/// perform a [`std::process::exit`] yourself.
///
/// **NOTE:** The first argument will be parsed as the binary name unless
/// [`Command::no_binary_name`] is used.
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];
///
/// let matches = Command::new("myprog")
/// // Args and options go here...
/// .try_get_matches_from(arg_vec)
/// .unwrap_or_else(|e| e.exit());
/// ```
/// [`App::get_matches_from`]: Command::get_matches_from()
/// [`App::try_get_matches`]: Command::try_get_matches()
/// [`Error::exit`]: crate::Error::exit()
/// [`std::process::exit`]: std::process::exit()
/// [`clap::Error`]: crate::Error
/// [`Error::exit`]: crate::Error::exit()
/// [`kind`]: crate::Error
/// [`ErrorKind::DisplayHelp`]: crate::ErrorKind::DisplayHelp
/// [`ErrorKind::DisplayVersion`]: crate::ErrorKind::DisplayVersion
/// [`clap::Result`]: Result
pub fn try_get_matches_from<I, T>(mut self, itr: I) -> ClapResult<ArgMatches>
where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
{
self.try_get_matches_from_mut(itr)
}
/// Parse the specified arguments, returning a [`clap::Result`] on failure.
///
/// Like [`App::try_get_matches_from`] but doesn't consume the `Command`.
///
/// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are
/// used. It will return a [`clap::Error`], where the [`kind`] is a [`ErrorKind::DisplayHelp`]
/// or [`ErrorKind::DisplayVersion`] respectively. You must call [`Error::exit`] or
/// perform a [`std::process::exit`] yourself.
///
/// **NOTE:** The first argument will be parsed as the binary name unless
/// [`Command::no_binary_name`] is used.
///
/// # Panics
///
/// If contradictory arguments or settings exist.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];
///
/// let mut cmd = Command::new("myprog");
/// // Args and options go here...
/// let matches = cmd.try_get_matches_from_mut(arg_vec)
/// .unwrap_or_else(|e| e.exit());
/// ```
/// [`App::try_get_matches_from`]: Command::try_get_matches_from()
/// [`clap::Result`]: Result
/// [`clap::Error`]: crate::Error
/// [`kind`]: crate::Error
pub fn try_get_matches_from_mut<I, T>(&mut self, itr: I) -> ClapResult<ArgMatches>
where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
{
let mut raw_args = clap_lex::RawArgs::new(itr.into_iter());
let mut cursor = raw_args.cursor();
if self.settings.is_set(AppSettings::Multicall) {
if let Some(argv0) = raw_args.next_os(&mut cursor) {
let argv0 = Path::new(&argv0);
if let Some(command) = argv0.file_stem().and_then(|f| f.to_str()) {
// Stop borrowing command so we can get another mut ref to it.
let command = command.to_owned();
debug!(
"Command::try_get_matches_from_mut: Parsed command {} from argv",
command
);
debug!("Command::try_get_matches_from_mut: Reinserting command into arguments so subcommand parser matches it");
raw_args.insert(&cursor, &[&command]);
debug!("Command::try_get_matches_from_mut: Clearing name and bin_name so that displayed command name starts with applet name");
self.name.clear();
self.bin_name = None;
return self._do_parse(&mut raw_args, cursor);
}
}
};
// Get the name of the program (argument 1 of env::args()) and determine the
// actual file
// that was used to execute the program. This is because a program called
// ./target/release/my_prog -a
// will have two arguments, './target/release/my_prog', '-a' but we don't want
// to display
// the full path when displaying help messages and such
if !self.settings.is_set(AppSettings::NoBinaryName) {
if let Some(name) = raw_args.next_os(&mut cursor) {
let p = Path::new(name);
if let Some(f) = p.file_name() {
if let Some(s) = f.to_str() {
if self.bin_name.is_none() {
self.bin_name = Some(s.to_owned());
}
}
}
}
}
self._do_parse(&mut raw_args, cursor)
}
/// Prints the short help message (`-h`) to [`io::stdout()`].
///
/// See also [`Command::print_long_help`].
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// let mut cmd = Command::new("myprog");
/// cmd.print_help();
/// ```
/// [`io::stdout()`]: std::io::stdout()
pub fn print_help(&mut self) -> io::Result<()> {
self._build_self();
let color = self.color_help();
let mut c = Colorizer::new(Stream::Stdout, color);
let usage = Usage::new(self);
Help::new(HelpWriter::Buffer(&mut c), self, &usage, false).write_help()?;
c.print()
}
/// Prints the long help message (`--help`) to [`io::stdout()`].
///
/// See also [`Command::print_help`].
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// let mut cmd = Command::new("myprog");
/// cmd.print_long_help();
/// ```
/// [`io::stdout()`]: std::io::stdout()
/// [`BufWriter`]: std::io::BufWriter
/// [`-h` (short)]: Arg::help()
/// [`--help` (long)]: Arg::long_help()
pub fn print_long_help(&mut self) -> io::Result<()> {
self._build_self();
let color = self.color_help();
let mut c = Colorizer::new(Stream::Stdout, color);
let usage = Usage::new(self);
Help::new(HelpWriter::Buffer(&mut c), self, &usage, true).write_help()?;
c.print()
}
/// Writes the short help message (`-h`) to a [`io::Write`] object.
///
/// See also [`Command::write_long_help`].
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// use std::io;
/// let mut cmd = Command::new("myprog");
/// let mut out = io::stdout();
/// cmd.write_help(&mut out).expect("failed to write to stdout");
/// ```
/// [`io::Write`]: std::io::Write
/// [`-h` (short)]: Arg::help()
/// [`--help` (long)]: Arg::long_help()
pub fn write_help<W: io::Write>(&mut self, w: &mut W) -> io::Result<()> {
self._build_self();
let usage = Usage::new(self);
Help::new(HelpWriter::Normal(w), self, &usage, false).write_help()?;
w.flush()
}
/// Writes the long help message (`--help`) to a [`io::Write`] object.
///
/// See also [`Command::write_help`].
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// use std::io;
/// let mut cmd = Command::new("myprog");
/// let mut out = io::stdout();
/// cmd.write_long_help(&mut out).expect("failed to write to stdout");
/// ```
/// [`io::Write`]: std::io::Write
/// [`-h` (short)]: Arg::help()
/// [`--help` (long)]: Arg::long_help()
pub fn write_long_help<W: io::Write>(&mut self, w: &mut W) -> io::Result<()> {
self._build_self();
let usage = Usage::new(self);
Help::new(HelpWriter::Normal(w), self, &usage, true).write_help()?;
w.flush()
}
/// Version message rendered as if the user ran `-V`.
///
/// See also [`Command::render_long_version`].
///
/// ### Coloring
///
/// This function does not try to color the message nor it inserts any [ANSI escape codes].
///
/// ### Examples
///
/// ```rust
/// # use clap::Command;
/// use std::io;
/// let cmd = Command::new("myprog");
/// println!("{}", cmd.render_version());
/// ```
/// [`io::Write`]: std::io::Write
/// [`-V` (short)]: Command::version()
/// [`--version` (long)]: Command::long_version()
/// [ANSI escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
pub fn render_version(&self) -> String {
self._render_version(false)
}
/// Version message rendered as if the user ran `--version`.
///
/// See also [`Command::render_version`].
///
/// ### Coloring
///
/// This function does not try to color the message nor it inserts any [ANSI escape codes].
///
/// ### Examples
///
/// ```rust
/// # use clap::Command;
/// use std::io;
/// let cmd = Command::new("myprog");
/// println!("{}", cmd.render_long_version());
/// ```
/// [`io::Write`]: std::io::Write
/// [`-V` (short)]: Command::version()
/// [`--version` (long)]: Command::long_version()
/// [ANSI escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
pub fn render_long_version(&self) -> String {
self._render_version(true)
}
/// Usage statement
///
/// ### Examples
///
/// ```rust
/// # use clap::Command;
/// use std::io;
/// let mut cmd = Command::new("myprog");
/// println!("{}", cmd.render_usage());
/// ```
pub fn render_usage(&mut self) -> String {
// If there are global arguments, or settings we need to propagate them down to subcommands
// before parsing incase we run into a subcommand
self._build_self();
Usage::new(self).create_usage_with_title(&[])
}
}
/// # Application-wide Settings
///
/// These settings will apply to the top-level command and all subcommands, by default. Some
/// settings can be overridden in subcommands.
impl<'help> App<'help> {
/// Specifies that the parser should not assume the first argument passed is the binary name.
///
/// This is normally the case when using a "daemon" style mode. For shells / REPLs, see
/// [`Command::multicall`][App::multicall].
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, arg};
/// let m = Command::new("myprog")
/// .no_binary_name(true)
/// .arg(arg!(<cmd> ... "commands to run"))
/// .get_matches_from(vec!["command", "set"]);
///
/// let cmds: Vec<&str> = m.values_of("cmd").unwrap().collect();
/// assert_eq!(cmds, ["command", "set"]);
/// ```
/// [`try_get_matches_from_mut`]: crate::Command::try_get_matches_from_mut()
#[inline]
pub fn no_binary_name(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::NoBinaryName)
} else {
self.unset_global_setting(AppSettings::NoBinaryName)
}
}
/// Try not to fail on parse errors, like missing option values.
///
/// **Note:** Make sure you apply it as `global_setting` if you want this setting
/// to be propagated to subcommands and sub-subcommands!
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, arg};
/// let cmd = Command::new("cmd")
/// .ignore_errors(true)
/// .arg(arg!(-c --config <FILE> "Sets a custom config file").required(false))
/// .arg(arg!(-x --stuff <FILE> "Sets a custom stuff file").required(false))
/// .arg(arg!(f: -f "Flag"));
///
/// let r = cmd.try_get_matches_from(vec!["cmd", "-c", "file", "-f", "-x"]);
///
/// assert!(r.is_ok(), "unexpected error: {:?}", r);
/// let m = r.unwrap();
/// assert_eq!(m.value_of("config"), Some("file"));
/// assert!(m.is_present("f"));
/// assert_eq!(m.value_of("stuff"), None);
/// ```
#[inline]
pub fn ignore_errors(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::IgnoreErrors)
} else {
self.unset_global_setting(AppSettings::IgnoreErrors)
}
}
/// Deprecated, replaced with [`ArgAction::Set`][super::ArgAction::Set]
///
/// The new actions (`ArgAction::Set`, `ArgAction::SetTrue`) do this by default.
///
/// See `ArgAction::StoreValue` and `ArgAction::IncOccurrence` for how to migrate
#[cfg_attr(
feature = "deprecated",
deprecated(
since = "3.2.0",
note = "Replaced with `Arg::action(ArgAction::...)`
The new actions (`ArgAction::Set`, `ArgAction::SetTrue`) do this by default.
See `ArgAction::StoreValue` and `ArgAction::IncOccurrence` for how to migrate
"
)
)]
pub fn args_override_self(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::AllArgsOverrideSelf)
} else {
self.unset_global_setting(AppSettings::AllArgsOverrideSelf)
}
}
/// Disables the automatic delimiting of values after `--` or when [`Command::trailing_var_arg`]
/// was used.
///
/// **NOTE:** The same thing can be done manually by setting the final positional argument to
/// [`Arg::use_value_delimiter(false)`]. Using this setting is safer, because it's easier to locate
/// when making changes.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .dont_delimit_trailing_values(true)
/// .get_matches();
/// ```
///
/// [`Arg::use_value_delimiter(false)`]: crate::Arg::use_value_delimiter()
#[inline]
pub fn dont_delimit_trailing_values(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DontDelimitTrailingValues)
} else {
self.unset_global_setting(AppSettings::DontDelimitTrailingValues)
}
}
/// Sets when to color output.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// **NOTE:** Default behaviour is [`ColorChoice::Auto`].
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, ColorChoice};
/// Command::new("myprog")
/// .color(ColorChoice::Never)
/// .get_matches();
/// ```
/// [`ColorChoice::Auto`]: crate::ColorChoice::Auto
#[cfg(feature = "color")]
#[inline]
#[must_use]
pub fn color(self, color: ColorChoice) -> Self {
#![allow(deprecated)]
let cmd = self
.unset_global_setting(AppSettings::ColorAuto)
.unset_global_setting(AppSettings::ColorAlways)
.unset_global_setting(AppSettings::ColorNever);
match color {
ColorChoice::Auto => cmd.global_setting(AppSettings::ColorAuto),
ColorChoice::Always => cmd.global_setting(AppSettings::ColorAlways),
ColorChoice::Never => cmd.global_setting(AppSettings::ColorNever),
}
}
/// Sets the terminal width at which to wrap help messages.
///
/// Using `0` will ignore terminal widths and use source formatting.
///
/// Defaults to current terminal width when `wrap_help` feature flag is enabled. If the flag
/// is disabled or it cannot be determined, the default is 100.
///
/// **NOTE:** This setting applies globally and *not* on a per-command basis.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .term_width(80)
/// # ;
/// ```
#[inline]
#[must_use]
pub fn term_width(mut self, width: usize) -> Self {
self.term_w = Some(width);
self
}
/// Sets the maximum terminal width at which to wrap help messages.
///
/// This only applies when setting the current terminal width. See [`Command::term_width`] for
/// more details.
///
/// Using `0` will ignore terminal widths and use source formatting.
///
/// **NOTE:** This setting applies globally and *not* on a per-command basis.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .max_term_width(100)
/// # ;
/// ```
#[inline]
#[must_use]
pub fn max_term_width(mut self, w: usize) -> Self {
self.max_w = Some(w);
self
}
/// Disables `-V` and `--version` flag.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let res = Command::new("myprog")
/// .disable_version_flag(true)
/// .try_get_matches_from(vec![
/// "myprog", "-V"
/// ]);
/// assert!(res.is_err());
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);
/// ```
#[inline]
pub fn disable_version_flag(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DisableVersionFlag)
} else {
self.unset_global_setting(AppSettings::DisableVersionFlag)
}
}
/// Specifies to use the version of the current command for all [`subcommands`].
///
/// Defaults to `false`; subcommands have independent version strings from their parents.
///
/// **Note:** Make sure you apply it as `global_setting` if you want this setting
/// to be propagated to subcommands and sub-subcommands!
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .version("v1.1")
/// .propagate_version(true)
/// .subcommand(Command::new("test"))
/// .get_matches();
/// // running `$ myprog test --version` will display
/// // "myprog-test v1.1"
/// ```
///
/// [`subcommands`]: crate::Command::subcommand()
#[inline]
pub fn propagate_version(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::PropagateVersion)
} else {
self.unset_global_setting(AppSettings::PropagateVersion)
}
}
/// Places the help string for all arguments and subcommands on the line after them.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .next_line_help(true)
/// .get_matches();
/// ```
#[inline]
pub fn next_line_help(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::NextLineHelp)
} else {
self.unset_global_setting(AppSettings::NextLineHelp)
}
}
/// Disables `-h` and `--help` flag.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let res = Command::new("myprog")
/// .disable_help_flag(true)
/// .try_get_matches_from(vec![
/// "myprog", "-h"
/// ]);
/// assert!(res.is_err());
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);
/// ```
#[inline]
pub fn disable_help_flag(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DisableHelpFlag)
} else {
self.unset_global_setting(AppSettings::DisableHelpFlag)
}
}
/// Disables the `help` [`subcommand`].
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let res = Command::new("myprog")
/// .disable_help_subcommand(true)
/// // Normally, creating a subcommand causes a `help` subcommand to automatically
/// // be generated as well
/// .subcommand(Command::new("test"))
/// .try_get_matches_from(vec![
/// "myprog", "help"
/// ]);
/// assert!(res.is_err());
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);
/// ```
///
/// [`subcommand`]: crate::Command::subcommand()
#[inline]
pub fn disable_help_subcommand(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DisableHelpSubcommand)
} else {
self.unset_global_setting(AppSettings::DisableHelpSubcommand)
}
}
/// Disables colorized help messages.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .disable_colored_help(true)
/// .get_matches();
/// ```
#[inline]
pub fn disable_colored_help(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DisableColoredHelp)
} else {
self.unset_global_setting(AppSettings::DisableColoredHelp)
}
}
/// Panic if help descriptions are omitted.
///
/// **NOTE:** When deriving [`Parser`][crate::Parser], you could instead check this at
/// compile-time with `#![deny(missing_docs)]`
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .help_expected(true)
/// .arg(
/// Arg::new("foo").help("It does foo stuff")
/// // As required via `help_expected`, a help message was supplied
/// )
/// # .get_matches();
/// ```
///
/// # Panics
///
/// ```rust,no_run
/// # use clap::{Command, Arg};
/// Command::new("myapp")
/// .help_expected(true)
/// .arg(
/// Arg::new("foo")
/// // Someone forgot to put .about("...") here
/// // Since the setting `help_expected` is activated, this will lead to
/// // a panic (if you are in debug mode)
/// )
/// # .get_matches();
///```
#[inline]
pub fn help_expected(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::HelpExpected)
} else {
self.unset_global_setting(AppSettings::HelpExpected)
}
}
/// Disables the automatic collapsing of positional args into `[ARGS]` inside the usage string.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .dont_collapse_args_in_usage(true)
/// .get_matches();
/// ```
#[inline]
pub fn dont_collapse_args_in_usage(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::DontCollapseArgsInUsage)
} else {
self.unset_global_setting(AppSettings::DontCollapseArgsInUsage)
}
}
/// Tells `clap` *not* to print possible values when displaying help information.
///
/// This can be useful if there are many values, or they are explained elsewhere.
///
/// To set this per argument, see
/// [`Arg::hide_possible_values`][crate::Arg::hide_possible_values].
///
/// **NOTE:** This choice is propagated to all child subcommands.
#[inline]
pub fn hide_possible_values(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::HidePossibleValues)
} else {
self.unset_global_setting(AppSettings::HidePossibleValues)
}
}
/// Allow partial matches of long arguments or their [aliases].
///
/// For example, to match an argument named `--test`, one could use `--t`, `--te`, `--tes`, and
/// `--test`.
///
/// **NOTE:** The match *must not* be ambiguous at all in order to succeed. i.e. to match
/// `--te` to `--test` there could not also be another argument or alias `--temp` because both
/// start with `--te`
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// [aliases]: crate::Command::aliases()
#[inline]
pub fn infer_long_args(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::InferLongArgs)
} else {
self.unset_global_setting(AppSettings::InferLongArgs)
}
}
/// Allow partial matches of [subcommand] names and their [aliases].
///
/// For example, to match a subcommand named `test`, one could use `t`, `te`, `tes`, and
/// `test`.
///
/// **NOTE:** The match *must not* be ambiguous at all in order to succeed. i.e. to match `te`
/// to `test` there could not also be a subcommand or alias `temp` because both start with `te`
///
/// **CAUTION:** This setting can interfere with [positional/free arguments], take care when
/// designing CLIs which allow inferred subcommands and have potential positional/free
/// arguments whose values could start with the same characters as subcommands. If this is the
/// case, it's recommended to use settings such as [`Command::args_conflicts_with_subcommands`] in
/// conjunction with this setting.
///
/// **NOTE:** This choice is propagated to all child subcommands.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let m = Command::new("prog")
/// .infer_subcommands(true)
/// .subcommand(Command::new("test"))
/// .get_matches_from(vec![
/// "prog", "te"
/// ]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
///
/// [subcommand]: crate::Command::subcommand()
/// [positional/free arguments]: crate::Arg::index()
/// [aliases]: crate::Command::aliases()
#[inline]
pub fn infer_subcommands(self, yes: bool) -> Self {
if yes {
self.global_setting(AppSettings::InferSubcommands)
} else {
self.unset_global_setting(AppSettings::InferSubcommands)
}
}
}
/// # Command-specific Settings
///
/// These apply only to the current command and are not inherited by subcommands.
impl<'help> App<'help> {
/// (Re)Sets the program's name.
///
/// See [`Command::new`] for more details.
///
/// # Examples
///
/// ```ignore
/// # use clap::{Command, load_yaml};
/// let yaml = load_yaml!("cmd.yaml");
/// let cmd = Command::from(yaml)
/// .name(crate_name!());
///
/// // continued logic goes here, such as `cmd.get_matches()` etc.
/// ```
#[must_use]
pub fn name<S: Into<String>>(mut self, name: S) -> Self {
self.name = name.into();
self
}
/// Overrides the runtime-determined name of the binary for help and error messages.
///
/// This should only be used when absolutely necessary, such as when the binary name for your
/// application is misleading, or perhaps *not* how the user should invoke your program.
///
/// **Pro-tip:** When building things such as third party `cargo`
/// subcommands, this setting **should** be used!
///
/// **NOTE:** This *does not* change or set the name of the binary file on
/// disk. It only changes what clap thinks the name is for the purposes of
/// error or help messages.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("My Program")
/// .bin_name("my_binary")
/// # ;
/// ```
#[must_use]
pub fn bin_name<S: Into<String>>(mut self, name: S) -> Self {
self.bin_name = Some(name.into());
self
}
/// Overrides the runtime-determined display name of the program for help and error messages.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("My Program")
/// .display_name("my_program")
/// # ;
/// ```
#[must_use]
pub fn display_name<S: Into<String>>(mut self, name: S) -> Self {
self.display_name = Some(name.into());
self
}
/// Sets the author(s) for the help message.
///
/// **Pro-tip:** Use `clap`s convenience macro [`crate_authors!`] to
/// automatically set your application's author(s) to the same thing as your
/// crate at compile time.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .author("Me, me@mymain.com")
/// # ;
/// ```
/// [`crate_authors!`]: ./macro.crate_authors!.html
#[must_use]
pub fn author<S: Into<&'help str>>(mut self, author: S) -> Self {
self.author = Some(author.into());
self
}
/// Sets the program's description for the short help (`-h`).
///
/// If [`Command::long_about`] is not specified, this message will be displayed for `--help`.
///
/// **NOTE:** Only `Command::about` (short format) is used in completion
/// script generation in order to be concise.
///
/// See also [`crate_description!`](crate::crate_description!).
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .about("Does really amazing things for great people")
/// # ;
/// ```
#[must_use]
pub fn about<O: Into<Option<&'help str>>>(mut self, about: O) -> Self {
self.about = about.into();
self
}
/// Sets the program's description for the long help (`--help`).
///
/// If [`Command::about`] is not specified, this message will be displayed for `-h`.
///
/// **NOTE:** Only [`Command::about`] (short format) is used in completion
/// script generation in order to be concise.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .long_about(
/// "Does really amazing things to great people. Now let's talk a little
/// more in depth about how this subcommand really works. It may take about
/// a few lines of text, but that's ok!")
/// # ;
/// ```
/// [`App::about`]: Command::about()
#[must_use]
pub fn long_about<O: Into<Option<&'help str>>>(mut self, long_about: O) -> Self {
self.long_about = long_about.into();
self
}
/// Free-form help text for after auto-generated short help (`-h`).
///
/// This is often used to describe how to use the arguments, caveats to be noted, or license
/// and contact information.
///
/// If [`Command::after_long_help`] is not specified, this message will be displayed for `--help`.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .after_help("Does really amazing things for great people... but be careful with -R!")
/// # ;
/// ```
///
#[must_use]
pub fn after_help<S: Into<&'help str>>(mut self, help: S) -> Self {
self.after_help = Some(help.into());
self
}
/// Free-form help text for after auto-generated long help (`--help`).
///
/// This is often used to describe how to use the arguments, caveats to be noted, or license
/// and contact information.
///
/// If [`Command::after_help`] is not specified, this message will be displayed for `-h`.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .after_long_help("Does really amazing things to great people... but be careful with -R, \
/// like, for real, be careful with this!")
/// # ;
/// ```
#[must_use]
pub fn after_long_help<S: Into<&'help str>>(mut self, help: S) -> Self {
self.after_long_help = Some(help.into());
self
}
/// Free-form help text for before auto-generated short help (`-h`).
///
/// This is often used for header, copyright, or license information.
///
/// If [`Command::before_long_help`] is not specified, this message will be displayed for `--help`.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .before_help("Some info I'd like to appear before the help info")
/// # ;
/// ```
#[must_use]
pub fn before_help<S: Into<&'help str>>(mut self, help: S) -> Self {
self.before_help = Some(help.into());
self
}
/// Free-form help text for before auto-generated long help (`--help`).
///
/// This is often used for header, copyright, or license information.
///
/// If [`Command::before_help`] is not specified, this message will be displayed for `-h`.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .before_long_help("Some verbose and long info I'd like to appear before the help info")
/// # ;
/// ```
#[must_use]
pub fn before_long_help<S: Into<&'help str>>(mut self, help: S) -> Self {
self.before_long_help = Some(help.into());
self
}
/// Sets the version for the short version (`-V`) and help messages.
///
/// If [`Command::long_version`] is not specified, this message will be displayed for `--version`.
///
/// **Pro-tip:** Use `clap`s convenience macro [`crate_version!`] to
/// automatically set your application's version to the same thing as your
/// crate at compile time.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .version("v0.1.24")
/// # ;
/// ```
/// [`crate_version!`]: ./macro.crate_version!.html
#[must_use]
pub fn version<S: Into<&'help str>>(mut self, ver: S) -> Self {
self.version = Some(ver.into());
self
}
/// Sets the version for the long version (`--version`) and help messages.
///
/// If [`Command::version`] is not specified, this message will be displayed for `-V`.
///
/// **Pro-tip:** Use `clap`s convenience macro [`crate_version!`] to
/// automatically set your application's version to the same thing as your
/// crate at compile time.
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .long_version(
/// "v0.1.24
/// commit: abcdef89726d
/// revision: 123
/// release: 2
/// binary: myprog")
/// # ;
/// ```
/// [`crate_version!`]: ./macro.crate_version!.html
#[must_use]
pub fn long_version<S: Into<&'help str>>(mut self, ver: S) -> Self {
self.long_version = Some(ver.into());
self
}
/// Overrides the `clap` generated usage string for help and error messages.
///
/// **NOTE:** Using this setting disables `clap`s "context-aware" usage
/// strings. After this setting is set, this will be *the only* usage string
/// displayed to the user!
///
/// **NOTE:** Multiple usage lines may be present in the usage argument, but
/// some rules need to be followed to ensure the usage lines are formatted
/// correctly by the default help formatter:
///
/// - Do not indent the first usage line.
/// - Indent all subsequent usage lines with four spaces.
/// - The last line must not end with a newline.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .override_usage("myapp [-clDas] <some_file>")
/// # ;
/// ```
///
/// Or for multiple usage lines:
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .override_usage(
/// "myapp -X [-a] [-b] <file>\n \
/// myapp -Y [-c] <file1> <file2>\n \
/// myapp -Z [-d|-e]"
/// )
/// # ;
/// ```
///
/// [`ArgMatches::usage`]: ArgMatches::usage()
#[must_use]
pub fn override_usage<S: Into<&'help str>>(mut self, usage: S) -> Self {
self.usage_str = Some(usage.into());
self
}
/// Overrides the `clap` generated help message (both `-h` and `--help`).
///
/// This should only be used when the auto-generated message does not suffice.
///
/// **NOTE:** This **only** replaces the help message for the current
/// command, meaning if you are using subcommands, those help messages will
/// still be auto-generated unless you specify a [`Command::override_help`] for
/// them as well.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myapp")
/// .override_help("myapp v1.0\n\
/// Does awesome things\n\
/// (C) me@mail.com\n\n\
///
/// USAGE: myapp <opts> <command>\n\n\
///
/// Options:\n\
/// -h, --help Display this message\n\
/// -V, --version Display version info\n\
/// -s <stuff> Do something with stuff\n\
/// -v Be verbose\n\n\
///
/// Commands:\n\
/// help Print this message\n\
/// work Do some work")
/// # ;
/// ```
#[must_use]
pub fn override_help<S: Into<&'help str>>(mut self, help: S) -> Self {
self.help_str = Some(help.into());
self
}
/// Sets the help template to be used, overriding the default format.
///
/// **NOTE:** The template system is by design very simple. Therefore, the
/// tags have to be written in the lowercase and without spacing.
///
/// Tags are given inside curly brackets.
///
/// Valid tags are:
///
/// * `{name}` - Display name for the (sub-)command.
/// * `{bin}` - Binary name.
/// * `{version}` - Version number.
/// * `{author}` - Author information.
/// * `{author-with-newline}` - Author followed by `\n`.
/// * `{author-section}` - Author preceded and followed by `\n`.
/// * `{about}` - General description (from [`Command::about`] or
/// [`Command::long_about`]).
/// * `{about-with-newline}` - About followed by `\n`.
/// * `{about-section}` - About preceded and followed by '\n'.
/// * `{usage-heading}` - Automatically generated usage heading.
/// * `{usage}` - Automatically generated or given usage string.
/// * `{all-args}` - Help for all arguments (options, flags, positional
/// arguments, and subcommands) including titles.
/// * `{options}` - Help for options.
/// * `{positionals}` - Help for positional arguments.
/// * `{subcommands}` - Help for subcommands.
/// * `{after-help}` - Help from [`App::after_help`] or [`Command::after_long_help`].
/// * `{before-help}` - Help from [`App::before_help`] or [`Command::before_long_help`].
///
/// # Examples
///
/// ```no_run
/// # use clap::Command;
/// Command::new("myprog")
/// .version("1.0")
/// .help_template("{bin} ({version}) - {usage}")
/// # ;
/// ```
/// [`App::about`]: Command::about()
/// [`App::long_about`]: Command::long_about()
/// [`App::after_help`]: Command::after_help()
/// [`App::after_long_help`]: Command::after_long_help()
/// [`App::before_help`]: Command::before_help()
/// [`App::before_long_help`]: Command::before_long_help()
#[must_use]
pub fn help_template<S: Into<&'help str>>(mut self, s: S) -> Self {
self.template = Some(s.into());
self
}
/// Apply a setting for the current command or subcommand.
///
/// See [`Command::global_setting`] to apply a setting to this command and all subcommands.
///
/// See [`AppSettings`] for a full list of possibilities and examples.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .setting(AppSettings::SubcommandRequired)
/// .setting(AppSettings::AllowLeadingHyphen)
/// # ;
/// ```
/// or
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)
/// # ;
/// ```
#[inline]
#[must_use]
pub fn setting<F>(mut self, setting: F) -> Self
where
F: Into<AppFlags>,
{
self.settings.insert(setting.into());
self
}
/// Remove a setting for the current command or subcommand.
///
/// See [`AppSettings`] for a full list of possibilities and examples.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .unset_setting(AppSettings::SubcommandRequired)
/// .setting(AppSettings::AllowLeadingHyphen)
/// # ;
/// ```
/// or
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .unset_setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)
/// # ;
/// ```
#[inline]
#[must_use]
pub fn unset_setting<F>(mut self, setting: F) -> Self
where
F: Into<AppFlags>,
{
self.settings.remove(setting.into());
self
}
/// Apply a setting for the current command and all subcommands.
///
/// See [`Command::setting`] to apply a setting only to this command.
///
/// See [`AppSettings`] for a full list of possibilities and examples.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .global_setting(AppSettings::AllowNegativeNumbers)
/// # ;
/// ```
#[inline]
#[must_use]
pub fn global_setting(mut self, setting: AppSettings) -> Self {
self.settings.set(setting);
self.g_settings.set(setting);
self
}
/// Remove a setting and stop propagating down to subcommands.
///
/// See [`AppSettings`] for a full list of possibilities and examples.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, AppSettings};
/// Command::new("myprog")
/// .unset_global_setting(AppSettings::AllowNegativeNumbers)
/// # ;
/// ```
/// [global]: Command::global_setting()
#[inline]
#[must_use]
pub fn unset_global_setting(mut self, setting: AppSettings) -> Self {
self.settings.unset(setting);
self.g_settings.unset(setting);
self
}
/// Deprecated, replaced with [`Command::next_help_heading`]
#[inline]
#[must_use]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.0", note = "Replaced with `App::next_help_heading`")
)]
pub fn help_heading<O>(self, heading: O) -> Self
where
O: Into<Option<&'help str>>,
{
self.next_help_heading(heading)
}
/// Set the default section heading for future args.
///
/// This will be used for any arg that hasn't had [`Arg::help_heading`] called.
///
/// This is useful if the default `OPTIONS` or `ARGS` headings are
/// not specific enough for one's use case.
///
/// For subcommands, see [`Command::subcommand_help_heading`]
///
/// [`App::arg`]: Command::arg()
/// [`Arg::help_heading`]: crate::Arg::help_heading()
#[inline]
#[must_use]
pub fn next_help_heading<O>(mut self, heading: O) -> Self
where
O: Into<Option<&'help str>>,
{
self.current_help_heading = heading.into();
self
}
/// Change the starting value for assigning future display orders for ags.
///
/// This will be used for any arg that hasn't had [`Arg::display_order`] called.
#[inline]
#[must_use]
pub fn next_display_order(mut self, disp_ord: impl Into<Option<usize>>) -> Self {
self.current_disp_ord = disp_ord.into();
self
}
/// Replaces an argument or subcommand used on the CLI at runtime with other arguments or subcommands.
///
/// **Note:** This is gated behind [`unstable-replace`](https://github.com/clap-rs/clap/issues/2836)
///
/// When this method is used, `name` is removed from the CLI, and `target`
/// is inserted in its place. Parsing continues as if the user typed
/// `target` instead of `name`.
///
/// This can be used to create "shortcuts" for subcommands, or if a
/// particular argument has the semantic meaning of several other specific
/// arguments and values.
///
/// # Examples
///
/// We'll start with the "subcommand short" example. In this example, let's
/// assume we have a program with a subcommand `module` which can be invoked
/// via `cmd module`. Now let's also assume `module` also has a subcommand
/// called `install` which can be invoked `cmd module install`. If for some
/// reason users needed to be able to reach `cmd module install` via the
/// short-hand `cmd install`, we'd have several options.
///
/// We *could* create another sibling subcommand to `module` called
/// `install`, but then we would need to manage another subcommand and manually
/// dispatch to `cmd module install` handling code. This is error prone and
/// tedious.
///
/// We could instead use [`Command::replace`] so that, when the user types `cmd
/// install`, `clap` will replace `install` with `module install` which will
/// end up getting parsed as if the user typed the entire incantation.
///
/// ```rust
/// # use clap::Command;
/// let m = Command::new("cmd")
/// .subcommand(Command::new("module")
/// .subcommand(Command::new("install")))
/// .replace("install", &["module", "install"])
/// .get_matches_from(vec!["cmd", "install"]);
///
/// assert!(m.subcommand_matches("module").is_some());
/// assert!(m.subcommand_matches("module").unwrap().subcommand_matches("install").is_some());
/// ```
///
/// Now let's show an argument example!
///
/// Let's assume we have an application with two flags `--save-context` and
/// `--save-runtime`. But often users end up needing to do *both* at the
/// same time. We can add a third flag `--save-all` which semantically means
/// the same thing as `cmd --save-context --save-runtime`. To implement that,
/// we have several options.
///
/// We could create this third argument and manually check if that argument
/// and in our own consumer code handle the fact that both `--save-context`
/// and `--save-runtime` *should* have been used. But again this is error
/// prone and tedious. If we had code relying on checking `--save-context`
/// and we forgot to update that code to *also* check `--save-all` it'd mean
/// an error!
///
/// Luckily we can use [`Command::replace`] so that when the user types
/// `--save-all`, `clap` will replace that argument with `--save-context
/// --save-runtime`, and parsing will continue like normal. Now all our code
/// that was originally checking for things like `--save-context` doesn't
/// need to change!
///
/// ```rust
/// # use clap::{Command, Arg, ArgAction};
/// let m = Command::new("cmd")
/// .arg(Arg::new("save-context")
/// .long("save-context")
/// .action(ArgAction::SetTrue))
/// .arg(Arg::new("save-runtime")
/// .long("save-runtime")
/// .action(ArgAction::SetTrue))
/// .replace("--save-all", &["--save-context", "--save-runtime"])
/// .get_matches_from(vec!["cmd", "--save-all"]);
///
/// assert!(*m.get_one::<bool>("save-context").expect("defaulted by clap"));
/// assert!(*m.get_one::<bool>("save-runtime").expect("defaulted by clap"));
/// ```
///
/// This can also be used with options, for example if our application with
/// `--save-*` above also had a `--format=TYPE` option. Let's say it
/// accepted `txt` or `json` values. However, when `--save-all` is used,
/// only `--format=json` is allowed, or valid. We could change the example
/// above to enforce this:
///
/// ```rust
/// # use clap::{Command, Arg, ArgAction};
/// let m = Command::new("cmd")
/// .arg(Arg::new("save-context")
/// .long("save-context")
/// .action(ArgAction::SetTrue))
/// .arg(Arg::new("save-runtime")
/// .long("save-runtime")
/// .action(ArgAction::SetTrue))
/// .arg(Arg::new("format")
/// .long("format")
/// .takes_value(true)
/// .value_parser(["txt", "json"]))
/// .replace("--save-all", &["--save-context", "--save-runtime", "--format=json"])
/// .get_matches_from(vec!["cmd", "--save-all"]);
///
/// assert!(*m.get_one::<bool>("save-context").expect("defaulted by clap"));
/// assert!(*m.get_one::<bool>("save-runtime").expect("defaulted by clap"));
/// assert_eq!(m.value_of("format"), Some("json"));
/// ```
///
/// [`App::replace`]: Command::replace()
#[inline]
#[cfg(feature = "unstable-replace")]
#[must_use]
pub fn replace(mut self, name: &'help str, target: &'help [&'help str]) -> Self {
self.replacers.insert(name, target);
self
}
/// Exit gracefully if no arguments are present (e.g. `$ myprog`).
///
/// **NOTE:** [`subcommands`] count as arguments
///
/// # Examples
///
/// ```rust
/// # use clap::{Command};
/// Command::new("myprog")
/// .arg_required_else_help(true);
/// ```
///
/// [`subcommands`]: crate::Command::subcommand()
/// [`Arg::default_value`]: crate::Arg::default_value()
#[inline]
pub fn arg_required_else_help(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::ArgRequiredElseHelp)
} else {
self.unset_setting(AppSettings::ArgRequiredElseHelp)
}
}
/// Specifies that leading hyphens are allowed in all argument *values* (e.g. `-10`).
///
/// Otherwise they will be parsed as another flag or option. See also
/// [`Command::allow_negative_numbers`].
///
/// **NOTE:** Use this setting with caution as it silences certain circumstances which would
/// otherwise be an error (such as accidentally forgetting to specify a value for leading
/// option). It is preferred to set this on a per argument basis, via [`Arg::allow_hyphen_values`].
///
/// # Examples
///
/// ```rust
/// # use clap::{Arg, Command};
/// // Imagine you needed to represent negative numbers as well, such as -10
/// let m = Command::new("nums")
/// .allow_hyphen_values(true)
/// .arg(Arg::new("neg"))
/// .get_matches_from(vec![
/// "nums", "-20"
/// ]);
///
/// assert_eq!(m.value_of("neg"), Some("-20"));
/// # ;
/// ```
/// [`Arg::allow_hyphen_values`]: crate::Arg::allow_hyphen_values()
#[inline]
pub fn allow_hyphen_values(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::AllowHyphenValues)
} else {
self.unset_setting(AppSettings::AllowHyphenValues)
}
}
/// Allows negative numbers to pass as values.
///
/// This is similar to [`Command::allow_hyphen_values`] except that it only allows numbers,
/// all other undefined leading hyphens will fail to parse.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
/// let res = Command::new("myprog")
/// .allow_negative_numbers(true)
/// .arg(Arg::new("num"))
/// .try_get_matches_from(vec![
/// "myprog", "-20"
/// ]);
/// assert!(res.is_ok());
/// let m = res.unwrap();
/// assert_eq!(m.value_of("num").unwrap(), "-20");
/// ```
#[inline]
pub fn allow_negative_numbers(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::AllowNegativeNumbers)
} else {
self.unset_setting(AppSettings::AllowNegativeNumbers)
}
}
/// Specifies that the final positional argument is a "VarArg" and that `clap` should not
/// attempt to parse any further args.
///
/// The values of the trailing positional argument will contain all args from itself on.
///
/// **NOTE:** The final positional argument **must** have [`Arg::multiple_values(true)`] or the usage
/// string equivalent.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, arg};
/// let m = Command::new("myprog")
/// .trailing_var_arg(true)
/// .arg(arg!(<cmd> ... "commands to run"))
/// .get_matches_from(vec!["myprog", "arg1", "-r", "val1"]);
///
/// let trail: Vec<&str> = m.values_of("cmd").unwrap().collect();
/// assert_eq!(trail, ["arg1", "-r", "val1"]);
/// ```
/// [`Arg::multiple_values(true)`]: crate::Arg::multiple_values()
pub fn trailing_var_arg(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::TrailingVarArg)
} else {
self.unset_setting(AppSettings::TrailingVarArg)
}
}
/// Allows one to implement two styles of CLIs where positionals can be used out of order.
///
/// The first example is a CLI where the second to last positional argument is optional, but
/// the final positional argument is required. Such as `$ prog [optional] <required>` where one
/// of the two following usages is allowed:
///
/// * `$ prog [optional] <required>`
/// * `$ prog <required>`
///
/// This would otherwise not be allowed. This is useful when `[optional]` has a default value.
///
/// **Note:** when using this style of "missing positionals" the final positional *must* be
/// [required] if `--` will not be used to skip to the final positional argument.
///
/// **Note:** This style also only allows a single positional argument to be "skipped" without
/// the use of `--`. To skip more than one, see the second example.
///
/// The second example is when one wants to skip multiple optional positional arguments, and use
/// of the `--` operator is OK (but not required if all arguments will be specified anyways).
///
/// For example, imagine a CLI which has three positional arguments `[foo] [bar] [baz]...` where
/// `baz` accepts multiple values (similar to man `ARGS...` style training arguments).
///
/// With this setting the following invocations are posisble:
///
/// * `$ prog foo bar baz1 baz2 baz3`
/// * `$ prog foo -- baz1 baz2 baz3`
/// * `$ prog -- baz1 baz2 baz3`
///
/// # Examples
///
/// Style number one from above:
///
/// ```rust
/// # use clap::{Command, Arg};
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_missing_positional(true)
/// .arg(Arg::new("arg1"))
/// .arg(Arg::new("arg2")
/// .required(true))
/// .get_matches_from(vec![
/// "prog", "other"
/// ]);
///
/// assert_eq!(m.value_of("arg1"), None);
/// assert_eq!(m.value_of("arg2"), Some("other"));
/// ```
///
/// Now the same example, but using a default value for the first optional positional argument
///
/// ```rust
/// # use clap::{Command, Arg};
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_missing_positional(true)
/// .arg(Arg::new("arg1")
/// .default_value("something"))
/// .arg(Arg::new("arg2")
/// .required(true))
/// .get_matches_from(vec![
/// "prog", "other"
/// ]);
///
/// assert_eq!(m.value_of("arg1"), Some("something"));
/// assert_eq!(m.value_of("arg2"), Some("other"));
/// ```
///
/// Style number two from above:
///
/// ```rust
/// # use clap::{Command, Arg};
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_missing_positional(true)
/// .arg(Arg::new("foo"))
/// .arg(Arg::new("bar"))
/// .arg(Arg::new("baz").takes_value(true).multiple_values(true))
/// .get_matches_from(vec![
/// "prog", "foo", "bar", "baz1", "baz2", "baz3"
/// ]);
///
/// assert_eq!(m.value_of("foo"), Some("foo"));
/// assert_eq!(m.value_of("bar"), Some("bar"));
/// assert_eq!(m.values_of("baz").unwrap().collect::<Vec<_>>(), &["baz1", "baz2", "baz3"]);
/// ```
///
/// Now nofice if we don't specify `foo` or `baz` but use the `--` operator.
///
/// ```rust
/// # use clap::{Command, Arg};
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_missing_positional(true)
/// .arg(Arg::new("foo"))
/// .arg(Arg::new("bar"))
/// .arg(Arg::new("baz").takes_value(true).multiple_values(true))
/// .get_matches_from(vec![
/// "prog", "--", "baz1", "baz2", "baz3"
/// ]);
///
/// assert_eq!(m.value_of("foo"), None);
/// assert_eq!(m.value_of("bar"), None);
/// assert_eq!(m.values_of("baz").unwrap().collect::<Vec<_>>(), &["baz1", "baz2", "baz3"]);
/// ```
///
/// [required]: crate::Arg::required()
#[inline]
pub fn allow_missing_positional(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::AllowMissingPositional)
} else {
self.unset_setting(AppSettings::AllowMissingPositional)
}
}
}
/// # Subcommand-specific Settings
impl<'help> App<'help> {
/// Sets the short version of the subcommand flag without the preceding `-`.
///
/// Allows the subcommand to be used as if it were an [`Arg::short`].
///
/// # Examples
///
/// ```
/// # use clap::{Command, Arg, ArgAction};
/// let matches = Command::new("pacman")
/// .subcommand(
/// Command::new("sync").short_flag('S').arg(
/// Arg::new("search")
/// .short('s')
/// .long("search")
/// .action(ArgAction::SetTrue)
/// .help("search remote repositories for matching strings"),
/// ),
/// )
/// .get_matches_from(vec!["pacman", "-Ss"]);
///
/// assert_eq!(matches.subcommand_name().unwrap(), "sync");
/// let sync_matches = matches.subcommand_matches("sync").unwrap();
/// assert!(*sync_matches.get_one::<bool>("search").expect("defaulted by clap"));
/// ```
/// [`Arg::short`]: Arg::short()
#[must_use]
pub fn short_flag(mut self, short: char) -> Self {
self.short_flag = Some(short);
self
}
/// Sets the long version of the subcommand flag without the preceding `--`.
///
/// Allows the subcommand to be used as if it were an [`Arg::long`].
///
/// **NOTE:** Any leading `-` characters will be stripped.
///
/// # Examples
///
/// To set `long_flag` use a word containing valid UTF-8 codepoints. If you supply a double leading
/// `--` such as `--sync` they will be stripped. Hyphens in the middle of the word; however,
/// will *not* be stripped (i.e. `sync-file` is allowed).
///
/// ```
/// # use clap::{Command, Arg, ArgAction};
/// let matches = Command::new("pacman")
/// .subcommand(
/// Command::new("sync").long_flag("sync").arg(
/// Arg::new("search")
/// .short('s')
/// .long("search")
/// .action(ArgAction::SetTrue)
/// .help("search remote repositories for matching strings"),
/// ),
/// )
/// .get_matches_from(vec!["pacman", "--sync", "--search"]);
///
/// assert_eq!(matches.subcommand_name().unwrap(), "sync");
/// let sync_matches = matches.subcommand_matches("sync").unwrap();
/// assert!(*sync_matches.get_one::<bool>("search").expect("defaulted by clap"));
/// ```
///
/// [`Arg::long`]: Arg::long()
#[must_use]
pub fn long_flag(mut self, long: &'help str) -> Self {
#[cfg(feature = "unstable-v4")]
{
self.long_flag = Some(long);
}
#[cfg(not(feature = "unstable-v4"))]
{
self.long_flag = Some(long.trim_start_matches(|c| c == '-'));
}
self
}
/// Sets a hidden alias to this subcommand.
///
/// This allows the subcommand to be accessed via *either* the original name, or this given
/// alias. This is more efficient and easier than creating multiple hidden subcommands as one
/// only needs to check for the existence of this command, and not all aliased variants.
///
/// **NOTE:** Aliases defined with this method are *hidden* from the help
/// message. If you're looking for aliases that will be displayed in the help
/// message, see [`Command::visible_alias`].
///
/// **NOTE:** When using aliases and checking for the existence of a
/// particular subcommand within an [`ArgMatches`] struct, one only needs to
/// search for the original name and not all aliases.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test")
/// .alias("do-stuff"))
/// .get_matches_from(vec!["myprog", "do-stuff"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::visible_alias`]: Command::visible_alias()
#[must_use]
pub fn alias<S: Into<&'help str>>(mut self, name: S) -> Self {
self.aliases.push((name.into(), false));
self
}
/// Add an alias, which functions as "hidden" short flag subcommand
///
/// This will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").short_flag('t')
/// .short_flag_alias('d'))
/// .get_matches_from(vec!["myprog", "-d"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
#[must_use]
pub fn short_flag_alias(mut self, name: char) -> Self {
assert!(name != '-', "short alias name cannot be `-`");
self.short_flag_aliases.push((name, false));
self
}
/// Add an alias, which functions as a "hidden" long flag subcommand.
///
/// This will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").long_flag("test")
/// .long_flag_alias("testing"))
/// .get_matches_from(vec!["myprog", "--testing"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
#[must_use]
pub fn long_flag_alias(mut self, name: &'help str) -> Self {
self.long_flag_aliases.push((name, false));
self
}
/// Sets multiple hidden aliases to this subcommand.
///
/// This allows the subcommand to be accessed via *either* the original name or any of the
/// given aliases. This is more efficient, and easier than creating multiple hidden subcommands
/// as one only needs to check for the existence of this command and not all aliased variants.
///
/// **NOTE:** Aliases defined with this method are *hidden* from the help
/// message. If looking for aliases that will be displayed in the help
/// message, see [`Command::visible_aliases`].
///
/// **NOTE:** When using aliases and checking for the existence of a
/// particular subcommand within an [`ArgMatches`] struct, one only needs to
/// search for the original name and not all aliases.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test")
/// .aliases(&["do-stuff", "do-tests", "tests"]))
/// .arg(Arg::new("input")
/// .help("the file to add")
/// .required(false))
/// .get_matches_from(vec!["myprog", "do-tests"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::visible_aliases`]: Command::visible_aliases()
#[must_use]
pub fn aliases(mut self, names: &[&'help str]) -> Self {
self.aliases.extend(names.iter().map(|n| (*n, false)));
self
}
/// Add aliases, which function as "hidden" short flag subcommands.
///
/// These will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").short_flag('t')
/// .short_flag_aliases(&['a', 'b', 'c']))
/// .arg(Arg::new("input")
/// .help("the file to add")
/// .required(false))
/// .get_matches_from(vec!["myprog", "-a"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
#[must_use]
pub fn short_flag_aliases(mut self, names: &[char]) -> Self {
for s in names {
assert!(s != &'-', "short alias name cannot be `-`");
self.short_flag_aliases.push((*s, false));
}
self
}
/// Add aliases, which function as "hidden" long flag subcommands.
///
/// These will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").long_flag("test")
/// .long_flag_aliases(&["testing", "testall", "test_all"]))
/// .arg(Arg::new("input")
/// .help("the file to add")
/// .required(false))
/// .get_matches_from(vec!["myprog", "--testing"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
#[must_use]
pub fn long_flag_aliases(mut self, names: &[&'help str]) -> Self {
for s in names {
self.long_flag_aliases.push((s, false));
}
self
}
/// Sets a visible alias to this subcommand.
///
/// This allows the subcommand to be accessed via *either* the
/// original name or the given alias. This is more efficient and easier
/// than creating hidden subcommands as one only needs to check for
/// the existence of this command and not all aliased variants.
///
/// **NOTE:** The alias defined with this method is *visible* from the help
/// message and displayed as if it were just another regular subcommand. If
/// looking for an alias that will not be displayed in the help message, see
/// [`Command::alias`].
///
/// **NOTE:** When using aliases and checking for the existence of a
/// particular subcommand within an [`ArgMatches`] struct, one only needs to
/// search for the original name and not all aliases.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test")
/// .visible_alias("do-stuff"))
/// .get_matches_from(vec!["myprog", "do-stuff"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::alias`]: Command::alias()
#[must_use]
pub fn visible_alias<S: Into<&'help str>>(mut self, name: S) -> Self {
self.aliases.push((name.into(), true));
self
}
/// Add an alias, which functions as "visible" short flag subcommand
///
/// This will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// See also [`Command::short_flag_alias`].
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").short_flag('t')
/// .visible_short_flag_alias('d'))
/// .get_matches_from(vec!["myprog", "-d"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::short_flag_alias`]: Command::short_flag_alias()
#[must_use]
pub fn visible_short_flag_alias(mut self, name: char) -> Self {
assert!(name != '-', "short alias name cannot be `-`");
self.short_flag_aliases.push((name, true));
self
}
/// Add an alias, which functions as a "visible" long flag subcommand.
///
/// This will automatically dispatch as if this subcommand was used. This is more efficient,
/// and easier than creating multiple hidden subcommands as one only needs to check for the
/// existence of this command, and not all variants.
///
/// See also [`Command::long_flag_alias`].
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").long_flag("test")
/// .visible_long_flag_alias("testing"))
/// .get_matches_from(vec!["myprog", "--testing"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::long_flag_alias`]: Command::long_flag_alias()
#[must_use]
pub fn visible_long_flag_alias(mut self, name: &'help str) -> Self {
self.long_flag_aliases.push((name, true));
self
}
/// Sets multiple visible aliases to this subcommand.
///
/// This allows the subcommand to be accessed via *either* the
/// original name or any of the given aliases. This is more efficient and easier
/// than creating multiple hidden subcommands as one only needs to check for
/// the existence of this command and not all aliased variants.
///
/// **NOTE:** The alias defined with this method is *visible* from the help
/// message and displayed as if it were just another regular subcommand. If
/// looking for an alias that will not be displayed in the help message, see
/// [`Command::alias`].
///
/// **NOTE:** When using aliases, and checking for the existence of a
/// particular subcommand within an [`ArgMatches`] struct, one only needs to
/// search for the original name and not all aliases.
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test")
/// .visible_aliases(&["do-stuff", "tests"]))
/// .get_matches_from(vec!["myprog", "do-stuff"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::alias`]: Command::alias()
#[must_use]
pub fn visible_aliases(mut self, names: &[&'help str]) -> Self {
self.aliases.extend(names.iter().map(|n| (*n, true)));
self
}
/// Add aliases, which function as *visible* short flag subcommands.
///
/// See [`Command::short_flag_aliases`].
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").short_flag('b')
/// .visible_short_flag_aliases(&['t']))
/// .get_matches_from(vec!["myprog", "-t"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::short_flag_aliases`]: Command::short_flag_aliases()
#[must_use]
pub fn visible_short_flag_aliases(mut self, names: &[char]) -> Self {
for s in names {
assert!(s != &'-', "short alias name cannot be `-`");
self.short_flag_aliases.push((*s, true));
}
self
}
/// Add aliases, which function as *visible* long flag subcommands.
///
/// See [`Command::long_flag_aliases`].
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg, };
/// let m = Command::new("myprog")
/// .subcommand(Command::new("test").long_flag("test")
/// .visible_long_flag_aliases(&["testing", "testall", "test_all"]))
/// .get_matches_from(vec!["myprog", "--testing"]);
/// assert_eq!(m.subcommand_name(), Some("test"));
/// ```
/// [`App::long_flag_aliases`]: Command::long_flag_aliases()
#[must_use]
pub fn visible_long_flag_aliases(mut self, names: &[&'help str]) -> Self {
for s in names {
self.long_flag_aliases.push((s, true));
}
self
}
/// Set the placement of this subcommand within the help.
///
/// Subcommands with a lower value will be displayed first in the help message. Subcommands
/// with duplicate display orders will be displayed in alphabetical order.
///
/// This is helpful when one would like to emphasize frequently used subcommands, or prioritize
/// those towards the top of the list.
///
/// **NOTE:** The default is 999 for all subcommands.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, };
/// let m = Command::new("cust-ord")
/// .subcommand(Command::new("alpha") // typically subcommands are grouped
/// // alphabetically by name. Subcommands
/// // without a display_order have a value of
/// // 999 and are displayed alphabetically with
/// // all other 999 subcommands
/// .about("Some help and text"))
/// .subcommand(Command::new("beta")
/// .display_order(1) // In order to force this subcommand to appear *first*
/// // all we have to do is give it a value lower than 999.
/// // Any other subcommands with a value of 1 will be displayed
/// // alphabetically with this one...then 2 values, then 3, etc.
/// .about("I should be first!"))
/// .get_matches_from(vec![
/// "cust-ord", "--help"
/// ]);
/// ```
///
/// The above example displays the following help message
///
/// ```text
/// cust-ord
///
/// USAGE:
/// cust-ord [OPTIONS]
///
/// OPTIONS:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// beta I should be first!
/// alpha Some help and text
/// ```
#[inline]
#[must_use]
pub fn display_order(mut self, ord: usize) -> Self {
self.disp_ord = Some(ord);
self
}
/// Specifies that this [`subcommand`] should be hidden from help messages
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .subcommand(
/// Command::new("test").hide(true)
/// )
/// # ;
/// ```
///
/// [`subcommand`]: crate::Command::subcommand()
#[inline]
pub fn hide(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::Hidden)
} else {
self.unset_setting(AppSettings::Hidden)
}
}
/// If no [`subcommand`] is present at runtime, error and exit gracefully.
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let err = Command::new("myprog")
/// .subcommand_required(true)
/// .subcommand(Command::new("test"))
/// .try_get_matches_from(vec![
/// "myprog",
/// ]);
/// assert!(err.is_err());
/// assert_eq!(err.unwrap_err().kind(), ErrorKind::MissingSubcommand);
/// # ;
/// ```
///
/// [`subcommand`]: crate::Command::subcommand()
pub fn subcommand_required(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::SubcommandRequired)
} else {
self.unset_setting(AppSettings::SubcommandRequired)
}
}
/// Assume unexpected positional arguments are a [`subcommand`].
///
/// Arguments will be stored in the `""` argument in the [`ArgMatches`]
///
/// **NOTE:** Use this setting with caution,
/// as a truly unexpected argument (i.e. one that is *NOT* an external subcommand)
/// will **not** cause an error and instead be treated as a potential subcommand.
/// One should check for such cases manually and inform the user appropriately.
///
/// **NOTE:** A built-in subcommand will be parsed as an external subcommand when escaped with
/// `--`.
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_external_subcommands(true)
/// .get_matches_from(vec![
/// "myprog", "subcmd", "--option", "value", "-fff", "--flag"
/// ]);
///
/// // All trailing arguments will be stored under the subcommand's sub-matches using an empty
/// // string argument name
/// match m.subcommand() {
/// Some((external, ext_m)) => {
/// let ext_args: Vec<&str> = ext_m.values_of("").unwrap().collect();
/// assert_eq!(external, "subcmd");
/// assert_eq!(ext_args, ["--option", "value", "-fff", "--flag"]);
/// },
/// _ => {},
/// }
/// ```
///
/// [`subcommand`]: crate::Command::subcommand()
/// [`ArgMatches`]: crate::ArgMatches
/// [`ErrorKind::UnknownArgument`]: crate::ErrorKind::UnknownArgument
pub fn allow_external_subcommands(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::AllowExternalSubcommands)
} else {
self.unset_setting(AppSettings::AllowExternalSubcommands)
}
}
/// Specifies that external subcommands that are invalid UTF-8 should *not* be treated as an error.
///
/// **NOTE:** Using external subcommand argument values with invalid UTF-8 requires using
/// [`ArgMatches::values_of_os`] or [`ArgMatches::values_of_lossy`] for those particular
/// arguments which may contain invalid UTF-8 values
///
/// **NOTE:** Setting this requires [`Command::allow_external_subcommands`]
///
/// # Platform Specific
///
/// Non Windows systems only
///
/// # Examples
///
#[cfg_attr(not(unix), doc = " ```ignore")]
#[cfg_attr(unix, doc = " ```")]
/// # use clap::Command;
/// // Assume there is an external subcommand named "subcmd"
/// let m = Command::new("myprog")
/// .allow_invalid_utf8_for_external_subcommands(true)
/// .allow_external_subcommands(true)
/// .get_matches_from(vec![
/// "myprog", "subcmd", "--option", "value", "-fff", "--flag"
/// ]);
///
/// // All trailing arguments will be stored under the subcommand's sub-matches using an empty
/// // string argument name
/// match m.subcommand() {
/// Some((external, ext_m)) => {
/// let ext_args: Vec<&std::ffi::OsStr> = ext_m.values_of_os("").unwrap().collect();
/// assert_eq!(external, "subcmd");
/// assert_eq!(ext_args, ["--option", "value", "-fff", "--flag"]);
/// },
/// _ => {},
/// }
/// ```
///
/// [`ArgMatches::values_of_os`]: crate::ArgMatches::values_of_os()
/// [`ArgMatches::values_of_lossy`]: crate::ArgMatches::values_of_lossy()
/// [`subcommands`]: crate::Command::subcommand()
pub fn allow_invalid_utf8_for_external_subcommands(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::AllowInvalidUtf8ForExternalSubcommands)
} else {
self.unset_setting(AppSettings::AllowInvalidUtf8ForExternalSubcommands)
}
}
/// Specifies that use of an argument prevents the use of [`subcommands`].
///
/// By default `clap` allows arguments between subcommands such
/// as `<cmd> [cmd_args] <subcmd> [subcmd_args] <subsubcmd> [subsubcmd_args]`.
///
/// This setting disables that functionality and says that arguments can
/// only follow the *final* subcommand. For instance using this setting
/// makes only the following invocations possible:
///
/// * `<cmd> <subcmd> <subsubcmd> [subsubcmd_args]`
/// * `<cmd> <subcmd> [subcmd_args]`
/// * `<cmd> [cmd_args]`
///
/// # Examples
///
/// ```rust
/// # use clap::Command;
/// Command::new("myprog")
/// .args_conflicts_with_subcommands(true);
/// ```
///
/// [`subcommands`]: crate::Command::subcommand()
pub fn args_conflicts_with_subcommands(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::ArgsNegateSubcommands)
} else {
self.unset_setting(AppSettings::ArgsNegateSubcommands)
}
}
/// Prevent subcommands from being consumed as an arguments value.
///
/// By default, if an option taking multiple values is followed by a subcommand, the
/// subcommand will be parsed as another value.
///
/// ```text
/// cmd --foo val1 val2 subcommand
/// --------- ----------
/// values another value
/// ```
///
/// This setting instructs the parser to stop when encountering a subcommand instead of
/// greedily consuming arguments.
///
/// ```text
/// cmd --foo val1 val2 subcommand
/// --------- ----------
/// values subcommand
/// ```
///
/// **Note:** Make sure you apply it as `global_setting` if you want this setting
/// to be propagated to subcommands and sub-subcommands!
///
/// # Examples
///
/// ```rust
/// # use clap::{Command, Arg};
/// let cmd = Command::new("cmd").subcommand(Command::new("sub")).arg(
/// Arg::new("arg")
/// .long("arg")
/// .multiple_values(true)
/// .takes_value(true),
/// );
///
/// let matches = cmd
/// .clone()
/// .try_get_matches_from(&["cmd", "--arg", "1", "2", "3", "sub"])
/// .unwrap();
/// assert_eq!(
/// matches.values_of("arg").unwrap().collect::<Vec<_>>(),
/// &["1", "2", "3", "sub"]
/// );
/// assert!(matches.subcommand_matches("sub").is_none());
///
/// let matches = cmd
/// .subcommand_precedence_over_arg(true)
/// .try_get_matches_from(&["cmd", "--arg", "1", "2", "3", "sub"])
/// .unwrap();
/// assert_eq!(
/// matches.values_of("arg").unwrap().collect::<Vec<_>>(),
/// &["1", "2", "3"]
/// );
/// assert!(matches.subcommand_matches("sub").is_some());
/// ```
pub fn subcommand_precedence_over_arg(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::SubcommandPrecedenceOverArg)
} else {
self.unset_setting(AppSettings::SubcommandPrecedenceOverArg)
}
}
/// Allows [`subcommands`] to override all requirements of the parent command.
///
/// For example, if you had a subcommand or top level application with a required argument
/// that is only required as long as there is no subcommand present,
/// using this setting would allow you to set those arguments to [`Arg::required(true)`]
/// and yet receive no error so long as the user uses a valid subcommand instead.
///
/// **NOTE:** This defaults to false (using subcommand does *not* negate requirements)
///
/// # Examples
///
/// This first example shows that it is an error to not use a required argument
///
/// ```rust
/// # use clap::{Command, Arg, ErrorKind};
/// let err = Command::new("myprog")
/// .subcommand_negates_reqs(true)
/// .arg(Arg::new("opt").required(true))
/// .subcommand(Command::new("test"))
/// .try_get_matches_from(vec![
/// "myprog"
/// ]);
/// assert!(err.is_err());
/// assert_eq!(err.unwrap_err().kind(), ErrorKind::MissingRequiredArgument);
/// # ;
/// ```
///
/// This next example shows that it is no longer error to not use a required argument if a
/// valid subcommand is used.
///
/// ```rust
/// # use clap::{Command, Arg, ErrorKind};
/// let noerr = Command::new("myprog")
/// .subcommand_negates_reqs(true)
/// .arg(Arg::new("opt").required(true))
/// .subcommand(Command::new("test"))
/// .try_get_matches_from(vec![
/// "myprog", "test"
/// ]);
/// assert!(noerr.is_ok());
/// # ;
/// ```
///
/// [`Arg::required(true)`]: crate::Arg::required()
/// [`subcommands`]: crate::Command::subcommand()
pub fn subcommand_negates_reqs(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::SubcommandsNegateReqs)
} else {
self.unset_setting(AppSettings::SubcommandsNegateReqs)
}
}
/// Multiple-personality program dispatched on the binary name (`argv[0]`)
///
/// A "multicall" executable is a single executable
/// that contains a variety of applets,
/// and decides which applet to run based on the name of the file.
/// The executable can be called from different names by creating hard links
/// or symbolic links to it.
///
/// This is desirable for:
/// - Easy distribution, a single binary that can install hardlinks to access the different
/// personalities.
/// - Minimal binary size by sharing common code (e.g. standard library, clap)
/// - Custom shells or REPLs where there isn't a single top-level command
///
/// Setting `multicall` will cause
/// - `argv[0]` to be stripped to the base name and parsed as the first argument, as if
/// [`Command::no_binary_name`][App::no_binary_name] was set.
/// - Help and errors to report subcommands as if they were the top-level command
///
/// When the subcommand is not present, there are several strategies you may employ, depending
/// on your needs:
/// - Let the error percolate up normally
/// - Print a specialized error message using the
/// [`Error::context`][crate::Error::context]
/// - Print the [help][App::write_help] but this might be ambiguous
/// - Disable `multicall` and re-parse it
/// - Disable `multicall` and re-parse it with a specific subcommand
///
/// When detecting the error condition, the [`ErrorKind`] isn't sufficient as a sub-subcommand
/// might report the same error. Enable
/// [`allow_external_subcommands`][App::allow_external_subcommands] if you want to specifically
/// get the unrecognized binary name.
///
/// **NOTE:** Multicall can't be used with [`no_binary_name`] since they interpret
/// the command name in incompatible ways.
///
/// **NOTE:** The multicall command cannot have arguments.
///
/// **NOTE:** Applets are slightly semantically different from subcommands,
/// so it's recommended to use [`Command::subcommand_help_heading`] and
/// [`Command::subcommand_value_name`] to change the descriptive text as above.
///
/// # Examples
///
/// `hostname` is an example of a multicall executable.
/// Both `hostname` and `dnsdomainname` are provided by the same executable
/// and which behaviour to use is based on the executable file name.
///
/// This is desirable when the executable has a primary purpose
/// but there is related functionality that would be convenient to provide
/// and implement it to be in the same executable.
///
/// The name of the cmd is essentially unused
/// and may be the same as the name of a subcommand.
///
/// The names of the immediate subcommands of the Command
/// are matched against the basename of the first argument,
/// which is conventionally the path of the executable.
///
/// This does not allow the subcommand to be passed as the first non-path argument.
///
/// ```rust
/// # use clap::{Command, ErrorKind};
/// let mut cmd = Command::new("hostname")
/// .multicall(true)
/// .subcommand(Command::new("hostname"))
/// .subcommand(Command::new("dnsdomainname"));
/// let m = cmd.try_get_matches_from_mut(&["/usr/bin/hostname", "dnsdomainname"]);
/// assert!(m.is_err());
/// assert_eq!(m.unwrap_err().kind(), ErrorKind::UnknownArgument);
/// let m = cmd.get_matches_from(&["/usr/bin/dnsdomainname"]);
/// assert_eq!(m.subcommand_name(), Some("dnsdomainname"));
/// ```
///
/// Busybox is another common example of a multicall executable
/// with a subcommmand for each applet that can be run directly,
/// e.g. with the `cat` applet being run by running `busybox cat`,
/// or with `cat` as a link to the `busybox` binary.
///
/// This is desirable when the launcher program has additional options
/// or it is useful to run the applet without installing a symlink
/// e.g. to test the applet without installing it
/// or there may already be a command of that name installed.
///
/// To make an applet usable as both a multicall link and a subcommand
/// the subcommands must be defined both in the top-level Command
/// and as subcommands of the "main" applet.
///
/// ```rust
/// # use clap::Command;
/// fn applet_commands() -> [Command<'static>; 2] {
/// [Command::new("true"), Command::new("false")]
/// }
/// let mut cmd = Command::new("busybox")
/// .multicall(true)
/// .subcommand(
/// Command::new("busybox")
/// .subcommand_value_name("APPLET")
/// .subcommand_help_heading("APPLETS")
/// .subcommands(applet_commands()),
/// )
/// .subcommands(applet_commands());
/// // When called from the executable's canonical name
/// // its applets can be matched as subcommands.
/// let m = cmd.try_get_matches_from_mut(&["/usr/bin/busybox", "true"]).unwrap();
/// assert_eq!(m.subcommand_name(), Some("busybox"));
/// assert_eq!(m.subcommand().unwrap().1.subcommand_name(), Some("true"));
/// // When called from a link named after an applet that applet is matched.
/// let m = cmd.get_matches_from(&["/usr/bin/true"]);
/// assert_eq!(m.subcommand_name(), Some("true"));
/// ```
///
/// [`no_binary_name`]: crate::Command::no_binary_name
/// [`App::subcommand_value_name`]: crate::Command::subcommand_value_name
/// [`App::subcommand_help_heading`]: crate::Command::subcommand_help_heading
#[inline]
pub fn multicall(self, yes: bool) -> Self {
if yes {
self.setting(AppSettings::Multicall)
} else {
self.unset_setting(AppSettings::Multicall)
}
}
/// Sets the value name used for subcommands when printing usage and help.
///
/// By default, this is "SUBCOMMAND".
///
/// See also [`Command::subcommand_help_heading`]
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .subcommand(Command::new("sub1"))
/// .print_help()
/// # ;
/// ```
///
/// will produce
///
/// ```text
/// myprog
///
/// USAGE:
/// myprog [SUBCOMMAND]
///
/// OPTIONS:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// help Print this message or the help of the given subcommand(s)
/// sub1
/// ```
///
/// but usage of `subcommand_value_name`
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .subcommand(Command::new("sub1"))
/// .subcommand_value_name("THING")
/// .print_help()
/// # ;
/// ```
///
/// will produce
///
/// ```text
/// myprog
///
/// USAGE:
/// myprog [THING]
///
/// OPTIONS:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// help Print this message or the help of the given subcommand(s)
/// sub1
/// ```
#[must_use]
pub fn subcommand_value_name<S>(mut self, value_name: S) -> Self
where
S: Into<&'help str>,
{
self.subcommand_value_name = Some(value_name.into());
self
}
/// Sets the help heading used for subcommands when printing usage and help.
///
/// By default, this is "SUBCOMMANDS".
///
/// See also [`Command::subcommand_value_name`]
///
/// # Examples
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .subcommand(Command::new("sub1"))
/// .print_help()
/// # ;
/// ```
///
/// will produce
///
/// ```text
/// myprog
///
/// USAGE:
/// myprog [SUBCOMMAND]
///
/// OPTIONS:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// help Print this message or the help of the given subcommand(s)
/// sub1
/// ```
///
/// but usage of `subcommand_help_heading`
///
/// ```no_run
/// # use clap::{Command, Arg};
/// Command::new("myprog")
/// .subcommand(Command::new("sub1"))
/// .subcommand_help_heading("THINGS")
/// .print_help()
/// # ;
/// ```
///
/// will produce
///
/// ```text
/// myprog
///
/// USAGE:
/// myprog [SUBCOMMAND]
///
/// OPTIONS:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// THINGS:
/// help Print this message or the help of the given subcommand(s)
/// sub1
/// ```
#[must_use]
pub fn subcommand_help_heading<T>(mut self, heading: T) -> Self
where
T: Into<&'help str>,
{
self.subcommand_heading = Some(heading.into());
self
}
}
/// # Reflection
impl<'help> App<'help> {
#[inline]
pub(crate) fn get_usage_name(&self) -> Option<&str> {
self.usage_name.as_deref()
}
/// Get the name of the binary.
#[inline]
pub fn get_display_name(&self) -> Option<&str> {
self.display_name.as_deref()
}
/// Get the name of the binary.
#[inline]
pub fn get_bin_name(&self) -> Option<&str> {
self.bin_name.as_deref()
}
/// Set binary name. Uses `&mut self` instead of `self`.
pub fn set_bin_name<S: Into<String>>(&mut self, name: S) {
self.bin_name = Some(name.into());
}
/// Get the name of the cmd.
#[inline]
pub fn get_name(&self) -> &str {
&self.name
}
/// Get the version of the cmd.
#[inline]
pub fn get_version(&self) -> Option<&'help str> {
self.version
}
/// Get the long version of the cmd.
#[inline]
pub fn get_long_version(&self) -> Option<&'help str> {
self.long_version
}
/// Get the authors of the cmd.
#[inline]
pub fn get_author(&self) -> Option<&'help str> {
self.author
}
/// Get the short flag of the subcommand.
#[inline]
pub fn get_short_flag(&self) -> Option<char> {
self.short_flag
}
/// Get the long flag of the subcommand.
#[inline]
pub fn get_long_flag(&self) -> Option<&'help str> {
self.long_flag
}
/// Get the help message specified via [`Command::about`].
///
/// [`App::about`]: Command::about()
#[inline]
pub fn get_about(&self) -> Option<&'help str> {
self.about
}
/// Get the help message specified via [`Command::long_about`].
///
/// [`App::long_about`]: Command::long_about()
#[inline]
pub fn get_long_about(&self) -> Option<&'help str> {
self.long_about
}
/// Deprecated, replaced with [`Command::get_next_help_heading`]
#[inline]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.0", note = "Replaced with `App::get_next_help_heading`")
)]
pub fn get_help_heading(&self) -> Option<&'help str> {
self.get_next_help_heading()
}
/// Get the custom section heading specified via [`Command::help_heading`].
///
/// [`App::help_heading`]: Command::help_heading()
#[inline]
pub fn get_next_help_heading(&self) -> Option<&'help str> {
self.current_help_heading
}
/// Iterate through the *visible* aliases for this subcommand.
#[inline]
pub fn get_visible_aliases(&self) -> impl Iterator<Item = &'help str> + '_ {
self.aliases.iter().filter(|(_, vis)| *vis).map(|a| a.0)
}
/// Iterate through the *visible* short aliases for this subcommand.
#[inline]
pub fn get_visible_short_flag_aliases(&self) -> impl Iterator<Item = char> + '_ {
self.short_flag_aliases
.iter()
.filter(|(_, vis)| *vis)
.map(|a| a.0)
}
/// Iterate through the *visible* long aliases for this subcommand.
#[inline]
pub fn get_visible_long_flag_aliases(&self) -> impl Iterator<Item = &'help str> + '_ {
self.long_flag_aliases
.iter()
.filter(|(_, vis)| *vis)
.map(|a| a.0)
}
/// Iterate through the set of *all* the aliases for this subcommand, both visible and hidden.
#[inline]
pub fn get_all_aliases(&self) -> impl Iterator<Item = &str> + '_ {
self.aliases.iter().map(|a| a.0)
}
/// Iterate through the set of *all* the short aliases for this subcommand, both visible and hidden.
#[inline]
pub fn get_all_short_flag_aliases(&self) -> impl Iterator<Item = char> + '_ {
self.short_flag_aliases.iter().map(|a| a.0)
}
/// Iterate through the set of *all* the long aliases for this subcommand, both visible and hidden.
#[inline]
pub fn get_all_long_flag_aliases(&self) -> impl Iterator<Item = &'help str> + '_ {
self.long_flag_aliases.iter().map(|a| a.0)
}
/// Check if the given [`AppSettings`] variant is currently set on the `Command`.
///
/// This checks both [local] and [global settings].
///
/// [local]: Command::setting()
/// [global settings]: Command::global_setting()
#[inline]
pub fn is_set(&self, s: AppSettings) -> bool {
self.settings.is_set(s) || self.g_settings.is_set(s)
}
/// Should we color the output?
#[inline(never)]
pub fn get_color(&self) -> ColorChoice {
debug!("Command::color: Color setting...");
if cfg!(feature = "color") {
#[allow(deprecated)]
if self.is_set(AppSettings::ColorNever) {
debug!("Never");
ColorChoice::Never
} else if self.is_set(AppSettings::ColorAlways) {
debug!("Always");
ColorChoice::Always
} else {
debug!("Auto");
ColorChoice::Auto
}
} else {
ColorChoice::Never
}
}
/// Iterate through the set of subcommands, getting a reference to each.
#[inline]
pub fn get_subcommands(&self) -> impl Iterator<Item = &App<'help>> {
self.subcommands.iter()
}
/// Iterate through the set of subcommands, getting a mutable reference to each.
#[inline]
pub fn get_subcommands_mut(&mut self) -> impl Iterator<Item = &mut App<'help>> {
self.subcommands.iter_mut()
}
/// Returns `true` if this `Command` has subcommands.
#[inline]
pub fn has_subcommands(&self) -> bool {
!self.subcommands.is_empty()
}
/// Returns the help heading for listing subcommands.
#[inline]
pub fn get_subcommand_help_heading(&self) -> Option<&str> {
self.subcommand_heading
}
/// Deprecated, replaced with [`App::get_subcommand_help_heading`]
#[inline]
#[cfg_attr(
feature = "deprecated",
deprecated(
since = "3.1.0",
note = "Replaced with `App::get_subcommand_help_heading`"
)
)]
pub fn get_subommand_help_heading(&self) -> Option<&str> {
self.get_subcommand_help_heading()
}
/// Returns the subcommand value name.
#[inline]
pub fn get_subcommand_value_name(&self) -> Option<&str> {
self.subcommand_value_name
}
/// Returns the help heading for listing subcommands.
#[inline]
pub fn get_before_help(&self) -> Option<&str> {
self.before_help
}
/// Returns the help heading for listing subcommands.
#[inline]
pub fn get_before_long_help(&self) -> Option<&str> {
self.before_long_help
}
/// Returns the help heading for listing subcommands.
#[inline]
pub fn get_after_help(&self) -> Option<&str> {
self.after_help
}
/// Returns the help heading for listing subcommands.
#[inline]
pub fn get_after_long_help(&self) -> Option<&str> {
self.after_long_help
}
/// Find subcommand such that its name or one of aliases equals `name`.
///
/// This does not recurse through subcommands of subcommands.
#[inline]
pub fn find_subcommand<T>(&self, name: &T) -> Option<&App<'help>>
where
T: PartialEq<str> + ?Sized,
{
self.get_subcommands().find(|s| s.aliases_to(name))
}
/// Find subcommand such that its name or one of aliases equals `name`, returning
/// a mutable reference to the subcommand.
///
/// This does not recurse through subcommands of subcommands.
#[inline]
pub fn find_subcommand_mut<T>(&mut self, name: &T) -> Option<&mut App<'help>>
where
T: PartialEq<str> + ?Sized,
{
self.get_subcommands_mut().find(|s| s.aliases_to(name))
}
/// Iterate through the set of groups.
#[inline]
pub fn get_groups(&self) -> impl Iterator<Item = &ArgGroup<'help>> {
self.groups.iter()
}
/// Iterate through the set of arguments.
#[inline]
pub fn get_arguments(&self) -> impl Iterator<Item = &Arg<'help>> {
self.args.args()
}
/// Iterate through the *positionals* arguments.
#[inline]
pub fn get_positionals(&self) -> impl Iterator<Item = &Arg<'help>> {
self.get_arguments().filter(|a| a.is_positional())
}
/// Iterate through the *options*.
pub fn get_opts(&self) -> impl Iterator<Item = &Arg<'help>> {
self.get_arguments()
.filter(|a| a.is_takes_value_set() && !a.is_positional())
}
/// Get a list of all arguments the given argument conflicts with.
///
/// If the provided argument is declared as global, the conflicts will be determined
/// based on the propagation rules of global arguments.
///
/// ### Panics
///
/// If the given arg contains a conflict with an argument that is unknown to
/// this `Command`.
pub fn get_arg_conflicts_with(&self, arg: &Arg) -> Vec<&Arg<'help>> // FIXME: This could probably have been an iterator
{
if arg.is_global_set() {
self.get_global_arg_conflicts_with(arg)
} else {
let mut result = Vec::new();
for id in arg.blacklist.iter() {
if let Some(arg) = self.find(id) {
result.push(arg);
} else if let Some(group) = self.find_group(id) {
result.extend(
self.unroll_args_in_group(&group.id)
.iter()
.map(|id| self.find(id).expect(INTERNAL_ERROR_MSG)),
);
} else {
panic!("Command::get_arg_conflicts_with: The passed arg conflicts with an arg unknown to the cmd");
}
}
result
}
}
// Get a unique list of all arguments of all commands and continuous subcommands the given argument conflicts with.
//
// This behavior follows the propagation rules of global arguments.
// It is useful for finding conflicts for arguments declared as global.
//
// ### Panics
//
// If the given arg contains a conflict with an argument that is unknown to
// this `App`.
fn get_global_arg_conflicts_with(&self, arg: &Arg) -> Vec<&Arg<'help>> // FIXME: This could probably have been an iterator
{
arg.blacklist
.iter()
.map(|id| {
self.args
.args()
.chain(
self.get_subcommands_containing(arg)
.iter()
.flat_map(|x| x.args.args()),
)
.find(|arg| arg.id == *id)
.expect(
"Command::get_arg_conflicts_with: \
The passed arg conflicts with an arg unknown to the cmd",
)
})
.collect()
}
// Get a list of subcommands which contain the provided Argument
//
// This command will only include subcommands in its list for which the subcommands
// parent also contains the Argument.
//
// This search follows the propagation rules of global arguments.
// It is useful to finding subcommands, that have inherited a global argument.
//
// **NOTE:** In this case only Sucommand_1 will be included
// Subcommand_1 (contains Arg)
// Subcommand_1.1 (doesn't contain Arg)
// Subcommand_1.1.1 (contains Arg)
//
fn get_subcommands_containing(&self, arg: &Arg) -> Vec<&App<'help>> {
let mut vec = std::vec::Vec::new();
for idx in 0..self.subcommands.len() {
if self.subcommands[idx].args.args().any(|ar| ar.id == arg.id) {
vec.push(&self.subcommands[idx]);
vec.append(&mut self.subcommands[idx].get_subcommands_containing(arg));
}
}
vec
}
/// Report whether [`Command::no_binary_name`] is set
pub fn is_no_binary_name_set(&self) -> bool {
self.is_set(AppSettings::NoBinaryName)
}
/// Report whether [`Command::ignore_errors`] is set
pub(crate) fn is_ignore_errors_set(&self) -> bool {
self.is_set(AppSettings::IgnoreErrors)
}
/// Report whether [`Command::dont_delimit_trailing_values`] is set
pub fn is_dont_delimit_trailing_values_set(&self) -> bool {
self.is_set(AppSettings::DontDelimitTrailingValues)
}
/// Report whether [`Command::disable_version_flag`] is set
pub fn is_disable_version_flag_set(&self) -> bool {
self.is_set(AppSettings::DisableVersionFlag)
}
/// Report whether [`Command::propagate_version`] is set
pub fn is_propagate_version_set(&self) -> bool {
self.is_set(AppSettings::PropagateVersion)
}
/// Report whether [`Command::next_line_help`] is set
pub fn is_next_line_help_set(&self) -> bool {
self.is_set(AppSettings::NextLineHelp)
}
/// Report whether [`Command::disable_help_flag`] is set
pub fn is_disable_help_flag_set(&self) -> bool {
self.is_set(AppSettings::DisableHelpFlag)
}
/// Report whether [`Command::disable_help_subcommand`] is set
pub fn is_disable_help_subcommand_set(&self) -> bool {
self.is_set(AppSettings::DisableHelpSubcommand)
}
/// Report whether [`Command::disable_colored_help`] is set
pub fn is_disable_colored_help_set(&self) -> bool {
self.is_set(AppSettings::DisableColoredHelp)
}
/// Report whether [`Command::help_expected`] is set
#[cfg(debug_assertions)]
pub(crate) fn is_help_expected_set(&self) -> bool {
self.is_set(AppSettings::HelpExpected)
}
/// Report whether [`Command::dont_collapse_args_in_usage`] is set
pub fn is_dont_collapse_args_in_usage_set(&self) -> bool {
self.is_set(AppSettings::DontCollapseArgsInUsage)
}
/// Report whether [`Command::infer_long_args`] is set
pub(crate) fn is_infer_long_args_set(&self) -> bool {
self.is_set(AppSettings::InferLongArgs)
}
/// Report whether [`Command::infer_subcommands`] is set
pub(crate) fn is_infer_subcommands_set(&self) -> bool {
self.is_set(AppSettings::InferSubcommands)
}
/// Report whether [`Command::arg_required_else_help`] is set
pub fn is_arg_required_else_help_set(&self) -> bool {
self.is_set(AppSettings::ArgRequiredElseHelp)
}
/// Report whether [`Command::allow_hyphen_values`] is set
pub(crate) fn is_allow_hyphen_values_set(&self) -> bool {
self.is_set(AppSettings::AllowHyphenValues)
}
/// Report whether [`Command::allow_negative_numbers`] is set
pub fn is_allow_negative_numbers_set(&self) -> bool {
self.is_set(AppSettings::AllowNegativeNumbers)
}
/// Report whether [`Command::trailing_var_arg`] is set
pub fn is_trailing_var_arg_set(&self) -> bool {
self.is_set(AppSettings::TrailingVarArg)
}
/// Report whether [`Command::allow_missing_positional`] is set
pub fn is_allow_missing_positional_set(&self) -> bool {
self.is_set(AppSettings::AllowMissingPositional)
}
/// Report whether [`Command::hide`] is set
pub fn is_hide_set(&self) -> bool {
self.is_set(AppSettings::Hidden)
}
/// Report whether [`Command::subcommand_required`] is set
pub fn is_subcommand_required_set(&self) -> bool {
self.is_set(AppSettings::SubcommandRequired)
}
/// Report whether [`Command::allow_external_subcommands`] is set
pub fn is_allow_external_subcommands_set(&self) -> bool {
self.is_set(AppSettings::AllowExternalSubcommands)
}
/// Report whether [`Command::allow_invalid_utf8_for_external_subcommands`] is set
pub fn is_allow_invalid_utf8_for_external_subcommands_set(&self) -> bool {
self.is_set(AppSettings::AllowInvalidUtf8ForExternalSubcommands)
}
/// Configured parser for values passed to an external subcommand
///
/// # Example
///
/// ```rust
/// let cmd = clap::Command::new("raw")
/// .allow_external_subcommands(true)
/// .allow_invalid_utf8_for_external_subcommands(true);
/// let value_parser = cmd.get_external_subcommand_value_parser();
/// println!("{:?}", value_parser);
/// ```
pub fn get_external_subcommand_value_parser(&self) -> Option<&super::ValueParser> {
if !self.is_allow_external_subcommands_set() {
None
} else if self.is_allow_invalid_utf8_for_external_subcommands_set() {
static DEFAULT: super::ValueParser = super::ValueParser::os_string();
Some(&DEFAULT)
} else {
static DEFAULT: super::ValueParser = super::ValueParser::string();
Some(&DEFAULT)
}
}
/// Report whether [`Command::args_conflicts_with_subcommands`] is set
pub fn is_args_conflicts_with_subcommands_set(&self) -> bool {
self.is_set(AppSettings::ArgsNegateSubcommands)
}
/// Report whether [`Command::subcommand_precedence_over_arg`] is set
pub fn is_subcommand_precedence_over_arg_set(&self) -> bool {
self.is_set(AppSettings::SubcommandPrecedenceOverArg)
}
/// Report whether [`Command::subcommand_negates_reqs`] is set
pub fn is_subcommand_negates_reqs_set(&self) -> bool {
self.is_set(AppSettings::SubcommandsNegateReqs)
}
/// Report whether [`Command::multicall`] is set
pub fn is_multicall_set(&self) -> bool {
self.is_set(AppSettings::Multicall)
}
}
/// Deprecated
impl<'help> App<'help> {
/// Deprecated in [Issue #3087](https://github.com/clap-rs/clap/issues/3087), maybe [`clap::Parser`][crate::Parser] would fit your use case?
#[cfg(feature = "yaml")]
#[cfg_attr(
feature = "deprecated",
deprecated(
since = "3.0.0",
note = "Deprecated in Issue #3087, maybe clap::Parser would fit your use case?"
)
)]
#[doc(hidden)]
pub fn from_yaml(y: &'help Yaml) -> Self {
#![allow(deprecated)]
let yaml_file_hash = y.as_hash().expect("YAML file must be a hash");
// We WANT this to panic on error...so expect() is good.
let (mut a, yaml, err) = if let Some(name) = y["name"].as_str() {
(App::new(name), yaml_file_hash, "cmd".into())
} else {
let (name_yaml, value_yaml) = yaml_file_hash
.iter()
.next()
.expect("There must be one subcommand in the YAML file");
let name_str = name_yaml
.as_str()
.expect("Subcommand name must be a string");
(
App::new(name_str),
value_yaml.as_hash().expect("Subcommand must be a hash"),
format!("subcommand '{}'", name_str),
)
};
for (k, v) in yaml {
a = match k.as_str().expect("App fields must be strings") {
"version" => yaml_to_str!(a, v, version),
"long_version" => yaml_to_str!(a, v, long_version),
"author" => yaml_to_str!(a, v, author),
"bin_name" => yaml_to_str!(a, v, bin_name),
"about" => yaml_to_str!(a, v, about),
"long_about" => yaml_to_str!(a, v, long_about),
"before_help" => yaml_to_str!(a, v, before_help),
"after_help" => yaml_to_str!(a, v, after_help),
"template" => yaml_to_str!(a, v, help_template),
"usage" => yaml_to_str!(a, v, override_usage),
"help" => yaml_to_str!(a, v, override_help),
"help_message" => yaml_to_str!(a, v, help_message),
"version_message" => yaml_to_str!(a, v, version_message),
"alias" => yaml_to_str!(a, v, alias),
"aliases" => yaml_vec_or_str!(a, v, alias),
"visible_alias" => yaml_to_str!(a, v, visible_alias),
"visible_aliases" => yaml_vec_or_str!(a, v, visible_alias),
"display_order" => yaml_to_usize!(a, v, display_order),
"args" => {
if let Some(vec) = v.as_vec() {
for arg_yaml in vec {
a = a.arg(Arg::from_yaml(arg_yaml));
}
} else {
panic!("Failed to convert YAML value {:?} to a vec", v);
}
a
}
"subcommands" => {
if let Some(vec) = v.as_vec() {
for sc_yaml in vec {
a = a.subcommand(App::from_yaml(sc_yaml));
}
} else {
panic!("Failed to convert YAML value {:?} to a vec", v);
}
a
}
"groups" => {
if let Some(vec) = v.as_vec() {
for ag_yaml in vec {
a = a.group(ArgGroup::from(ag_yaml));
}
} else {
panic!("Failed to convert YAML value {:?} to a vec", v);
}
a
}
"setting" | "settings" => {
yaml_to_setting!(a, v, setting, AppSettings, "AppSetting", err)
}
"global_setting" | "global_settings" => {
yaml_to_setting!(a, v, global_setting, AppSettings, "AppSetting", err)
}
_ => a,
}
}
a
}
/// Deprecated, replaced with [`Command::override_usage`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::override_usage`")
)]
#[doc(hidden)]
#[must_use]
pub fn usage<S: Into<&'help str>>(self, usage: S) -> Self {
self.override_usage(usage)
}
/// Deprecated, replaced with [`Command::override_help`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::override_help`")
)]
#[doc(hidden)]
#[must_use]
pub fn help<S: Into<&'help str>>(self, help: S) -> Self {
self.override_help(help)
}
/// Deprecated, replaced with [`Command::mut_arg`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::mut_arg`")
)]
#[doc(hidden)]
#[must_use]
pub fn help_short(self, c: char) -> Self {
self.mut_arg("help", |a| a.short(c))
}
/// Deprecated, replaced with [`Command::mut_arg`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::mut_arg`")
)]
#[doc(hidden)]
#[must_use]
pub fn version_short(self, c: char) -> Self {
self.mut_arg("version", |a| a.short(c))
}
/// Deprecated, replaced with [`Command::mut_arg`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::mut_arg`")
)]
#[doc(hidden)]
#[must_use]
pub fn help_message(self, s: impl Into<&'help str>) -> Self {
self.mut_arg("help", |a| a.help(s.into()))
}
/// Deprecated, replaced with [`Command::mut_arg`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::mut_arg`")
)]
#[doc(hidden)]
#[must_use]
pub fn version_message(self, s: impl Into<&'help str>) -> Self {
self.mut_arg("version", |a| a.help(s.into()))
}
/// Deprecated, replaced with [`Command::help_template`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::help_template`")
)]
#[doc(hidden)]
#[must_use]
pub fn template<S: Into<&'help str>>(self, s: S) -> Self {
self.help_template(s)
}
/// Deprecated, replaced with [`Command::setting(a| b)`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::setting(a | b)`")
)]
#[doc(hidden)]
#[must_use]
pub fn settings(mut self, settings: &[AppSettings]) -> Self {
for s in settings {
self.settings.insert((*s).into());
}
self
}
/// Deprecated, replaced with [`Command::unset_setting(a| b)`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::unset_setting(a | b)`")
)]
#[doc(hidden)]
#[must_use]
pub fn unset_settings(mut self, settings: &[AppSettings]) -> Self {
for s in settings {
self.settings.remove((*s).into());
}
self
}
/// Deprecated, replaced with [`Command::global_setting(a| b)`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::global_setting(a | b)`")
)]
#[doc(hidden)]
#[must_use]
pub fn global_settings(mut self, settings: &[AppSettings]) -> Self {
for s in settings {
self.settings.insert((*s).into());
self.g_settings.insert((*s).into());
}
self
}
/// Deprecated, replaced with [`Command::term_width`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::term_width`")
)]
#[doc(hidden)]
#[must_use]
pub fn set_term_width(self, width: usize) -> Self {
self.term_width(width)
}
/// Deprecated in [Issue #3086](https://github.com/clap-rs/clap/issues/3086), see [`arg!`][crate::arg!].
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Deprecated in Issue #3086, see `clap::arg!")
)]
#[doc(hidden)]
#[must_use]
pub fn arg_from_usage(self, usage: &'help str) -> Self {
#![allow(deprecated)]
self.arg(Arg::from_usage(usage))
}
/// Deprecated in [Issue #3086](https://github.com/clap-rs/clap/issues/3086), see [`arg!`][crate::arg!].
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Deprecated in Issue #3086, see `clap::arg!")
)]
#[doc(hidden)]
#[must_use]
pub fn args_from_usage(mut self, usage: &'help str) -> Self {
#![allow(deprecated)]
for line in usage.lines() {
let l = line.trim();
if l.is_empty() {
continue;
}
self = self.arg(Arg::from_usage(l));
}
self
}
/// Deprecated, replaced with [`Command::render_version`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::render_version`")
)]
#[doc(hidden)]
pub fn write_version<W: io::Write>(&self, w: &mut W) -> ClapResult<()> {
write!(w, "{}", self.render_version()).map_err(From::from)
}
/// Deprecated, replaced with [`Command::render_long_version`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::render_long_version`")
)]
#[doc(hidden)]
pub fn write_long_version<W: io::Write>(&self, w: &mut W) -> ClapResult<()> {
write!(w, "{}", self.render_long_version()).map_err(From::from)
}
/// Deprecated, replaced with [`Command::try_get_matches`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::try_get_matches`")
)]
#[doc(hidden)]
pub fn get_matches_safe(self) -> ClapResult<ArgMatches> {
self.try_get_matches()
}
/// Deprecated, replaced with [`Command::try_get_matches_from`]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.0.0", note = "Replaced with `App::try_get_matches_from`")
)]
#[doc(hidden)]
pub fn get_matches_from_safe<I, T>(self, itr: I) -> ClapResult<ArgMatches>
where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
{
self.try_get_matches_from(itr)
}
/// Deprecated, replaced with [`Command::try_get_matches_from_mut`]
#[cfg_attr(
feature = "deprecated",
deprecated(
since = "3.0.0",
note = "Replaced with `App::try_get_matches_from_mut`"
)
)]
#[doc(hidden)]
pub fn get_matches_from_safe_borrow<I, T>(&mut self, itr: I) -> ClapResult<ArgMatches>
where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
{
self.try_get_matches_from_mut(itr)
}
}
// Internally used only
impl<'help> App<'help> {
pub(crate) fn get_id(&self) -> Id {
self.id.clone()
}
pub(crate) fn get_override_usage(&self) -> Option<&str> {
self.usage_str
}
pub(crate) fn get_override_help(&self) -> Option<&str> {
self.help_str
}
pub(crate) fn get_help_template(&self) -> Option<&str> {
self.template
}
pub(crate) fn get_term_width(&self) -> Option<usize> {
self.term_w
}
pub(crate) fn get_max_term_width(&self) -> Option<usize> {
self.max_w
}
pub(crate) fn get_replacement(&self, key: &str) -> Option<&[&str]> {
self.replacers.get(key).copied()
}
pub(crate) fn get_keymap(&self) -> &MKeyMap<'help> {
&self.args
}
fn get_used_global_args(&self, matches: &ArgMatches, global_arg_vec: &mut Vec<Id>) {
global_arg_vec.extend(
self.args
.args()
.filter(|a| a.is_global_set())
.map(|ga| ga.id.clone()),
);
if let Some((id, matches)) = matches.subcommand() {
if let Some(used_sub) = self.find_subcommand(id) {
used_sub.get_used_global_args(matches, global_arg_vec);
}
}
}
fn _do_parse(
&mut self,
raw_args: &mut clap_lex::RawArgs,
args_cursor: clap_lex::ArgCursor,
) -> ClapResult<ArgMatches> {
debug!("Command::_do_parse");
// If there are global arguments, or settings we need to propagate them down to subcommands
// before parsing in case we run into a subcommand
self._build_self();
let mut matcher = ArgMatcher::new(self);
// do the real parsing
let mut parser = Parser::new(self);
if let Err(error) = parser.get_matches_with(&mut matcher, raw_args, args_cursor) {
if self.is_set(AppSettings::IgnoreErrors) {
debug!("Command::_do_parse: ignoring error: {}", error);
} else {
return Err(error);
}
}
let mut global_arg_vec = Default::default();
self.get_used_global_args(&matcher, &mut global_arg_vec);
matcher.propagate_globals(&global_arg_vec);
Ok(matcher.into_inner())
}
#[doc(hidden)]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.10", note = "Replaced with `Command::build`")
)]
pub fn _build_all(&mut self) {
self.build();
}
#[doc(hidden)]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.10", note = "Replaced with `Command::build`")
)]
pub fn _build(&mut self) {
self._build_self()
}
#[doc(hidden)]
#[cfg_attr(
feature = "deprecated",
deprecated(since = "3.1.13", note = "Replaced with `Command::build`")
)]
pub fn _build_bin_names(&mut self) {
self._build_bin_names_internal();
}
/// Prepare for introspecting on all included [`Command`]s
///
/// Call this on the top-level [`Command`] when done building and before reading state for
/// cases like completions, custom help output, etc.
pub fn build(&mut self) {
self._build_recursive();
self._build_bin_names_internal();
}
pub(crate) fn _build_recursive(&mut self) {
self._build_self();
for subcmd in self.get_subcommands_mut() {
subcmd._build_recursive();
}
}
pub(crate) fn _build_self(&mut self) {
debug!("Command::_build: name={:?}", self.get_name());
if !self.settings.is_set(AppSettings::Built) {
// Make sure all the globally set flags apply to us as well
self.settings = self.settings | self.g_settings;
if self.is_multicall_set() {
self.settings.insert(AppSettings::SubcommandRequired.into());
self.settings.insert(AppSettings::DisableHelpFlag.into());
self.settings.insert(AppSettings::DisableVersionFlag.into());
}
self._propagate();
self._check_help_and_version();
self._propagate_global_args();
self._derive_display_order();
let mut pos_counter = 1;
let self_override = self.is_set(AppSettings::AllArgsOverrideSelf);
let hide_pv = self.is_set(AppSettings::HidePossibleValues);
let auto_help =
!self.is_set(AppSettings::NoAutoHelp) && !self.is_disable_help_flag_set();
let auto_version =
!self.is_set(AppSettings::NoAutoVersion) && !self.is_disable_version_flag_set();
for a in self.args.args_mut() {
// Fill in the groups
for g in &a.groups {
if let Some(ag) = self.groups.iter_mut().find(|grp| grp.id == *g) {
ag.args.push(a.id.clone());
} else {
let mut ag = ArgGroup::with_id(g.clone());
ag.args.push(a.id.clone());
self.groups.push(ag);
}
}
// Figure out implied settings
if a.is_last_set() {
// if an arg has `Last` set, we need to imply DontCollapseArgsInUsage so that args
// in the usage string don't get confused or left out.
self.settings.set(AppSettings::DontCollapseArgsInUsage);
}
if hide_pv && a.is_takes_value_set() {
a.settings.set(ArgSettings::HidePossibleValues);
}
if self_override {
let self_id = a.id.clone();
a.overrides.push(self_id);
}
a._build();
// HACK: Setting up action at this level while auto-help / disable help flag is
// required. Otherwise, most of this won't be needed because when we can break
// compat, actions will reign supreme (default to `Store`)
if a.action.is_none() {
if a.get_id() == "help" && auto_help && !a.is_takes_value_set() {
let action = super::ArgAction::Help;
a.action = Some(action);
} else if a.get_id() == "version" && auto_version && !a.is_takes_value_set() {
let action = super::ArgAction::Version;
a.action = Some(action);
} else if a.is_takes_value_set() {
let action = super::ArgAction::StoreValue;
a.action = Some(action);
} else {
let action = super::ArgAction::IncOccurrence;
a.action = Some(action);
}
}
if a.is_positional() && a.index.is_none() {
a.index = Some(pos_counter);
pos_counter += 1;
}
}
self.args._build();
#[cfg(debug_assertions)]
assert_app(self);
self.settings.set(AppSettings::Built);
} else {
debug!("Command::_build: already built");
}
}
pub(crate) fn _build_subcommand(&mut self, name: &str) -> Option<&mut Self> {
use std::fmt::Write;
let mut mid_string = String::from(" ");
if !self.is_subcommand_negates_reqs_set() && !self.is_args_conflicts_with_subcommands_set()
{
let reqs = Usage::new(self).get_required_usage_from(&[], None, true); // maybe Some(m)
for s in &reqs {
mid_string.push_str(s);
mid_string.push(' ');
}
}
let is_multicall_set = self.is_multicall_set();
let sc = self.subcommands.iter_mut().find(|s| s.name == name)?;
// Display subcommand name, short and long in usage
let mut sc_names = sc.name.clone();
let mut flag_subcmd = false;
if let Some(l) = sc.long_flag {
write!(sc_names, "|--{}", l).unwrap();
flag_subcmd = true;
}
if let Some(s) = sc.short_flag {
write!(sc_names, "|-{}", s).unwrap();
flag_subcmd = true;
}
if flag_subcmd {
sc_names = format!("{{{}}}", sc_names);
}
let usage_name = self
.bin_name
.as_ref()
.map(|bin_name| format!("{}{}{}", bin_name, mid_string, sc_names))
.unwrap_or(sc_names);
sc.usage_name = Some(usage_name);
// bin_name should be parent's bin_name + [<reqs>] + the sc's name separated by
// a space
let bin_name = format!(
"{}{}{}",
self.bin_name.as_ref().unwrap_or(&String::new()),
if self.bin_name.is_some() { " " } else { "" },
&*sc.name
);
debug!(
"Command::_build_subcommand Setting bin_name of {} to {:?}",
sc.name, bin_name
);
sc.bin_name = Some(bin_name);
if sc.display_name.is_none() {
let self_display_name = if is_multicall_set {
self.display_name.as_deref().unwrap_or("")
} else {
self.display_name.as_deref().unwrap_or(&self.name)
};
let display_name = format!(
"{}{}{}",
self_display_name,
if !self_display_name.is_empty() {
"-"
} else {
""
},
&*sc.name
);
debug!(
"Command::_build_subcommand Setting display_name of {} to {:?}",
sc.name, display_name
);
sc.display_name = Some(display_name);
}
// Ensure all args are built and ready to parse
sc._build_self();
Some(sc)
}
fn _build_bin_names_internal(&mut self) {
debug!("Command::_build_bin_names");
if !self.is_set(AppSettings::BinNameBuilt) {
let mut mid_string = String::from(" ");
if !self.is_subcommand_negates_reqs_set()
&& !self.is_args_conflicts_with_subcommands_set()
{
let reqs = Usage::new(self).get_required_usage_from(&[], None, true); // maybe Some(m)
for s in &reqs {
mid_string.push_str(s);
mid_string.push(' ');
}
}
let is_multicall_set = self.is_multicall_set();
let self_bin_name = if is_multicall_set {
self.bin_name.as_deref().unwrap_or("")
} else {
self.bin_name.as_deref().unwrap_or(&self.name)
}
.to_owned();
for mut sc in &mut self.subcommands {
debug!("Command::_build_bin_names:iter: bin_name set...");
if sc.usage_name.is_none() {
use std::fmt::Write;
// Display subcommand name, short and long in usage
let mut sc_names = sc.name.clone();
let mut flag_subcmd = false;
if let Some(l) = sc.long_flag {
write!(sc_names, "|--{}", l).unwrap();
flag_subcmd = true;
}
if let Some(s) = sc.short_flag {
write!(sc_names, "|-{}", s).unwrap();
flag_subcmd = true;
}
if flag_subcmd {
sc_names = format!("{{{}}}", sc_names);
}
let usage_name = format!("{}{}{}", self_bin_name, mid_string, sc_names);
debug!(
"Command::_build_bin_names:iter: Setting usage_name of {} to {:?}",
sc.name, usage_name
);
sc.usage_name = Some(usage_name);
} else {
debug!(
"Command::_build_bin_names::iter: Using existing usage_name of {} ({:?})",
sc.name, sc.usage_name
);
}
if sc.bin_name.is_none() {
let bin_name = format!(
"{}{}{}",
self_bin_name,
if !self_bin_name.is_empty() { " " } else { "" },
&*sc.name
);
debug!(
"Command::_build_bin_names:iter: Setting bin_name of {} to {:?}",
sc.name, bin_name
);
sc.bin_name = Some(bin_name);
} else {
debug!(
"Command::_build_bin_names::iter: Using existing bin_name of {} ({:?})",
sc.name, sc.bin_name
);
}
if sc.display_name.is_none() {
let self_display_name = if is_multicall_set {
self.display_name.as_deref().unwrap_or("")
} else {
self.display_name.as_deref().unwrap_or(&self.name)
};
let display_name = format!(
"{}{}{}",
self_display_name,
if !self_display_name.is_empty() {
"-"
} else {
""
},
&*sc.name
);
debug!(
"Command::_build_bin_names:iter: Setting display_name of {} to {:?}",
sc.name, display_name
);
sc.display_name = Some(display_name);
} else {
debug!(
"Command::_build_bin_names::iter: Using existing display_name of {} ({:?})",
sc.name, sc.display_name
);
}
sc._build_bin_names_internal();
}
self.set(AppSettings::BinNameBuilt);
} else {
debug!("Command::_build_bin_names: already built");
}
}
pub(crate) fn _panic_on_missing_help(&self, help_required_globally: bool) {
if self.is_set(AppSettings::HelpExpected) || help_required_globally {
let args_missing_help: Vec<String> = self
.args
.args()
.filter(|arg| arg.help.is_none() && arg.long_help.is_none())
.map(|arg| String::from(arg.name))
.collect();
assert!(args_missing_help.is_empty(),
"Command::help_expected is enabled for the Command {}, but at least one of its arguments does not have either `help` or `long_help` set. List of such arguments: {}",
self.name,
args_missing_help.join(", ")
);
}
for sub_app in &self.subcommands {
sub_app._panic_on_missing_help(help_required_globally);
}
}
#[cfg(debug_assertions)]
pub(crate) fn two_args_of<F>(&self, condition: F) -> Option<(&Arg<'help>, &Arg<'help>)>
where
F: Fn(&Arg) -> bool,
{
two_elements_of(self.args.args().filter(|a: &&Arg| condition(a)))
}
// just in case
#[allow(unused)]
fn two_groups_of<F>(&self, condition: F) -> Option<(&ArgGroup, &ArgGroup)>
where
F: Fn(&ArgGroup) -> bool,
{
two_elements_of(self.groups.iter().filter(|a| condition(a)))
}
/// Propagate global args
pub(crate) fn _propagate_global_args(&mut self) {
debug!("Command::_propagate_global_args:{}", self.name);
for sc in &mut self.subcommands {
for a in self.args.args().filter(|a| a.is_global_set()) {
let mut propagate = false;
let is_generated = matches!(
a.provider,
ArgProvider::Generated | ArgProvider::GeneratedMutated
);
// Remove generated help and version args in the subcommand
//
// Don't remove if those args are further mutated
if is_generated {
let generated_pos = sc
.args
.args()
.position(|x| x.id == a.id && x.provider == ArgProvider::Generated);
if let Some(index) = generated_pos {
debug!(
"Command::_propagate removing {}'s {:?}",
sc.get_name(),
a.id
);
sc.args.remove(index);
propagate = true;
}
}
if propagate || sc.find(&a.id).is_none() {
debug!(
"Command::_propagate pushing {:?} to {}",
a.id,
sc.get_name(),
);
sc.args.push(a.clone());
}
}
}
}
/// Propagate settings
pub(crate) fn _propagate(&mut self) {
debug!("Command::_propagate:{}", self.name);
let mut subcommands = std::mem::take(&mut self.subcommands);
for sc in &mut subcommands {
self._propagate_subcommand(sc);
}
self.subcommands = subcommands;
}
fn _propagate_subcommand(&self, sc: &mut Self) {
// We have to create a new scope in order to tell rustc the borrow of `sc` is
// done and to recursively call this method
{
if self.settings.is_set(AppSettings::PropagateVersion) {
if sc.version.is_none() && self.version.is_some() {
sc.version = Some(self.version.unwrap());
}
if sc.long_version.is_none() && self.long_version.is_some() {
sc.long_version = Some(self.long_version.unwrap());
}
}
sc.settings = sc.settings | self.g_settings;
sc.g_settings = sc.g_settings | self.g_settings;
sc.term_w = self.term_w;
sc.max_w = self.max_w;
}
}
#[allow(clippy::blocks_in_if_conditions)]
pub(crate) fn _check_help_and_version(&mut self) {
debug!("Command::_check_help_and_version: {}", self.name);
if self.is_set(AppSettings::DisableHelpFlag)
|| self.args.args().any(|x| {
x.provider == ArgProvider::User
&& (x.long == Some("help") || x.id == Id::help_hash())
})
|| self
.subcommands
.iter()
.any(|sc| sc.long_flag == Some("help"))
{
debug!("Command::_check_help_and_version: Removing generated help");
let generated_help_pos = self
.args
.args()
.position(|x| x.id == Id::help_hash() && x.provider == ArgProvider::Generated);
if let Some(index) = generated_help_pos {
self.args.remove(index);
}
} else {
let help = self
.args
.args()
.find(|x| x.id == Id::help_hash())
.expect(INTERNAL_ERROR_MSG);
assert_ne!(help.provider, ArgProvider::User);
if help.short.is_some() {
if help.short == Some('h') {
if let Some(other_arg) = self
.args
.args()
.find(|x| x.id != Id::help_hash() && x.short == Some('h'))
{
panic!(
"`help`s `-h` conflicts with `{}`.
To change `help`s short, call `cmd.arg(Arg::new(\"help\")...)`.",
other_arg.name
);
}
}
} else if !(self.args.args().any(|x| x.short == Some('h'))
|| self.subcommands.iter().any(|sc| sc.short_flag == Some('h')))
{
let help = self
.args
.args_mut()
.find(|x| x.id == Id::help_hash())
.expect(INTERNAL_ERROR_MSG);
help.short = Some('h');
} else {
debug!("Command::_check_help_and_version: Removing `-h` from help");
}
}
// Determine if we should remove the generated --version flag
//
// Note that if only mut_arg() was used, the first expression will evaluate to `true`
// however inside the condition block, we only check for Generated args, not
// GeneratedMutated args, so the `mut_arg("version", ..) will be skipped and fall through
// to the following condition below (Adding the short `-V`)
if self.settings.is_set(AppSettings::DisableVersionFlag)
|| (self.version.is_none() && self.long_version.is_none())
|| self.args.args().any(|x| {
x.provider == ArgProvider::User
&& (x.long == Some("version") || x.id == Id::version_hash())
})
|| self
.subcommands
.iter()
.any(|sc| sc.long_flag == Some("version"))
{
debug!("Command::_check_help_and_version: Removing generated version");
// This is the check mentioned above that only checks for Generated, not
// GeneratedMutated args by design.
let generated_version_pos = self
.args
.args()
.position(|x| x.id == Id::version_hash() && x.provider == ArgProvider::Generated);
if let Some(index) = generated_version_pos {
self.args.remove(index);
}
}
// If we still have a generated --version flag, determine if we can apply the short `-V`
if self.args.args().any(|x| {
x.id == Id::version_hash()
&& matches!(
x.provider,
ArgProvider::Generated | ArgProvider::GeneratedMutated
)
}) {
let other_arg_has_short = self.args.args().any(|x| x.short == Some('V'));
let version = self
.args
.args_mut()
.find(|x| x.id == Id::version_hash())
.expect(INTERNAL_ERROR_MSG);
if !(version.short.is_some()
|| other_arg_has_short
|| self.subcommands.iter().any(|sc| sc.short_flag == Some('V')))
{
version.short = Some('V');
}
}
if !self.is_set(AppSettings::DisableHelpSubcommand)
&& self.has_subcommands()
&& !self.subcommands.iter().any(|s| s.id == Id::help_hash())
{
debug!("Command::_check_help_and_version: Building help subcommand");
let mut help_subcmd = App::new("help")
.about("Print this message or the help of the given subcommand(s)")
.arg(
Arg::new("subcommand")
.index(1)
.takes_value(true)
.multiple_occurrences(true)
.value_name("SUBCOMMAND")
.help("The subcommand whose help message to display"),
);
self._propagate_subcommand(&mut help_subcmd);
// The parser acts like this is set, so let's set it so we don't falsely
// advertise it to the user
help_subcmd.version = None;
help_subcmd.long_version = None;
help_subcmd = help_subcmd
.setting(AppSettings::DisableHelpFlag)
.unset_global_setting(AppSettings::PropagateVersion);
self.subcommands.push(help_subcmd);
}
}
pub(crate) fn _derive_display_order(&mut self) {
debug!("Command::_derive_display_order:{}", self.name);
if self.settings.is_set(AppSettings::DeriveDisplayOrder) {
for a in self
.args
.args_mut()
.filter(|a| !a.is_positional())
.filter(|a| a.provider != ArgProvider::Generated)
{
a.disp_ord.make_explicit();
}
for (i, sc) in &mut self.subcommands.iter_mut().enumerate() {
sc.disp_ord.get_or_insert(i);
}
}
for sc in &mut self.subcommands {
sc._derive_display_order();
}
}
pub(crate) fn _render_version(&self, use_long: bool) -> String {
debug!("Command::_render_version");
let ver = if use_long {
self.long_version.or(self.version).unwrap_or("")
} else {
self.version.or(self.long_version).unwrap_or("")
};
if let Some(bn) = self.bin_name.as_ref() {
if bn.contains(' ') {
// In case we're dealing with subcommands i.e. git mv is translated to git-mv
format!("{} {}\n", bn.replace(' ', "-"), ver)
} else {
format!("{} {}\n", &self.name[..], ver)
}
} else {
format!("{} {}\n", &self.name[..], ver)
}
}
pub(crate) fn format_group(&self, g: &Id) -> String {
let g_string = self
.unroll_args_in_group(g)
.iter()
.filter_map(|x| self.find(x))
.map(|x| {
if x.is_positional() {
// Print val_name for positional arguments. e.g. <file_name>
x.name_no_brackets().to_string()
} else {
// Print usage string for flags arguments, e.g. <--help>
x.to_string()
}
})
.collect::<Vec<_>>()
.join("|");
format!("<{}>", &*g_string)
}
}
/// A workaround:
/// <https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999>
pub(crate) trait Captures<'a> {}
impl<'a, T> Captures<'a> for T {}
// Internal Query Methods
impl<'help> App<'help> {
/// Iterate through the *flags* & *options* arguments.
pub(crate) fn get_non_positionals(&self) -> impl Iterator<Item = &Arg<'help>> {
self.get_arguments().filter(|a| !a.is_positional())
}
/// Iterate through the *positionals* that don't have custom heading.
pub(crate) fn get_positionals_with_no_heading(&self) -> impl Iterator<Item = &Arg<'help>> {
self.get_positionals()
.filter(|a| a.get_help_heading().is_none())
}
/// Iterate through the *flags* & *options* that don't have custom heading.
pub(crate) fn get_non_positionals_with_no_heading(&self) -> impl Iterator<Item = &Arg<'help>> {
self.get_non_positionals()
.filter(|a| a.get_help_heading().is_none())
}
pub(crate) fn find(&self, arg_id: &Id) -> Option<&Arg<'help>> {
self.args.args().find(|a| a.id == *arg_id)
}
#[inline]
pub(crate) fn contains_short(&self, s: char) -> bool {
assert!(
self.is_set(AppSettings::Built),
"If App::_build hasn't been called, manually search through Arg shorts"
);
self.args.contains(s)
}
#[inline]
pub(crate) fn set(&mut self, s: AppSettings) {
self.settings.set(s)
}
#[inline]
pub(crate) fn has_args(&self) -> bool {
!self.args.is_empty()
}
pub(crate) fn has_positionals(&self) -> bool {
self.args.keys().any(|x| x.is_position())
}
pub(crate) fn has_visible_subcommands(&self) -> bool {
self.subcommands
.iter()
.any(|sc| sc.name != "help" && !sc.is_set(AppSettings::Hidden))
}
/// Check if this subcommand can be referred to as `name`. In other words,
/// check if `name` is the name of this subcommand or is one of its aliases.
#[inline]
pub(crate) fn aliases_to<T>(&self, name: &T) -> bool
where
T: PartialEq<str> + ?Sized,
{
*name == *self.get_name() || self.get_all_aliases().any(|alias| *name == *alias)
}
/// Check if this subcommand can be referred to as `name`. In other words,
/// check if `name` is the name of this short flag subcommand or is one of its short flag aliases.
#[inline]
pub(crate) fn short_flag_aliases_to(&self, flag: char) -> bool {
Some(flag) == self.short_flag
|| self.get_all_short_flag_aliases().any(|alias| flag == alias)
}
/// Check if this subcommand can be referred to as `name`. In other words,
/// check if `name` is the name of this long flag subcommand or is one of its long flag aliases.
#[inline]
pub(crate) fn long_flag_aliases_to<T>(&self, flag: &T) -> bool
where
T: PartialEq<str> + ?Sized,
{
match self.long_flag {
Some(long_flag) => {
flag == long_flag || self.get_all_long_flag_aliases().any(|alias| flag == alias)
}
None => self.get_all_long_flag_aliases().any(|alias| flag == alias),
}
}
#[cfg(debug_assertions)]
pub(crate) fn id_exists(&self, id: &Id) -> bool {
self.args.args().any(|x| x.id == *id) || self.groups.iter().any(|x| x.id == *id)
}
/// Iterate through the groups this arg is member of.
pub(crate) fn groups_for_arg<'a>(&'a self, arg: &Id) -> impl Iterator<Item = Id> + 'a {
debug!("Command::groups_for_arg: id={:?}", arg);
let arg = arg.clone();
self.groups
.iter()
.filter(move |grp| grp.args.iter().any(|a| a == &arg))
.map(|grp| grp.id.clone())
}
pub(crate) fn find_group(&self, group_id: &Id) -> Option<&ArgGroup<'help>> {
self.groups.iter().find(|g| g.id == *group_id)
}
/// Iterate through all the names of all subcommands (not recursively), including aliases.
/// Used for suggestions.
pub(crate) fn all_subcommand_names(&self) -> impl Iterator<Item = &str> + Captures<'help> {
self.get_subcommands().flat_map(|sc| {
let name = sc.get_name();
let aliases = sc.get_all_aliases();
std::iter::once(name).chain(aliases)
})
}
pub(crate) fn required_graph(&self) -> ChildGraph<Id> {
let mut reqs = ChildGraph::with_capacity(5);
for a in self.args.args().filter(|a| a.is_required_set()) {
reqs.insert(a.id.clone());
}
for group in &self.groups {
if group.required {
let idx = reqs.insert(group.id.clone());
for a in &group.requires {
reqs.insert_child(idx, a.clone());
}
}
}
reqs
}
pub(crate) fn unroll_args_in_group(&self, group: &Id) -> Vec<Id> {
debug!("Command::unroll_args_in_group: group={:?}", group);
let mut g_vec = vec![group];
let mut args = vec![];
while let Some(g) = g_vec.pop() {
for n in self
.groups
.iter()
.find(|grp| grp.id == *g)
.expect(INTERNAL_ERROR_MSG)
.args
.iter()
{
debug!("Command::unroll_args_in_group:iter: entity={:?}", n);
if !args.contains(n) {
if self.find(n).is_some() {
debug!("Command::unroll_args_in_group:iter: this is an arg");
args.push(n.clone())
} else {
debug!("Command::unroll_args_in_group:iter: this is a group");
g_vec.push(n);
}
}
}
}
args
}
pub(crate) fn unroll_arg_requires<F>(&self, func: F, arg: &Id) -> Vec<Id>
where
F: Fn(&(ArgPredicate<'_>, Id)) -> Option<Id>,
{
let mut processed = vec![];
let mut r_vec = vec![arg];
let mut args = vec![];
while let Some(a) = r_vec.pop() {
if processed.contains(&a) {
continue;
}
processed.push(a);
if let Some(arg) = self.find(a) {
for r in arg.requires.iter().filter_map(&func) {
if let Some(req) = self.find(&r) {
if !req.requires.is_empty() {
r_vec.push(&req.id)
}
}
args.push(r);
}
}
}
args
}
/// Find a flag subcommand name by short flag or an alias
pub(crate) fn find_short_subcmd(&self, c: char) -> Option<&str> {
self.get_subcommands()
.find(|sc| sc.short_flag_aliases_to(c))
.map(|sc| sc.get_name())
}
/// Find a flag subcommand name by long flag or an alias
pub(crate) fn find_long_subcmd(&self, long: &str) -> Option<&str> {
self.get_subcommands()
.find(|sc| sc.long_flag_aliases_to(long))
.map(|sc| sc.get_name())
}
pub(crate) fn get_display_order(&self) -> usize {
self.disp_ord.unwrap_or(999)
}
pub(crate) fn write_help_err(
&self,
mut use_long: bool,
stream: Stream,
) -> ClapResult<Colorizer> {
debug!(
"Parser::write_help_err: use_long={:?}, stream={:?}",
use_long && self.use_long_help(),
stream
);
use_long = use_long && self.use_long_help();
let usage = Usage::new(self);
let mut c = Colorizer::new(stream, self.color_help());
Help::new(HelpWriter::Buffer(&mut c), self, &usage, use_long).write_help()?;
Ok(c)
}
pub(crate) fn use_long_help(&self) -> bool {
debug!("Command::use_long_help");
// In this case, both must be checked. This allows the retention of
// original formatting, but also ensures that the actual -h or --help
// specified by the user is sent through. If hide_short_help is not included,
// then items specified with hidden_short_help will also be hidden.
let should_long = |v: &Arg| {
v.long_help.is_some()
|| v.is_hide_long_help_set()
|| v.is_hide_short_help_set()
|| cfg!(feature = "unstable-v4")
&& v.get_possible_values2()
.iter()
.any(PossibleValue::should_show_help)
};
// Subcommands aren't checked because we prefer short help for them, deferring to
// `cmd subcmd --help` for more.
self.get_long_about().is_some()
|| self.get_before_long_help().is_some()
|| self.get_after_long_help().is_some()
|| self.get_arguments().any(should_long)
}
// Should we color the help?
pub(crate) fn color_help(&self) -> ColorChoice {
#[cfg(feature = "color")]
if self.is_disable_colored_help_set() {
return ColorChoice::Never;
}
self.get_color()
}
}
impl<'help> Default for App<'help> {
fn default() -> Self {
Self {
id: Default::default(),
name: Default::default(),
long_flag: Default::default(),
short_flag: Default::default(),
display_name: Default::default(),
bin_name: Default::default(),
author: Default::default(),
version: Default::default(),
long_version: Default::default(),
about: Default::default(),
long_about: Default::default(),
before_help: Default::default(),
before_long_help: Default::default(),
after_help: Default::default(),
after_long_help: Default::default(),
aliases: Default::default(),
short_flag_aliases: Default::default(),
long_flag_aliases: Default::default(),
usage_str: Default::default(),
usage_name: Default::default(),
help_str: Default::default(),
disp_ord: Default::default(),
term_w: Default::default(),
max_w: Default::default(),
template: Default::default(),
settings: Default::default(),
g_settings: Default::default(),
args: Default::default(),
subcommands: Default::default(),
replacers: Default::default(),
groups: Default::default(),
current_help_heading: Default::default(),
current_disp_ord: Some(0),
subcommand_value_name: Default::default(),
subcommand_heading: Default::default(),
}
}
}
impl<'help> Index<&'_ Id> for App<'help> {
type Output = Arg<'help>;
fn index(&self, key: &Id) -> &Self::Output {
self.find(key).expect(INTERNAL_ERROR_MSG)
}
}
impl fmt::Display for App<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.name)
}
}
fn two_elements_of<I, T>(mut iter: I) -> Option<(T, T)>
where
I: Iterator<Item = T>,
{
let first = iter.next();
let second = iter.next();
match (first, second) {
(Some(first), Some(second)) => Some((first, second)),
_ => None,
}
}
#[test]
fn check_auto_traits() {
static_assertions::assert_impl_all!(Command: Send, Sync, Unpin);
}