Procedure | Location | Procedure Type | Description |
---|---|---|---|
add | flap_command_line_arguments_group_t | Subroutine | Add CLA to CLAs list. |
add | flap_command_line_interface_t | Subroutine | Add CLA to CLI. |
add_group | flap_command_line_interface_t | Subroutine | Add CLAs group to CLI. |
assert_close_c32 | tester | Subroutine | Check if two complex numbers (32 bits) are close with respect a tolerance. |
assert_close_c32_1 | tester | Subroutine | Check if two complex (32 bits) arrays (rank 1) are close with respect a tolerance. |
assert_close_c64 | tester | Subroutine | Check if two complex numbers (64 bits) are close with respect a tolerance. |
assert_close_c64_1 | tester | Subroutine | Check if two real (64 bits) arrays (rank 1) are close with respect a tolerance. |
assert_close_r32 | tester | Subroutine | Check if two reals (32 bits) are close with respect a tolerance. |
assert_close_r32_1 | tester | Subroutine | Check if two real (32 bits) arrays (rank 1) are close with respect a tolerance. |
assert_close_r64 | tester | Subroutine | Check if two reals (64 bits) are close with respect a tolerance. |
assert_close_r64_1 | tester | Subroutine | Check if two real (64 bits) arrays (rank 1) are close with respect a tolerance. |
assert_equal_c32 | tester | Subroutine | Check if two complex numbers (32 bits) are equal. |
assert_equal_c32_1 | tester | Subroutine | Check if two complex (32 bits) arrays (rank 1) are equal. |
assert_equal_c64 | tester | Subroutine | Check if two complex numbers (64 bits) are equal. |
assert_equal_c64_1 | tester | Subroutine | Check if two complex (64 bits) arrays (rank 1) are equal. |
assert_equal_i16 | tester | Subroutine | Check if two integers (16 bits) are equal. |
assert_equal_i16_1 | tester | Subroutine | Check if two integer (16 bits) arrays (rank 1) are equal. |
assert_equal_i32 | tester | Subroutine | Check if two integers (32 bits) are equal. |
assert_equal_i32_1 | tester | Subroutine | Check if two integer (32 bits) arrays (rank 1) are equal. |
assert_equal_i64 | tester | Subroutine | Check if two integers (64 bits) are equal. |
assert_equal_i64_1 | tester | Subroutine | Check if two integer (64 bits) arrays (rank 1) are equal. |
assert_equal_i8 | tester | Subroutine | Check if two integers (8 bits) are equal. |
assert_equal_i8_1 | tester | Subroutine | Check if two integer (8 bits) arrays (rank 1) are equal. |
assert_equal_l | tester | Subroutine | Check if two logicals are equal. |
assert_equal_l_1 | tester | Subroutine | Check if two logical arrays (rank 1) are equal. |
assert_equal_r32 | tester | Subroutine | Check if two reals (32 bits) are equal. |
assert_equal_r32_1 | tester | Subroutine | Check if two real (32 bits) arrays (rank 1) are equal. |
assert_equal_r64 | tester | Subroutine | Check if two reals (64 bits) are equal. |
assert_equal_r64_1 | tester | Subroutine | Check if two real (64 bits) arrays (rank 1) are equal. |
assert_positive_i16 | tester | Subroutine | Check if a integer (16 bits) is positive. |
assert_positive_i16_1 | tester | Subroutine | Check if a integer (16 bits) array (rank 1) is positive. |
assert_positive_i32 | tester | Subroutine | Check if a integer (32 bits) is positive. |
assert_positive_i32_1 | tester | Subroutine | Check if a integer (32 bits) array (rank 1) is positive. |
assert_positive_i64 | tester | Subroutine | Check if a integer (32 bits) is positive. |
assert_positive_i64_1 | tester | Subroutine | Check if a integer (64 bits) array (rank 1) is positive. |
assert_positive_i8 | tester | Subroutine | Check if a integer (32 bits) is positive. |
assert_positive_i8_1 | tester | Subroutine | Check if a integer (8 bits) array (rank 1) is positive. |
assert_positive_r32 | tester | Subroutine | Check if a real (32 bits) is positive. |
assert_positive_r32_1 | tester | Subroutine | Check if a real (32 bits) array (rank 1) is positive. |
assert_positive_r64 | tester | Subroutine | Check if a real (64 bits) is positive. |
assert_positive_r64_1 | tester | Subroutine | Check if a real (64 bits) array (rank 1) is positive. |
assign_object | flap_object_t | Subroutine | Assign two abstract objects. |
check | flap_command_line_arguments_group_t | Subroutine | Check data consistency. |
check | flap_command_line_argument_t | Subroutine | Check data consistency. |
check | flap_command_line_interface_t | Subroutine | Check data consistency. |
check_action_consistency | flap_command_line_argument_t | Subroutine | Check CLA action consistency. |
check_choices | flap_command_line_argument_t | Subroutine | Check if CLA value is in allowed choices. |
check_envvar_consistency | flap_command_line_argument_t | Subroutine | Check data consistency for envvar CLA. |
check_list_size | flap_command_line_argument_t | Function | Check CLA multiple values list size consistency. |
check_m_exclude_consistency | flap_command_line_argument_t | Subroutine | Check mutually exclusion consistency. |
check_m_exclusive | flap_command_line_arguments_group_t | Subroutine | Check if two mutually exclusive CLAs have been passed. |
check_m_exclusive | flap_command_line_interface_t | Subroutine | Check if two mutually exclusive CLAs group have been called. |
check_named_consistency | flap_command_line_argument_t | Subroutine | Check named CLA consistency. |
check_optional_consistency | flap_command_line_argument_t | Subroutine | Check optional CLA consistency. |
check_positional_consistency | flap_command_line_argument_t | Subroutine | Check positional CLA consistency. |
cla_assign_cla | flap_command_line_argument_t | Subroutine | Assignment operator. |
clasg_assign_clasg | flap_command_line_arguments_group_t | Subroutine | Assignment operator. |
cli_assign_cli | flap_command_line_interface_t | Subroutine | Assignment operator. |
color_index | face | Function | Return the array-index corresponding to the queried color. |
colorize | face | Interface | |
colorize_ascii | face | Function | Colorize and stylize strings, ASCII kind. |
colorize_default | face | Function | Colorize and stylize strings, DEFAULT kind. |
colorize_ucs4 | face | Function | Colorize and stylize strings, UCS4 kind. |
colors_samples | face | Subroutine | Print to standard output all colors samples. |
count | flap_utils_m | Interface | Overload intrinsic function count for counting substring occurences into strings. |
count_substring | flap_utils_m | Function | Count the number of occurences of a substring into a string. |
errored | flap_command_line_arguments_group_t | Subroutine | Trig error occurrence and print meaningful message. |
errored | flap_command_line_argument_t | Subroutine | Trig error occurence and print meaningful message. |
errored | flap_command_line_interface_t | Subroutine | Trig error occurrence and print meaningful message. |
fake_call | flap_test_group | Subroutine | Wrapper for fake calls. |
finalize | flap_command_line_arguments_group_t | Subroutine | Free dynamic memory when finalizing. |
finalize | flap_command_line_argument_t | Subroutine | Free dynamic memory when finalizing. |
finalize | flap_command_line_interface_t | Subroutine | Free dynamic memory when finalizing. |
free | flap_command_line_arguments_group_t | Subroutine | Free dynamic memory. |
free | flap_command_line_argument_t | Subroutine | Free dynamic memory. |
free | flap_command_line_interface_t | Subroutine | Free dynamic memory. |
free_object | flap_object_t | Subroutine | Free dynamic memory. |
get_args_from_invocation | flap_command_line_interface_t | Subroutine | Get CLAs from CLI invocation. |
get_args_from_string | flap_command_line_interface_t | Subroutine | Get CLAs from string. |
get_cla | flap_command_line_argument_t | Subroutine | Get CLA (single) value. |
get_cla | flap_command_line_interface_t | Subroutine | Get CLA (single) value from CLAs list parsed. |
get_cla_from_buffer | flap_command_line_argument_t | Subroutine | Get CLA (single) value from parsed value. |
get_cla_list | flap_command_line_argument_t | Subroutine | Get CLA multiple values. |
get_cla_list | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed. |
get_cla_list_from_buffer | flap_command_line_argument_t | Subroutine | Get CLA multiple values from a buffer. |
get_cla_list_varying_char | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, character. |
get_cla_list_varying_char | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, character. |
get_cla_list_varying_I1P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, integer(I1P). |
get_cla_list_varying_I1P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, integer(I1P). |
get_cla_list_varying_I2P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, integer(I2P). |
get_cla_list_varying_I2P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, integer(I2P). |
get_cla_list_varying_I4P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, integer(I4P). |
get_cla_list_varying_I4P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, integer(I4P). |
get_cla_list_varying_I8P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, integer(I8P). |
get_cla_list_varying_I8P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, integer(I8P). |
get_cla_list_varying_logical | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, logical. |
get_cla_list_varying_logical | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, logical. |
get_cla_list_varying_R16P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, real(R16P). |
get_cla_list_varying_R16P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, real(R16P). |
get_cla_list_varying_R4P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, real(R4P). |
get_cla_list_varying_R4P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, real(R4P). |
get_cla_list_varying_R8P | flap_command_line_argument_t | Subroutine | Get CLA (multiple) value with varying size, real(R8P). |
get_cla_list_varying_R8P | flap_command_line_interface_t | Subroutine | Get CLA multiple values from CLAs list parsed with varying size list, real(R8P). |
get_clasg_indexes | flap_command_line_interface_t | Subroutine | Get the argument indexes of CLAs groups defined parsing the actual passed CLAs. |
has_choices | flap_command_line_argument_t | Function | Return true if CLA has choices. |
init | flap_command_line_interface_t | Subroutine | Initialize CLI. |
init | tester | Subroutine | Initialize the tester. |
is_called_group | flap_command_line_interface_t | Function | Check if a CLAs group has been run. |
is_defined | flap_command_line_arguments_group_t | Function | Check if a CLA has been defined. |
is_defined | flap_command_line_interface_t | Function | Check if a CLA has been defined. |
is_defined_group | flap_command_line_interface_t | Function | Check if a CLAs group has been defined. |
is_parsed | flap_command_line_interface_t | Function | Check if CLI has been parsed. |
is_passed | flap_command_line_arguments_group_t | Function | Check if a CLA has been passed. |
is_passed | flap_command_line_interface_t | Function | Check if a CLA has been passed. |
is_required_passed | flap_command_line_arguments_group_t | Subroutine | Check if required CLAs are passed. |
is_required_passed | flap_command_line_argument_t | Function | Check if required CLA is passed. |
is_required_val_passed | flap_command_line_argument_t | Function | Check if required value of CLA is passed. |
parse | flap_command_line_arguments_group_t | Subroutine | Parse CLAsG arguments. |
parse | flap_command_line_interface_t | Subroutine | Parse Command Line Interfaces by means of a previously initialized CLAs groups list. |
tester | Subroutine | Print tests results. |
|
print_error_message | flap_object_t | Subroutine | Print meaningful error message to standard-error. |
print_usage | flap_command_line_interface_t | Subroutine | Print correct usage. |
print_version | flap_object_t | Subroutine | Print version. |
raise_error_duplicated_clas | flap_command_line_argument_t | Subroutine | Raise error duplicated CLAs passed. |
raise_error_m_exclude | flap_command_line_arguments_group_t | Subroutine | Raise error mutually exclusive CLAs passed. |
raise_error_m_exclude | flap_command_line_argument_t | Subroutine | Raise error mutually exclusive CLAs passed. |
raise_error_nargs_insufficient | flap_command_line_argument_t | Subroutine | Raise error insufficient number of argument values passed. |
raise_error_switch_unknown | flap_command_line_argument_t | Subroutine | Raise error switch_unknown. |
raise_error_value_missing | flap_command_line_argument_t | Subroutine | Raise error missing value. |
replace | flap_utils_m | Function | Replace substring (only first occurrence) into a string. |
replace_all | flap_utils_m | Function | Replace substring (all occurrences) into a string. |
sanitize_defaults | flap_command_line_arguments_group_t | Subroutine | Sanitize defaults values. |
sanitize_defaults | flap_command_line_argument_t | Subroutine | Sanitize defaults values. |
save_bash_completion | flap_command_line_interface_t | Subroutine | Save bash completion script (for named CLAs only). |
save_man_page | flap_command_line_interface_t | Subroutine | Save CLI usage as man page. |
save_usage_to_markdown | flap_command_line_interface_t | Subroutine | Save CLI usage as markdown. |
set_examples | flap_object_t | Subroutine | Set examples of correct usage. |
set_mutually_exclusive_groups | flap_command_line_interface_t | Subroutine | Set two CLAs group ad mutually exclusive. |
signature | flap_command_line_arguments_group_t | Function | Get CLAsG signature. |
signature | flap_command_line_argument_t | Function | Get signature. |
signature | flap_command_line_interface_t | Function | Get signature. |
style_index | face | Function | Return the array-index corresponding to the queried style. |
styles_samples | face | Subroutine | Print to standard output all styles samples. |
tokenize | flap_utils_m | Subroutine | Tokenize a string in order to parse it. |
unique | flap_utils_m | Function | Reduce to one (unique) multiple (sequential) occurrences of a characters substring into a string. |
upper | face | Function | Return a string with all uppercase characters. |
upper_case | flap_utils_m | Function | Convert the lower case characters of a string to upper case one. |
usage | flap_command_line_arguments_group_t | Function | Get correct CLAsG usage. |
usage | flap_command_line_argument_t | Function | Get correct usage. |
usage | flap_command_line_interface_t | Function | Print correct usage of CLI. |
wstrip | flap_utils_m | Function | Strip out leading and trailing white spaces from a string. |