note
	description: "Common ancestor for object inspection."
	date: "$Date: 2020-05-19 14:29:33 +0000 (Tue, 19 May 2020) $"
	revision: "$Revision: 104259 $"

deferred class 
	REFLECTED_OBJECT

inherit
	REFLECTOR_CONSTANTS

feature -- Access

	object: ANY
			-- Associated object for Current.
			-- It might be a copy if Current is expanded.
		deferred
		end

	class_name: STRING_8
			-- Name of the class associated with object
		do
			Result := {ISE_RUNTIME}.generator_of_type (dynamic_type)
		end

	type_name: STRING_8
			-- Name of object's generating type (type of which object
			-- is a direct instance).
		do
			Result := {ISE_RUNTIME}.generating_type_of_type (dynamic_type)
		end

	dynamic_type: INTEGER_32
			-- Dynamic type of object

	generic_count: INTEGER_32
			-- Number of generic parameter in base type of object.
		do
			Result := {ISE_RUNTIME}.generic_parameter_count (dynamic_type)
		end

	generic_dynamic_type (i: INTEGER_32): INTEGER_32
			-- Dynamic type of generic parameter of object at
			-- position i.
		require
			object_generic: generic_count > 0
			i_valid: i > 0 and i <= generic_count
		do
			Result := {ISE_RUNTIME}.eif_gen_param_id (dynamic_type, i)
		ensure
			dynamic_type_nonnegative: Result >= 0
		end

	field (i: INTEGER_32): detachable ANY
			-- Object attached to the i-th field of object
			-- (directly or through a reference)
			-- Use specific version of xxx_field to get best performance.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			not_special: not is_special
		do
			inspect field_type (i)
			when Integer_8_type then
				Result := integer_8_field (i)
			when Integer_16_type then
				Result := integer_16_field (i)
			when Integer_32_type then
				Result := integer_32_field (i)
			when Integer_64_type then
				Result := integer_64_field (i)
			when Natural_8_type then
				Result := natural_8_field (i)
			when Natural_16_type then
				Result := natural_16_field (i)
			when Natural_32_type then
				Result := natural_32_field (i)
			when Natural_64_type then
				Result := natural_64_field (i)
			when Real_32_type then
				Result := real_32_field (i)
			when Real_64_type then
				Result := real_64_field (i)
			when Character_8_type then
				Result := character_8_field (i)
			when Character_32_type then
				Result := character_32_field (i)
			when Boolean_type then
				Result := boolean_field (i)
			when Pointer_type then
				Result := pointer_field (i)
			when Expanded_type, Reference_type then
				Result := reference_field (i)
			end
		end

	reference_field (i: INTEGER_32): detachable ANY
			-- Object attached to the i-th field of object
			-- (directly or through a reference)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			not_special: not is_special
			reference_field: field_type (i) = Reference_type or field_type (i) = Expanded_type
		do
			Result := {ISE_RUNTIME}.reference_field (i, object_address, 0)
		end
	
feature -- Status report

	is_instance_of (type_id: INTEGER_32): BOOLEAN
			-- Is object an instance of type type_id?
		require
			object_not_void: object /= Void
			type_id_nonnegative: type_id >= 0
		do
			Result := {ISE_RUNTIME}.type_conforms_to (dynamic_type, type_id)
		end

	is_special: BOOLEAN
			-- Is object special?
		do
			Result := {ISE_RUNTIME}.is_special (object_address)
		end

	is_special_of_expanded: BOOLEAN
			-- Is Current a SPECIAL [XX] where XX is a user defined expanded type?
		require
			is_special: is_special
		do
			Result := {ISE_RUNTIME}.is_special_of_expanded (object_address)
		end

	is_special_of_reference: BOOLEAN
			-- Is Current a SPECIAL [XX] where XX is a reference type?
		require
			is_special: is_special
		do
			Result := {ISE_RUNTIME}.is_special_of_reference (object_address)
		end

	is_expanded: BOOLEAN
			-- Is Current an instance of an expanded type?
		do
			Result := {ISE_RUNTIME}.is_expanded (object_address)
		end

	is_tuple: BOOLEAN
			-- Is object a TUPLE?
		do
			Result := {ISE_RUNTIME}.is_tuple (object_address)
		end

	is_field_transient (i: INTEGER_32): BOOLEAN
			-- Is i-th field of object a transient attribute?
			-- I.e. an attribute that does not need to be stored?
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
		do
			Result := {ISE_RUNTIME}.is_field_transient_of_type (i, dynamic_type)
		end

	is_field_statically_expanded (i: INTEGER_32): BOOLEAN
			-- Is i-th field of object a user-defined expanded attribute?
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
		do
			Result := {ISE_RUNTIME}.is_field_expanded_of_type (i, dynamic_type)
		end

	is_copy_semantics_field (i: INTEGER_32): BOOLEAN
			-- Is i-th field of object a reference with copy-semantics properties?
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			is_reference_field: field_type (i) = Reference_type
		do
			Result := {ISE_RUNTIME}.is_copy_semantics_field (i, object_address, 0)
		end

	is_special_copy_semantics_item (i: INTEGER_32): BOOLEAN
			-- Is i-th field of object a reference with copy-semantics properties?
		require
			is_special: is_special
			is_special_of_reference: is_special_of_reference
			valid_index: attached {ABSTRACT_SPECIAL} object as l_spec and then l_spec.valid_index (i)
		do
			Result := {ISE_RUNTIME}.is_special_copy_semantics_item (i, object_address)
		end

	is_field_statically_attached (i: INTEGER_32): BOOLEAN
			-- Is i-th field of object defined as attached?
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
		do
			Result := {ISE_RUNTIME}.is_attached_type (field_static_type (i))
		end

	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
		do
			Result := {ISE_RUNTIME}.type_conforms_to (a_source_type, {ISE_RUNTIME}.detachable_type (a_field_type))
		end

	field_name (i: INTEGER_32): STRING_8
			-- Name of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			not_special: not is_special
		do
			create Result.make_from_c ({ISE_RUNTIME}.field_name_of_type (i, dynamic_type))
		ensure
			result_exists: Result /= Void
		end

	field_offset (i: INTEGER_32): INTEGER_32
			-- Offset of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			not_special: not is_special
		do
			Result := {ISE_RUNTIME}.field_offset_of_type (i, dynamic_type)
		end

	field_type (i: INTEGER_32): INTEGER_32
			-- Abstract type of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
		do
			Result := {ISE_RUNTIME}.field_type_of_type (i, dynamic_type)
		ensure
			field_type_nonnegative: Result >= 0
		end

	field_static_type (i: INTEGER_32): INTEGER_32
			-- Static type of declared i-th field of dynamic type dynamic_type
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
		do
			Result := {ISE_RUNTIME}.field_static_type_of_type (i, dynamic_type)
		ensure
			field_type_nonnegative: Result >= 0
		end

	copy_semantics_field (i: INTEGER_32): REFLECTED_COPY_SEMANTICS_OBJECT
			-- Object attached to the i-th field of object
			-- (directly or through a reference)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			not_special: not is_special
			reference_field: field_type (i) = Reference_type and is_copy_semantics_field (i)
		deferred
		end

	special_copy_semantics_item (i: INTEGER_32): REFLECTED_COPY_SEMANTICS_OBJECT
			-- Object attached to the ith item of special.
		require
			is_special: is_special
			is_special_reference: is_special_of_reference
			valid_index: attached {ABSTRACT_SPECIAL} object as l_spec and then l_spec.valid_index (i)
		do
			create Result.make_special (twin, i)
		end

	expanded_field (i: INTEGER_32): REFLECTED_OBJECT
			-- Object representation of the i-th field of object
			-- which is expanded. We provide a wrapper that enables
			-- direct editing of the field without duplicating
			-- the expanded object.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			expanded_field: field_type (i) = Expanded_type
			not_special: not is_special
		deferred
		end

	character_8_field (i: INTEGER_32): CHARACTER_8
			-- CHARACTER_8 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			character_8_field: field_type (i) = Character_8_type
		do
			Result := {ISE_RUNTIME}.character_8_field (i, object_address, 0)
		end

	character_32_field (i: INTEGER_32): CHARACTER_32
			-- CHARACTER_32 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			character_32_field: field_type (i) = Character_32_type
		do
			Result := {ISE_RUNTIME}.character_32_field (i, object_address, 0)
		end

	boolean_field (i: INTEGER_32): BOOLEAN
			-- Boolean value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			boolean_field: field_type (i) = Boolean_type
		do
			Result := {ISE_RUNTIME}.boolean_field (i, object_address, 0)
		end

	natural_8_field (i: INTEGER_32): NATURAL_8
			-- NATURAL_8 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_8_field: field_type (i) = Natural_8_type
		do
			Result := {ISE_RUNTIME}.natural_8_field (i, object_address, 0)
		end

	natural_16_field (i: INTEGER_32): NATURAL_16
			-- NATURAL_16 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_16_field: field_type (i) = Natural_16_type
		do
			Result := {ISE_RUNTIME}.natural_16_field (i, object_address, 0)
		end

	natural_32_field (i: INTEGER_32): NATURAL_32
			-- NATURAL_32 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_32_field: field_type (i) = Natural_32_type
		do
			Result := {ISE_RUNTIME}.natural_32_field (i, object_address, 0)
		end

	natural_64_field (i: INTEGER_32): NATURAL_64
			-- NATURAL_64 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_64_field: field_type (i) = Natural_64_type
		do
			Result := {ISE_RUNTIME}.natural_64_field (i, object_address, 0)
		end

	integer_8_field (i: INTEGER_32): INTEGER_8
			-- INTEGER_8 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_8_field: field_type (i) = Integer_8_type
		do
			Result := {ISE_RUNTIME}.integer_8_field (i, object_address, 0)
		end

	integer_16_field (i: INTEGER_32): INTEGER_16
			-- INTEGER_16 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_16_field: field_type (i) = Integer_16_type
		do
			Result := {ISE_RUNTIME}.integer_16_field (i, object_address, 0)
		end

	integer_32_field (i: INTEGER_32): INTEGER_32
			-- INTEGER_32 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_32_field: field_type (i) = Integer_32_type
		do
			Result := {ISE_RUNTIME}.integer_32_field (i, object_address, 0)
		end

	integer_64_field (i: INTEGER_32): INTEGER_64
			-- INTEGER_64 value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_64_field: field_type (i) = Integer_64_type
		do
			Result := {ISE_RUNTIME}.integer_64_field (i, object_address, 0)
		end

	real_32_field (i: INTEGER_32): REAL_32
			-- Real value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_32_field: field_type (i) = Real_32_type
		do
			Result := {ISE_RUNTIME}.real_32_field (i, object_address, 0)
		end

	pointer_field (i: INTEGER_32): POINTER
			-- Pointer value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			pointer_field: field_type (i) = Pointer_type
		do
			Result := {ISE_RUNTIME}.pointer_field (i, object_address, 0)
		end

	real_64_field (i: INTEGER_32): REAL_64
			-- Double precision value of i-th field of object
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_64_field: field_type (i) = Real_64_type
		do
			Result := {ISE_RUNTIME}.real_64_field (i, object_address, 0)
		end
	
feature -- Element change

	set_reference_field (i: INTEGER_32; value: detachable ANY)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			reference_field: field_type (i) = Reference_type
			valid_value: is_field_statically_attached (i) implies value /= Void
			value_conforms_to_field_static_type: value /= Void implies field_conforms_to (value.generating_type.type_id, field_static_type (i))
		do
			{ISE_RUNTIME}.set_reference_field (i, object_address, 0, value)
		end

	set_real_64_field (i: INTEGER_32; value: REAL_64)
			-- Was declared in REFLECTED_OBJECT as synonym of set_double_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_64_field: field_type (i) = Real_64_type
		do
			{ISE_RUNTIME}.set_real_64_field (i, object_address, 0, value)
		end

	set_double_field (i: INTEGER_32; value: REAL_64)
			-- Was declared in REFLECTED_OBJECT as synonym of set_real_64_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_64_field: field_type (i) = Real_64_type
		do
			{ISE_RUNTIME}.set_real_64_field (i, object_address, 0, value)
		end

	set_character_8_field (i: INTEGER_32; value: CHARACTER_8)
			-- Set character value of i-th field of object to value
			-- Was declared in REFLECTED_OBJECT as synonym of set_character_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			character_field: field_type (i) = Character_8_type
		do
			{ISE_RUNTIME}.set_character_8_field (i, object_address, 0, value)
		end

	set_character_field (i: INTEGER_32; value: CHARACTER_8)
			-- Set character value of i-th field of object to value
			-- Was declared in REFLECTED_OBJECT as synonym of set_character_8_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			character_field: field_type (i) = Character_8_type
		do
			{ISE_RUNTIME}.set_character_8_field (i, object_address, 0, value)
		end

	set_character_32_field (i: INTEGER_32; value: CHARACTER_32)
			-- Set character 32 value of i-th field of object to value
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			character_field: field_type (i) = Character_32_type
		do
			{ISE_RUNTIME}.set_character_32_field (i, object_address, 0, value)
		end

	set_boolean_field (i: INTEGER_32; value: BOOLEAN)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			boolean_field: field_type (i) = Boolean_type
		do
			{ISE_RUNTIME}.set_boolean_field (i, object_address, 0, value)
		end

	set_natural_8_field (i: INTEGER_32; value: NATURAL_8)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_8_field: field_type (i) = Natural_8_type
		do
			{ISE_RUNTIME}.set_natural_8_field (i, object_address, 0, value)
		end

	set_natural_16_field (i: INTEGER_32; value: NATURAL_16)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_16_field: field_type (i) = Natural_16_type
		do
			{ISE_RUNTIME}.set_natural_16_field (i, object_address, 0, value)
		end

	set_natural_32_field (i: INTEGER_32; value: NATURAL_32)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_32_field: field_type (i) = Natural_32_type
		do
			{ISE_RUNTIME}.set_natural_32_field (i, object_address, 0, value)
		end

	set_natural_64_field (i: INTEGER_32; value: NATURAL_64)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			natural_64_field: field_type (i) = Natural_64_type
		do
			{ISE_RUNTIME}.set_natural_64_field (i, object_address, 0, value)
		end

	set_integer_8_field (i: INTEGER_32; value: INTEGER_8)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_8_field: field_type (i) = Integer_8_type
		do
			{ISE_RUNTIME}.set_integer_8_field (i, object_address, 0, value)
		end

	set_integer_16_field (i: INTEGER_32; value: INTEGER_16)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_16_field: field_type (i) = Integer_16_type
		do
			{ISE_RUNTIME}.set_integer_16_field (i, object_address, 0, value)
		end

	set_integer_field (i: INTEGER_32; value: INTEGER_32)
			-- Was declared in REFLECTED_OBJECT as synonym of set_integer_32_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_32_field: field_type (i) = Integer_32_type
		do
			{ISE_RUNTIME}.set_integer_32_field (i, object_address, 0, value)
		end

	set_integer_32_field (i: INTEGER_32; value: INTEGER_32)
			-- Was declared in REFLECTED_OBJECT as synonym of set_integer_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_32_field: field_type (i) = Integer_32_type
		do
			{ISE_RUNTIME}.set_integer_32_field (i, object_address, 0, value)
		end

	set_integer_64_field (i: INTEGER_32; value: INTEGER_64)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			integer_64_field: field_type (i) = Integer_64_type
		do
			{ISE_RUNTIME}.set_integer_64_field (i, object_address, 0, value)
		end

	set_real_32_field (i: INTEGER_32; value: REAL_32)
			-- Was declared in REFLECTED_OBJECT as synonym of set_real_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_32_field: field_type (i) = Real_32_type
		do
			{ISE_RUNTIME}.set_real_32_field (i, object_address, 0, value)
		end

	set_real_field (i: INTEGER_32; value: REAL_32)
			-- Was declared in REFLECTED_OBJECT as synonym of set_real_32_field.
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			real_32_field: field_type (i) = Real_32_type
		do
			{ISE_RUNTIME}.set_real_32_field (i, object_address, 0, value)
		end

	set_pointer_field (i: INTEGER_32; value: POINTER)
		require
			index_large_enough: i >= 1
			index_small_enough: i <= field_count
			pointer_field: field_type (i) = Pointer_type
		do
			{ISE_RUNTIME}.set_pointer_field (i, object_address, 0, value)
		end
	
feature -- Measurement

	field_count: INTEGER_32
			-- Number of logical fields in object
		do
			Result := {ISE_RUNTIME}.field_count_of_type (dynamic_type)
		end

	persistent_field_count: INTEGER_32
			-- Number of logical fields in object that are not transient.
		do
			Result := {ISE_RUNTIME}.persistent_field_count_of_type (dynamic_type)
		ensure
			count_positive: Result >= 0
		end

	physical_size: INTEGER_32
			-- Space occupied by object in bytes
		local
			l_size: NATURAL_64
		do
			l_size := physical_size_64
			Result := l_size.min ({INTEGER_32}.max_value.as_natural_64).as_integer_32
		end

	deep_physical_size: INTEGER_32
			-- Space occupied by object and its children in bytes
		local
			l_size: NATURAL_64
		do
			l_size := deep_physical_size_64
			Result := l_size.min ({INTEGER_32}.max_value.as_natural_64).as_integer_32
		end

	physical_size_64: NATURAL_64
			-- Space occupied by object in bytes
		do
			Result := {ISE_RUNTIME}.object_size (object_address)
		end

	deep_physical_size_64: NATURAL_64
			-- Space occupied by object and its children in bytes
		local
			l_traverse: OBJECT_GRAPH_BREADTH_FIRST_TRAVERSABLE
			l_obj: like {OBJECT_GRAPH_BREADTH_FIRST_TRAVERSABLE}.visited_objects.item
		do
			create l_traverse;
			l_traverse.set_root_object (object);
			l_traverse.set_is_skip_transient (False);
			l_traverse.traverse
			if attached l_traverse.visited_objects as l_objects then
				from
					l_objects.start
				until
					l_objects.after
				loop
					l_obj := l_objects.item
					Result := Result + {ISE_RUNTIME}.object_size ($l_obj.to_pointer);
					l_objects.forth
				end
			end
		end
	
feature {REFLECTED_OBJECT} -- Implementation

	object_address: POINTER
			-- Unprotected reference to object.
		deferred
		end
	
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 REFLECTED_OBJECT

Generated by ISE EiffelStudio