+
Point of view
All features
deferred class CLARG_WITH_ARGS [E_]
Summary
top
Direct parents
Inherit list: COMMAND_LINE_TYPED_ARGUMENT, TRAVERSABLE
Insert list: CLARG_PARSER
Known children
Inherit list: CLARG_CUSTOMS, CLARG_INTEGERS, CLARG_STRINGS
Class invariant
top
Overview
top
Features
{ANY}
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
{}
{ANY}
{}
{ANY}
Other features:
{ANY}
Agent-based features:
{ANY}
Printing:
{ANY}
{ANY}
{}
Agent-based features:
{ANY}
{}
Indexing:
{ANY}
{ANY}
  • as_mandatory: CLARG_WITH_ARGS [E_]
    Make the option mandatory (default for positionals)
  • prefix "+": CLARG_WITH_ARGS [E_]
    Make the option mandatory (default for positionals)
  • as_optional: CLARG_WITH_ARGS [E_]
    Make the option optional (default for options)
  • prefix "-": CLARG_WITH_ARGS [E_]
    Make the option optional (default for options)
{ANY}
{ANY}
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
{}
  • parent: CLARG_WITH_ARGS [E_]
    Internal technical trick to ensure that arguments with a non-standard behaviour (set_mandatory) are correctly managed.
{ANY}
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
{}
{ANY}
parsing
{}
{CLARG_PARSER}
{ANY}
{}
Implementation of ARGUMENTS (do not use directly):
{}
patterns
{}
queries
{}
usage output helpers
{}
items: TRAVERSABLE[E_]
effective function
{ANY}
top
The argument value, if is_set
is_repeatable: BOOLEAN
is True
constant attribute
{ANY}
top
True if the argument is repeatable; False if unique.
is_set: BOOLEAN
effective function
{ANY}
top
True if the option is present and correct.
prepare_parse
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
is_set_at (context: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
True if the option is present and correct at the given context.
undo_parse (context: COMMAND_LINE_CONTEXT)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
set_data (context: COMMAND_LINE_CONTEXT, data: STRING)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
decode (data: STRING): E_
deferred function
{}
top
count: INTEGER_32
effective function
{ANY}
top
Number of available items in the hoard.
is_empty: BOOLEAN
effective function
{ANY}
top
Is the hoard empty ?
See also count.
lower: INTEGER_32
effective function
{ANY}
top
Minimum index.
upper: INTEGER_32
effective function
{ANY}
top
Maximum index.
item (i: INTEGER_32): E_
effective function
{ANY}
top
Item at the corresponding index i.
first: E_
effective function
{ANY}
top
The very first item.
last: E_
effective function
{ANY}
top
The last item.
new_iterator: ITERATOR[E_]
effective function
{ANY}
top
set: AVL_DICTIONARY[E_, COMMAND_LINE_CONTEXT]
writable attribute
{}
top
optional (a_short: ABSTRACT_STRING, a_long: ABSTRACT_STRING, a_name: ABSTRACT_STRING, a_usage: ABSTRACT_STRING)
effective procedure
{}
top
positional (a_name: ABSTRACT_STRING, a_usage: ABSTRACT_STRING)
effective procedure
{}
top
enumerate: ENUMERATE[E_]
effective function
{ANY}
top
get_new_iterator: ITERATOR[E_]
frozen
effective function
{ANY}
top
for_each (action: PROCEDURE[TUPLE[TUPLE 1[E_]]])
effective procedure
{ANY}
top
Apply action to every item of Current.
for_all (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Do all items satisfy test?
exists (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Does at least one item satisfy test?
aggregate (action: FUNCTION[TUPLE[TUPLE 2[E_, E_], E_]], initial: E_): E_
effective function
{ANY}
top
Aggregate all the elements starting from the initial value.
out_in_tagged_out_memory
effective procedure
{ANY}
top
Append terse printable representation of current object in tagged_out_memory.
generation: INTEGER_32
writable attribute
{ANY}
top
next_generation
effective procedure
{}
top
do_all (action: ROUTINE[TUPLE[TUPLE 1[E_]]])
frozen
effective procedure
{ANY}
top
Apply action to every item of Current.
_inline_agent1 (a: ROUTINE[TUPLE[TUPLE 1[E_]]], e: E_)
frozen
effective procedure
{}
top
valid_index (i: INTEGER_32): BOOLEAN
effective function
{ANY}
top
True when i is valid (i.e., inside actual bounds).
as_mandatory: CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option mandatory (default for positionals)
prefix "+": CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option mandatory (default for positionals)
as_optional: CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option optional (default for options)
prefix "-": CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option optional (default for options)
is_mandatory: BOOLEAN
deferred function
{ANY}
top
True if the argument must be set at least once.
is_optional: BOOLEAN
deferred function
{ANY}
top
True if the argument may not be set.
is_positional: BOOLEAN
deferred function
{ANY}
top
True if the argument is not introduced by a flag.
can_be_mandatory: BOOLEAN
deferred function
{ANY}
top
True if the argument can be set_mandatory(True).
can_be_optional: BOOLEAN
deferred function
{ANY}
top
True if the argument can be set_mandatory(False).
short: FIXED_STRING
deferred function
{ANY}
top
The short (one-letter) option flag introducing the argument, Void for positionals
deferred function
{ANY}
top
The long option flag introducing the argument, Void for positionals
usage: FIXED_STRING
deferred function
{ANY}
top
The option usage
force_index (a_index: INTEGER_32)
deferred procedure
{ANY}
top
Force a positional parameter to be valid only at the given index
set_mandatory (parent_option: CLARG_WITH_ARGS [E_], enable: BOOLEAN)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
parent: CLARG_WITH_ARGS [E_]
deferred function
{}
top
Internal technical trick to ensure that arguments with a non-standard behaviour (set_mandatory) are correctly managed.
effective function
{ANY}
top
Arguments disjunction.
infix "or else" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
Arguments disjunction.
effective function
{ANY}
top
Arguments conjunction.
infix "and then" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
Arguments conjunction.
prefix "not": COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
(tentative; don't use it, the semantics is not well defined)
parse_command_line (context: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
deferred function
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
usage_summary (stream: OUTPUT_STREAM)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
usage_details (stream: OUTPUT_STREAM)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
detailed: BOOLEAN
deferred function
{}
top
writable attribute
{ANY}
top
index: INTEGER_32
writable attribute
{ANY}
top
parse_positional (context: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
{}
top
effective function
{}
top
effective function
{}
top
set_data_ (context: COMMAND_LINE_CONTEXT, data: STRING)
effective procedure
{CLARG_PARSER}
top
is_valid_data (data: STRING): BOOLEAN
deferred function
{CLARG_PARSER}
top
argument_count: INTEGER_32
effective function
{ANY}
top
Number of arguments given to command that started system execution (command name does not count).
argument (i: INTEGER_32): STRING
effective function
{ANY}
top
i th argument of command that started system execution Gives the command name if i is 0.
command_name: STRING
effective function
{ANY}
top
command_arguments: FAST_ARRAY[STRING]
frozen
once function
{}
top
Give access to arguments command line including the command name at index 0.
se_argc: INTEGER_32
{}
top
To implement command_arguments
se_argv (i: INTEGER_32): STRING
{}
top
To implement command_arguments
short_pattern: REGULAR_EXPRESSION
once function
{}
top
long_pattern: REGULAR_EXPRESSION
once function
{}
top
long_equal_pattern: REGULAR_EXPRESSION
once function
{}
top
is_short (arg: STRING, a_index: INTEGER_32): BOOLEAN
effective function
{}
top
is_long (arg: STRING): BOOLEAN
effective function
{}
top
is_long_equal (arg: STRING): BOOLEAN
effective function
{}
top
put_short (stream: OUTPUT_STREAM)
effective procedure
{}
top
put_long (stream: OUTPUT_STREAM)
effective procedure
{}
top