note description: "[ Access to internal object properties. 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: 2020-05-19 14:25:56 +0000 (Tue, 19 May 2020) $" revision: "$Revision: 104258 $" class interface REFLECTOR create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access attached_type (type_id: INTEGER_32): INTEGER_32 -- Attached version of type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class unchanged_if_attached: is_attached_type (type_id) implies type_id = Result Bit_type: INTEGER_32 = 8 -- This type is obsolete and is not used anymore. -- (from REFLECTOR_CONSTANTS) Boolean_type: INTEGER_32 = 3 -- Abstract type ID for predefined type BOOLEAN. -- (from REFLECTOR_CONSTANTS) Character_32_type: INTEGER_32 = 12 -- Abstract type ID for predefined type CHARACTER_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Wide_character_type. -- (from REFLECTOR_CONSTANTS) Character_8_type: INTEGER_32 = 2 -- Abstract type ID for predefined type CHARACTER_8. -- Was declared in REFLECTOR_CONSTANTS as synonym of Character_type. -- (from REFLECTOR_CONSTANTS) Character_type: INTEGER_32 = 2 -- Abstract type ID for predefined type CHARACTER_8. -- Was declared in REFLECTOR_CONSTANTS as synonym of Character_8_type. -- (from REFLECTOR_CONSTANTS) class_name_8_of_type (type_id: INTEGER_32): STRING_8 -- Name of class associated with dynamic type type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class class_name_of_type (type_id: INTEGER_32): STRING_8 -- Name of class associated with dynamic type type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class detachable_type (type_id: INTEGER_32): INTEGER_32 -- Detachable version of type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class unchanged_if_detachable: not is_attached_type (type_id) implies type_id = Result Double_type: INTEGER_32 = 6 -- Abstract type ID for predefined type REAL_64. -- Was declared in REFLECTOR_CONSTANTS as synonym of Real_64_type. -- (from REFLECTOR_CONSTANTS) Expanded_type: INTEGER_32 = 7 -- Abstract type ID for a non-predefined expanded type. -- (from REFLECTOR_CONSTANTS) field_name_8_of_type (i: INTEGER_32; type_id: INTEGER_32): STRING_8 -- Name of i-th field of dynamic type type_id. require type_id_nonnegative: type_id >= 0 index_large_enough: i >= 1 index_small_enought: i <= field_count_of_type (type_id) ensure instance_free: class field_name_of_type (i: INTEGER_32; type_id: INTEGER_32): STRING_8 -- Name of i-th field of dynamic type type_id. require type_id_nonnegative: type_id >= 0 index_large_enough: i >= 1 index_small_enought: i <= field_count_of_type (type_id) ensure instance_free: class field_static_type_of_type (i: INTEGER_32; type_id: INTEGER_32): INTEGER_32 -- Static type of declared i-th field of dynamic type type_id require type_id_nonnegative: type_id >= 0 index_large_enough: i >= 1 index_small_enough: i <= field_count_of_type (type_id) ensure instance_free: class field_type_nonnegative: Result >= 0 field_type_of_type (i: INTEGER_32; type_id: INTEGER_32): INTEGER_32 -- Abstract type of i-th field of dynamic type type_id require type_id_nonnegative: type_id >= 0 index_large_enough: i >= 1 index_small_enough: i <= field_count_of_type (type_id) ensure instance_free: class field_type_nonnegative: Result >= 0 generating_type: TYPE [detachable REFLECTOR] -- 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_count_of_type (type_id: INTEGER_32): INTEGER_32 -- Number of generic parameter in type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class generic_dynamic_type_of_type (type_id: INTEGER_32; i: INTEGER_32): INTEGER_32 -- Dynamic type of generic parameter of type_id at position i. require type_id_nonnegative: type_id >= 0 type_id_generic: generic_count_of_type (type_id) > 0 i_valid: i > 0 and i <= generic_count_of_type (type_id) ensure instance_free: class dynamic_type_nonnegative: Result >= 0 Integer_16_type: INTEGER_32 = 10 -- Abstract type ID for predefined type INTEGER_16. -- (from REFLECTOR_CONSTANTS) Integer_32_type: INTEGER_32 = 4 -- Abstract type ID for predefined type INTEGER_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Integer_type. -- (from REFLECTOR_CONSTANTS) Integer_64_type: INTEGER_32 = 11 -- Abstract type ID for predefined type INTEGER_64. -- (from REFLECTOR_CONSTANTS) Integer_8_type: INTEGER_32 = 9 -- Abstract type ID for predefined type INTEGER_8. -- (from REFLECTOR_CONSTANTS) Integer_type: INTEGER_32 = 4 -- Abstract type ID for predefined type INTEGER_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Integer_32_type. -- (from REFLECTOR_CONSTANTS) Max_predefined_type: INTEGER_32 = 16 -- (from REFLECTOR_CONSTANTS) Min_predefined_type: INTEGER_32 = -2 -- (from REFLECTOR_CONSTANTS) Natural_16_type: INTEGER_32 = 14 -- Abstract type ID for predefined type NATURAL_16. -- (from REFLECTOR_CONSTANTS) Natural_32_type: INTEGER_32 = 15 -- Abstract type ID for predefined type NATURAL_32. -- (from REFLECTOR_CONSTANTS) Natural_64_type: INTEGER_32 = 16 -- Abstract type ID for predefined type NATURAL_64. -- (from REFLECTOR_CONSTANTS) Natural_8_type: INTEGER_32 = 13 -- Abstract type ID for predefined type NATURAL_8. -- (from REFLECTOR_CONSTANTS) None_type: INTEGER_32 = -2 -- Type ID representation for NONE. -- (from REFLECTOR_CONSTANTS) Pointer_type: INTEGER_32 = 0 -- Abstract type ID for predefined type POINTER. -- (from REFLECTOR_CONSTANTS) Real_32_type: INTEGER_32 = 5 -- Abstract type ID for predefined type REAL_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Real_type. -- (from REFLECTOR_CONSTANTS) Real_64_type: INTEGER_32 = 6 -- Abstract type ID for predefined type REAL_64. -- Was declared in REFLECTOR_CONSTANTS as synonym of Double_type. -- (from REFLECTOR_CONSTANTS) Real_type: INTEGER_32 = 5 -- Abstract type ID for predefined type REAL_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Real_32_type. -- (from REFLECTOR_CONSTANTS) Reference_type: INTEGER_32 = 1 -- Abstract type ID for a reference type. -- (from REFLECTOR_CONSTANTS) storable_version_of_type (a_type_id: INTEGER_32): detachable IMMUTABLE_STRING_8 -- Storable version if any specified. require a_type_id_nonnegative: a_type_id >= 0 ensure instance_free: class type_name_8_of_type (type_id: INTEGER_32): STRING_8 -- Name of type_id's generating type (type of which type_id -- is a direct instance). require type_id_nonnegative: type_id >= 0 ensure instance_free: class type_name_of_type (type_id: INTEGER_32): STRING_8 -- Name of type_id's generating type (type of which type_id -- is a direct instance). require type_id_nonnegative: type_id >= 0 ensure instance_free: class Wide_character_type: INTEGER_32 = 12 -- Abstract type ID for predefined type CHARACTER_32. -- Was declared in REFLECTOR_CONSTANTS as synonym of Character_32_type. -- (from REFLECTOR_CONSTANTS) feature -- Measurement field_count_of_type (type_id: INTEGER_32): INTEGER_32 -- Number of logical fields in dynamic type type_id. require type_id_nonnegative: type_id >= 0 ensure instance_free: class persistent_field_count_of_type (a_type_id: INTEGER_32): INTEGER_32 -- Number of logical fields in dynamic type type_id that are not transient. require a_type_non_negative: a_type_id >= 0 ensure instance_free: class 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: REFLECTOR): 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: REFLECTOR): 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: REFLECTOR): 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 is_attached_type (a_type_id: INTEGER_32): BOOLEAN -- Is a_type_id an attached type? require a_type_non_negative: a_type_id >= 0 ensure instance_free: class is_field_expanded_of_type (i: INTEGER_32; a_type_id: INTEGER_32): BOOLEAN -- Is i-th field of type a_type_id a user-defined expanded attribute? require a_type_non_negative: a_type_id >= 0 index_large_enough: i >= 1 index_small_enough: i <= field_count_of_type (a_type_id) ensure instance_free: class is_field_transient_of_type (i: INTEGER_32; a_type_id: INTEGER_32): BOOLEAN -- Is i-th field of object a transient attribute? -- I.e. an attribute that does not need to be stored? require a_type_non_negative: a_type_id >= 0 index_large_enough: i >= 1 index_small_enough: i <= field_count_of_type (a_type_id) ensure instance_free: class is_pre_ecma_mapping_disabled: BOOLEAN -- Are we mapping old names to new ECMA names? -- False means mapping STRING to STRING_8, INTEGER to INTEGER_32,... -- Redefine in descendants of REFLECTOR to modify the behavior of inspection queries of REFLECTOR. -- (from REFLECTOR_HELPER) ensure -- from REFLECTOR_HELPER instance_free: class is_special_any_type (type_id: INTEGER_32): BOOLEAN -- Is type represented by type_id represent -- a SPECIAL [XX] where XX is a reference type. require type_id_nonnegative: type_id >= 0 ensure instance_free: class is_special_type (type_id: INTEGER_32): BOOLEAN -- Is type represented by type_id represent -- a SPECIAL [XX] where XX is a reference type -- or a basic expanded type (note that user-defined -- expanded types are excluded). require type_id_nonnegative: type_id >= 0 ensure instance_free: class is_tuple_type (type_id: INTEGER_32): BOOLEAN -- Is type represented by type_id represent a TUPLE? require type_id_nonnegative: type_id >= 0 ensure instance_free: class is_valid_type_string (s: READABLE_STRING_GENERAL): BOOLEAN -- Is s a valid string representation for a TYPE. -- (from REFLECTOR_HELPER) ensure -- from REFLECTOR_HELPER instance_free: class mapped_type (a_type: READABLE_STRING_GENERAL): READABLE_STRING_GENERAL -- If is_pre_ecma_mapping_disabled a_type, otherwise -- the mapped typed. -- (from REFLECTOR_HELPER) require -- from REFLECTOR_HELPER a_type_not_void: a_type /= Void ensure -- from REFLECTOR_HELPER instance_free: class mapped_type_not_void: Result /= Void 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 -- Duplication copy (other: REFLECTOR) -- 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: REFLECTOR) -- 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: REFLECTOR -- 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: REFLECTOR) -- 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: REFLECTOR -- 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: REFLECTOR -- 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 REFLECTOR -- 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 -- Conformance field_conforms_to (a_source_type, a_field_type: INTEGER_32): BOOLEAN -- Does a_source_type conform to a_field_type? require a_source_type_non_negative: a_source_type >= 0 a_field_type_non_negative: a_field_type >= 0 ensure instance_free: class type_conforms_to (type1, type2: INTEGER_32): BOOLEAN -- Does type1 conform to type2? require type1_nonnegative: type1 >= 0 type2_nonnegative: type2 >= 0 ensure instance_free: class feature -- Creation dynamic_type_from_string (class_type: READABLE_STRING_GENERAL): INTEGER_32 -- Dynamic type corresponding to class_type. -- If no dynamic type available, returns -1. require class_type_not_void: class_type /= Void class_type_not_empty: not class_type.is_empty is_valid_type_string: is_valid_type_string (class_type) ensure instance_free: class dynamic_type_from_string_valid: Result = -1 or Result = None_type or Result >= 0 new_instance_of (type_id: INTEGER_32): ANY -- New instance of dynamic type_id. -- Note: returned object is not initialized and may -- hence violate its invariant. -- type_id cannot represent a SPECIAL type, use -- new_special_any_instance instead. require type_id_nonnegative: type_id >= 0 not_special_type: not is_special_type (type_id) not_deferred: not type_of_type (type_id).is_deferred ensure instance_free: class not_special_type: not attached {SPECIAL [detachable ANY]} Result dynamic_type_set: attached_type (Result.generating_type.type_id) = attached_type (type_id) new_special_any_instance (type_id, a_capacity: INTEGER_32): SPECIAL [detachable ANY] -- New instance of dynamic type_id that represents -- a SPECIAL which can contain a_capacity elements of reference type. -- To create a SPECIAL of basic type, use class SPECIAL directly. require a_capacity_valid: a_capacity >= 0 type_id_nonnegative: type_id >= 0 special_type: is_special_any_type (type_id) ensure instance_free: class dynamic_type_set: Result.generating_type.type_id = type_id count_set: Result.count = 0 capacity_set: Result.capacity = a_capacity new_tuple_from_special (type_id: INTEGER_32; values: SPECIAL [detachable separate ANY]): detachable TUPLE -- New instance of a tuple of type type_id filled with values if all types of items are suitable. -- Void if some items from values are inappropriate for a tuple of type type_id. require type_id_nonnegative: type_id >= 0 is_tuple_type: is_tuple_type (type_id) ensure instance_free: class dynamic_type_set: attached Result implies Result.generating_type.type_id = type_id values_set: attached Result implies ∀ k: 1 |..| Result.count ¦ Result.item (k) = values [k - 1] new_tuple_from_tuple (type_id: INTEGER_32; source: separate TUPLE): detachable TUPLE -- New instance of a tuple of type type_id filled with values fom source if all value types are suitable. -- Void if some values from source are inappropriate for a tuple of type type_id. require type_id_nonnegative: type_id >= 0 is_tuple_type: is_tuple_type (type_id) ensure instance_free: class dynamic_type_set: attached Result implies Result.generating_type.type_id = type_id object_comparison_set: attached Result implies Result.object_comparison = source.object_comparison values_set: attached Result implies ∀ k: 1 |..| Result.count ¦ Result.item (k) = source [k] type_of_type (type_id: INTEGER_32): TYPE [detachable ANY] -- Associated TYPE instance for an object of type id type_id require type_id_nonnegative: type_id >= 0 ensure instance_free: class result_not_void: Result /= Void 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 -- Version compiler_version: INTEGER_32 ensure instance_free: class 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 REFLECTOR
Generated by ISE EiffelStudio