Chapter 13 Extended Stream Output Facilities
13.1 Basic Output Streams
CLIM performs all of its input and output operations on objects called streams. Stream functionality is partitioned into two layers: the basic stream protocol and the extended stream protocol. The stream-oriented output layer is implemented on top of the sheet output architecture. The basic CLIM output stream protocol is based on the character output stream protocol proposal submitted to the ANSI Common Lisp committee by David Gray. This proposal was not approved by the committee, but CLIM provides an implementation of the basic output stream facilities. This protocol is documented in Appendix F, "Common Lisp Streams." standard-output-stream [Class]
- Summary:
- This class provides an implementation of the CLIM basic output stream protocol, based on the CLIM output kernel. Members of this class are mutable.
stream-write-char [Generic Function]
- Arguments:
- stream character
- Summary:
- Writes the character character to the output stream stream, and returns character as its value.
stream-line-column [Generic Function]
- Arguments:
- stream
- Summary:
- This function returns the column number where the next character will be written on the output stream stream. The first column on a line is numbered 0.
stream-start-line-p [Generic Function]
- Arguments:
- stream
- Summary:
- Returns t if the output stream stream is positioned at the beginning of a line (that is, column 0); otherwise, it returns nil.
stream-write-string [Generic Function]
- Arguments:
- stream string
&optional (start 0) end
- Summary:
- Writes the string string to the output stream stream. If start and end are supplied, they are integers that specify what part of string to output. string is returned as the value.
stream-terpri [Generic Function]
- Arguments:
- stream
- Summary:
- Writes an end-of-line character on the output stream stream, and returns nil.
stream-fresh-line [Generic Function]
- Arguments:
- stream
- Summary:
- Writes an end-of-line character on the output stream stream only if the stream is not at the beginning of the line.
stream-finish-output [Generic Function]
- Arguments:
- stream
- Summary:
- Ensures that all the output sent to the output stream stream has reached its destination, and only then does it return nil.
stream-force-output [Generic Function]
- Arguments:
- stream
- Summary:
- Like stream-finish-output, except that it may immediately return nil without waiting for the output to complete.
stream-clear-output [Generic Function]
- Arguments:
- stream
- Summary:
- Aborts any outstanding output operation in progress on the output stream stream, and returns nil.
stream-advance-to-column [Generic Function]
- Arguments:
- stream column
- Summary:
- Writes enough blank space on the output stream stream so that the next character will be written at the position specified by column, which is an integer.
CLIM 2.0 User's Guide - OCT 1998 Generated with Harlequin WebMaker