+
Point of view
All features
class CLARG_COUNTER
Summary
top
Direct parents
Inherit list: COMMAND_LINE_TYPED_ARGUMENT
Insert list: ARGUMENTS, CLARG_OPTIONS
Class invariant
top
Overview
top
Creation features
{COMMAND_LINE_ARGUMENT_FACTORY}
Features
{ANY}
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
{}
{ANY}
  • as_mandatory: CLARG_COUNTER
    Make the option mandatory (default for positionals)
  • prefix "+": CLARG_COUNTER
    Make the option mandatory (default for positionals)
  • as_optional: CLARG_COUNTER
    Make the option optional (default for options)
  • prefix "-": CLARG_COUNTER
    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: INTEGER_32
effective function
{ANY}
top
The argument value, if is_set
usage: FIXED_STRING
writable attribute
{ANY}
top
The option usage
is_mandatory: BOOLEAN
is False
constant attribute
{ANY}
top
True if the argument must be set at least once.
ensure
  • Result implies can_be_mandatory
can_be_mandatory: BOOLEAN
is False
constant attribute
{ANY}
top
True if the argument can be set_mandatory(True).
is_optional: BOOLEAN
is True
constant attribute
{ANY}
top
True if the argument may not be set.
ensure
  • Result implies not is_positional
  • is_mandatory implies not Result
  • Result implies can_be_optional
can_be_optional: BOOLEAN
is True
constant attribute
{ANY}
top
True if the argument can be set_mandatory(False).
is_positional: BOOLEAN
is False
constant attribute
{ANY}
top
True if the argument is not introduced by a flag.
Such an argument is mandatory and may have an explicit position on the command line (see force_index).
ensure
  • Result implies not is_optional
  • Result implies is_mandatory
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.
force_index (a_index: INTEGER_32)
effective procedure
{ANY}
top
Force a positional parameter to be valid only at the given index
require
  • a_index > 0
  • is_positional
  • not is_repeatable
out_in_tagged_out_memory
effective procedure
{ANY}
top
Append terse printable representation of current object in tagged_out_memory.
require
    • locked: tagged_out_locked
    • locked: tagged_out_locked
ensure
  • still_locked: tagged_out_locked
  • not_cleared: tagged_out_memory.count >= old tagged_out_memory.count
  • append_only: old tagged_out_memory.twin.is_equal(tagged_out_memory.substring(1, old tagged_out_memory.count))
prepare_parse
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
ensure
  • not is_set
parse_command_line (context: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require
  • context.is_parsed
usage_summary (stream: OUTPUT_STREAM)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
ensure
  • not detailed
usage_details (stream: OUTPUT_STREAM)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
ensure
  • detailed
set_mandatory (parent_option: CLARG_COUNTER, enable: BOOLEAN)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require
  • parent_option /= Void
  • enable /= is_mandatory
  • enable implies can_be_mandatory
  • not enable implies can_be_optional
ensure
  • parent = parent_option
  • is_mandatory = enable
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.
require
  • context.is_parsed
ensure
  • Result implies is_set
  • not is_repeatable implies Result = is_set
undo_parse (context: COMMAND_LINE_CONTEXT)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require
  • is_set_at(context)
ensure
  • not is_set_at(context)
  • not is_repeatable implies not is_set
make (a_short: ABSTRACT_STRING, a_long: ABSTRACT_STRING, a_usage: ABSTRACT_STRING)
effective procedure
{}
top
require
  • a_short /= Void implies a_short.count = 1
  • a_short /= Void or else a_long /= Void
ensure
  • a_short /= Void implies short.is_equal(a_short)
  • a_long /= Void implies long.is_equal(a_long)
  • a_usage /= Void implies usage.is_equal(a_usage)
parent: CLARG_COUNTER
writable attribute
{}
top
Internal technical trick to ensure that arguments with a non-standard behaviour (set_mandatory) are correctly managed.
writable attribute
{}
top
detailed: BOOLEAN
writable attribute
{}
top
as_mandatory: CLARG_COUNTER
effective function
{ANY}
top
Make the option mandatory (default for positionals)
require ensure
prefix "+": CLARG_COUNTER
effective function
{ANY}
top
Make the option mandatory (default for positionals)
require ensure
as_optional: CLARG_COUNTER
effective function
{ANY}
top
Make the option optional (default for options)
require ensure
prefix "-": CLARG_COUNTER
effective function
{ANY}
top
Make the option optional (default for options)
require ensure
short: FIXED_STRING
deferred function
{ANY}
top
The short (one-letter) option flag introducing the argument, Void for positionals
ensure
  • is_positional implies Result = Void
  • Result /= Void implies Result.count = 1
deferred function
{ANY}
top
The long option flag introducing the argument, Void for positionals
ensure
  • is_positional implies Result = Void
  • Result /= Void implies not Result.is_empty
effective function
{ANY}
top
Arguments disjunction.
Useful to implement mutually exclusive sets of arguments.
require
  • other /= Void
ensure
  • Result /= Void
infix "or else" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
Arguments disjunction.
Useful to implement mutually exclusive sets of arguments.
require
  • other /= Void
ensure
  • Result /= Void
effective function
{ANY}
top
Arguments conjunction.
All the arguments are checked, in any order.
require
  • other /= Void
ensure
  • Result /= Void
infix "and then" (other: COMMAND_LINE_ARGUMENT): COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
Arguments conjunction.
All the arguments are checked, in any order.
require
  • other /= Void
ensure
  • Result /= Void
prefix "not": COMMAND_LINE_ARGUMENT
effective function
{ANY}
top
(tentative; don't use it, the semantics is not well defined)
ensure
  • Result /= Void
argument_count: INTEGER_32
effective function
{ANY}
top
Number of arguments given to command that started system execution (command name does not count).
ensure
  • Result >= 0
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.
require ensure
  • Result /= Void
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.
This is a once function, so you can modify command-line arguments! (NOTE: just be sure not to remove the first argument, although you may change it)
ensure
  • not Result.is_empty
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
require
is_long (arg: STRING): BOOLEAN
effective function
{}
top
require
is_long_equal (arg: STRING): BOOLEAN
effective function
{}
top
require ensure
put_short (stream: OUTPUT_STREAM)
effective procedure
{}
top
require
put_long (stream: OUTPUT_STREAM)
effective procedure
{}
top
require