mirror of
https://github.com/CLIUtils/CLI11.git
synced 2025-05-02 21:53:51 +00:00
fe7e84f29a
rework return values from _parse_* function to return true if the value was processed false otherwise, this simplified the logic and got rid of the pulling and clearing of the missing fields from option groups. add TriggerOff and TriggerOn helper functions and some tests for them add shapes example of multiple callbacks in order. allow specification of callbacks that get executed immediately on completion of parsing of subcommand add tests for enabled/disabled by default add _get_fallthrough_parent. To get the most appropriate parent to fallthrough to add enabled and disabled by default functions add positional_arity example Add a pre_parse_callback_ for apps. The Pre parse callback takes an argument for the number of remaining arguments left to process, and will execute prior to parsing for subcommands, and after the first option parse for option_groups.
205 lines
8.1 KiB
CMake
205 lines
8.1 KiB
CMake
function(add_cli_exe T)
|
|
add_executable(${T} ${ARGN} ${CLI11_headers})
|
|
target_link_libraries(${T} PUBLIC CLI11)
|
|
set_target_properties(
|
|
${T} PROPERTIES
|
|
FOLDER "Examples"
|
|
)
|
|
|
|
if(CLANG_TIDY_EXE)
|
|
set_target_properties(
|
|
${T} PROPERTIES
|
|
CXX_CLANG_TIDY "${DO_CLANG_TIDY}"
|
|
)
|
|
endif()
|
|
endfunction()
|
|
|
|
option(CLI11_EXAMPLE_JSON OFF)
|
|
if(CLI11_EXAMPLE_JSON)
|
|
if(NOT EXISTS "${CLI11_SOURCE_DIR}/extern/json/single_include/nlohmann/json.hpp")
|
|
message(ERROR "You are missing the json package for CLI11_EXAMPLE_JSON. Please update your submodules (git submodule update --init)")
|
|
endif()
|
|
if(CMAKE_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.9)
|
|
message(WARNING "The json example requires GCC 4.9+ (requirement on json library)")
|
|
endif()
|
|
add_cli_exe(json json.cpp)
|
|
target_include_directories(json PUBLIC SYSTEM "${CLI11_SOURCE_DIR}/extern/json/single_include")
|
|
|
|
add_test(NAME json_config_out COMMAND json --item 2)
|
|
set_property(TEST json_config_out PROPERTY PASS_REGULAR_EXPRESSION
|
|
"{"
|
|
"\"item\": \"2\""
|
|
"\"simple\": false"
|
|
"}")
|
|
|
|
file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/input.json" [=[{"item":3,"simple":false}]=])
|
|
add_test(NAME json_config_in COMMAND json --config "${CMAKE_CURRENT_BINARY_DIR}/input.json")
|
|
set_property(TEST json_config_in PROPERTY PASS_REGULAR_EXPRESSION
|
|
"{"
|
|
"\"item\": \"3\""
|
|
"\"simple\": false"
|
|
"}")
|
|
endif()
|
|
|
|
add_cli_exe(simple simple.cpp)
|
|
add_test(NAME simple_basic COMMAND simple)
|
|
add_test(NAME simple_all COMMAND simple -f filename.txt -c 12 --flag --flag -d 1.2)
|
|
set_property(TEST simple_all PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Working on file: filename.txt, direct count: 1, opt count: 1"
|
|
"Working on count: 12, direct count: 1, opt count: 1"
|
|
"Received flag: 2 (2) times"
|
|
"Some value: 1.2")
|
|
|
|
|
|
add_cli_exe(subcommands subcommands.cpp)
|
|
add_test(NAME subcommands_none COMMAND subcommands)
|
|
set_property(TEST subcommands_none PROPERTY
|
|
PASS_REGULAR_EXPRESSION "A subcommand is required")
|
|
add_test(NAME subcommands_all COMMAND subcommands --random start --file name stop --count)
|
|
set_property(TEST subcommands_all PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Working on --file from start: name"
|
|
"Working on --count from stop: 1, direct count: 1"
|
|
"Count of --random flag: 1"
|
|
"Subcommand: start"
|
|
"Subcommand: stop")
|
|
|
|
add_cli_exe(subcom_partitioned subcom_partitioned.cpp)
|
|
add_test(NAME subcom_partitioned_none COMMAND subcom_partitioned)
|
|
set_property(TEST subcom_partitioned_none PROPERTY PASS_REGULAR_EXPRESSION
|
|
"This is a timer:"
|
|
"--file is required"
|
|
"Run with --help for more information.")
|
|
|
|
add_test(NAME subcom_partitioned_all COMMAND subcom_partitioned --file this --count --count -d 1.2)
|
|
set_property(TEST subcom_partitioned_all PROPERTY PASS_REGULAR_EXPRESSION
|
|
"This is a timer:"
|
|
"Working on file: this, direct count: 1, opt count: 1"
|
|
"Working on count: 2, direct count: 2, opt count: 2"
|
|
"Some value: 1.2")
|
|
# test shows that the help prints out for unnamed subcommands
|
|
add_test(NAME subcom_partitioned_help COMMAND subcom_partitioned --help)
|
|
set_property(TEST subcom_partitioned_help PROPERTY PASS_REGULAR_EXPRESSION
|
|
"-f,--file TEXT REQUIRED"
|
|
"-d,--double FLOAT")
|
|
|
|
add_cli_exe(option_groups option_groups.cpp)
|
|
add_test(NAME option_groups_missing COMMAND option_groups )
|
|
set_property(TEST option_groups_missing PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Exactly 1 option from"
|
|
"is required")
|
|
add_test(NAME option_groups_extra COMMAND option_groups --csv --binary)
|
|
set_property(TEST option_groups_extra PROPERTY PASS_REGULAR_EXPRESSION
|
|
"and 2 were given")
|
|
add_test(NAME option_groups_extra2 COMMAND option_groups --csv --address "192.168.1.1" -o "test.out")
|
|
set_property(TEST option_groups_extra2 PROPERTY PASS_REGULAR_EXPRESSION
|
|
"at most 1")
|
|
|
|
add_cli_exe(positional_arity positional_arity.cpp)
|
|
add_test(NAME positional_arity1 COMMAND positional_arity one )
|
|
set_property(TEST positional_arity1 PROPERTY PASS_REGULAR_EXPRESSION
|
|
"File 1 = one")
|
|
add_test(NAME positional_arity2 COMMAND positional_arity one two )
|
|
set_property(TEST positional_arity2 PROPERTY PASS_REGULAR_EXPRESSION
|
|
"File 1 = one"
|
|
"File 2 = two")
|
|
add_test(NAME positional_arity3 COMMAND positional_arity 1 2 one)
|
|
set_property(TEST positional_arity3 PROPERTY PASS_REGULAR_EXPRESSION
|
|
"File 1 = one")
|
|
add_test(NAME positional_arity_fail COMMAND positional_arity 1 one two)
|
|
set_property(TEST positional_arity_fail PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Could not convert")
|
|
|
|
add_cli_exe(shapes shapes.cpp)
|
|
add_test(NAME shapes_all COMMAND shapes circle 4.4 circle 10.7 rectangle 4 4 circle 2.3 triangle 4.5 ++ rectangle 2.1 ++ circle 234.675)
|
|
set_property(TEST shapes_all PROPERTY PASS_REGULAR_EXPRESSION
|
|
"circle2"
|
|
"circle4"
|
|
"rectangle2 with edges [2.1,2.1]"
|
|
"triangel1 with sides [4.5]")
|
|
|
|
add_cli_exe(ranges ranges.cpp)
|
|
add_test(NAME ranges_range COMMAND ranges --range 1 2 3)
|
|
set_property(TEST ranges_range PROPERTY PASS_REGULAR_EXPRESSION
|
|
"[2:1:3]")
|
|
add_test(NAME ranges_minmax COMMAND ranges --min 2 --max 3)
|
|
set_property(TEST ranges_minmax PROPERTY PASS_REGULAR_EXPRESSION
|
|
"[2:1:3]")
|
|
add_test(NAME ranges_error COMMAND ranges --min 2 --max 3 --step 1 --range 1 2 3)
|
|
set_property(TEST ranges_error PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Exactly 1 option from")
|
|
|
|
add_cli_exe(validators validators.cpp)
|
|
add_test(NAME validators_help COMMAND validators --help)
|
|
set_property(TEST validators_help PROPERTY PASS_REGULAR_EXPRESSION
|
|
" -f,--file TEXT:FILE[\\r\\n\\t ]+File name"
|
|
" -v,--value INT:INT in [3 - 6][\\r\\n\\t ]+Value in range")
|
|
add_test(NAME validators_file COMMAND validators --file nonex.xxx)
|
|
set_property(TEST validators_file PROPERTY PASS_REGULAR_EXPRESSION
|
|
"--file: File does not exist: nonex.xxx"
|
|
"Run with --help for more information.")
|
|
add_test(NAME validators_plain COMMAND validators --value 9)
|
|
set_property(TEST validators_plain PROPERTY PASS_REGULAR_EXPRESSION
|
|
"--value: Value 9 not in range 3 to 6"
|
|
"Run with --help for more information.")
|
|
|
|
add_cli_exe(groups groups.cpp)
|
|
add_test(NAME groups_none COMMAND groups)
|
|
set_property(TEST groups_none PROPERTY PASS_REGULAR_EXPRESSION
|
|
"This is a timer:"
|
|
"--file is required"
|
|
"Run with --help for more information.")
|
|
add_test(NAME groups_all COMMAND groups --file this --count --count -d 1.2)
|
|
set_property(TEST groups_all PROPERTY PASS_REGULAR_EXPRESSION
|
|
"This is a timer:"
|
|
"Working on file: this, direct count: 1, opt count: 1"
|
|
"Working on count: 2, direct count: 2, opt count: 2"
|
|
"Some value: 1.2")
|
|
|
|
add_cli_exe(inter_argument_order inter_argument_order.cpp)
|
|
add_test(NAME inter_argument_order COMMAND inter_argument_order --foo 1 2 3 --x --bar 4 5 6 --z --foo 7 8)
|
|
set_property(TEST inter_argument_order PROPERTY PASS_REGULAR_EXPRESSION
|
|
[=[foo : 1
|
|
foo : 2
|
|
foo : 3
|
|
bar : 4
|
|
bar : 5
|
|
bar : 6
|
|
foo : 7
|
|
foo : 8]=])
|
|
|
|
add_cli_exe(prefix_command prefix_command.cpp)
|
|
add_test(NAME prefix_command COMMAND prefix_command -v 3 2 1 -- other one two 3)
|
|
set_property(TEST prefix_command PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Prefix: 3 : 2 : 1"
|
|
"Remaining commands: other one two 3")
|
|
|
|
add_cli_exe(enum enum.cpp)
|
|
add_test(NAME enum_pass COMMAND enum -l 1)
|
|
add_test(NAME enum_fail COMMAND enum -l 4)
|
|
set_property(TEST enum_fail PROPERTY PASS_REGULAR_EXPRESSION
|
|
"--level: Check 4 value in {" "FAILED")
|
|
|
|
add_cli_exe(digit_args digit_args.cpp)
|
|
add_test(NAME digit_args COMMAND digit_args -h)
|
|
set_property(TEST digit_args PROPERTY PASS_REGULAR_EXPRESSION
|
|
"-3{3}")
|
|
|
|
add_cli_exe(modhelp modhelp.cpp)
|
|
add_test(NAME modhelp COMMAND modhelp -a test -h)
|
|
set_property(TEST modhelp PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Option -a string in help: test")
|
|
|
|
add_subdirectory(subcom_in_files)
|
|
add_test(NAME subcom_in_files COMMAND subcommand_main subcommand_a -f this.txt --with-foo)
|
|
set_property(TEST subcom_in_files PROPERTY PASS_REGULAR_EXPRESSION
|
|
"Working on file: this\.txt"
|
|
"Using foo!")
|
|
|
|
add_cli_exe(formatter formatter.cpp)
|
|
|
|
add_cli_exe(nested nested.cpp)
|
|
|
|
add_cli_exe(subcom_help subcom_help.cpp)
|
|
add_test(NAME subcom_help_normal COMMAND subcom_help sub --help)
|
|
add_test(NAME subcom_help_reversed COMMAND subcom_help --help sub)
|