Eiffeldoc: STRING_INPUT

An input stream where the data is read from a string.

Direct parents: Inherit list: TERMINAL_INPUT_STREAM

Overview

Creation features

{ANY}

from_string (a_string: ABSTRACT_STRING)

Features

{ANY}

end_of_input: BOOLEAN

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

True if the stream is connected.
must_disconnect: BOOLEAN
can_unread_character: BOOLEAN
disconnect

Try to disconnect the stream.
valid_last_character: BOOLEAN

filtered_read_character
filtered_unread_character
filtered_last_character: CHARACTER

filtered_descriptor: INTEGER_32

Find the descriptor of the terminal stream...
filtered_has_descriptor: BOOLEAN

True if the underlying terminal stream has a descriptor
filtered_stream_pointer: POINTER

Find the pointer of the terminal stream...
filtered_has_stream_pointer: BOOLEAN

True if the underlying terminal stream has a pointer

{}

dispose

Action to be executed just before garbage collection reclaims an object.
from_string (a_string: ABSTRACT_STRING)
string: STRING

where the data comes from
offset: INTEGER_32

{ANY}

can_read_character: BOOLEAN

Note that this state is usually temporary.
can_read_line: BOOLEAN
can_disconnect: BOOLEAN

True if the stream can be safely disconnected (without data loss, etc.)

{ANY}

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
detach

Shake off the filter.

filtered_read_available_in (buffer: STRING, limit: INTEGER_32)
filtered_read_line_in (buffer: STRING)

filter: FILTER_INPUT_STREAM

The filter that uses this stream as backend

{ANY}

event_can_read: EVENT_DESCRIPTOR

{}

{ANY}

descriptor: INTEGER_32

Some OS-dependent descriptor.
has_descriptor: BOOLEAN

True if that stream can be associated to some OS-meaningful descriptor.
url: URL

The URL to this stream as resource

{}

url_memory: URL

{STREAM_HANDLER}

stream_pointer: POINTER

Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)
has_stream_pointer: BOOLEAN

True if that stream can be associated to some Back-end-meaningful stream pointer.

{ANY}

event_exception: EVENT_DESCRIPTOR

{}

stream_exception: STREAM_EXCEPTION

{RECYCLING_POOL}

recycle

Do whatever needs to be done to free resources or recycle other objects when recycling this one

{}

sequencer_descriptor (file: POINTER): INTEGER_32

{ANY}

is_filtered: BOOLEAN

Skipping separators:

{ANY}

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:

{ANY}

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:

{ANY}

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:

{ANY}

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

set_filter (a_filter: FILTER)

Used by the filter itself to get attached

end_of_input: BOOLEAN

effective function

{ANY}

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

is_connected: BOOLEAN

writable attribute

{ANY}

True if the stream is connected.

must_disconnect: BOOLEAN

is False

constant attribute

{ANY}

can_unread_character: BOOLEAN

effective function

{ANY}

disconnect

effective procedure

{ANY}

Try to disconnect the stream.

valid_last_character: BOOLEAN

effective function

{ANY}

filtered_read_character

effective procedure

filtered_unread_character

effective procedure

filtered_last_character: CHARACTER

effective function

filtered_descriptor: INTEGER_32

effective function

Find the descriptor of the terminal stream...

filtered_has_descriptor: BOOLEAN

is False

constant attribute

True if the underlying terminal stream has a descriptor

filtered_stream_pointer: POINTER

effective function

Find the pointer of the terminal stream...

filtered_has_stream_pointer: BOOLEAN

is False

constant attribute

True if the underlying terminal stream has a pointer

dispose

effective procedure

{}

Action to be executed just before garbage collection reclaims an object.

from_string (a_string: ABSTRACT_STRING)

effective procedure

{}

string: STRING

writable attribute

{}

where the data comes from

offset: INTEGER_32

writable attribute

{}

can_read_character: BOOLEAN

is True

constant attribute

{ANY}

Note that this state is usually temporary.

can_read_line: BOOLEAN

is True

constant attribute

{ANY}

can_disconnect: BOOLEAN

is True

constant attribute

{ANY}

True if the stream can be safely disconnected (without data loss, etc.)

read_character

effective procedure

{ANY}

If read_character fail, end_of_input is set.

read_line_in (buffer: STRING)

effective procedure

{ANY}

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

read_available_in (buffer: STRING, limit: INTEGER_32)

effective procedure

{ANY}

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

unread_character

effective procedure

{ANY}

last_character: CHARACTER

effective function

{ANY}

detach

effective procedure

{ANY}

Shake off the filter.

filtered_read_available_in (buffer: STRING, limit: INTEGER_32)

effective procedure

filtered_read_line_in (buffer: STRING)

effective procedure

filter: FILTER_INPUT_STREAM

writable attribute

The filter that uses this stream as backend

event_can_read: EVENT_DESCRIPTOR

effective function

{ANY}

can_read: CAN_READ_DATA_FROM_STREAM

writable attribute

{}

new_url: URL

effective function

{}

descriptor: INTEGER_32

effective function

{ANY}

Some OS-dependent descriptor.

has_descriptor: BOOLEAN

effective function

{ANY}

True if that stream can be associated to some OS-meaningful descriptor.

url: URL

frozen

effective function

{ANY}

The URL to this stream as resource

url_memory: URL

writable attribute

{}

stream_pointer: POINTER

effective function

{STREAM_HANDLER}

Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)

has_stream_pointer: BOOLEAN

effective function

{STREAM_HANDLER}

True if that stream can be associated to some Back-end-meaningful stream pointer.

event_exception: EVENT_DESCRIPTOR

effective function

{ANY}

stream_exception: STREAM_EXCEPTION

writable attribute

{}

recycle

effective procedure

{RECYCLING_POOL}

Do whatever needs to be done to free resources or recycle other objects when recycling this one

sequencer_descriptor (file: POINTER): INTEGER_32

{}

is_filtered: BOOLEAN

deferred function

{ANY}

skip_separators

effective procedure

{ANY}

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}

Same job as skip_separators using the separators set.

skip_remainder_of_line

effective procedure

{ANY}

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

read_integer

effective procedure

{ANY}

Read an integer according to the Eiffel syntax.

last_integer: INTEGER_32

writable attribute

{ANY}

Last integer read using read_integer.

valid_last_integer: BOOLEAN

writable attribute

{ANY}

Was the last call to read_integer successful ?

last_real: REAL_64

writable attribute

{ANY}

Last real read with read_real.

valid_last_real: BOOLEAN

writable attribute

{ANY}

Was the last call to read_real successful ?

read_real

effective procedure

{ANY}

Read a REAL and make the result available in last_real.

last_string: STRING

once function

{ANY}

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}

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

read_available (limit: INTEGER_32)

effective procedure

{ANY}

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}

Read a word using is_separator of class CHARACTER.

newline

effective procedure

{ANY}

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

reach_and_skip (keyword: STRING)

effective procedure

{ANY}

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

read_word_using (separators: STRING)

effective procedure

{ANY}

Same job as read_word using separators.

read_tail_in (str: STRING)

effective procedure

{ANY}

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

{}

set_filter (a_filter: FILTER)

effective procedure