indexing
	description: "References to objects meant to be exchanged with non-Eiffel software."
	library: "Free implementation of ELKS library"
	copyright: "Copyright (c) 1986-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see forum.txt)"
	date: "$Date: 2008-05-23 17:24:07 -0700 (Fri, 23 May 2008) $"
	revision: "$Revision: 170 $"

frozen expanded class interface
	POINTER


create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

	make_from_reference (v: POINTER_REF)
			-- Initialize `Current' with `v.item'.
			-- (from POINTER_REF)
		require -- from POINTER_REF
			v_not_void: v /= Void
		ensure -- from POINTER_REF
			item_set: item = v.item

convert
	make_from_reference ({POINTER_REF})

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void
			generating_type_not_empty: not Result.is_empty

	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
		require -- from  HASHABLE
			True
		ensure -- from HASHABLE
			good_hash_value: Result >= 0

	item: POINTER
			-- Pointer value
			-- (from POINTER_REF)
	
feature -- Comparison

	frozen deep_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies (other /= Void and then some.same_type (other))
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	frozen is_deep_equal (other: POINTER): 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: POINTER): 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.is_equal (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 (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' 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
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: POINTER): 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_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.

	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: POINTER)
			-- 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: is_equal (other)

	frozen deep_copy (other: POINTER)
			-- 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: POINTER
			-- 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: POINTER)
			-- 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: POINTER
			-- 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: POINTER
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: POINTER
			-- 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)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
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

	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

	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: STRING_8)
			-- Mark code that has to be "fixed" with `comment'.
			-- (from REFACTORING_HELPER)
		require -- from REFACTORING_HELPER
			comment_not_void: comment /= Void

	to_implement (comment: STRING_8)
			-- Mark code that has to be "implemented" with `comment'.
			-- (from REFACTORING_HELPER)
		require -- from REFACTORING_HELPER
			comment_not_void: comment /= Void

	to_implement_assertion (comment: STRING_8): BOOLEAN
			-- Mark assertion that has to be "implemented" with `comment'.
			-- (from REFACTORING_HELPER)
		require -- from REFACTORING_HELPER
			comment_not_void: comment /= Void
	
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

	infix "+" (offset: INTEGER_32): POINTER
			-- Pointer moved by an offset of `offset' bytes.
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			io_not_void: Result /= Void

	out: STRING_8
			-- Printable representation of pointer value
		require -- from  ANY
			True
		ensure -- from ANY
			out_not_void: Result /= Void

	print (some: ?ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	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
			operating_environment_not_void: Result /= Void
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class POINTER