    indexing
    	description: "Encapsulation of standard implementation of IStream interface."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-04-25 12:20:38 -0700 (Tue, 25 Apr 2006) $"
    	revision: "$Revision: 58454 $"

    class interface
    	ECOM_STREAM

    create
    	make_from_other (other: ECOM_INTERFACE)
    			-- Make from other Queriable.
    			-- (from ECOM_QUERIABLE)
    		require -- from ECOM_QUERIABLE
    			non_void_other: other /= Void
    		ensure -- from ECOM_QUERIABLE
    			valid_initializer: initializer /= default_pointer
    			exists: exists

    	make_from_pointer (cpp_obj: POINTER)
    			-- Make from pointer
    		require -- from ECOM_QUERIABLE
    			non_default_pointer: cpp_obj /= default_pointer
    		ensure -- from ECOM_QUERIABLE
    			valid_initializer: initializer /= default_pointer
    			exists: exists

    feature --  Access

    	hresult: INTEGER_32
    			-- Original HRESULT.
    			-- (from ECOM_EXCEPTION)
    		require -- from ECOM_EXCEPTION
    			applicable: is_developer_exception

    	hresult_code: INTEGER_32
    			-- Status code.
    			-- (from ECOM_EXCEPTION)
    		require -- from ECOM_EXCEPTION
    			applicable: is_developer_exception

    	hresult_facility: INTEGER_32
    			-- Facility code.
    			-- (from ECOM_EXCEPTION)
    		require -- from ECOM_EXCEPTION
    			applicable: is_developer_exception

    	hresult_message: STRING_8
    			-- Error message.
    			-- (from ECOM_EXCEPTION)
    		require -- from ECOM_EXCEPTION
    			applicable: is_developer_exception
    		ensure -- from ECOM_EXCEPTION
    			non_void_message: Result /= Void

    feature -- Access

    	access_time: WEL_FILE_TIME
    			-- Access time

    	check_instruction: INTEGER_32 is 7
    			-- Exception code for violated check
    			-- (from EXCEP_CONST)

    	class_invariant: INTEGER_32 is 6
    			-- Exception code for violated class invariant
    			-- (from EXCEP_CONST)

    	com_exception: INTEGER_32 is 28
    			-- Exception code for a COM error.
    			-- (from EXCEP_CONST)

    	create_on_deferred: INTEGER_32 is 17
    			-- Create on deferred
    			-- (from EXCEP_CONST)

    	creation_time: WEL_FILE_TIME
    			-- Creation time

    	description (stat_flag: INTEGER_32): ECOM_STATSTG
    			-- STATSTG structure
    			-- See class ECOM_STAT_FLAGS for `stat_flag' values.
    		require
    			valid_stat_flag: is_valid_stat_flag (stat_flag)
    		ensure
    			Result /= Void

    	developer_exception: INTEGER_32 is 24
    			-- Exception code for developer exception
    			-- (from EXCEP_CONST)

    	dollar_applied_to_melted_feature: INTEGER_32 is 26
    			-- $ applied to melted feature
    			-- (from EXCEP_CONST)

    	eiffel_runtime_fatal_error: INTEGER_32 is 25
    			-- Eiffel run-time fatal error
    			-- (from EXCEP_CONST)

    	eiffel_runtime_panic: INTEGER_32 is 13
    			-- Eiffel run-time panic
    			-- (from EXCEP_CONST)

    	end_of_stream: BOOLEAN
    			-- Is current seek pointer at end of stream?
    			-- Valid only after read ,update_end_of_stream, start, or finish.

    	exception_in_signal_handler: INTEGER_32 is 20
    			-- Exception in signal handler
    			-- (from EXCEP_CONST)

    	exists: BOOLEAN
    			-- Is wrapped structure initialized?
    			-- (from ECOM_QUERIABLE)

    	external_exception: INTEGER_32 is 18
    			-- Exception code for operating system error
    			-- which does not set the `errno' variable
    			-- (Unix-specific)
    			-- (from EXCEP_CONST)

    	floating_point_exception: INTEGER_32 is 5
    			-- Exception code for floating point exception
    			-- (from EXCEP_CONST)

    	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)

    	incorrect_inspect_value: INTEGER_32 is 9
    			-- Exception code for inspect value which is not one
    			-- of the inspect constants, if there is no Else_part
    			-- (from EXCEP_CONST)

    	io_exception: INTEGER_32 is 21
    			-- Exception code for I/O error
    			-- (from EXCEP_CONST)

    	is_valid_lock (lock: INTEGER_32): BOOLEAN
    			-- Is `lock' a valid locktype?
    			-- (from ECOM_LOCK_TYPES)

    	is_valid_seek (seek: INTEGER_32): BOOLEAN
    			-- Is seek a valid IStorage and IStream seek flag?
    			-- (from ECOM_STREAM_SEEK)

    	is_valid_stat_flag (flag: INTEGER_32): BOOLEAN
    			-- Is `flag' a valid stat flag?
    			-- (from ECOM_STAT_FLAGS)

    	item: POINTER
    			-- Pointer to COM object wrapper.
    			-- (from ECOM_QUERIABLE)

    	last_boolean: BOOLEAN
    			-- last read BOOLEAN

    	last_character: CHARACTER_8
    			-- last read CHARACTER

    	last_integer: INTEGER_32
    			-- last read INTEGER

    	last_real: REAL_32
    			-- last read REAL

    	last_string: STRING_8
    			-- last read STRING

    	lock_exclusive: INTEGER_32
    			-- Attempts to read or write this stream by other stream openings
    			-- return error EOLE_STG_E_ACCESSDENIED.
    			-- (from ECOM_LOCK_TYPES)

    	lock_onlyonce: INTEGER_32
    			-- If lock is granted, no other EOLE_LOCK_ONLYONCE lock can be
    			-- obtained on bytes in given region. Usually this lock type
    			-- is an alias for some other lock type and other semantics might occur
    			-- as a side effect.
    			-- (from ECOM_LOCK_TYPES)

    	lock_write: INTEGER_32
    			-- If lock is granted, specified region of stream
    			-- can be read by calling IStream.Read from any opening of
    			-- this stream. Attempts to write to this region from any opening
    			-- of this stream other than the one to which lock was granted
    			-- returns error EOLE_STG_E_ACCESSDENIED.
    			-- (from ECOM_LOCK_TYPES)

    	locks_supported: INTEGER_32
    			-- Types of region locking supported by stream

    	loop_invariant: INTEGER_32 is 11
    			-- Exception code for violated loop invariant
    			-- (from EXCEP_CONST)

    	loop_variant: INTEGER_32 is 10
    			-- Exception code for non-decreased loop variant
    			-- (from EXCEP_CONST)

    	modification_time: WEL_FILE_TIME
    			-- Modification time

    	name: STRING_8
    			-- Name

    	no_more_memory: INTEGER_32 is 2
    			-- Exception code for failed memory allocation
    			-- (from EXCEP_CONST)

    	number_of_codes: INTEGER_32 is 29
    			-- How many codes are there to represent exceptions?
    			-- (from EXCEP_CONST)

    	operating_system_exception: INTEGER_32 is 22
    			-- Exception code for operating system error
    			-- which sets the `errno' variable
    			-- (Unix-specific)
    			-- (from EXCEP_CONST)

    	out_of_memory: INTEGER_32 is 15
    			-- Out of memory (cannot be ignored)
    			-- (from EXCEP_CONST)

    	postcondition: INTEGER_32 is 4
    			-- Exception code for violated postcondition
    			-- (from EXCEP_CONST)

    	precondition: INTEGER_32 is 3
    			-- Exception code for violated precondition
    			-- (from EXCEP_CONST)

    	rescue_exception: INTEGER_32 is 14
    			-- Exception code for exception in rescue clause
    			-- (from EXCEP_CONST)

    	resumption_failed: INTEGER_32 is 16
    			-- Resumption failed (retry did not succeed)
    			-- (from EXCEP_CONST)

    	retrieve_exception: INTEGER_32 is 23
    			-- Exception code for retrieval error
    			-- may be raised by `retrieved' in `IO_MEDIUM'.
    			-- (from EXCEP_CONST)

    	routine_failure: INTEGER_32 is 8
    			-- Exception code for failed routine
    			-- (from EXCEP_CONST)

    	runtime_check_exception: INTEGER_32 is 29
    			-- Exception code for runtime check being violated.
    			-- (from EXCEP_CONST)

    	runtime_io_exception: INTEGER_32 is 27
    			-- Exception code for I/O error raised by runtime functions
    			-- such as store/retrieve, file access...
    			-- (from EXCEP_CONST)

    	signal_exception: INTEGER_32 is 12
    			-- Exception code for operating system signal
    			-- (from EXCEP_CONST)

    	size: ECOM_ULARGE_INTEGER
    			-- Size in bytes

    	statflag_default: INTEGER_32
    			-- Indicate that this is not used for property
    			-- (from ECOM_STAT_FLAGS)

    	statflag_noname: INTEGER_32
    			-- Indicate that this is not used for property
    			-- (from ECOM_STAT_FLAGS)

    	stream_seek_cur: INTEGER_32
    			-- Sets seek position relative to
    			-- current position of stream
    			-- (from ECOM_STREAM_SEEK)

    	stream_seek_end: INTEGER_32
    			-- Sets seek position relative to
    			-- current end of stream
    			-- (from ECOM_STREAM_SEEK)

    	stream_seek_set: INTEGER_32
    			-- Sets seek position relative to
    			-- beginning of stream
    			-- (from ECOM_STREAM_SEEK)

    	valid_code (c: INTEGER_32): BOOLEAN
    			-- Is `c' a valid code to represent some kind of exceptions?
    			-- (from EXCEP_CONST)

    	void_assigned_to_expanded: INTEGER_32 is 19
    			-- Exception code for assignment of void value
    			-- to expanded entity
    			-- (from EXCEP_CONST)

    	void_call_target: INTEGER_32 is 1
    			-- Exception code for feature applied to void reference
    			-- (from EXCEP_CONST)

    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

    	assertion_violation: BOOLEAN
    			-- Is last exception originally due to a violated
    			-- assertion or non-decreasing variant?
    			-- (from EXCEPTIONS)

    	class_name: STRING_8
    			-- Name of the class that includes the recipient
    			-- of original form of last exception
    			-- (from EXCEPTIONS)

    	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

    	developer_exception_name: STRING_8
    			-- Name of last developer-raised exception
    			-- (from EXCEPTIONS)
    		require -- from EXCEPTIONS
    			applicable: is_developer_exception

    	exception: INTEGER_32
    			-- Code of last exception that occurred
    			-- (from EXCEPTIONS)

    	exception_trace: STRING_8
    			-- String representation of the exception trace
    			-- (from EXCEPTIONS)

    	is_developer_exception: BOOLEAN
    			-- Is the last exception originally due to
    			-- a developer exception?
    			-- (from EXCEPTIONS)

    	is_developer_exception_of_name (name: STRING_8): BOOLEAN
    			-- Is the last exception originally due to a developer
    			-- exception of name name?
    			-- (from EXCEPTIONS)

    	is_signal: BOOLEAN
    			-- Is last exception originally due to an external
    			-- event (operating system signal)?
    			-- (from EXCEPTIONS)

    	is_system_exception: BOOLEAN
    			-- Is last exception originally due to an
    			-- external event (operating system error)?
    			-- (from EXCEPTIONS)

    	meaning (except: INTEGER_32): STRING_8
    			-- A message in English describing what `except' is
    			-- (from EXCEPTIONS)

    	original_class_name: STRING_8
    			-- Name of the class that includes the recipient
    			-- of original form of last exception
    			-- (from EXCEPTIONS)

    	original_exception: INTEGER_32
    			-- Original code of last exception that triggered
    			-- current exception
    			-- (from EXCEPTIONS)

    	original_recipient_name: STRING_8
    			-- Name of the routine whose execution was
    			-- interrupted by original form of last exception
    			-- (from EXCEPTIONS)

    	original_tag_name: STRING_8
    			-- Assertion tag for original form of last
    			-- assertion violation.
    			-- (from EXCEPTIONS)

    	recipient_name: STRING_8
    			-- Name of the routine whose execution was
    			-- interrupted by last exception
    			-- (from EXCEPTIONS)

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

    	tag_name: STRING_8
    			-- Tag of last violated assertion clause
    			-- (from EXCEPTIONS)

    feature -- Status setting

    	catch (code: INTEGER_32)
    			-- Make sure that any exception of code `code' will be
    			-- caught. This is the default.
    			-- (from EXCEPTIONS)

    	die (code: INTEGER_32)
    			-- Terminate execution with exit status `code',
    			-- without triggering an exception.
    			-- (from EXCEPTIONS)

    	ignore (code: INTEGER_32)
    			-- Make sure that any exception of code `code' will be
    			-- ignored. This is not the default.
    			-- (from EXCEPTIONS)

    	message_on_failure
    			-- Print an exception history table
    			-- in case of failure.
    			-- This is the default.
    			-- (from EXCEPTIONS)

    	no_message_on_failure
    			-- Do not print an exception history table
    			-- in case of failure.
    			-- (from EXCEPTIONS)

    	raise (name: STRING_8)
    			-- Raise a developer exception of name name.
    			-- (from EXCEPTIONS)

    	raise_retrieval_exception (name: STRING_8)
    			-- Raise a retrieval exception of name name.
    			-- (from EXCEPTIONS)

    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 -- Basic Operations

    	clone_stream: ECOM_STREAM
    			-- New stream referencing
    			-- the same bytes as Current
    			-- Seek pointer is also cloned
    		ensure
    			clone_created: Result /= Void and then Result.exists

    	copy_to (destination: ECOM_STREAM; bytes: ECOM_ULARGE_INTEGER)
    			-- Copy `bytes' number of bytes from current seek pointer
    			-- in stream to current seek pointer in
    			-- `destination'.
    		require
    			valid_destination: destination /= Void and then destination.exists
    			valid_bytes_number: bytes /= Void and then bytes.exists

    	finish
    			-- Set seek pointer to end of stream.
    		ensure
    			at_end: end_of_stream

    	lock_region (offset, count: ECOM_ULARGE_INTEGER; lock: INTEGER_32)
    			-- Restricts access to range of bytes defined by
    			-- `offset' and `count'.
    		require
    			valid_offset: offset /= Void and then offset.exists
    			valid_count: count /= Void and then count.exists
    			valid_lock: is_valid_lock (lock)

    	read (buffer: POINTER; bytes: INTEGER_32)
    			-- Reads `bytes' number of bytes from stream
    			-- into `buffer' starting at current seek pointer.
    		require
    			valid_buffer: buffer /= default_pointer
    			valid_bytes: bytes >= 0

    	read_boolean
    			-- Read boolean from stream.

    	read_character
    			-- Read character from stream.

    	read_integer
    			-- Read integer from stream.

    	read_real
    			-- Read real from stream.

    	read_string
    			-- Read string from stream.

    	seek (displacement: ECOM_LARGE_INTEGER; origin: INTEGER_32)
    			-- Move seek pointer by `displacement'
    			-- relative to `origin'.
    			-- See class ECOM_STREAM_SEEK for `origin' values.
    		require
    			non_void_displacement: displacement /= Void
    			valid_displacement: displacement.exists
    			valid_seek_origin: is_valid_seek (origin)

    	set_size (new_size: ECOM_ULARGE_INTEGER)
    			-- Change size of stream to `new_size'.
    		require
    			valid_new_size: new_size /= Void and then new_size.exists
    		ensure
    			size = new_size

    	start
    			-- Set seek pointer to beginning of stream.
    		ensure
    			not_end: not end_of_stream

    	unlock_region (offset, count: ECOM_ULARGE_INTEGER; lock: INTEGER_32)
    			-- Removes access restriction to range of bytes defined by
    			-- `offset' and `count'.
    		require
    			valid_offset: offset /= Void and then offset.exists
    			valid_count: count /= Void and then count.exists
    			valid_lock: is_valid_lock (lock)

    	update_end_of_stream
    			-- Update value of end_of_stream.

    	write (buffer: POINTER; bytes: INTEGER_32)
    			-- Writes `bytes' number of bytes into stream
    			-- starting at current seek pointer.
    		require
    			valid_buffer: buffer /= default_pointer

    	write_boolean (boolean: BOOLEAN)
    			-- Write `boolean' into stream.

    	write_character (character: CHARACTER_8)
    			-- Write `character' into stream.

    	write_integer (integer: INTEGER_32)
    			-- Write `integer' into stream.

    	write_real (real: REAL_32)
    			-- Write `real' into stream.

    	write_string (string: STRING_8)
    			-- Write `string' into stream.
    		require
    			string /= Void

    feature -- Element Change

    	trigger (code: INTEGER_32)
    			-- Raise exception with code `code'.
    			-- See class ECOM_EXCEPTION_CODES for possible values.
    			-- (from ECOM_EXCEPTION)

    feature -- Output

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

    	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)

    	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 ECOM_QUERIABLE
    	queriable_invariant: initializer /= default_pointer and then exists

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

    indexing
    	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 ECOM_STREAM