Automatic generation produced by ISE Eiffel

Classes
Clusters
Cluster hierarchy
Chart
Relations
Text
Flat
Contracts
Flat contracts
Go to: 
indexing
	description: "Implementation of the STORABLE mechanism with streams."
	date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $"
	revision: "$Revision: 51435 $"

class 
	STREAM

inherit
	IO_MEDIUM

create 
	make,
	make_with_size

feature -- Initialization

	make is
			-- Create stream object with a default_size of 100 bytes
		do
			buffer_size := 200
			create_c_buffer
		end

	make_with_size (n: INTEGER) is
			-- Create stream object with a default_size of n bytes
		do
			buffer_size := n
			create_c_buffer
		end
	
feature -- Status report

	Support_storable: BOOLEAN is True
			-- Can medium be used to store an Eiffel structure?
	
feature -- Access

	buffer: POINTER
			-- C buffer correspond to the Eiffel STREAM.

	buffer_size: INTEGER
			-- Buffer's size.

	object_stored_size: INTEGER
			-- Size of last stored object.

	create_c_buffer is
			-- Create the C memory corresponding to the C
			-- buffer.
		do
			buffer := c_malloc (buffer_size)
		end

	retrieved: ANY is
			-- 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.
		local
			size: INTEGER
		do
			Result := c_retrieved (buffer, buffer_size, 0, $size)
			object_stored_size := size
		end
	
feature -- Element change

	basic_store (object: ANY) is
			-- Produce an external representation of the
			-- entire object structure reachable from object.
			-- Retrievable within current system only.
		local
			size: INTEGER
		do
			buffer_size := c_stream_basic_store (buffer, buffer_size, $object, $size)
			object_stored_size := size
		end

	general_store (object: ANY) is
			-- Produce an external representation of the
			-- entire object structure reachable from object.
			-- Retrievable from other systems for same platform
			-- (machine architecture).
		local
			size: INTEGER
		do
			buffer_size := c_stream_general_store (buffer, buffer_size, $object, $size)
			object_stored_size := size
		end

	independent_store (object: ANY) is
			-- Produce an external representation of the
			-- entire object structure reachable from object.
			-- Retrievable from other systems for the same or other
			-- platform (machine architecture).
		local
			size: INTEGER
		do
			buffer_size := c_stream_independent_store (buffer, buffer_size, $object, $size)
			object_stored_size := size
		end

	set_additional_size (new_size: INTEGER) is
			-- Set new_size to BUFFER_SIZE, internal value used to
			-- increment buffer_size during storable operations.
		external
			"C | %"eif_store.h%""
		alias
			"set_buffer_size"
		end
	
feature {NONE} -- Implementation

	c_stream_basic_store (stream_buffer: POINTER; stream_buffer_size: INTEGER; object: POINTER; c_real_size: POINTER): INTEGER is
			-- Store object structure reachable form current object
			-- Return new size of buffer.
		external
			"C | %"eif_store.h%""
		alias
			"stream_estore"
		end

	c_stream_general_store (stream_buffer: POINTER; stream_buffer_size: INTEGER; object: POINTER; c_real_size: POINTER): INTEGER is
			-- Store object structure reachable form current object
			-- Return new size of buffer.
		external
			"C | %"eif_store.h%""
		alias
			"stream_eestore"
		end

	c_stream_independent_store (stream_buffer: POINTER; stream_buffer_size: INTEGER; object: POINTER; c_real_size: POINTER): INTEGER is
			-- Store object structure reachable form current object
			-- Return new size of buffer.
		external
			"C |%"eif_store.h%""
		alias
			"stream_sstore"
		end

	c_retrieved (stream_buffer: POINTER; stream_buffer_size: INTEGER; stream_buffer_position: INTEGER; c_real_size: POINTER): ANY is
			-- Object structured retrieved from stream of pointer
			-- stream_ptr
		external
			"C | %"eif_retrieve.h%""
		alias
			"stream_eretrieve"
		end

	c_malloc (size: INTEGER): POINTER is
		external
			"C | %"eif_store.h%""
		alias
			"stream_malloc"
		end

	c_free (buf: POINTER) is
		external
			"C | %"eif_store.h%""
		alias
			"stream_free"
		end
	
feature -- Status report

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

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

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

	Is_readable: BOOLEAN is True

	is_executable: BOOLEAN is
			-- Is stream executable?
		do
			Result := False
		end

	Is_writable: BOOLEAN is True
			-- Stream is writable.

	readable: BOOLEAN is
			-- Is there a current item that may be read?
		do
		end

	extendible: BOOLEAN is
			-- May new items be added?
		do
			Result := True
		end

	is_closed: BOOLEAN
			-- Is the I/O medium open
	
feature -- Status setting

	close is
			-- Close medium.
		do
			is_closed := True
			c_free (buffer)
			buffer := default_pointer
		end
	
feature -- Output

	put_new_line is
			-- Write a new line character to medium
			-- Was declared in STREAM as synonym of new_line.
		require else
			stream_exists: exists
		do
			put_character ('%N')
		end

	new_line is
			-- Write a new line character to medium
			-- Was declared in STREAM as synonym of put_new_line.
		require else
			stream_exists: exists
		do
			put_character ('%N')
		end

	put_string (s: STRING) is
			-- Write s to medium.
			-- Was declared in STREAM as synonym of putstring.
		do
		end

	putstring (s: STRING) is
			-- Write s to medium.
			-- Was declared in STREAM as synonym of put_string.
		do
		end

	put_character (c: CHARACTER) is
			-- Write c to medium.
			-- Was declared in STREAM as synonym of putchar.
		do
		end

	putchar (c: CHARACTER) is
			-- Write c to medium.
			-- Was declared in STREAM as synonym of put_character.
		do
		end

	put_real (r: REAL) is
			-- Write r to medium.
			-- Was declared in STREAM as synonym of putreal.
		do
		end

	putreal (r: REAL) is
			-- Write r to medium.
			-- Was declared in STREAM as synonym of put_real.
		do
		end

	put_integer (i: INTEGER) is
			-- Write i to medium.
			-- Was declared in STREAM as synonym of putint.
		do
		end

	putint (i: INTEGER) is
			-- Write i to medium.
			-- Was declared in STREAM as synonym of put_integer.
		do
		end

	put_boolean (b: BOOLEAN) is
			-- Write b to medium.
			-- Was declared in STREAM as synonym of putbool.
		do
		end

	putbool (b: BOOLEAN) is
			-- Write b to medium.
			-- Was declared in STREAM as synonym of put_boolean.
		do
		end

	put_double (d: DOUBLE) is
			-- Write d to medium.
			-- Was declared in STREAM as synonym of putdouble.
		do
		end

	putdouble (d: DOUBLE) is
			-- Write d to medium.
			-- Was declared in STREAM as synonym of put_double.
		do
		end
	
feature -- Input

	read_real is
			-- Read a new real.
			-- Make result available in last_real.
			-- Was declared in STREAM as synonym of readreal.
		do
		end

	readreal is
			-- Read a new real.
			-- Make result available in last_real.
			-- Was declared in STREAM as synonym of read_real.
		do
		end

	read_double is
			-- Read a new double.
			-- Make result available in last_double.
			-- Was declared in STREAM as synonym of readdouble.
		do
		end

	readdouble is
			-- Read a new double.
			-- Make result available in last_double.
			-- Was declared in STREAM as synonym of read_double.
		do
		end

	read_character is
			-- Read a new character.
			-- Make result available in last_character.
			-- Was declared in STREAM as synonym of readchar.
		do
		end

	readchar is
			-- Read a new character.
			-- Make result available in last_character.
			-- Was declared in STREAM as synonym of read_character.
		do
		end

	read_integer is
			-- Read a new integer.
			-- Make result available in last_integer.
			-- Was declared in STREAM as synonym of readint.
		do
		end

	readint is
			-- Read a new integer.
			-- Make result available in last_integer.
			-- Was declared in STREAM as synonym of read_integer.
		do
		end

	read_stream (nb_char: INTEGER) is
			-- 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.
		do
		end

	readstream (nb_char: INTEGER) is
			-- 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.
		do
		end

	read_line is
			-- Read characters until a new line or
			-- end of medium.
			-- Make result available in last_string.
			-- Was declared in STREAM as synonym of readline.
		do
		end

	readline is
			-- 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.
		do
		end
	
feature {NONE} -- Not exported

	name: STRING is
			-- Not meaningful
		do
		end

	handle: INTEGER is
			-- Handle to medium
		do
		end

	handle_available: BOOLEAN is
			-- Is the handle available after class has been
			-- created?
		do
		end
	
indexing
	library: "[
			EiffelBase: Library of reusable components for Eiffel.
	]"
	status: "[
			Copyright 1986-2001 Interactive Software Engineering (ISE).
			For ISE customers the original versions are an ISE product
			covered by the ISE Eiffel license and support agreements.
	]"
	license: "[
			EiffelBase may now be used by anyone as FREE SOFTWARE to
			develop any product, public-domain or commercial, without
			payment to ISE, under the terms of the ISE Free Eiffel Library
			License (IFELL) at http://eiffel.com/products/base/license.html.
	]"
	source: "[
			Interactive Software Engineering Inc.
			ISE Building
			360 Storke Road, Goleta, CA 93117 USA
			Telephone 805-685-1006, Fax 805-685-6869
			Electronic mail <info@eiffel.com>
			Customer support http://support.eiffel.com
	]"
	info: "[
			For latest info see award-winning pages: http://eiffel.com
	]"

end -- class STREAM


Classes
Clusters
Cluster hierarchy
Chart
Relations
Text
Flat
Contracts
Flat contracts
Go to: 

-- Generated by ISE Eiffel --
For more details: www.eiffel.com