note description: "Any medium that can perform input and/or output" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2016-12-05 17:39:47 +0000 (Mon, 05 Dec 2016) $" revision: "$Revision: 99631 $" deferred class IO_MEDIUM inherit DISPOSABLE export {NONE} all end STRING_HANDLER feature -- Access name: detachable STRING_8 -- Medium name deferred end retrieved: detachable 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 is_readable: readable support_storable: support_storable deferred end 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 object_not_void: object /= Void extendible: extendible support_storable: support_storable deferred end 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 object_not_void: object /= Void extendible: extendible support_storable: support_storable deferred end 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 object_not_void: object /= Void extendible: extendible support_storable: support_storable deferred end feature -- Status report handle: INTEGER_32 -- Handle to medium require valid_handle: handle_available deferred end handle_available: BOOLEAN -- Is the handle available after class has been -- created? deferred end is_plain_text: BOOLEAN -- Is file reserved for text (character sequences)? do end last_character: CHARACTER_8 -- Last character read by read_character last_string: STRING_8 -- Last string read last_integer: INTEGER_32 -- Last integer read by read_integer last_integer_32: INTEGER_32 -- Synonymy of last_integer do Result := last_integer end last_integer_64: INTEGER_64 -- Last 64-bit integer read by read_integer_64 last_integer_16: INTEGER_16 -- Last 16-bit integer read by read_integer_16 last_integer_8: INTEGER_8 -- Last 8-bit integer read by read_integer_8 last_natural_64: NATURAL_64 -- Last 64-bit natural read by read_natural_64 last_natural: NATURAL_32 -- Last 32-bit natural read by read_natural last_natural_32: NATURAL_32 -- Synonymy of last_natural do Result := last_natural end last_natural_16: NATURAL_16 -- Last 16-bit natural read by read_natural_16 last_natural_8: NATURAL_8 -- Last 8-bit natural read by read_natural_8 last_real: REAL_32 -- Last real read by read_real last_double: REAL_64 -- Last double read by read_double bytes_read: INTEGER_32 -- Last number of bytes read by read_to_managed_pointer. exists: BOOLEAN -- Does medium exist? deferred end is_open_read: BOOLEAN -- Is this medium opened for input deferred end is_open_write: BOOLEAN -- Is this medium opened for output deferred end is_readable: BOOLEAN -- Is medium readable? require handle_exists: exists deferred end is_executable: BOOLEAN -- Is medium executable? require handle_exists: exists deferred end is_writable: BOOLEAN -- Is medium writable? require handle_exists: exists deferred end readable: BOOLEAN -- Is there a current item that may be read? require handle_exists: exists deferred end extendible: BOOLEAN -- May new items be added? deferred end is_closed: BOOLEAN -- Is the I/O medium open deferred end support_storable: BOOLEAN -- Can medium be used to store an Eiffel object? deferred end feature -- Status setting close -- Close medium. require medium_is_open: not is_closed deferred end feature -- Removal dispose -- Ensure this medium is closed when garbage collected. do if not is_closed then close end end feature -- Output put_new_line -- Write a new line character to medium -- Was declared in IO_MEDIUM as synonym of new_line. require extendible: extendible deferred end new_line -- Write a new line character to medium -- Was declared in IO_MEDIUM as synonym of put_new_line. require extendible: extendible deferred end put_string (s: STRING_8) -- Write s to medium. -- Was declared in IO_MEDIUM as synonym of putstring. require extendible: extendible non_void: s /= Void deferred end putstring (s: STRING_8) -- Write s to medium. -- Was declared in IO_MEDIUM as synonym of put_string. require extendible: extendible non_void: s /= Void deferred end put_character (c: CHARACTER_8) -- Write c to medium. -- Was declared in IO_MEDIUM as synonym of putchar. require extendible: extendible deferred end putchar (c: CHARACTER_8) -- Write c to medium. -- Was declared in IO_MEDIUM as synonym of put_character. require extendible: extendible deferred end put_real (r: REAL_32) -- Write r to medium. -- Was declared in IO_MEDIUM as synonym of putreal. require extendible: extendible deferred end putreal (r: REAL_32) -- Write r to medium. -- Was declared in IO_MEDIUM as synonym of put_real. require extendible: extendible deferred end put_integer (i: INTEGER_32) -- Write i to medium. -- Was declared in IO_MEDIUM as synonym of putint and put_integer_32. require extendible: extendible deferred end putint (i: INTEGER_32) -- Write i to medium. -- Was declared in IO_MEDIUM as synonym of put_integer and put_integer_32. require extendible: extendible deferred end put_integer_32 (i: INTEGER_32) -- Write i to medium. -- Was declared in IO_MEDIUM as synonym of put_integer and putint. require extendible: extendible deferred end put_integer_8 (i: INTEGER_8) -- Write i to medium. require extendible: extendible deferred end put_integer_16 (i: INTEGER_16) -- Write i to medium. require extendible: extendible deferred end put_integer_64 (i: INTEGER_64) -- Write i to medium. require extendible: extendible deferred end put_natural_8 (i: NATURAL_8) -- Write i to medium. require extendible: extendible deferred end put_natural_16 (i: NATURAL_16) -- Write i to medium. require extendible: extendible deferred end put_natural (i: NATURAL_32) -- Write i to medium. -- Was declared in IO_MEDIUM as synonym of put_natural_32. require extendible: extendible deferred end put_natural_32 (i: NATURAL_32) -- Write i to medium. -- Was declared in IO_MEDIUM as synonym of put_natural. require extendible: extendible deferred end put_natural_64 (i: NATURAL_64) -- Write i to medium. require extendible: extendible deferred end put_boolean (b: BOOLEAN) -- Write b to medium. -- Was declared in IO_MEDIUM as synonym of putbool. require extendible: extendible deferred end putbool (b: BOOLEAN) -- Write b to medium. -- Was declared in IO_MEDIUM as synonym of put_boolean. require extendible: extendible deferred end put_double (d: REAL_64) -- Write d to medium. -- Was declared in IO_MEDIUM as synonym of putdouble. require extendible: extendible deferred end putdouble (d: REAL_64) -- Write d to medium. -- Was declared in IO_MEDIUM as synonym of put_double. require extendible: extendible deferred end 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 p_not_void: p /= Void p_large_enough: p.count >= nb_bytes + start_pos nb_bytes_non_negative: nb_bytes >= 0 extendible: extendible deferred end feature -- Input read_real -- Read a new real. -- Make result available in last_real. -- Was declared in IO_MEDIUM as synonym of readreal. require is_readable: readable deferred end readreal -- Read a new real. -- Make result available in last_real. -- Was declared in IO_MEDIUM as synonym of read_real. require is_readable: readable deferred end read_double -- Read a new double. -- Make result available in last_double. -- Was declared in IO_MEDIUM as synonym of readdouble. require is_readable: readable deferred end readdouble -- Read a new double. -- Make result available in last_double. -- Was declared in IO_MEDIUM as synonym of read_double. require is_readable: readable deferred end read_character -- Read a new character. -- Make result available in last_character. -- Was declared in IO_MEDIUM as synonym of readchar. require is_readable: readable deferred end readchar -- Read a new character. -- Make result available in last_character. -- Was declared in IO_MEDIUM as synonym of read_character. require is_readable: readable deferred end read_integer -- Read a new 32-bit integer. -- Make result available in last_integer. -- Was declared in IO_MEDIUM as synonym of readint and read_integer_32. require is_readable: readable deferred end readint -- Read a new 32-bit integer. -- Make result available in last_integer. -- Was declared in IO_MEDIUM as synonym of read_integer and read_integer_32. require is_readable: readable deferred end read_integer_32 -- Read a new 32-bit integer. -- Make result available in last_integer. -- Was declared in IO_MEDIUM as synonym of read_integer and readint. require is_readable: readable deferred end read_integer_8 -- Read a new 8-bit integer. -- Make result available in last_integer_8. require is_readable: readable deferred end read_integer_16 -- Read a new 16-bit integer. -- Make result available in last_integer_16. require is_readable: readable deferred end read_integer_64 -- Read a new 64-bit integer. -- Make result available in last_integer_64. require is_readable: readable deferred end read_natural_8 -- Read a new 8-bit natural. -- Make result available in last_natural_8. require is_readable: readable deferred end read_natural_16 -- Read a new 16-bit natural. -- Make result available in last_natural_16. require is_readable: readable deferred end read_natural -- Read a new 32-bit natural. -- Make result available in last_natural. -- Was declared in IO_MEDIUM as synonym of read_natural_32. require is_readable: readable deferred end read_natural_32 -- Read a new 32-bit natural. -- Make result available in last_natural. -- Was declared in IO_MEDIUM as synonym of read_natural. require is_readable: readable deferred end read_natural_64 -- Read a new 64-bit natural. -- Make result available in last_natural_64. require is_readable: readable deferred end 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 IO_MEDIUM as synonym of readstream. require is_readable: readable deferred ensure last_string_not_void: last_string /= Void end 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 IO_MEDIUM as synonym of read_stream. require is_readable: readable deferred ensure last_string_not_void: last_string /= Void end read_stream_thread_aware (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. -- Functionally identical to read_stream but -- won't prevent garbage collection from occurring -- while blocked waiting for data, though data must -- be copied an extra time. require is_readable: readable do read_stream (nb_char) ensure last_string_not_void: last_string /= Void end read_line -- Read characters until a new line or -- end of medium. -- Make result available in last_string. -- Was declared in IO_MEDIUM as synonym of readline. require is_readable: readable deferred ensure last_string_not_void: last_string /= Void end readline -- Read characters until a new line or -- end of medium. -- Make result available in last_string. -- Was declared in IO_MEDIUM as synonym of read_line. require is_readable: readable deferred ensure last_string_not_void: last_string /= Void end read_line_thread_aware -- Read characters until a new line or -- end of medium. -- Make result available in last_string. -- Functionally identical to read_line but -- won't prevent garbage collection from occurring -- while blocked waiting for data, though data must -- be copied an extra time. require is_readable: readable do read_line ensure last_string_not_void: last_string /= Void end 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 p_not_void: p /= Void p_large_enough: p.count >= nb_bytes + start_pos nb_bytes_non_negative: nb_bytes >= 0 is_readable: readable deferred ensure bytes_read_non_negative: bytes_read >= 0 bytes_read_not_too_big: bytes_read <= nb_bytes end feature -- Obsolete lastchar: CHARACTER_8 -- Last character read by read_character do Result := last_character end laststring: like last_string -- Last string read do Result := last_string end lastint: INTEGER_32 -- Last integer read by read_integer do Result := last_integer end lastreal: REAL_32 -- Last real read by read_real do Result := last_real end lastdouble: REAL_64 -- Last double read by read_double do Result := last_double end 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 IO_MEDIUM
Generated by ISE EiffelStudio