+
Point of view
All features
expanded class COMMAND_LINE_CONTEXT
Summary
top
Internal command-line parsing context.
Direct parents
Insert list: COMPARABLE, HASHABLE
Class invariant
top
Overview
top
Features
{ANY}
{ANY}
{COMMAND_LINE_ARGUMENTS}
{COMMAND_LINE_ARGUMENT, CLARG_PARSER}
{ANY}
  • is_equal (other: COMMAND_LINE_CONTEXT): BOOLEAN
    Is other attached to an object considered equal to current object?
{ANY}
  • infix "<=" (other: COMMAND_LINE_CONTEXT): BOOLEAN
    Is Current less than or equal other?
  • infix ">" (other: COMMAND_LINE_CONTEXT): BOOLEAN
    Is Current strictly greater than other?
  • infix ">=" (other: COMMAND_LINE_CONTEXT): BOOLEAN
    Is Current greater than or equal than other?
  • in_range (lower: COMMAND_LINE_CONTEXT, upper: COMMAND_LINE_CONTEXT): BOOLEAN
    Return True if Current is in range [lower..upper]
    See also min, max, compare.
  • compare (other: COMMAND_LINE_CONTEXT): INTEGER_32
    If current object equal to other, 0 if smaller, -1; if greater, 1.
  • three_way_comparison (other: COMMAND_LINE_CONTEXT): INTEGER_32
    If current object equal to other, 0 if smaller, -1; if greater, 1.
  • min (other: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
    Minimum of Current and other.
  • max (other: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
    Maximum of Current and other.
  • bounded_by (a_min: COMMAND_LINE_CONTEXT, a_max: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
    A value that is equal to Current if it is between the limits set by a_min and a_max.
hash_code: INTEGER_32
effective function
{ANY}
top
The hash-code value of Current.
ensure
  • good_hash_value: Result >= 0
infix "<" (other: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{ANY}
top
Is Current strictly less than other?
See also >, <=, >=, min, max.
require
  • other_exists: other /= Void
ensure
  • asymmetric: Result implies not other < Current
index: INTEGER_32
writable attribute
{ANY}
top
set to the next argument to read
short_index: INTEGER_32
writable attribute
{ANY}
top
set to the next option parameter position when parsing a short parameters sequence
short_option_index: INTEGER_32
writable attribute
{ANY}
top
position of the short option in the short option sequence
is_parsed: BOOLEAN
effective function
{ANY}
top
True if the parsing may continue.
False if a grave parsing error occurs (such as an option present but with invalid data)
is_short: BOOLEAN
effective function
{ANY}
top
init
effective procedure
{COMMAND_LINE_ARGUMENTS}
top
ensure
set_short (a_short_index: INTEGER_32, a_short_option_index: INTEGER_32)
effective procedure
{COMMAND_LINE_ARGUMENT, CLARG_PARSER}
top
require ensure
set_index (a_index: INTEGER_32)
effective procedure
{COMMAND_LINE_ARGUMENT, CLARG_PARSER}
top
require
  • a_index > 0
ensure
is_equal (other: COMMAND_LINE_CONTEXT): BOOLEAN
deferred function
{ANY}
top
Is other attached to an object considered equal to current object?
require
  • other /= Void
ensure
  • Result implies hash_code = other.hash_code
  • commutative: generating_type = other.generating_type implies Result = other.is_equal(Current)
infix "<=" (other: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{ANY}
top
Is Current less than or equal other?
See also >=, <, >, min, max.
require
  • other_exists: other /= Void
ensure
  • definition: Result = Current < other or is_equal(other)
infix ">" (other: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{ANY}
top
Is Current strictly greater than other?
See also <, >=, <=, min, max.
require
  • other_exists: other /= Void
ensure
  • definition: Result = other < Current
infix ">=" (other: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{ANY}
top
Is Current greater than or equal than other?
See also <=, >, <, min, max.
require
  • other_exists: other /= Void
ensure
  • definition: Result = other <= Current
in_range (lower: COMMAND_LINE_CONTEXT, upper: COMMAND_LINE_CONTEXT): BOOLEAN
effective function
{ANY}
top
Return True if Current is in range [lower..upper]
See also min, max, compare.
ensure
  • Result = Current >= lower and Current <= upper
compare (other: COMMAND_LINE_CONTEXT): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
See also min, max, in_range.
require
  • other_exists: other /= Void
ensure
  • equal_zero: Result = 0 = is_equal(other)
  • smaller_negative: Result = -1 = Current < other
  • greater_positive: Result = 1 = Current > other
three_way_comparison (other: COMMAND_LINE_CONTEXT): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
See also min, max, in_range.
require
  • other_exists: other /= Void
ensure
  • equal_zero: Result = 0 = is_equal(other)
  • smaller_negative: Result = -1 = Current < other
  • greater_positive: Result = 1 = Current > other
min (other: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
{ANY}
top
Minimum of Current and other.
See also max, in_range.
require
  • other /= Void
ensure
  • Result <= Current and then Result <= other
  • compare(Result) = 0 or else other.compare(Result) = 0
max (other: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
{ANY}
top
Maximum of Current and other.
See also min, in_range.
require
  • other /= Void
ensure
  • Result >= Current and then Result >= other
  • compare(Result) = 0 or else other.compare(Result) = 0
bounded_by (a_min: COMMAND_LINE_CONTEXT, a_max: COMMAND_LINE_CONTEXT): COMMAND_LINE_CONTEXT
effective function
{ANY}
top
A value that is equal to Current if it is between the limits set by a_min and a_max.
Otherwise it's a_min if Current is smaller or a_max if Current is greater It's a shortcut for Current.min(a_max).max(a_min) also known as "clamp" in the widespread C library Glib
ensure
  • correctness: Result.in_range(a_min, a_max)