class CLARG_BOOLEAN
Summary
Direct parents
Inherit list: COMMAND_LINE_TYPED_ARGUMENT
Insert list: ARGUMENTS, CLARG_OPTIONS
Class invariant
Overview
Creation features
{COMMAND_LINE_ARGUMENT_FACTORY}
Features
{ANY}
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
{}
{ANY}
  • as_mandatory: CLARG_BOOLEAN
    Make the option mandatory (default for positionals)
  • prefix "+": CLARG_BOOLEAN
    Make the option mandatory (default for positionals)
  • as_optional: CLARG_BOOLEAN
    Make the option optional (default for options)
  • prefix "-": CLARG_BOOLEAN
    Make the option optional (default for options)
{ANY}
  • short: FIXED_STRING
    The short (one-letter) option flag introducing the argument, Void for positionals
  • long: FIXED_STRING
    The long option flag introducing the argument, Void for positionals
{ANY}
{ANY}
{}
Implementation of ARGUMENTS (do not use directly):
{}
patterns
{}
queries
{}
usage output helpers
{}
item: BOOLEAN
writable attribute
{ANY}
The argument value, if is_set
usage: FIXED_STRING
writable attribute
{ANY}
The option usage
is_mandatory: BOOLEAN
is False
constant attribute
{ANY}
True if the argument must be set at least once.
can_be_mandatory: BOOLEAN
is False
constant attribute
{ANY}
True if the argument can be set_mandatory(True).
is_optional: BOOLEAN
is True
constant attribute
{ANY}
True if the argument may not be set.
can_be_optional: BOOLEAN
is True
constant attribute
{ANY}
True if the argument can be set_mandatory(False).
is_positional: BOOLEAN
is False
constant attribute
{ANY}
True if the argument is not introduced by a flag.
is_repeatable: BOOLEAN
is False
constant attribute
{ANY}
True if the argument is repeatable; False if unique.
is_set: BOOLEAN
effective function
{ANY}
True if the option is present and correct.
force_index (a_index: INTEGER_32)
effective procedure
{ANY}
Force a positional parameter to be valid only at the given index
out_in_tagged_out_memory
effective procedure
{ANY}
Append terse printable representation of current object in tagged_out_memory.
prepare_parse
effective procedure
parse_command_line (context: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
is_set_at (context: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
True if the option is present and correct at the given context.
undo_parse (context: COMMAND_LINE_CONTEXT)
effective procedure
usage_summary (stream: OUTPUT_STREAM)
effective procedure
usage_details (stream: OUTPUT_STREAM)
effective procedure
set_mandatory (parent_option: CLARG_BOOLEAN, enable: BOOLEAN)
effective procedure
make (a_short: ABSTRACT_STRING, a_long: ABSTRACT_STRING, a_usage: ABSTRACT_STRING)
effective procedure
{}
parent: CLARG_BOOLEAN
writable attribute
{}
Internal technical trick to ensure that arguments with a non-standard behaviour (set_mandatory) are correctly managed.
detailed: BOOLEAN
writable attribute
{}
as_mandatory: CLARG_BOOLEAN
effective function
{ANY}
Make the option mandatory (default for positionals)
prefix "+": CLARG_BOOLEAN
effective function
{ANY}
Make the option mandatory (default for positionals)
as_optional: CLARG_BOOLEAN
effective function
{ANY}
Make the option optional (default for options)
prefix "-": CLARG_BOOLEAN
effective function
{ANY}
Make the option optional (default for options)
short: FIXED_STRING
deferred function
{ANY}
The short (one-letter) option flag introducing the argument, Void for positionals
deferred function
{ANY}
The long option flag introducing the argument, Void for positionals
effective function
{ANY}
Arguments disjunction.
infix "or else" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
Arguments disjunction.
effective function
{ANY}
Arguments conjunction.
infix "and then" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
Arguments conjunction.
prefix "not": COMMAND_LINE_ARGUMENT
effective function
{ANY}
(tentative; don't use it, the semantics is not well defined)
argument_count: INTEGER_32
effective function
{ANY}
Number of arguments given to command that started system execution (command name does not count).
argument (i: INTEGER_32): STRING
effective function
{ANY}
i th argument of command that started system execution Gives the command name if i is 0.
command_name: STRING
effective function
{ANY}
command_arguments: FAST_ARRAY[STRING]
frozen
once function
{}
Give access to arguments command line including the command name at index 0.
se_argc: INTEGER_32
{}
To implement command_arguments
se_argv (i: INTEGER_32): STRING
{}
To implement command_arguments
short_pattern: REGULAR_EXPRESSION
once function
{}
long_pattern: REGULAR_EXPRESSION
once function
{}
long_equal_pattern: REGULAR_EXPRESSION
once function
{}
is_short (arg: STRING, a_index: INTEGER_32): BOOLEAN
effective function
{}
is_long (arg: STRING): BOOLEAN
effective function
{}
is_long_equal (arg: STRING): BOOLEAN
effective function
{}
put_short (stream: OUTPUT_STREAM)
effective procedure
{}
put_long (stream: OUTPUT_STREAM)
effective procedure
{}