Automatic generation produced by ISE Eiffel
note description: "[ Objects that launch an arbitrary command in a separate process and provide in- and output support routines. ]" author: "" date: "$Date: 2013-12-26 16:25:42 -0900 (Thu, 26 Dec 2013) $" revision: "$Revision: 93822 $" class interface EQA_EXECUTION create make (a_test_set: like test_set; a_command: READABLE_STRING_GENERAL) -- Initialize Current. -- -- a_test_set: Test set for which Current will be used. -- a_command: Executable name require an_environment_attached: a_test_set /= Void feature -- Access command: IMMUTABLE_STRING_32 -- Executable name error_file_name: detachable IMMUTABLE_STRING_32 -- File to which error output will be printed -- -- Note: if error_file and `error_processor` are void at the time the Current is launched, -- the error output will be redirected to the regular output error_processor: detachable EQA_SYSTEM_OUTPUT_PROCESSOR -- Processor analysing errors, Void if errors should not be analysed -- -- Note: if `error_file_name` and `error_processor` are void at the time the Current is launched, -- the error output will be redirected to the regular output exit_code: INTEGER_32 -- Exit code process has returned. require exited: has_exited generating_type: TYPE [detachable EQA_EXECUTION] -- 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 input_file_name: detachable IMMUTABLE_STRING_32 -- File from which input will be read, Void if input is not read from a file output_file_name: detachable IMMUTABLE_STRING_32 -- File to which output will be printed, Void if output should be stored output_processor: detachable EQA_SYSTEM_OUTPUT_PROCESSOR -- Processor analysing output, Void if output should not be analysed test_set: EQA_SYSTEM_TEST_SET -- Test set for which Current is used working_directory: IMMUTABLE_STRING_32 -- Working directory in which process is launched 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: EQA_EXECUTION): 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: EQA_EXECUTION): 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: EQA_EXECUTION): 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 has_exited: BOOLEAN -- Has system exited yet? require launched: is_launched ensure result_implies_status_attached: Result implies process = Void is_launched: BOOLEAN -- Has system been launched yet? 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_error_file_name (a_error_file_name: detachable READABLE_STRING_GENERAL) -- Set `error_file_name` to a_error_file_name. require not_launched: not is_launched a_error_file_name_not_empty: a_error_file_name /= Void implies not a_error_file_name.is_empty ensure error_file_name_set: a_error_file_name /= Void implies (attached error_file_name as l_path and then l_path.same_string_general (a_error_file_name)) error_file_name_unset: a_error_file_name = Void implies error_file_name = Void set_error_file_path (a_error_file_name: detachable PATH) -- Set `error_file_name` to a_error_file_name. require not_launched: not is_launched a_error_file_name_not_empty: a_error_file_name /= Void implies not a_error_file_name.is_empty ensure error_file_name_set: a_error_file_name /= Void implies (attached error_file_name as l_path and then l_path.same_string (a_error_file_name.name)) error_file_name_unset: a_error_file_name = Void implies error_file_name = Void set_error_path (a_path: EQA_SYSTEM_PATH) -- Set `error_file_name` to file in `output_directory` with a_path appended. require not_launched: not is_launched a_path_attached: a_path /= Void a_path_not_empty: not a_path.is_empty ensure error_file_name_set: attached error_file_name as l_file_name and then l_file_name.same_string (test_set.file_system.build_path (output_directory, a_path)) set_error_processor (a_error_processor: like error_processor) -- Set `error_processor` to a_error_processor. require not_launched: not is_launched ensure error_processor_set: error_processor = a_error_processor set_input_file_name (a_input_file_name: detachable READABLE_STRING_GENERAL) -- Set `input_file_name` to a_input_file_name. require not_launched: not is_launched a_input_file_name_not_empty: a_input_file_name /= Void implies not a_input_file_name.is_empty ensure input_file_name_set: a_input_file_name /= Void implies (attached input_file_name as l_path and then l_path.same_string_general (a_input_file_name)) input_file_name_unset: a_input_file_name = Void implies input_file_name = Void set_input_file_path (a_input_file_name: detachable PATH) -- Set `input_file_name` to a_input_file_name. require not_launched: not is_launched a_input_file_name_not_empty: a_input_file_name /= Void implies not a_input_file_name.is_empty ensure input_file_name_set: a_input_file_name /= Void implies (attached input_file_name as l_path and then l_path.same_string (a_input_file_name.name)) input_file_name_unset: a_input_file_name = Void implies input_file_name = Void set_input_path (a_path: EQA_SYSTEM_PATH) -- Set `input_file_name` to file in the source directory with a_path appended. require not_launched: not is_launched a_path_attached: a_path /= Void a_path_not_empty: not a_path.is_empty ensure input_file_name_set: attached input_file_name as l_file_name and then l_file_name.same_string (test_set.file_system.build_source_path (a_path)) set_output_file_name (a_output_file_name: detachable READABLE_STRING_GENERAL) -- Set `output_file_name` to a_output_file_name. require not_launched: not is_launched a_output_file_name_not_empty: a_output_file_name /= Void implies not a_output_file_name.is_empty ensure output_file_name_set: a_output_file_name /= Void implies (attached output_file_name as l_path and then l_path.same_string_general (a_output_file_name)) output_file_name_unset: a_output_file_name = Void implies output_file_name = Void set_output_file_path (a_output_file_name: detachable PATH) -- Set `output_file_name` to a_output_file_name. require not_launched: not is_launched a_output_file_name_not_empty: a_output_file_name /= Void implies not a_output_file_name.is_empty ensure output_file_name_set: a_output_file_name /= Void implies (attached output_file_name as l_path and then l_path.same_string (a_output_file_name.name)) output_file_name_unset: a_output_file_name = Void implies output_file_name = Void set_output_path (a_path: EQA_SYSTEM_PATH) -- Set `output_file_name` to file in `output_directory` with a_path appended. require not_launched: not is_launched a_path_attached: a_path /= Void a_path_not_empty: not a_path.is_empty ensure output_file_name_set: attached output_file_name as l_file_name and then l_file_name.same_string (test_set.file_system.build_path (output_directory, a_path)) set_output_processor (a_output_processor: like output_processor) -- Set `output_processor` to a_output_processor. require not_launched: not is_launched ensure output_processor_set: output_processor = a_output_processor set_working_directory (a_working_directory: READABLE_STRING_GENERAL) -- Set `working_directory` to a_working_directory. require a_working_directory_attached: a_working_directory /= Void not_launched: not is_launched ensure working_directory_set: working_directory.same_string_general (a_working_directory) feature -- Element change add_argument (a_argument: READABLE_STRING_GENERAL) -- Add a_arguments to end of `arguments`. require a_argument_attached: a_argument /= Void not_launched: not is_launched a_argument_not_empty: not a_argument.is_empty ensure arguments_count_increased: arguments.count = old arguments.count + 1 a_argument_last: arguments.last.same_string (a_argument) clear_argument -- Wipe out `arguments` feature -- Duplication copy (other: EQA_EXECUTION) -- 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: EQA_EXECUTION) -- 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: EQA_EXECUTION -- 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: EQA_EXECUTION) -- 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: EQA_EXECUTION -- 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: EQA_EXECUTION -- 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 EQA_EXECUTION -- 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 launch -- Launch system. require not_launched: not is_launched ensure launched: is_launched process_output -- Check if any output has been received from system and process it if so. require launched: is_launched not_exited: not has_exited process_output_until_exit -- Process all output received from system until system terminates. require launched: is_launched not_exited: not has_exited ensure exited: has_exited put_string (a_input: READABLE_STRING_8) -- Send input to process. -- -- a_input: Input to be sent to process. require launched: is_launched not_exited: not has_exited input_file_name_detached: input_file_name = Void feature -- Constants Default_output_directory: STRING_32 = "output" Output_path_key: STRING_32 = "OUTPUT_PATH" 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 running_implies_status_attached: (is_launched and not has_exited) implies process /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2013, 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 EQA_EXECUTION -- Generated by Eiffel Studio --
For more details: eiffel.org