Automatic generation produced by ISE Eiffel
note description: "[ An extended version of {ARGUMENT_TERMINAL_SOURCE} that aguments the terminal command line arguments with a value take from an environment variable. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" class interface ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE create make (a_var_name: READABLE_STRING_8) -- Initializes an argument source with an environment variable. -- -- a_var_name: Name of the environment variable, see variable_name. require a_var_name_attached: attached a_var_name not_a_var_name_is_empty: not a_var_name.is_empty ensure arguments_environment_name_set: arguments_environment_name.same_string (a_var_name) feature -- Access Application: STRING_8 -- The application's location argument -- (from ARGUMENT_SOURCE) ensure -- from ARGUMENT_SOURCE result_attached: Result /= Void not_result_is_empty: not Result.is_empty Application_base: STRING_8 -- The application's base location, or the working directory if the base location cannot -- be determined. -- (from ARGUMENT_SOURCE) ensure -- from ARGUMENT_SOURCE result_attached: Result /= Void not_result_is_empty: not Result.is_empty no_trailing_separator: Result.item (Result.count) /= Operating_environment.Directory_separator result_exists: (create {DIRECTORY}.make (Result) end).exists argument (i: INTEGER_32): STRING_8 -- i-th argument of command that started system execution -- (the command name if i = 0) -- (from ENVIRONMENT_ARGUMENTS) require -- from ENVIRONMENT_ARGUMENTS index_large_enough: i >= 0 index_small_enough: i <= argument_count ensure -- from ENVIRONMENT_ARGUMENTS argument_not_void: Result /= Void generating_type: TYPE [detachable ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty feature -- Measurement argument_count: INTEGER_32 -- Number of arguments given to command that started -- system execution (command name does not count) -- (from ENVIRONMENT_ARGUMENTS) ensure -- from ENVIRONMENT_ARGUMENTS argument_count_positive: Result >= 0 feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void 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. -- (from ENVIRONMENT_ARGUMENTS) require -- from ENVIRONMENT_ARGUMENTS opt_non_void: opt /= Void opt_meaningful: not opt.is_empty is_empty: BOOLEAN -- Indicates if there are no supplied arguments require -- from ARGUMENT_SOURCE True ensure -- from ARGUMENT_SOURCE not_arguments_is_empty: not Result implies not Arguments.is_empty ensure then argument_count_positive: Result implies argument_count > 0 Option_sign: CHARACTER_8_REF -- The character used to signal options on the command line. -- This can be '%U' if no sign is necesary for the argument -- to be an option -- Default is '-' -- (from ENVIRONMENT_ARGUMENTS) same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Status setting set_option_sign (c: CHARACTER_8) -- Make c the option sign. -- Use'%U' if no sign is necesary for the argument to -- be an option -- (from ENVIRONMENT_ARGUMENTS) feature -- Duplication copy (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Implementation Arguments: ARRAY [STRING_8] -- Arguments array extracted from environment -- (from ENVIRONMENT_ARGUMENTS) require -- from ARGUMENT_SOURCE True ensure -- from ARGUMENT_SOURCE result_attached: Result /= Void result_consistent: Result ~ Arguments result_contains_attached_items: Result.for_all (agent (ia_item: STRING_8): BOOLEAN ) feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant arguments_environment_name_attached: attached arguments_environment_name not_arguments_environment_name_is_empty: not arguments_environment_name.is_empty -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from ENVIRONMENT_ARGUMENTS environment_arguments_valid: not Arguments.is_empty implies (argument_count > Terminal_arguments.argument_count and Arguments.lower = Terminal_arguments.argument_count + 1 and Arguments.upper = argument_count) note copyright: "Copyright (c) 1984-2009, Eiffel Software" license: "GPL version 2 (see http://www.eiffel.com/licensing/gpl.txt)" licensing_options: "http://www.eiffel.com/licensing" copying: "[ This file is part of Eiffel Software's Eiffel Development Environment. Eiffel Software's Eiffel Development Environment is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 of the License (available at the URL listed under "license" above). Eiffel Software's Eiffel Development Environment is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Eiffel Software's Eiffel Development Environment; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ]" 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 ARGUMENT_ENVIRONMENT_TERMINAL_SOURCE -- Generated by Eiffel Studio --
For more details: eiffel.org