Automatic generation produced by ISE Eiffel
note description: "[ Objects representing delayed calls to a function, with some arguments possibly still open. Note: Features are the same as those of ROUTINE, with `apply` made effective, and the addition of `last_result` and `item`. ]" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2021-10-03 23:28:32 -0800 (Sun, 03 Oct 2021) $" revision: "$Revision: 105810 $" class interface FUNCTION [OPEN_ARGS -> detachable TUPLE create default_create end, RESULT_TYPE -> ] create {NONE} set_rout_disp (a_rout_disp, a_encaps_rout_disp, a_calc_rout_addr: POINTER; a_routine_id: INTEGER_32; a_open_map: like open_map; a_is_basic, a_is_target_closed: BOOLEAN; a_written_type_id_inline_agent: INTEGER_32; a_closed_operands: TUPLE; a_open_count: INTEGER_32) -- Initialize object in workbench mode. -- (from ROUTINE) require -- from ROUTINE a_routine_id_valid: a_routine_id > -1 target_valid: a_is_target_closed implies valid_target (a_closed_operands) set_rout_disp_final (a_rout_disp, a_encaps_rout_disp, a_calc_rout_addr: POINTER; a_closed_operands: TUPLE; a_is_target_closed: BOOLEAN; a_open_count: INTEGER_32) -- Initialize object in finalized mode. -- (from ROUTINE) require -- from ROUTINE target_valid: a_is_target_closed implies valid_target (a_closed_operands) feature -- Initialization adapt (other: FUNCTION [OPEN_ARGS, RESULT_TYPE]) -- Initialize from other. -- Useful in descendants. -- (from ROUTINE) require -- from ROUTINE other_exists: other /= Void conforming: conforms_to (other) feature -- Access apply -- Call function with `operands` as last set. require -- from ROUTINE valid_operands: valid_operands (operands) call (args: detachable separate OPEN_ARGS) -- Call routine with args. require -- from ROUTINE valid_operands: valid_operands (args) generating_type: TYPE [detachable FUNCTION [OPEN_ARGS, RESULT_TYPE]] -- 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 hash_code: INTEGER_32 -- Hash code value. -- (from ROUTINE) ensure -- from HASHABLE good_hash_value: Result >= 0 item alias "()" (args: detachable separate OPEN_ARGS): RESULT_TYPE -- Result of calling function with args as operands. require valid_operands: valid_operands (args) last_result: detachable RESULT_TYPE -- Result of last call, if any frozen operands: detachable OPEN_ARGS -- (from ROUTINE) postcondition (args: like operands): BOOLEAN -- Does current state satisfy routine's -- postcondition for args? -- (from ROUTINE) precondition (args: like operands): BOOLEAN -- Do args satisfy routine's precondition -- in current state? -- (from ROUTINE) target: detachable ANY -- Target of call, if already known -- (from ROUTINE) feature -- Measurement open_count: INTEGER_32 -- Number of open operands. -- (from ROUTINE) 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: FUNCTION [OPEN_ARGS, RESULT_TYPE]): 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: like Current): BOOLEAN -- Is associated function the same as the one -- associated with other? 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: FUNCTION [OPEN_ARGS, RESULT_TYPE]): 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 Callable: BOOLEAN = True -- Can routine be called on current object? -- (from ROUTINE) 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 is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_target_closed: BOOLEAN -- Is target for current agent closed, i.e. specified at creation time? -- (from ROUTINE) 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)) valid_operands (args: detachable separate TUPLE): BOOLEAN -- Are args valid operands for this routine? -- (from ROUTINE) valid_target (args: detachable TUPLE): BOOLEAN -- Is the first element of tuple args a valid target -- (from ROUTINE) feature -- Removal clear_last_result -- Reset content of `last_result` to its default value. feature -- Duplication copy (other: like Current) -- Use same function as other. require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other ensure then -- from ROUTINE same_call_status: other.Callable implies Callable frozen deep_copy (other: FUNCTION [OPEN_ARGS, RESULT_TYPE]) -- 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: FUNCTION [OPEN_ARGS, RESULT_TYPE] -- 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: FUNCTION [OPEN_ARGS, RESULT_TYPE]) -- 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: FUNCTION [OPEN_ARGS, RESULT_TYPE] -- 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: FUNCTION [OPEN_ARGS, RESULT_TYPE] -- 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 FUNCTION [OPEN_ARGS, RESULT_TYPE] -- 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 -- Correction correct_mismatch -- Attempt to correct object mismatch using `mismatch_information`. -- (from ROUTINE) Mismatch_information: MISMATCH_INFORMATION -- Original attribute values of mismatched object -- (from MISMATCH_CORRECTOR) feature -- Extended operations flexible_call (a: detachable separate TUPLE) -- Call routine with arguments a. -- Compared to `call` the type of a may be different from `{FUNCTION [Generic #1, Generic #2]}`. -- (from ROUTINE) require -- from ROUTINE valid_operands: valid_operands (a) flexible_item (a: detachable separate TUPLE): RESULT_TYPE -- Result of calling function with a as arguments. -- Compared to `item` the type of a may be different from `{FUNCTION [Generic #1, Generic #2]}`. require valid_operands: valid_operands (a) 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 feature -- Settings frozen set_operands (args: detachable OPEN_ARGS) -- Use args as operands for next call. -- (from ROUTINE) require -- from ROUTINE valid_operands: valid_operands (args) ensure -- from ROUTINE operands_set: (operands /= Void implies (operands ~ args)) or (operands = Void implies (args = Void or else args.is_empty)) set_target (a_target: like target) -- Set a_target as the next `target` for remaining calls to Current. -- (from ROUTINE) require -- from ROUTINE a_target_not_void: a_target /= Void is_target_closed: is_target_closed target_not_void: target /= Void same_target_type: attached target as t and then t.same_type (a_target) ensure -- from ROUTINE target_set: target = a_target invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2017, 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 FUNCTION -- Generated by Eiffel Studio --
For more details: eiffel.org