Eiffeldoc: INPUT_STREAM_TOOLS

+

Point of view

All features

deferred class INPUT_STREAM_TOOLS

Summary

Direct parents: Insert list: ANY
Known children: Insert list: INPUT_STREAM

Overview

Features

read_character

If read_character fail, end_of_input is set.
read_line_in (buffer: STRING)

Same job as read_line but storage is directly done in buffer.
read_available_in (buffer: STRING, limit: INTEGER_32)

Same job as read_available but storage is directly done in buffer.
unread_character
last_character: CHARACTER
can_read_character: BOOLEAN

Note that this state is usually temporary.
can_read_line: BOOLEAN
can_unread_character: BOOLEAN
valid_last_character: BOOLEAN
end_of_input: BOOLEAN

end_of_input means the previous attempt in character reading failed because the end has been reached.
is_filtered: BOOLEAN
is_connected: BOOLEAN

Skipping separators:

skip_separators

Skip all separators (see is_separator of class CHARACTER) and make the first non-separator available in last_character.
skip_separators_using (separators: STRING)

Same job as skip_separators using the separators set.
skip_remainder_of_line

Skip all the remainder of the line including the end of line delimiter itself.

To read one number at a time:

read_integer

Read an integer according to the Eiffel syntax.
last_integer: INTEGER_32

Last integer read using read_integer.
valid_last_integer: BOOLEAN

Was the last call to read_integer successful ?
last_real: REAL_64

Last real read with read_real.
valid_last_real: BOOLEAN

Was the last call to read_real successful ?
read_real

Read a REAL and make the result available in last_real.

To read one line or one word at a time:

last_string: STRING

Access to the unique common buffer to get for example the result computed by read_line, read_word, newline, etc.
read_line

Read a complete line ended by '%N' or end_of_input.%
read_available (limit: INTEGER_32)

Read as many characters as possible, as long as the stream does not block and up to the given limit.
read_word

Read a word using is_separator of class CHARACTER.
newline

Consume input until newline ('%N') is found.
reach_and_skip (keyword: STRING)

Try to skip enough characters in order to reach the keyword which is skipped too.

Other features:

read_word_using (separators: STRING)

Same job as read_word using separators.
read_tail_in (str: STRING)

Read all remaining character of the stream in str.

{}

io_getc (stream: POINTER): INTEGER_32
io_ungetc (byte: CHARACTER, stream: POINTER)
io_fread (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32

return size read or 0 if end of input (-1 on error => exception ?)
eof: INTEGER_32

read_character

deferred procedure

If read_character fail, end_of_input is set.

read_line_in (buffer: STRING)

deferred procedure

Same job as read_line but storage is directly done in buffer.

read_available_in (buffer: STRING, limit: INTEGER_32)

deferred procedure

Same job as read_available but storage is directly done in buffer.

unread_character

deferred procedure

last_character: CHARACTER

deferred function

can_read_character: BOOLEAN

deferred function

Note that this state is usually temporary.

can_read_line: BOOLEAN

deferred function

can_unread_character: BOOLEAN

deferred function

valid_last_character: BOOLEAN

deferred function

end_of_input: BOOLEAN

deferred function

end_of_input means the previous attempt in character reading failed because the end has been reached.

is_filtered: BOOLEAN

deferred function

is_connected: BOOLEAN

deferred function

skip_separators

effective procedure

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

Same job as skip_separators using the separators set.

skip_remainder_of_line

effective procedure

Skip all the remainder of the line including the end of line delimiter itself.

read_integer

effective procedure

Read an integer according to the Eiffel syntax.

last_integer: INTEGER_32

writable attribute

Last integer read using read_integer.

valid_last_integer: BOOLEAN

writable attribute

Was the last call to read_integer successful ?

last_real: REAL_64

writable attribute

Last real read with read_real.

valid_last_real: BOOLEAN

writable attribute

Was the last call to read_real successful ?

read_real

effective procedure

Read a REAL and make the result available in last_real.

last_string: STRING

once function

Access to the unique common buffer to get for example the result computed by read_line, read_word, newline, etc.

read_line

effective procedure

Read a complete line ended by '%N' or end_of_input.%

read_available (limit: INTEGER_32)

effective procedure

Read as many characters as possible, as long as the stream does not block and up to the given limit.

read_word

effective procedure

Read a word using is_separator of class CHARACTER.

newline

effective procedure

Consume input until newline ('%N') is found.

reach_and_skip (keyword: STRING)

effective procedure

Try to skip enough characters in order to reach the keyword which is skipped too.

read_word_using (separators: STRING)

effective procedure

Same job as read_word using separators.

read_tail_in (str: STRING)

effective procedure

Read all remaining character of the stream in str.

io_getc (stream: POINTER): INTEGER_32

{}

io_ungetc (byte: CHARACTER, stream: POINTER)

{}

io_fread (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32

{}

return size read or 0 if end of input (-1 on error => exception ?)

eof: INTEGER_32

{}