note description: "[ References to objects containing reference to object meant to be exchanged with non-Eiffel software. ]" assembly: "mscorlib" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2012-05-24 04:13:10 +0000 (Thu, 24 May 2012) $" revision: "$Revision: 91981 $" frozen expanded class interface TYPED_POINTER [G] create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) convert default_create: {POINTER} feature -- Access generating_type: TYPE [detachable TYPED_POINTER [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 hash_code: INTEGER_32 -- Hash code value -- (from POINTER_REF) ensure -- from HASHABLE good_hash_value: Result >= 0 to_pointer: POINTER -- Pointer value -- (from POINTER_REF) 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: TYPED_POINTER [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: TYPED_POINTER [G]): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? -- (from POINTER_REF) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result memory_compare (other: POINTER; a_size: INTEGER_32): BOOLEAN -- True if Current and other are identical on a_size bytes. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size > 0 valid_other: other /= default_pointer 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: TYPED_POINTER [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 is_default_pointer: BOOLEAN -- Is current default_pointer? -- (from POINTER_REF) ensure -- from POINTER_REF definition: Result = (to_pointer = default_pointer) is_hashable: BOOLEAN -- May current object be hashed? -- (True if it is not its type's default.) -- (from POINTER_REF) 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 -- Element change frozen set_item (p: POINTER) -- Make p the item value. -- (from POINTER_REF) feature -- Conversion to_integer_32: INTEGER_32 -- Convert item into an INTEGER_32 value. -- (from POINTER_REF) to_reference: POINTER_REF -- Associated reference of Current -- (from POINTER_REF) ensure -- from POINTER_REF to_reference_not_void: Result /= Void feature -- Duplication copy (other: TYPED_POINTER [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: TYPED_POINTER [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: TYPED_POINTER [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: TYPED_POINTER [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: TYPED_POINTER [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: TYPED_POINTER [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 default: detachable TYPED_POINTER [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 -- Allocation/free memory_alloc (a_size: INTEGER_32): POINTER -- Allocated size bytes using malloc. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size > 0 ensure -- from POINTER_REF instance_free: class memory_calloc (a_count, a_element_size: INTEGER_32): POINTER -- Allocate a_count elements of size a_element_size bytes using `calloc. -- (from POINTER_REF) require -- from POINTER_REF valid_element_count: a_count > 0 valid_element_size: a_element_size > 0 ensure -- from POINTER_REF instance_free: class memory_free -- Free allocated memory with malloc. -- (from POINTER_REF) memory_realloc (a_size: INTEGER_32): POINTER -- Realloc Current. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 feature -- Markers fixme (comment: READABLE_STRING_8) -- Mark code that has to be "fixed" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement (comment: READABLE_STRING_8) -- Mark code that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement_assertion (comment: READABLE_STRING_8): BOOLEAN -- Mark assertion that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class feature -- Memory copy memory_copy (a_source: POINTER; a_size: INTEGER_32) -- Copy a_size bytes from a_source to Current. -- a_source and Current should not overlap. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 valid_source: a_source /= default_pointer memory_move (a_source: POINTER; a_size: INTEGER_32) -- Copy a_size bytes from a_source to Current. -- a_source and Current can overlap. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 valid_source: a_source /= default_pointer memory_set (val, n: INTEGER_32) -- Fill first n bytes of the memory pointed by Current -- with constant val. -- (from POINTER_REF) require -- from POINTER_REF valid_val: val >= 0 valid_n: n >= 0 feature -- Operations plus alias "+" (offset: INTEGER_32): POINTER -- Pointer moved by an offset of offset bytes. -- (from POINTER_REF) 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 -- Printable representation of pointer value -- (from POINTER_REF) 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-2012, 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 TYPED_POINTER
Generated by ISE EiffelStudio