    indexing
    	description: "Implementation of the STORABLE mechanism with streams."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-03-22 15:17:14 -0800 (Wed, 22 Mar 2006) $"
    	revision: "$Revision: 57607 $"

    class interface
    	STREAM

    create
    	make
    			-- Create stream object with a default_size of 100 bytes

    	make_with_size (n: INTEGER_32)
    			-- Create stream object with a default_size of `n' bytes

    feature -- Initialization

    	make
    			-- Create stream object with a default_size of 100 bytes

    	make_with_size (n: INTEGER_32)
    			-- Create stream object with a default_size of `n' bytes

    feature -- Access

    	buffer_size: INTEGER_32
    			-- Buffer's size.

    	create_c_buffer
    			-- Create the C memory corresponding to the C buffer.

    	generating_type: STRING_8
    			-- Name of current object's generating type
    			-- (type of which it is a direct instance)
    			-- (from ANY)

    	generator: STRING_8
    			-- Name of current object's generating class
    			-- (base class of the type of which it is a direct instance)
    			-- (from ANY)

    	item: POINTER
    			-- Direct access to stored/retrieved data

    	object_stored_size: INTEGER_32
    			-- Size of last stored object.

    	retrieved: ANY
    			-- Retrieved object structure
    			-- To access resulting object under correct type,
    			-- use assignment attempt.
    			-- Will raise an exception (code `Retrieve_exception')
    			-- if content is not a stored Eiffel structure.
    		require -- from IO_MEDIUM
    			is_readable: readable
    			support_storable: support_storable
    		require else
    			True
    		ensure -- from IO_MEDIUM
    			result_exists: Result /= Void

    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 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))

    	is_equal (other: like Current): 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.is_equal (Current)
    			consistent: standard_is_equal (other) implies Result

    	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: like Current): 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

    	bytes_read: INTEGER_32
    			-- Last number of bytes read by read_to_managed_pointer.
    			-- (from IO_MEDIUM)

    	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

    	exists: BOOLEAN is True
    			-- Stream exists in any cases.

    	extendible: BOOLEAN
    			-- May new items be added?

    	is_closed: BOOLEAN
    			-- Is the I/O medium open

    	is_executable: BOOLEAN
    			-- Is stream executable?
    		require -- from IO_MEDIUM
    			handle_exists: exists

    	is_open_read: BOOLEAN is True
    			-- Stream opens for input.

    	is_open_write: BOOLEAN is True
    			-- Stream opens for output.

    	is_plain_text: BOOLEAN
    			-- Is file reserved for text (character sequences)?
    			-- (from IO_MEDIUM)

    	is_readable: BOOLEAN is True

    	is_writable: BOOLEAN is True
    			-- Stream is writable.

    	last_character: CHARACTER_8
    			-- Last character read by read_character
    			-- (from IO_MEDIUM)

    	last_double: REAL_64
    			-- Last double read by read_double
    			-- (from IO_MEDIUM)

    	last_integer: INTEGER_32
    			-- Last integer read by read_integer
    			-- (from IO_MEDIUM)

    	last_integer_16: INTEGER_16
    			-- Last 16-bit integer read by read_integer_16
    			-- (from IO_MEDIUM)

    	last_integer_32: INTEGER_32
    			-- Synonymy of last_integer
    			-- (from IO_MEDIUM)

    	last_integer_64: INTEGER_64
    			-- Last 64-bit integer read by read_integer_64
    			-- (from IO_MEDIUM)

    	last_integer_8: INTEGER_8
    			-- Last 8-bit integer read by read_integer_8
    			-- (from IO_MEDIUM)

    	last_natural: NATURAL_32
    			-- Last 32-bit natural read by read_natural
    			-- (from IO_MEDIUM)

    	last_natural_16: NATURAL_16
    			-- Last 16-bit natural read by read_natural_16
    			-- (from IO_MEDIUM)

    	last_natural_32: NATURAL_32
    			-- Synonymy of last_natural
    			-- (from IO_MEDIUM)

    	last_natural_64: NATURAL_64
    			-- Last 64-bit natural read by read_natural_64
    			-- (from IO_MEDIUM)

    	last_natural_8: NATURAL_8
    			-- Last 8-bit natural read by read_natural_8
    			-- (from IO_MEDIUM)

    	last_real: REAL_32
    			-- Last real read by read_real
    			-- (from IO_MEDIUM)

    	last_string: STRING_8
    			-- Last string read
    			-- (from IO_MEDIUM)

    	readable: BOOLEAN
    			-- Is there a current item that may be read?
    		require -- from IO_MEDIUM
    			handle_exists: exists

    	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))

    	support_storable: BOOLEAN is True
    			-- Can medium be used to store an Eiffel structure?

    feature -- Status setting

    	close
    			-- Close medium.
    		require -- from IO_MEDIUM
    			medium_is_open: not is_closed

    feature -- Element change

    	basic_store (object: ANY)
    			-- Produce an external representation of the
    			-- entire object structure reachable from `object'.
    			-- Retrievable within current system only.
    		require -- from IO_MEDIUM
    			object_not_void: object /= Void
    			extendible: extendible
    			support_storable: support_storable

    	general_store (object: ANY)
    			-- Produce an external representation of the
    			-- entire object structure reachable from `object'.
    			-- Retrievable from other systems for same platform
    			-- (machine architecture).
    		require -- from IO_MEDIUM
    			object_not_void: object /= Void
    			extendible: extendible
    			support_storable: support_storable

    	independent_store (object: ANY)
    			-- Produce an external representation of the
    			-- entire object structure reachable from `object'.
    			-- Retrievable from other systems for the same or other
    			-- platform (machine architecture).
    		require -- from IO_MEDIUM
    			object_not_void: object /= Void
    			extendible: extendible
    			support_storable: support_storable

    	set_additional_size (new_size: INTEGER_32)
    			-- Set `new_size' to BUFFER_SIZE, internal value used to
    			-- increment buffer_size during storable operations.

    feature -- Removal

    	dispose
    			-- Ensure this medium is closed when garbage collected.
    			-- (from IO_MEDIUM)

    feature -- Duplication

    	copy (other: like Current)
    			-- 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: like Current)
    			-- 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: like Current
    			-- New object structure recursively duplicated from Current.
    			-- (from ANY)
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, Result)

    	frozen standard_copy (other: like Current)
    			-- 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: like Current
    			-- 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: like Current
    			-- 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: like Current
    			-- 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 -- Obsolete

    	lastchar: CHARACTER_8
    			-- Last character read by read_character
    			-- (from IO_MEDIUM)

    	lastdouble: REAL_64
    			-- Last double read by read_double
    			-- (from IO_MEDIUM)

    	lastint: INTEGER_32
    			-- Last integer read by read_integer
    			-- (from IO_MEDIUM)

    	lastreal: REAL_32
    			-- Last real read by read_real
    			-- (from IO_MEDIUM)

    	laststring: STRING_8
    			-- Last string read
    			-- (from IO_MEDIUM)

    feature -- Input

    	read_character
    			-- Read a new character.
    			-- Make result available in last_character.
    			-- Was declared in STREAM as synonym of readchar.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_double
    			-- Read a new double.
    			-- Make result available in last_double.
    			-- Was declared in STREAM as synonym of readdouble.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_integer
    			-- Read a new integer.
    			-- Make result available in last_integer.
    			-- Was declared in STREAM as synonym of readint and read_integer_32.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_integer_16
    			-- Read a new integer.
    			-- Make result available in last_integer_16.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_integer_32
    			-- Read a new integer.
    			-- Make result available in last_integer.
    			-- Was declared in STREAM as synonym of read_integer and readint.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_integer_64
    			-- Read a new integer.
    			-- Make result available in last_integer_64.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_integer_8
    			-- Read a new integer.
    			-- Make result available in last_integer_8.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_line
    			-- Read characters until a new line or
    			-- end of medium.
    			-- Make result available in last_string.
    			-- Was declared in STREAM as synonym of readline.
    		require -- from IO_MEDIUM
    			is_readable: readable
    		ensure -- from IO_MEDIUM
    			last_string_not_void: last_string /= Void

    	read_natural
    			-- Read a new natural.
    			-- Make result available in last_natural.
    			-- Was declared in STREAM as synonym of read_natural_32.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_natural_16
    			-- Read a new natural.
    			-- Make result available in last_natural_16.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_natural_32
    			-- Read a new natural.
    			-- Make result available in last_natural.
    			-- Was declared in STREAM as synonym of read_natural.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_natural_64
    			-- Read a new natural.
    			-- Make result available in last_natural_64.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_natural_8
    			-- Read a new natural.
    			-- Make result available in last_natural_8.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_real
    			-- Read a new real.
    			-- Make result available in last_real.
    			-- Was declared in STREAM as synonym of readreal.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	read_stream (nb_char: INTEGER_32)
    			-- Read a string of at most `nb_char' bound characters
    			-- or until end of medium is encountered.
    			-- Make result available in last_string.
    			-- Was declared in STREAM as synonym of readstream.
    		require -- from IO_MEDIUM
    			is_readable: readable
    		ensure -- from IO_MEDIUM
    			last_string_not_void: last_string /= Void

    	read_to_managed_pointer (p: MANAGED_POINTER; start_pos, nb_bytes: INTEGER_32)
    			-- Read at most `nb_bytes' bound bytes and make result
    			-- available in `p' at position `start_pos'.
    		require -- from IO_MEDIUM
    			p_not_void: p /= Void
    			p_large_enough: p.count >= nb_bytes + start_pos
    			nb_bytes_non_negative: nb_bytes >= 0
    			is_readable: readable
    		ensure -- from IO_MEDIUM
    			bytes_read_non_negative: bytes_read >= 0
    			bytes_read_not_too_big: bytes_read <= nb_bytes

    	readchar
    			-- Read a new character.
    			-- Make result available in last_character.
    			-- Was declared in STREAM as synonym of read_character.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	readdouble
    			-- Read a new double.
    			-- Make result available in last_double.
    			-- Was declared in STREAM as synonym of read_double.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	readint
    			-- Read a new integer.
    			-- Make result available in last_integer.
    			-- Was declared in STREAM as synonym of read_integer and read_integer_32.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	readline
    			-- Read characters until a new line or
    			-- end of medium.
    			-- Make result available in last_string.
    			-- Was declared in STREAM as synonym of read_line.
    		require -- from IO_MEDIUM
    			is_readable: readable
    		ensure -- from IO_MEDIUM
    			last_string_not_void: last_string /= Void

    	readreal
    			-- Read a new real.
    			-- Make result available in last_real.
    			-- Was declared in STREAM as synonym of read_real.
    		require -- from IO_MEDIUM
    			is_readable: readable

    	readstream (nb_char: INTEGER_32)
    			-- Read a string of at most `nb_char' bound characters
    			-- or until end of medium is encountered.
    			-- Make result available in last_string.
    			-- Was declared in STREAM as synonym of read_stream.
    		require -- from IO_MEDIUM
    			is_readable: readable
    		ensure -- from IO_MEDIUM
    			last_string_not_void: last_string /= Void

    feature -- Output

    	io: STD_FILES
    			-- Handle to standard file setup
    			-- (from ANY)

    	new_line
    			-- Write a new line character to medium
    			-- Was declared in STREAM as synonym of put_new_line.
    		require -- from IO_MEDIUM
    			extendible: extendible
    		require else
    			stream_exists: exists

    	out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of tagged_out.
    			-- (from ANY)

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

    	put_boolean (b: BOOLEAN)
    			-- Write `b' to medium.
    			-- Was declared in STREAM as synonym of putbool.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_character (c: CHARACTER_8)
    			-- Write `c' to medium.
    			-- Was declared in STREAM as synonym of putchar.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_double (d: REAL_64)
    			-- Write `d' to medium.
    			-- Was declared in STREAM as synonym of putdouble.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_integer (i: INTEGER_32)
    			-- Write `i' to medium.
    			-- Was declared in STREAM as synonym of putint and put_integer_32.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_integer_16 (i: INTEGER_16)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_integer_32 (i: INTEGER_32)
    			-- Write `i' to medium.
    			-- Was declared in STREAM as synonym of put_integer and putint.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_integer_64 (i: INTEGER_64)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_integer_8 (i: INTEGER_8)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_managed_pointer (p: MANAGED_POINTER; start_pos, nb_bytes: INTEGER_32)
    			-- Put data of length `nb_bytes' pointed by `start_pos' index in `p' at
    			-- current position.
    		require -- from IO_MEDIUM
    			p_not_void: p /= Void
    			p_large_enough: p.count >= nb_bytes + start_pos
    			nb_bytes_non_negative: nb_bytes >= 0
    			extendible: extendible

    	put_natural (i: NATURAL_32)
    			-- Write `i' to medium.
    			-- Was declared in STREAM as synonym of put_natural_32.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_natural_16 (i: NATURAL_16)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_natural_32 (i: NATURAL_32)
    			-- Write `i' to medium.
    			-- Was declared in STREAM as synonym of put_natural.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_natural_64 (i: NATURAL_64)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_natural_8 (i: NATURAL_8)
    			-- Write `i' to medium.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_new_line
    			-- Write a new line character to medium
    			-- Was declared in STREAM as synonym of new_line.
    		require -- from IO_MEDIUM
    			extendible: extendible
    		require else
    			stream_exists: exists

    	put_real (r: REAL_32)
    			-- Write `r' to medium.
    			-- Was declared in STREAM as synonym of putreal.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	put_string (s: STRING_8)
    			-- Write `s' to medium.
    			-- Was declared in STREAM as synonym of putstring.
    		require -- from IO_MEDIUM
    			extendible: extendible
    			non_void: s /= Void

    	putbool (b: BOOLEAN)
    			-- Write `b' to medium.
    			-- Was declared in STREAM as synonym of put_boolean.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	putchar (c: CHARACTER_8)
    			-- Write `c' to medium.
    			-- Was declared in STREAM as synonym of put_character.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	putdouble (d: REAL_64)
    			-- Write `d' to medium.
    			-- Was declared in STREAM as synonym of put_double.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	putint (i: INTEGER_32)
    			-- Write `i' to medium.
    			-- Was declared in STREAM as synonym of put_integer and put_integer_32.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	putreal (r: REAL_32)
    			-- Write `r' to medium.
    			-- Was declared in STREAM as synonym of put_real.
    		require -- from IO_MEDIUM
    			extendible: extendible

    	putstring (s: STRING_8)
    			-- Write `s' to medium.
    			-- Was declared in STREAM as synonym of put_string.
    		require -- from IO_MEDIUM
    			extendible: extendible
    			non_void: s /= Void

    	frozen tagged_out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of out.
    			-- (from ANY)

    feature -- Platform

    	operating_environment: OPERATING_ENVIRONMENT
    			-- Objects available from the operating system
    			-- (from ANY)

    invariant
    		-- from ANY
    	reflexive_equality: standard_is_equal (Current)
    	reflexive_conformance: conforms_to (Current)

    indexing
    	library: "EiffelBase: Library of reusable components for Eiffel."
    	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
    	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
    	source: "[
    		Eiffel Software
    		356 Storke Road, 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 STREAM