Basic input/output stream operations

Reads from Stream the next character and unifies Code with its character code. At end of stream, unifies Code with the integer -1.

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Behaves like current_input(S), get_code(S,Code).

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Reads from Stream the next non-layout character (see code_class/2) and unifies Code with its character code. At end of stream, unifies Code with the integer -1.

Usage:

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Behaves like current_input(S), get1_code(S,Code).

Usage:

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Unifies Code with the character code of the next character of Stream, leaving the stream position unaltered. At end of stream, unifies Code with the integer -1.

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.

Behaves like current_input(S), peek_code(S,Code).

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.

Skips just past the next character code Code from Stream.

Usage:

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:int/1)Code is an integer.

Behaves like current_input(S), skip_code(S,Code).

Usage:

• The following properties should hold at call time:
  (basic_props:int/1)Code is an integer.

Skips from Stream the remaining input characters on the current line. If the end of the stream is reached, the stream will stay at its end. Portable among different operating systems.

Usage:

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.

Behaves like current_input(S), skip_line(S).

Outputs to Stream the character corresponding to character code Code.

Usage:ISO

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form put_code(Stream,Code) are deterministic.

Behaves like current_output(S), put_code(S,Code).

Usage:ISO

• The following properties should hold at call time:
  (basic_props:int/1)Code is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form put_code(Code) are deterministic.

Outputs a newline character to Stream. Equivalent to put_code(Stream, 0'\n).

Usage:ISO

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form nl(Stream) are deterministic.
  (native_props:not_fails/1)All the calls of the form nl(Stream) do not fail.

Behaves like current_output(S), nl(S).

Usage:ISO

• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form nl are deterministic.
  (native_props:not_fails/1)All the calls of the form nl do not fail.
  (native_props:relations/2)Goal nl produces 1 solutions.

Outputs Num spaces to Stream.

Usage:

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:int/1)Num is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form tab(Stream,Num) are deterministic.

Behaves like current_output(S), tab(S,Num).

Usage:

• The following properties should hold at call time:
  (basic_props:int/1)Num is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form tab(Num) are deterministic.

Unifies Class with an integer corresponding to the lexical class of the character whose code is Code, with the following correspondence:

0 - layout (includes space, newline, tab)
1 - small letter
2 - capital letter (including '_')
3 - digit
4 - graphic (includes #$&*+-./:<=>?@^\`~ )
5 - punctuation (includes !;"'%(),[]{|} )
6 - extended identifier continuation
7 - invalid

Usage:

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Class is an integer.
• The following properties should hold at call time:
  (basic_props:int/1)Code is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Class is an integer.

String is the list of the character codes encoded by the list of bytes Bytes (equivalent to String=Bytes if any of the lists is a list of ASCII codes).

Reads from the current input stream the next character, unifying Code with its character code, and Type with its lexical class. At end of stream, unifies both Code and Type with the integer -1. Equivalent to

   get(Code), (Code = -1 -> Type = -1 ; code_class(Code,Type))

Usage:

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
  (basic_props:int/1)Type is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
  (basic_props:int/1)Type is an integer.

Reads from the current input stream the next non-layout character, unifying Code with its character code, and Type with its lexical class (which will be nonzero). At end of stream, unifies both Code and Type with the integer -1. Equivalent to

   get1(Code), (Code = -1 -> Type = -1 ; code_class(Code,Type))

Usage:

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Code is an integer.
  (basic_props:int/1)Type is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Code is an integer.
  (basic_props:int/1)Type is an integer.

Reads from Stream the next byte and unifies it with Byte. At end of stream, unifies Byte with the integer -1.

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Byte is an integer.
• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold upon exit:
  (basic_props:int/1)Byte is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Behaves like current_input(S), get_byte(S,Byte).

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Byte is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Byte is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Unifies Byte with the next byte of Stream, leaving the stream position unaltered. At end of stream, unifies Byte with the integer -1.

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Byte is an integer.
• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties hold upon exit:
  (basic_props:int/1)Byte is an integer.

Behaves like current_input(S), peek_byte(S,Byte).

Usage:ISO

• Calls should, and exit will be compatible with:
  (basic_props:int/1)Byte is an integer.
• The following properties hold upon exit:
  (basic_props:int/1)Byte is an integer.

Outputs to Stream the byte Byte.

Usage:ISO

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:int/1)Byte is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Behaves like current_output(S), put_byte(S,Byte).

Usage:ISO

• The following properties should hold at call time:
  (basic_props:int/1)Byte is an integer.
• The following properties hold globally:
  (basic_props:native/1)This predicate is understood natively by CiaoPP.
  (native_props:is_det/1)All calls of the form put_byte(Byte) are deterministic.

Behaves like current_input(S), at_end_of_stream(S).

Stream has a stream position end-of-stream or past-end-of-stream. This predicate is provided for ISO compatibility, but its usage is discouraged, since it cannot reliably detect that no more data is available in the stream (e.g., without blocking). Use peek_byte/2 or peek_code/2 instead.

Usage:ISO

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.

Displays Term onto Stream. Lists are output using list notation, the other compound terms are output in functional notation. Similar to write_term(Stream, Term, [ignore_ops(ops)]), except that curly bracketed notation is not used with {}/1, and the write_strings flag is not honored.

Usage:

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:term/1)Term is any term.
• The following properties hold upon exit:
  (basic_props:term/1)Term is any term.
• The following properties hold globally:
  (basic_props:not_further_inst/2)Term is not further instantiated.
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Behaves like current_output(S), display(S,Term).

Usage:

• The following properties should hold at call time:
  (basic_props:term/1)Term is any term.
• The following properties hold upon exit:
  (basic_props:term/1)Term is any term.
• The following properties hold globally:
  (basic_props:not_further_inst/2)Term is not further instantiated.
  (basic_props:native/1)This predicate is understood natively by CiaoPP.

Similar to display(Stream, Term), but atoms and functors that can't be read back by read_term/3 are quoted. Thus, similar to write_term(Stream, Term, [quoted(true), ignore_ops(ops)]), with the same exceptions as display/2.

Usage:

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:term/1)Term is any term.
• The following properties hold upon exit:
  (basic_props:term/1)Term is any term.
• The following properties hold globally:
  (basic_props:not_further_inst/2)Term is not further instantiated.

Behaves like current_output(S), displayq(S,Term).

Usage:

• The following properties should hold at call time:
  (basic_props:term/1)Term is any term.
• The following properties hold upon exit:
  (basic_props:term/1)Term is any term.
• The following properties hold globally:
  (basic_props:not_further_inst/2)Term is not further instantiated.

Stream has a stream position end-of-stream or past-end-of-stream. This predicate is provided for ISO compatibility, but its usage is discouraged, since it cannot reliably detect that no more data is available in the stream (e.g., without blocking). Use peek_byte/2 or peek_code/2 instead.

Usage:ISO

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.

Behaves like current_input(S), at_end_of_stream(S).