21. Streams

• 21.1 Stream Concepts
• Dictionary

21.1 Stream Concepts#

21.1.1 Introduction to Streams#

Some operations may be performed on any kind of stream; the next figure provides a list of standardized operations that are potentially useful with any kind of stream.

Other operations are only meaningful on certain stream types. For example, read-char is only defined for character streams and read-byte is only defined for binary streams.

21.1.1.1 Abstract Classifications of Streams#

21.1.1.1.1 Input, Output, and Bidirectional Streams#

The next figure shows operators relating to input streams.

The next figure shows operators relating to output streams.

A stream that is both an input stream and an output stream is called a bidirectional stream. See the functions input-stream-p and output-stream-p.

Any of the operators listed in Figure 21–2 or Figure 21–3 can be used with bidirectional streams. In addition, the next figure shows a list of operators that relate specificaly to bidirectional streams.

21.1.1.1.2 Open and Closed Streams#

Streams are either open or closed.

Except as explicitly specified otherwise, operations that create and return streams return open streams.

The action of closing a stream marks the end of its use as a source or sink of data, permitting the implementation to reclaim its internal data structures, and to free any external resources which might have been locked by the stream when it was opened.

Except as explicitly specified otherwise, the consequences are undefined when a closed stream is used where a stream is called for.

Coercion of streams to pathnames is permissible for closed streams; in some situations, such as for a truename computation, the result might be different for an open stream and for that same stream once it has been closed.

21.1.1.1.3 Interactive Streams#

An interactive stream is one on which it makes sense to perform interactive querying.

The precise meaning of an interactive stream is implementation-defined, and may depend on the underlying operating system. Some examples of the things that an implementation might choose to use as identifying characteristics of an interactive stream include:

• The stream is connected to a person (or equivalent) in such a way that the program can prompt for information and expect to receive different input depending on the prompt.

• The program is expected to prompt for input and support “normal input editing”.

• read-char might wait for the user to type something before returning instead of immediately returning a character or end-of-file.

The general intent of having some streams be classified as interactive streams is to allow them to be distinguished from streams containing batch (or background or command-file) input. Output to batch streams is typically discarded or saved for later viewing, so interactive queries to such streams might not have the expected effect.

Terminal I/O might or might not be an interactive stream.

21.1.1.2 Abstract Classifications of Streams#

21.1.1.2.1 File Streams#

The basic operation for opening a file is open, which typically returns a file stream (see its dictionary entry for details). The basic operation for closing a stream is close. The macro with-open-file is useful to express the common idiom of opening a file for the duration of a given body of code, and assuring that the resulting stream is closed upon exit from that body.

21.1.1.3 Other Subclasses of Stream#

21.1.2 Stream Variables#

Certain stream variables are defined by this specification to be the proper source of input or output in various situations where no specific stream has been specified instead. A complete list of such standardized stream variables appears in the next figure. Added by agreement of Barrett, Loosemore, and KMP. -kmp 14-Feb-92The consequences are undefined if at any time the value of any of these variables is not an open stream.

Note that, by convention, standardized stream variables have names ending in “-input*” if they must be input streams, ending in “-output*” if they must be output streams, or ending in “-io*” if they must be bidirectional streams.

User programs may assign or bind any standardized stream variable except *terminal-io*.

21.1.3 Stream Arguments to Standardized Functions#

This list conjured by KMP, Barrett, and Loosemore. -kmp 14-Feb-92The operators in the next figure accept stream arguments that might be either open or closed streams.

This list conjured by KMP, Barrett, and Loosemore. -kmp 14-Feb-92The operators in the next figure accept stream arguments that must be open streams.

21.1.4 Restrictions on Composite Streams#

The consequences are undefined if the synonym stream symbol is not bound to an open stream from the time of the synonym stream's creation until the time it is closed.

Dictionary

• stream System Class
• broadcast-stream System Class
• concatenated-stream System Class
• echo-stream System Class
• file-stream System Class
• string-stream System Class
• synonym-stream System Class
• two-way-stream System Class
• input-stream-p, output-stream-p Function
• interactive-stream-p Function
• open-stream-p Function
• stream-element-type Function
• streamp Function
• read-byte Function
• write-byte Function
• peek-char Function
• read-char Function
• read-char-no-hang Function
• terpri, fresh-line Function
• unread-char Function
• write-char Function
• read-line Function
• write-string, write-line Function
• read-sequence Function
• write-sequence Function
• file-length Function
• file-position Function
• file-string-length Function
• open Function
• stream-external-format Function
• with-open-file Macro
• close Function
• with-open-stream Macro
• listen Function
• clear-input Function
• finish-output, force-output, clear-output Function
• y-or-n-p, yes-or-no-p Function
• make-synonym-stream Function
• synonym-stream-symbol Function
• broadcast-stream-streams Function
• make-broadcast-stream Function
• make-two-way-stream Function
• two-way-stream-input-stream, two-way-stream-output-stream Function
• echo-stream-input-stream, echo-stream-output-stream Function
• make-echo-stream Function
• concatenated-stream-streams Function
• make-concatenated-stream Function
• get-output-stream-string Function
• make-string-input-stream Function
• make-string-output-stream Function
• with-input-from-string Macro
• with-output-to-string Macro
• *debug-io*, *error-output*, *query-io*, *standard-input*, *standard-output*, *trace-output* Variable
• *terminal-io* Variable
• stream-error Condition Type
• stream-error-stream Function
• end-of-file Condition Type