note description: "[ Access to command-line arguments. This class may be used as ancestor by classes needing its facilities. ]" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2018-05-18 08:50:43 +0000 (Fri, 18 May 2018) $" revision: "$Revision: 101749 $" class interface ARGUMENTS create default_create feature -- Access argument (i: INTEGER_32): STRING_8 -- i-th argument of command that started system execution -- (the command name if i = 0) require index_large_enough: i >= 0 index_small_enough: i <= argument_count ensure instance_free: class argument_not_void: Result /= Void Argument_array: ARRAY [STRING_8] -- Array containing command name (position 0) and arguments ensure instance_free: class argument_array_not_void: Result /= Void argument_array_compare_objects: Result.object_comparison Command_line: STRING_8 -- Total command line ensure instance_free: class Result.count >= Command_name.count Command_name: STRING_8 -- Name of command that started system execution ensure instance_free: class definition: Result ~ argument (0) feature -- Access: Cursor new_cursor: ITERATION_CURSOR [STRING_8] -- Fresh cursor associated with current structure ensure then instance_free: class feature -- Status report index_of_word_option (opt: STRING_8): INTEGER_32 -- Does command line specify word option opt and, if so, -- at what position? -- If one of the arguments in list of space-separated arguments -- is Xopt, where X is the current Option_sign, -- then index of this argument in list; -- else 0. require opt_non_void: opt /= Void opt_meaningful: not opt.is_empty ensure instance_free: class index_of_beginning_with_word_option (opt: STRING_8): INTEGER_32 -- Does command line specify argument beginning with word -- option opt and, if so, at what position? -- If one of the arguments in list of space-separated arguments -- is Xoptxx, where X is the current Option_sign, 'xx' -- is arbitrary, possibly empty sequence of characters, -- then index of this argument in list; -- else 0. require opt_non_void: opt /= Void opt_meaningful: not opt.is_empty ensure instance_free: class index_of_character_option (o: CHARACTER_8): INTEGER_32 -- Does command line specify character option o and, if so, -- at what position? -- If one of the space-separated arguments is of the form Xxxoyy, -- where X is the current Option_sign, xx and yy -- are arbitrary, possibly empty sequences of characters, -- then index of this argument in list of arguments; -- else 0. require o_non_null: o /= '%U' ensure instance_free: class separate_character_option_value (o: CHARACTER_8): detachable STRING_8 -- The value, if any, specified after character option o on -- the command line. -- This is one of the following (where X is the current -- Option_sign, xx and 'yy' are arbitrary, possibly empty -- sequences of characters): -- val if command line includes two consecutive arguments -- of the form Xxxoyy and val respectively. -- Empty string if command line includes argument Xxxoyy, which is -- either last argument or followed by argument starting with X. -- Void if there is no argument of the form Xxxoyy. require o_non_null: o /= '%U' ensure instance_free: class separate_word_option_value (opt: STRING_8): detachable STRING_8 -- The value, if any, specified after word option opt on the -- command line. -- This is one of the following (where X is the current Option_sign): -- val if command line includes two consecutive arguments -- of the form Xopt and val respectively. -- Empty string if command line includes argument Xopt, which is -- either last argument or followed by argument starting with X. -- Void if no Xopt argument. require opt_non_void: opt /= Void opt_meaningful: not opt.is_empty ensure instance_free: class coalesced_character_option_value (o: CHARACTER_8): detachable STRING_8 -- The value, if any, specified for character option o on -- the command line. -- Defined as follows (where 'X' is the current 'option_sign' and -- 'xx' is an arbitrary, possibly empty sequence of characters): -- val if command line includes an argument of the form Xxxoval -- (this may be an empty string if argument is just Xxxo). -- Void otherwise. require o_non_null: o /= '%U' ensure instance_free: class coalesced_word_option_value (opt: STRING_8): detachable STRING_8 -- The value, if any, specified for word option opt on the -- command line. -- Defined as follows (where X is the current Option_sign): -- val if command line includes an argument of the form Xoptval -- (this may be an empty string if argument is just Xopt). -- Void otherwise. require opt_non_void: opt /= Void opt_meaningful: not opt.is_empty ensure instance_free: class Option_sign: CHARACTER_8_REF -- The character used to signal options on the command line. -- This can be '%U' if no sign is necessary for the argument -- to be an option -- Default is '-' ensure instance_free: class feature -- Status setting set_option_sign (c: CHARACTER_8) -- Make c the option sign. -- Use'%U' if no sign is necessary for the argument to -- be an option ensure instance_free: class feature -- Measurement argument_count: INTEGER_32 -- Number of arguments given to command that started -- system execution (command name does not count) ensure instance_free: class argument_count_positive: Result >= 0 invariant argument_array_consistent: Argument_array ~ internal_argument_array note copyright: "Copyright (c) 1984-2018, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class ARGUMENTS
Generated by ISE EiffelStudio