+
Point of view
All features
class BINARY_FILE_READ
Summary
top
This class allow to read a file on the disk as a binary file (ie. file containing bytes). If you need to read a file which contain text, then consider using TEXT_FILE_READ.
Direct parents
Inherit list: BINARY_INPUT_STREAM, FILE_STREAM, TERMINAL_INPUT_STREAM
Insert list: PLATFORM
Class invariant
top
Overview
top
Creation features
{ANY}
Features
{ANY}
{FILTER}
{FILTER_INPUT_STREAM}
{}
{ANY}
{FILTER_INPUT_STREAM}
{FILTER}
{ANY}
{}
{ANY}
{}
{STREAM_HANDLER}
{ANY}
{}
{RECYCLING_POOL}
  • recycle
    Do whatever needs to be done to free resources or recycle other objects when recycling this one
{}
  • dispose
    Action to be executed just before garbage collection reclaims an object.
{}
{ANY}
Skipping separators:
{ANY}
To read one number at a time:
{ANY}
To read one line or one word at a time:
{ANY}
Other features:
{ANY}
{}
{FILTER}
{ANY}
  • path: STRING
    Not Void when connected to the corresponding file on the disk.
{}
Maximum:
{}
Minimum:
{}
Bits:
{}
connect_to (new_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Open binary file for reading.
disconnect
effective procedure
{ANY}
top
Try to disconnect the stream.
can_unread_character: BOOLEAN
effective function
{ANY}
top
read_byte
effective procedure
{ANY}
top
Read a byte and assign it to last_byte.
last_byte: INTEGER_32
effective function
{ANY}
top
Last byte read with read_byte.
read_integer_16_native_endian
effective procedure
{ANY}
top
Read in the same order as the machine running this code.
read_integer_16_big_endian
effective procedure
{ANY}
top
Read a big endian value is the file.
read_integer_16_little_endian
effective procedure
{ANY}
top
Read a little endian value is the file.
last_integer_16: INTEGER_32
writable attribute
{ANY}
top
Last byte read with read_integer_16_*.
read_integer_32_native_endian
effective procedure
{ANY}
top
Read in the same order as the machine running this code.
read_integer_32_big_endian
effective procedure
{ANY}
top
Read a big endian value is the file.
read_integer_32_little_endian
effective procedure
{ANY}
top
Read a little endian value is the file.
last_integer_32: INTEGER_32
writable attribute
{ANY}
top
end_of_input: BOOLEAN
writable attribute
{ANY}
top
end_of_input means the previous attempt in character reading failed because the end has been reached.
seek (new_offset: INTEGER_64)
effective procedure
{ANY}
top
Next read will start at position new_offset, counted from the beginning of the file.
offset: INTEGER_64
effective function
{ANY}
top
The offset that will be used for the next read.
terminal_settings: TERMINAL_SETTINGS
effective function
{ANY}
top
filtered_descriptor: INTEGER_32
effective function
{FILTER}
top
Find the descriptor of the terminal stream...
filtered_has_descriptor: BOOLEAN
is True
constant attribute
{FILTER}
top
True if the underlying terminal stream has a descriptor
filtered_stream_pointer: POINTER
writable attribute
{FILTER}
top
Find the pointer of the terminal stream...
filtered_has_stream_pointer: BOOLEAN
is True
constant attribute
{FILTER}
top
True if the underlying terminal stream has a pointer
filtered_read_character
effective procedure
{FILTER_INPUT_STREAM}
top
filtered_unread_character
effective procedure
{FILTER_INPUT_STREAM}
top
filtered_last_character: CHARACTER
writable attribute
{FILTER_INPUT_STREAM}
top
writable attribute
{}
top
buffer_position: INTEGER_32
writable attribute
{}
top
buffer_size: INTEGER_32
writable attribute
{}
top
capacity: INTEGER_32
writable attribute
{}
top
the_terminal_settings: TERMINAL_SETTINGS
writable attribute
{}
top
fill_buffer
effective procedure
{}
top
make
effective procedure
{}
top
The new created object is not connected.
with_buffer_size (buffer_capacity: INTEGER_32)
effective procedure
{}
top
binary_file_read_open (path_pointer: POINTER): POINTER
{}
top
io_fclose (stream: POINTER)
{}
top
io_fseek (path_pointer: POINTER, new_offset: INTEGER_64): INTEGER_32
{}
top
io_ftell (path_pointer: POINTER): INTEGER_64
{}
top
as_16_ne (c1: CHARACTER, c2: CHARACTER): INTEGER_16
{}
top
as_32_ne (i1: INTEGER_16, i2: INTEGER_16): INTEGER_32
{}
top
read_character
effective procedure
{ANY}
top
If read_character fail, end_of_input is set.
read_line_in (buffer: STRING)
effective procedure
{ANY}
top
Same job as read_line but storage is directly done in buffer.
read_available_in (buffer: STRING, limit: INTEGER_32)
effective procedure
{ANY}
top
Same job as read_available but storage is directly done in buffer.
unread_character
effective procedure
{ANY}
top
last_character: CHARACTER
effective function
{ANY}
top
detach
effective procedure
{ANY}
top
Shake off the filter.
filtered_read_available_in (buffer: STRING, limit: INTEGER_32)
effective procedure
{FILTER_INPUT_STREAM}
top
filtered_read_line_in (buffer: STRING)
effective procedure
{FILTER_INPUT_STREAM}
top
writable attribute
{FILTER}
top
The filter that uses this stream as backend
event_can_read: EVENT_DESCRIPTOR
effective function
{ANY}
top
writable attribute
{}
top
new_url: URL
effective function
{}
top
is_connected: BOOLEAN
deferred function
{ANY}
top
True if the stream is connected.
descriptor: INTEGER_32
effective function
{ANY}
top
Some OS-dependent descriptor.
has_descriptor: BOOLEAN
effective function
{ANY}
top
True if that stream can be associated to some OS-meaningful descriptor.
can_disconnect: BOOLEAN
deferred function
{ANY}
top
True if the stream can be safely disconnected (without data loss, etc.)
url: URL
frozen
effective function
{ANY}
top
The URL to this stream as resource
url_memory: URL
writable attribute
{}
top
stream_pointer: POINTER
effective function
{STREAM_HANDLER}
top
Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)
has_stream_pointer: BOOLEAN
effective function
{STREAM_HANDLER}
top
True if that stream can be associated to some Back-end-meaningful stream pointer.
event_exception: EVENT_DESCRIPTOR
effective function
{ANY}
top
stream_exception: STREAM_EXCEPTION
writable attribute
{}
top
recycle
effective procedure
{RECYCLING_POOL}
top
Do whatever needs to be done to free resources or recycle other objects when recycling this one
dispose
effective procedure
{}
top
Action to be executed just before garbage collection reclaims an object.
sequencer_descriptor (file: POINTER): INTEGER_32
{}
top
can_read_character: BOOLEAN
deferred function
{ANY}
top
Note that this state is usually temporary.
can_read_line: BOOLEAN
deferred function
{ANY}
top
valid_last_character: BOOLEAN
deferred function
{ANY}
top
is_filtered: BOOLEAN
deferred function
{ANY}
top
skip_separators
effective procedure
{ANY}
top
Skip all separators (see is_separator of class CHARACTER) and make the first non-separator available in last_character.
skip_separators_using (separators: STRING)
effective procedure
{ANY}
top
Same job as skip_separators using the separators set.
skip_remainder_of_line
effective procedure
{ANY}
top
Skip all the remainder of the line including the end of line delimiter itself.
read_integer
effective procedure
{ANY}
top
Read an integer according to the Eiffel syntax.
last_integer: INTEGER_32
writable attribute
{ANY}
top
Last integer read using read_integer.
valid_last_integer: BOOLEAN
writable attribute
{ANY}
top
Was the last call to read_integer successful ?
last_real: REAL_64
writable attribute
{ANY}
top
Last real read with read_real.
valid_last_real: BOOLEAN
writable attribute
{ANY}
top
Was the last call to read_real successful ?
read_real
effective procedure
{ANY}
top
Read a REAL and make the result available in last_real.
last_string: STRING
once function
{ANY}
top
Access to the unique common buffer to get for example the result computed by read_line, read_word, newline, etc.
read_line
effective procedure
{ANY}
top
Read a complete line ended by '%N' or end_of_input.%
read_available (limit: INTEGER_32)
effective procedure
{ANY}
top
Read as many characters as possible, as long as the stream does not block and up to the given limit.
read_word
effective procedure
{ANY}
top
Read a word using is_separator of class CHARACTER.
newline
effective procedure
{ANY}
top
Consume input until newline ('%N') is found.
reach_and_skip (keyword: STRING)
effective procedure
{ANY}
top
Try to skip enough characters in order to reach the keyword which is skipped too.
read_word_using (separators: STRING)
effective procedure
{ANY}
top
Same job as read_word using separators.
read_tail_in (str: STRING)
effective procedure
{ANY}
top
Read all remaining character of the stream in str.
io_getc (stream: POINTER): INTEGER_32
{}
top
io_ungetc (byte: CHARACTER, stream: POINTER)
{}
top
io_fread (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32
{}
top
return size read or 0 if end of input (-1 on error => exception ?)
{}
top
set_filter (a_filter: FILTER)
effective procedure
{FILTER}
top
Used by the filter itself to get attached
path: STRING
writable attribute
{ANY}
top
Not Void when connected to the corresponding file on the disk.
set_path (new_path: ABSTRACT_STRING)
effective procedure
{}
top
Maximum_character_code: INTEGER_16
{}
top
Largest supported code for CHARACTER values.
Maximum_integer_8: INTEGER_8
is 127
constant attribute
{}
top
Largest supported value of type INTEGER_8.
Maximum_integer_16: INTEGER_16
is 32767
constant attribute
{}
top
Largest supported value of type INTEGER_16.
Maximum_integer: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_32: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_64: INTEGER_64
is 9223372036854775807
constant attribute
{}
top
Largest supported value of type INTEGER_64.
Maximum_real_32: REAL_32
is {REAL_32 3.4028234663852885981170418348451692544e+38}
constant attribute
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL_32.
Maximum_real: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_64: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_80: REAL_EXTENDED
{}
top
Largest supported value of type REAL_80.
Minimum_character_code: INTEGER_16
{}
top
Smallest supported code for CHARACTER values.
Minimum_integer_8: INTEGER_8
is -128
constant attribute
{}
top
Smallest supported value of type INTEGER_8.
Minimum_integer_16: INTEGER_16
is -32768
constant attribute
{}
top
Smallest supported value of type INTEGER_16.
Minimum_integer: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_32: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_64: INTEGER_64
is -9223372036854775808
constant attribute
{}
top
Smallest supported value of type INTEGER_64.
Minimum_real_32: REAL_32
is {REAL_32 -3.40282346638528859811704183484516925440e+38}
constant attribute
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL_32.
Minimum_real: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_64: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_80: REAL_64
{}
top
Smallest supported value of type REAL_80.
Boolean_bits: INTEGER_32
{}
top
Number of bits in a value of type BOOLEAN.
Character_bits: INTEGER_32
{}
top
Number of bits in a value of type CHARACTER.
Integer_bits: INTEGER_32
{}
top
Number of bits in a value of type INTEGER.
Real_bits: INTEGER_32
is 64
constant attribute
{}
top
Number of bits in a value of type REAL.
Pointer_bits: INTEGER_32
{}
top
Number of bits in a value of type POINTER.