This module provides for I/O that is essentially equivalent to the I/O
provided by Pascal with "text", or "file of char".
- Output buffers are automaically flushed at program termination.
+ Output buffers are automatically flushed at program termination.
The CloseOutput routine is just there for compatibility with earlier
versions of this module.
*)
*)
PROCEDURE CloseOutput();
- (* To be called at the end of the program, to flush all output buffers *)
+ (* To be called at the end of the program, to flush all output buffers. *)
(***************************************************************************
Input routines;
****************************************************************************)
PROCEDURE NextChar(InputText: Text): CHAR;
- (* Returns the next character of the InputText, 0C on end of file.
+ (* Returns the next character from the InputText, 0C on end of file.
Does not advance the "read pointer", so behaves much like "input^"
- in Pascal. However, unlike Pascal, if Eoln(InputText) is true, it
+ in Pascal. However, unlike Pascal, if Eoln(InputText) is TRUE, it
returns the newline character, rather than a space.
*)
PROCEDURE Get(InputText: Text);
- (* Advances the "read pointer" by one character *)
+ (* Advances the "read pointer" by one character. *)
PROCEDURE Eoln(InputText: Text): BOOLEAN;
- (* Returns TRUE if the next character of the InputText is a linefeed.
+ (* Returns TRUE if the next character from the InputText is a linefeed.
Unlike Pascal however, it does not produce a runtime error when
called when Eof(InputText) is TRUE.
*)
PROCEDURE Eof(InputText: Text): BOOLEAN;
- (* Returns TRUE if the end of the InputText is reached *)
+ (* Returns TRUE if the end of the InputText is reached. *)
PROCEDURE ReadChar(InputText: Text; VAR Char: CHAR);
- (* Read a character from the InputText, and leave result in "Char".
- Unlike Pascal, if Eoln(InputText) is true, the newline character
+ (* Read a character from the InputText, and leave the result in "Char".
+ Unlike Pascal, if Eoln(InputText) is TRUE, the newline character
is put in "Char".
*)
PROCEDURE ReadLn(InputText: Text);
- (* Skip the rest of the current line of the InputText,
- including the linefeed
+ (* Skip the rest of the current line from the InputText,
+ including the linefeed.
*)
PROCEDURE ReadInteger(InputText: Text; VAR Integer: INTEGER);
****************************************************************************)
PROCEDURE WriteChar(OutputText: Text; Char: CHAR);
- (* Writes the character "Char" to the OutputText *)
+ (* Writes the character "Char" to the OutputText. *)
PROCEDURE WriteLn(OutputText: Text);
- (* Writes a linefeed to the OutputText *)
+ (* Writes a linefeed to the OutputText. *)
PROCEDURE Page(OutputText: Text);
(* Writes a form-feed to the OutputText *)
(* Write boolean "Boolean" to the OutputText, using at least "Width" places,
blank-padding to the left if needed.
Equivalent to WriteString(OutputText, " TRUE", Width), or
- WriteString(OutputText, "FALSE", Width)
+ WriteString(OutputText, "FALSE", Width).
*)
PROCEDURE WriteString(OutputText: Text;
String: ARRAY OF CHAR; Width: CARDINAL);
(* Write string "String" to the OutputText, using at least "Width" places,
blank-padding to the left if needed.
- The string is terminated either by the character Eos, or the upperbound of
- the array "String".
+ The string is terminated either by the character Eos, or by the upperbound
+ of the array "String".
*)
PROCEDURE WriteReal(OutputText: Text; Real: REAL; Width, Nfrac: CARDINAL);