note description: "Representation of an Eiffel type." library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2020-05-19 14:32:38 +0000 (Tue, 19 May 2020) $" revision: "$Revision: 104260 $" frozen class interface TYPE [G] create {NONE} convert to_string_8: {STRING_8, READABLE_STRING_8}, to_string_32: {STRING_32, READABLE_STRING_32, STRING_GENERAL, READABLE_STRING_GENERAL} feature -- Access generating_type: TYPE [detachable TYPE [G]] -- 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 generic_parameter_type (i: INTEGER_32): TYPE [detachable ANY] -- i-th generic parameter of Eiffel type represented by Current require i_large_enough: i >= 1 i_small_enough: i <= generic_parameter_count ensure generic_parameter_not_void: Result /= Void hash_code: INTEGER_32 -- Hash code value ensure -- from HASHABLE good_hash_value: Result >= 0 name: IMMUTABLE_STRING_8 -- Name of Eiffel type represented by Current, using Eiffel style guidelines -- as specified in OOSC2 (e.g. COMPARABLE, HASH_TABLE [FOO, BAR], ...) -- Consider using name_32 instead. ensure name_not_void: Result /= Void name_32: IMMUTABLE_STRING_32 -- Name of Eiffel type represented by Current, using Eiffel style guidelines -- as specified in OOSC2 (e.g. COMPARABLE, HASH_TABLE [FOO, BAR], ...) ensure name_32_attached: attached Result type_id: INTEGER_32 -- Id of the Eiffel type represented by Current ensure type_id_not_negative: Result >= 0 feature -- Measurement generic_parameter_count: INTEGER_32 -- Number of generic parameters in Eiffel type represented by Current ensure generic_parameter_count_not_negative: 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)) is_conforming_to alias "<=" (other: like Current): BOOLEAN -- Does type represented by Current conform to type represented by other? require -- from PART_COMPARABLE other_exists: other /= Void frozen is_deep_equal alias "≡≡≡" (other: TYPE [G]): 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 other attached to an object considered -- equal to current object? require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result is_greater alias ">" (other: TYPE [G]): BOOLEAN -- Is current object greater than other? -- (from PART_COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void is_greater_equal alias ">=" alias "≥" (other: TYPE [G]): BOOLEAN -- Is current object greater than or equal to other? -- (from PART_COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void is_strictly_conforming_to alias "<" (other: like Current): BOOLEAN -- Does type represented by Current conform to type represented by other and differ from it? require -- from PART_COMPARABLE other_exists: other /= Void 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: TYPE [G]): 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_default: BOOLEAN -- Is current type a type that has a default value? -- I.e. a detachable type or an expanded type. is_attached: BOOLEAN -- Is current type attached? is_deferred: BOOLEAN -- Is current type a deferred type? is_expanded: BOOLEAN -- Is current type an expanded type? is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) 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 -- Conversion adapt alias "[]" (g: detachable G): detachable G -- Adapts g or calls necessary conversion routine to adapt g ensure adapted: Result ~ g attempted alias "/" (obj: detachable separate ANY): detachable G -- If possible, obj understood as an object of type G; -- If not, default detachable value of type G.. ensure assigned_or_void: Result = obj or Result = default_detachable_value default: G require has_default: has_default default_detachable_value: detachable G feature -- Duplication copy (other: TYPE [G]) -- 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: TYPE [G]) -- 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: TYPE [G] -- 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: TYPE [G]) -- 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: TYPE [G] -- 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: TYPE [G] -- 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 any_default: detachable TYPE [G] -- 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 -- Output debug_output: READABLE_STRING_32 -- String that should be displayed in debugger to represent Current. ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void 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 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 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, 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 TYPE
Generated by ISE EiffelStudio