+
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
ensure
  • not is_set
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
set_data (context: COMMAND_LINE_CONTEXT, data: STRING)
effective procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require
  • is_valid_data(data)
ensure
  • is_set_at(context)
decode (data: STRING): E_
deferred function
{}
top
require
count: INTEGER_32
effective function
{ANY}
top
Number of available items in the hoard.
See also is_empty
ensure
  • Result >= 0
is_empty: BOOLEAN
effective function
{ANY}
top
Is the hoard empty ?
See also count.
ensure
  • definition: Result = count = 0
lower: INTEGER_32
effective function
{ANY}
top
Minimum index.
See also upper, valid_index, item.
upper: INTEGER_32
effective function
{ANY}
top
Maximum index.
See also lower, valid_index, item.
item (i: INTEGER_32): E_
effective function
{ANY}
top
Item at the corresponding index i.
See also lower, upper, valid_index.
require
  • valid_index(i)
first: E_
effective function
{ANY}
top
The very first item.
See also last, item.
require
  • not is_empty
ensure
  • definition: Result = item(lower)
last: E_
effective function
{ANY}
top
The last item.
See also first, item.
require
  • not is_empty
ensure
  • definition: Result = item(upper)
new_iterator: ITERATOR[E_]
effective function
{ANY}
top
ensure
  • Result /= Void
  • Result.generation = generation
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
require
  • a_short /= Void implies a_short.count = 1
  • a_short /= Void or else a_long /= Void
  • a_name /= Void
ensure
  • is_optional
  • a_short /= Void implies short.is_equal(a_short)
  • a_long /= Void implies long.is_equal(a_long)
  • name.is_equal(a_name)
  • a_usage /= Void implies usage.is_equal(a_usage)
positional (a_name: ABSTRACT_STRING, a_usage: ABSTRACT_STRING)
effective procedure
{}
top
require
  • a_name /= Void
ensure
  • is_positional
  • is_mandatory
  • name.is_equal(a_name)
  • a_usage /= Void implies usage.is_equal(a_usage)
enumerate: ENUMERATE[E_]
effective function
{ANY}
top
get_new_iterator: ITERATOR[E_]
frozen
effective function
{ANY}
top
This feature is obsolete: Use `new_iterator' instead. This historical SmartEiffel feature is badly named.
for_each (action: PROCEDURE[TUPLE[TUPLE 1[E_]]])
effective procedure
{ANY}
top
Apply action to every item of Current.
See also for_all, exists, aggregate.
require
  • action /= Void
for_all (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Do all items satisfy test?
See also for_each, exists, aggregate.
require
  • test /= Void
exists (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Does at least one item satisfy test?
See also for_each, for_all, aggregate.
require
  • test /= Void
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.
See also for_each, for_all, exists.
require
  • action /= Void
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
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))
generation: INTEGER_32
writable attribute
{ANY}
top
next_generation
effective procedure
{}
top
ensure
do_all (action: ROUTINE[TUPLE[TUPLE 1[E_]]])
frozen
effective procedure
{ANY}
top
Apply action to every item of Current.
This feature is obsolete: Use `for_each` instead. This feature is not secure because it accepts a FUNCTION, the result of which is lost.
_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).
See also lower, upper, item.
ensure
as_mandatory: CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option mandatory (default for positionals)
require ensure
prefix "+": CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option mandatory (default for positionals)
require ensure
as_optional: CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option optional (default for options)
require ensure
prefix "-": CLARG_WITH_ARGS [E_]
effective function
{ANY}
top
Make the option optional (default for options)
require ensure
is_mandatory: BOOLEAN
deferred function
{ANY}
top
True if the argument must be set at least once.
ensure
is_optional: BOOLEAN
deferred function
{ANY}
top
True if the argument may not be set.
ensure
is_positional: BOOLEAN
deferred function
{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
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
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
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
require
set_mandatory (parent_option: CLARG_WITH_ARGS [E_], enable: BOOLEAN)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require ensure
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.
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
parse_command_line (context: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
deferred function
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
require
  • context.is_parsed
usage_summary (stream: OUTPUT_STREAM)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
ensure
usage_details (stream: OUTPUT_STREAM)
deferred procedure
{COMMAND_LINE_ARGUMENTS, COMMAND_LINE_ARGUMENT}
top
ensure
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
require
effective function
{}
top
require
effective function
{}
top
require
set_data_ (context: COMMAND_LINE_CONTEXT, data: STRING)
effective procedure
{CLARG_PARSER}
top
require
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).
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