Newer
Older
;;; -*- Package: Lisp -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the CMU Common Lisp project at
;;; Carnegie Mellon University, and has been placed in the public domain.
;;;
(ext:file-comment
"$Header: src/code/stream.lisp $")
;;; **********************************************************************
;;;
;;; Stream functions for Spice Lisp.
;;; Written by Skef Wholey and Rob MacLachlan.
;;; Gray streams support by Douglas Crosher, 1998.
;;; Simple-streams support by Paul Foley, 2003.
;;; This file contains the OS-independent stream functions.
(in-package "LISP")
(intl:textdomain "cmucl")
(export '(broadcast-stream make-broadcast-stream broadcast-stream-streams
synonym-stream make-synonym-stream synonym-stream-symbol
concatenated-stream make-concatenated-stream
concatenated-stream-streams
two-way-stream make-two-way-stream two-way-stream-input-stream
two-way-stream-output-stream
echo-stream make-echo-stream echo-stream-input-stream
echo-stream-output-stream
make-string-input-stream make-string-output-stream
output-stream-p open-stream-p interactive-stream-p
open-stream-p close read-line read-char
unread-char peek-char listen read-char-no-hang clear-input read-byte
write-char write-string write-line terpri fresh-line
finish-output force-output clear-output write-byte
stream streamp string-stream
*standard-input* *standard-output*
*error-output* *query-io* *debug-io* *terminal-io* *trace-output*))
(in-package "EXT")
(export '(get-stream-command
stream-command stream-command-p stream-command-name
stream-command-args make-stream-command make-case-frob-stream))
(in-package "LISP")
;;;; Standard streams:
;;;
;;; The initialization of these streams is performed by Stream-Init,
;;; which lives in the file of machine-specific stream functions.
;;;
(defvar *terminal-io* () "Terminal I/O stream.")
(defvar *standard-input* () "Default input stream.")
(defvar *standard-output* () "Default output stream.")
(defvar *error-output* () "Error output stream.")
(defvar *query-io* () "Query I/O stream.")
(defvar *trace-output* () "Trace output stream.")
(defvar *debug-io* () "Interactive debugging stream.")
(defun ill-in-any (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control (intl:gettext "~S is not an input stream.")
:format-arguments (list stream)))
(defun ill-out-any (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies output-stream-p)
:format-control (intl:gettext "~S is not an output stream.")
:format-arguments (list stream)))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control (intl:gettext "~S is not a character input stream.")
:format-arguments (list stream)))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies output-stream-p)
:format-control (intl:gettext "~S is not a character output stream.")
:format-arguments (list stream)))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control (intl:gettext "~S is not a binary input stream.")
:format-arguments (list stream)))
(defun ill-n-bin (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control (intl:gettext "~S is not a binary input stream ~
or does not support multi-byte read operations.")
:format-arguments (list stream)))
(defun ill-bout (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies output-stream-p)
:format-control (intl:gettext "~S is not a binary output stream.")
:format-arguments (list stream)))
(defun closed-flame (stream &rest ignore)
(declare (ignore ignore))
(error (intl:gettext "~S is closed.") stream))
(defun no-gray-streams (stream)
(error 'simple-type-error
:datum stream
:expected-type 'stream
:format-control (intl:gettext "~S is an unsupported Gray stream.")
:format-arguments (list stream)))
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
(defun %print-stream (structure stream d)
(declare (ignore d structure))
(write-string "#<Bare Stream>" stream))
;;; HOW THE STREAM STRUCTURE IS USED:
;;;
;;; Many of the slots of the stream structure contain functions
;;; which are called to perform some operation on the stream. Closed
;;; streams have #'Closed-Flame in all of their function slots. If
;;; one side of an I/O or echo stream is closed, the whole stream is
;;; considered closed. The functions in the operation slots take
;;; arguments as follows:
;;;
;;; In: Stream, Eof-Errorp, Eof-Value
;;; Bin: Stream, Eof-Errorp, Eof-Value
;;; N-Bin: Stream, Buffer, Start, Numbytes, Eof-Errorp
;;; Out: Stream, Character
;;; Bout: Stream, Integer
;;; Sout: Stream, String, Start, End
;;; Misc: Stream, Operation, &Optional Arg1, Arg2
;;;
;;; In order to save space, some of the less common stream operations
;;; are handled by just one function, the Misc method. This function
;;; is passed a keyword which indicates the operation to perform.
;;; The following keywords are used:
;;; :listen - Return the following values:
;;; t if any input waiting.
;;; :eof if at eof.
;;; nil if no input is available and not at eof.
;;; :unread - Unread the character Arg.
;;; :close - Do any stream specific stuff to close the stream.
;;; The methods are set to closed-flame by the close
;;; function, so that need not be done by this
;;; function.
;;; :clear-input - Clear any unread input
;;; :finish-output,
;;; :force-output - Cause output to happen
;;; :clear-output - Clear any undone output
;;; :element-type - Return the type of element the stream deals with.
;;; :line-length - Return the length of a line of output.
;;; :charpos - Return current output position on the line.
;;; :file-length - Return the file length of a file stream.
;;; :file-position - Return or change the current position of a file stream.
;;; :file-name - Return the name of an associated file.
;;; :interactive-p - Is this an interactive device?
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
;;;
;;; In order to do almost anything useful, it is necessary to
;;; define a new type of structure that includes stream, so that the
;;; stream can have some state information.
;;;
;;; THE STREAM IN-BUFFER:
;;;
;;; The In-Buffer in the stream holds characters or bytes that
;;; are ready to be read by some input function. If there is any
;;; stuff in the In-Buffer, then the reading function can use it
;;; without calling any stream method. Any stream may put stuff in
;;; the In-Buffer, and may also assume that any input in the In-Buffer
;;; has been consumed before any in-method is called. If a text
;;; stream has in In-Buffer, then the first character should not be
;;; used to buffer normal input so that it is free for unreading into.
;;;
;;; The In-Buffer slot is a vector In-Buffer-Length long. The
;;; In-Index is the index in the In-Buffer of the first available
;;; object. The available objects are thus between In-Index and the
;;; length of the In-Buffer.
;;;
;;; When this buffer is only accessed by the normal stream
;;; functions, the number of function calls is halved, thus
;;; potentially doubling the speed of simple operations. If the
;;; Fast-Read-Char and Fast-Read-Byte macros are used, nearly all
;;; function call overhead is removed, vastly speeding up these
;;; important operations.
;;;
;;; If a stream does not have an In-Buffer, then the In-Buffer slot
;;; must be nil, and the In-Index must be In-Buffer-Length. These are
;;; the default values for the slots.
;;; Stream manipulation functions.
(defun input-stream-p (stream)
"Returns non-nil if the given Stream can perform input operations."
(declare (type stream stream))
;; Note: Gray streams redefines this function; any changes made here need
;; to be duplicated in .../pcl/gray-streams.lisp
(stream-dispatch stream
;; simple-stream
(stream::%input-stream-p stream)
;; lisp-stream
(let ((stream (if (synonym-stream-p stream)
(symbol-value (synonym-stream-symbol stream))
stream)))
(and (not (eq (lisp-stream-in stream) #'closed-flame))
(or (not (eq (lisp-stream-in stream) #'ill-in))
(not (eq (lisp-stream-bin stream) #'ill-bin))
(not (eq (lisp-stream-n-bin stream) #'ill-n-bin)))))))
"Returns non-nil if the given Stream can perform output operations."
(declare (type stream stream))
;; Note: Gray streams redefines this function; any changes made here need
;; to be duplicated in .../pcl/gray-streams.lisp
(stream-dispatch stream
;; simple-stream
(stream::%output-stream-p stream)
;; lisp-stream
(let ((stream (if (synonym-stream-p stream)
(symbol-value (synonym-stream-symbol stream))
stream)))
(and (not (eq (lisp-stream-in stream) #'closed-flame))
(or (not (eq (lisp-stream-out stream) #'ill-out))
(not (eq (lisp-stream-bout stream) #'ill-bout)))))))
(defun open-stream-p (stream)
"Return true if Stream is not closed."
(declare (type stream stream))
;; Note: Gray streams redefines this function; any changes made here need
;; to be duplicated in .../pcl/gray-streams.lisp
(stream-dispatch stream
;; simple-stream
(stream::%open-stream-p stream)
;; lisp-stream
(not (eq (lisp-stream-in stream) #'closed-flame))))
"Returns a type specifier for the kind of object returned by the Stream."
(declare (type stream stream))
;; Note: Gray streams redefines this function; any changes made here need
;; to be duplicated in .../pcl/gray-streams.lisp
(stream-dispatch stream
;; simple-stream
'(unsigned-byte 8)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :element-type)))
(defun interactive-stream-p (stream)
"Return true if Stream does I/O on a terminal or other interactive device."
(declare (type stream stream))
(stream-dispatch stream
;; simple-stream
(stream::%interactive-stream-p stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :interactive-p)))
(defun (setf interactive-stream-p) (flag stream)
(declare (type stream stream))
(stream-dispatch stream
;; simple-stream
(if flag
(stream::%interactive-stream-y stream)
(stream::%interactive-stream-n stream))
;; lisp-stream
(error 'simple-type-error
:datum stream
:expected-type 'stream:simple-stream
:format-control (intl:gettext "Can't set interactive flag on ~S.")
:format-arguments (list stream))))
(defun stream-external-format (stream)
"Returns the external format used by the given Stream."
(declare (type stream stream))
(stream-dispatch stream
;; simple-stream
(stream::%stream-external-format stream)
;; lisp-stream. For unsupported streams, signal a type error.
(etypecase stream
(fd-stream (fd-stream-external-format stream))
(broadcast-stream
;; See http://www.lispworks.com/documentation/HyperSpec/Body/t_broadc.htm
(let ((components (broadcast-stream-streams stream)))
(if (null components)
:default
(stream-external-format (car (last components))))))
(synonym-stream
;; Not defined by CLHS. What should happen if
;; (synonym-stream-symbol stream) is unbound?
(stream-external-format
(symbol-value (synonym-stream-symbol stream)))))
;; fundamental-stream
:default))
;; This is only used while building; it's reimplemented in
;; fd-stream-extfmt.lisp
#+unicode
(defun %set-fd-stream-external-format (stream extfmt &optional (updatep t))
;; This is only used while building; it's reimplemented in
;; fd-stream-extfmt.lisp
(defun (setf stream-external-format) (extfmt stream)
"Closes the given Stream. No more I/O may be performed, but inquiries
may still be made. If :Abort is non-nil, an attempt is made to clean
up the side effects of having created the stream."
(declare (type stream stream))
;; Note: Gray streams redefines this function; any changes made here need
;; to be duplicated in .../pcl/gray-streams.lisp
(stream-dispatch stream
;; simple-stream
(stream:device-close stream abort)
;; lisp-stream
(when (open-stream-p stream)
(funcall (lisp-stream-misc stream) stream :close abort)))
(declare (type lisp-stream stream))
(setf (lisp-stream-in stream) #'closed-flame)
(setf (lisp-stream-bin stream) #'closed-flame)
(setf (lisp-stream-n-bin stream) #'closed-flame)
(setf (lisp-stream-in stream) #'closed-flame)
(setf (lisp-stream-out stream) #'closed-flame)
(setf (lisp-stream-bout stream) #'closed-flame)
(setf (lisp-stream-sout stream) #'closed-flame)
(setf (lisp-stream-misc stream) #'closed-flame))
;;;; File position and file length.
;;; File-Position -- Public
;;;
;;; Call the misc method with the :file-position operation.
;;;
(defun file-position (stream &optional position)
"With one argument returns the current position within the file
File-Stream is open to. If the second argument is supplied, then
this becomes the new file position. The second argument may also
be :start or :end for the start and end of the file, respectively."
(declare (type stream stream)
(type (or (integer 0 *) (member nil :start :end)) position))
(stream-dispatch stream
;; simple-stream
(stream::%file-position stream position)
;; lisp-stream
(cond
(position
(setf (lisp-stream-in-index stream) in-buffer-length)
(funcall (lisp-stream-misc stream) stream :file-position position))
(t
(let ((res (funcall (lisp-stream-misc stream) stream
:file-position nil)))
;; For Unicode, the LISP-STREAM-MISC function handles
;; everything, so we can just return the result.
#-unicode
(- res (- in-buffer-length (lisp-stream-in-index stream))))
#+unicode
res)))
;; fundamental stream
(cond
(position
(setf (stream-file-position stream) position))
(t
(stream-file-position stream)))))
;;; File-Length -- Public
;;;
;;; Like File-Position, only use :file-length.
;;;
(defun file-length (stream)
"This function returns the length of the file that File-Stream is open to."
(stream-dispatch stream
;; simple-stream
(stream::%file-length stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :file-length)))
;;; Input functions:
(defun read-line (&optional (stream *standard-input*) (eof-errorp t) eof-value
recursive-p)
"Returns a line of text read from the Stream as a string, discarding the
(let ((stream (in-synonym-of stream)))
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
(stream-dispatch stream
;; simple-stream
(stream::%read-line stream eof-errorp eof-value recursive-p)
;; lisp-stream
(prepare-for-fast-read-char stream
(let ((res (make-string 80))
(len 80)
(index 0))
(loop
(let ((ch (fast-read-char nil nil)))
(cond (ch
(when (char= ch #\newline)
(done-with-fast-read-char)
(return (values (shrink-vector res index) nil)))
(when (= index len)
(setq len (* len 2))
(let ((new (make-string len)))
(replace new res)
(setq res new)))
(setf (schar res index) ch)
(incf index))
((zerop index)
(done-with-fast-read-char)
(return (values (eof-or-lose stream eof-errorp eof-value)
t)))
;; since fast-read-char hit already the eof char, we
;; shouldn't do another read-char
(t
(done-with-fast-read-char)
(return (values (shrink-vector res index) t))))))))
;; fundamental-stream
(multiple-value-bind (string eof)
(stream-read-line stream)
(if (and eof (zerop (length string)))
(values (eof-or-lose stream eof-errorp eof-value) t)
(values string eof))))))
;;; We proclaim them inline here, then proclaim them notinline at EOF,
;;; so, except in this file, they are not inline by default, but they can be.
;;;
(declaim (inline read-char unread-char read-byte listen))
(defun read-char (&optional (stream *standard-input*) (eof-errorp t) eof-value
recursive-p)
"Inputs a character from Stream and returns it."
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%read-char stream eof-errorp eof-value recursive-p t)
;; lisp-stream
(prepare-for-fast-read-char stream
(prog1
(fast-read-char eof-errorp eof-value)
(done-with-fast-read-char)))
;; fundamental-stream
(let ((char (stream-read-char stream)))
(if (eq char :eof)
(eof-or-lose stream eof-errorp eof-value)
char)))))
(defun unread-char (character &optional (stream *standard-input*))
"Puts the Character back on the front of the input Stream."
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%unread-char stream character)
;; lisp-stream
(let ((index (1- (lisp-stream-in-index stream)))
(buffer (lisp-stream-in-buffer stream)))
(declare (fixnum index))
(when (minusp index) (error (intl:gettext "Nothing to unread.")))
(cond (buffer
(setf (aref buffer index) (char-code character))
(setf (lisp-stream-in-index stream) index))
(t
(funcall (lisp-stream-misc stream) stream
:unread character))))
#+unicode
(let ((sbuf (lisp-stream-string-buffer stream))
(ibuf (lisp-stream-in-buffer stream)))
(cond (sbuf
(let ((index (1- (lisp-stream-string-index stream))))
(when (minusp index)
(error (intl:gettext "Nothing to unread.")))
(setf (aref sbuf index) character)
(setf (lisp-stream-string-index stream) index)))
(ibuf
(let ((index (1- (lisp-stream-in-index stream))))
(when (minusp index)
(error (intl:gettext "Nothing to unread.")))
;; This only works for iso8859-1!
(setf (aref ibuf index) (char-code character))
(setf (lisp-stream-in-index stream) index)))
(t
(funcall (lisp-stream-misc stream) stream
:unread character))))
;; fundamental-stream
(stream-unread-char stream character)))
;;; In the interest of ``once and only once'' this macro contains the
;;; framework necessary to implement a peek-char function, which has
;;; two special-cases (one for gray streams and one for echo streams)
;;; in addition to the normal case.
;;;
;;; All arguments are forms which will be used for a specific purpose
;;; PEEK-TYPE - the current peek-type as defined by ANSI CL
;;; EOF-VALUE - the eof-value argument to peek-char
;;; CHAR-VAR - the variable which will be used to store the current character
;;; READ-FORM - the form which will be used to read a character
;;; READ-EOF - the result returned from READ-FORM when eof is reached.
;;; UNREAD-FORM - ditto for unread-char
;;; SKIPPED-CHAR-FORM - the form to execute when skipping a character
;;; EOF-DETECTED-FORM - the form to execute when EOF has been detected
;;; (this will default to CHAR-VAR)
(defmacro generalized-peeking-mechanism (peek-type eof-value char-var
read-form read-eof unread-form
&key (skipped-char-form nil)
(eof-detected-form nil))
(cond ((eql ,char-var ,read-eof)
,(if eof-detected-form
eof-detected-form
((characterp ,peek-type)
(do ((,char-var ,char-var ,read-form))
((or (eql ,char-var ,read-eof)
(cond ((eql ,char-var ,read-eof)
,(if eof-detected-form
eof-detected-form
(t ,unread-form
,char-var)))
,skipped-char-form))
((eql ,peek-type t)
(do ((,char-var ,char-var ,read-form))
((or (eql ,char-var ,read-eof)
(not (eql (get-cat-entry ,char-var *readtable*) whitespace)))
(cond ((eql ,char-var ,read-eof)
,(if eof-detected-form
eof-detected-form
(t ,unread-form
,char-var)))
,skipped-char-form))
((null ,peek-type)
,unread-form
(when (eql char-var read-eof)
(error (intl:gettext "Impossible case reached in PEEK-CHAR"))))))
(defun peek-char (&optional (peek-type nil) (stream *standard-input*)
(eof-errorp t) eof-value recursive-p)
"Peeks at the next character in the input Stream. See manual for details."
;; FIXME: The type of PEEK-TYPE is also declared in a DEFKNOWN, but
;; the compiler doesn't seem to be smart enough to go from there to
;; imposing a type check. Figure out why (because PEEK-TYPE is an
;; &OPTIONAL argument?) and fix it, and then this explicit type
;; check can go away.
(unless (typep peek-type '(or character boolean))
(error 'simple-type-error
:datum peek-type
:expected-type '(or character boolean)
:format-control (intl:gettext "~@<bad PEEK-TYPE=~S, ~_expected ~S~:>")
:format-arguments (list peek-type '(or character boolean))))
(let ((stream (in-synonym-of stream)))
(if (typep stream 'echo-stream)
(echo-misc stream :peek-char peek-type (list eof-errorp eof-value))
(stream-dispatch stream
;; simple-stream
(stream::%peek-char stream peek-type eof-errorp eof-value
recursive-p)
;; lisp-stream
(generalized-peeking-mechanism
peek-type eof-value char
(read-char stream eof-errorp :eof)
:eof
:skipped-char-form nil
:eof-detected-form (eof-or-lose stream (or eof-errorp recursive-p) eof-value))
;; fundamental-stream
(generalized-peeking-mechanism
peek-type :eof char
(if (null peek-type)
(stream-peek-char stream)
(stream-read-char stream))
(if (null peek-type)
()
(stream-unread-char stream char))
:skipped-char-form ()
:eof-detected-form (eof-or-lose stream eof-errorp eof-value))))))
(defun listen (&optional (stream *standard-input*) (width 1))
"Returns T if a character is available on the given Stream."
(declare (type streamlike stream))
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%listen stream width)
;; lisp-stream
(or (/= (the fixnum (lisp-stream-in-index stream)) in-buffer-length)
;; Test for t explicitly since misc methods return :eof sometimes.
(eq (funcall (lisp-stream-misc stream) stream :listen) t))
;; fundamental-stream
(stream-listen stream))))
(defun read-char-no-hang (&optional (stream *standard-input*)
(eof-errorp t) eof-value recursive-p)
"Returns the next character from the Stream if one is available, or nil."
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%read-char stream eof-errorp eof-value recursive-p nil)
;; lisp-stream
(if (funcall (lisp-stream-misc stream) stream :listen)
;; On t or :eof get READ-CHAR to do the work.
(read-char stream eof-errorp eof-value)
nil)
;; fundamental-stream
(let ((char (stream-read-char-no-hang stream)))
(if (eq char :eof)
(eof-or-lose stream eof-errorp eof-value)
char)))))
(defun clear-input (&optional (stream *standard-input*) buffer-only)
"Clears any buffered input associated with the Stream."
(declare (type streamlike stream))
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%clear-input stream buffer-only)
;; lisp-stream
(progn
(setf (lisp-stream-in-index stream) in-buffer-length)
(funcall (lisp-stream-misc stream) stream :clear-input))
;; fundamental-stream
(stream-clear-input stream)))
"Returns the next byte of the Stream."
(declare (type stream stream))
(let ((stream (in-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%read-byte stream eof-errorp eof-value)
;; lisp-stream
(prepare-for-fast-read-byte stream
(prog1
(fast-read-byte eof-errorp eof-value t)
(done-with-fast-read-byte)))
;; fundamental-stream
(let ((char (stream-read-byte stream)))
(if (eq char :eof)
(eof-or-lose stream eof-errorp eof-value)
char)))))
(defun read-n-bytes (stream buffer start numbytes &optional (eof-errorp t))
"Reads Numbytes bytes into the Buffer starting at Start, returning the number
of bytes read.
-- If EOF-ERROR-P is true, an END-OF-FILE condition is signalled if
end-of-file is encountered before Count bytes have been read.
-- If EOF-ERROR-P is false, READ-N-BYTES reads as much data as is currently
available (up to count bytes). On pipes or similar devices, this
function returns as soon as any data is available, even if the amount
read is less than Count and eof has not been hit."
(declare (type lisp-stream stream)
(type index numbytes start)
(type (or (simple-array * (*)) system-area-pointer) buffer))
(let* ((stream (in-synonym-of stream lisp-stream))
(in-buffer (lisp-stream-in-buffer stream))
(index (lisp-stream-in-index stream))
(num-buffered (- in-buffer-length index)))
(declare (fixnum index num-buffered))
(cond
((not in-buffer)
(funcall (lisp-stream-n-bin stream) stream
buffer start numbytes eof-errorp))
((<= numbytes num-buffered)
(%primitive byte-blt in-buffer index buffer start (+ start numbytes))
numbytes)
(t
(let ((end (+ start num-buffered)))
(%primitive byte-blt in-buffer index buffer start end)
(setf (lisp-stream-in-index stream) in-buffer-length)
(+ (funcall (lisp-stream-n-bin stream) stream buffer end
(- numbytes num-buffered)
eof-errorp)
;;; Amount of space we leave at the start of the in-buffer for unreading. 4
;;; instead of 1 to allow word-aligned copies.
;;;
(defconstant in-buffer-extra 4)
;;; FAST-READ-CHAR-REFILL -- Interface
;;;
;;; This function is called by the fast-read-char expansion to refill the
;;; in-buffer for text streams. There is definitely an in-buffer, and hence
;;;
(defun fast-read-char-refill (stream eof-errorp eof-value)
(let* ((ibuf (lisp-stream-in-buffer stream))
(count (funcall (lisp-stream-n-bin stream) stream
ibuf in-buffer-extra
(- in-buffer-length in-buffer-extra)
nil))
(start (- in-buffer-length count)))
(declare (type index start count))
(cond ((zerop count)
(setf (lisp-stream-in-index stream) in-buffer-length)
(funcall (lisp-stream-in stream) stream eof-errorp eof-value))
(t
(when (/= start in-buffer-extra)
(bit-bash-copy ibuf (+ (* in-buffer-extra vm:byte-bits)
(* vm:vector-data-offset vm:word-bits))
ibuf (+ (the index (* start vm:byte-bits))
(* vm:vector-data-offset vm:word-bits))
(* count vm:byte-bits)))
(code-char (aref ibuf start))))))
;;; FAST-READ-CHAR-STRING-REFILL -- Interface
;;;
;;; This function is called by the fast-read-char expansion to refill the
;;; string-buffer for text streams. There is definitely a
;;; string-buffer and an in-buffer, which implies there must be an
;;; n-bin method.
;;;
#+unicode
(defun fast-read-char-string-refill (stream eof-errorp eof-value)
;; Like fast-read-char-refill, but we don't need or want the
;; in-buffer-extra.
(let* ((ibuf (lisp-stream-in-buffer stream))
(index (lisp-stream-in-index stream))
(in-length (fd-stream-in-length stream)))
(declare (type (integer 0 #.in-buffer-length) index in-length))
#+(or debug-frc-sr)
(progn
(format t "index = ~A~%" index)
(format t "in-length = ~A~%" in-length)
(format t "ibuf before = ~A~%" ibuf)
(format t "sbuf before = ~S~%" (subseq (lisp-stream-string-buffer stream) 0
(lisp-stream-string-buffer-len stream))))
;; For debugging, clear out the stuff we've already read so we can
;; see what's happening.
#+(or debug-frc-sr)
(fill ibuf 0 :start 0 :end index)
;; Copy the stuff we haven't read from in-buffer to the beginning
;; of the buffer.
(if (< index in-length)
(replace ibuf ibuf
:start1 0
:start2 index :end2 in-length)
(setf index in-length))
;; For debugging, clear out the stuff we've already read so we can
;; see what's happening.
#+(or debug-frc-sr)
(when (< index (1- in-buffer-length))
(fill ibuf 0 :start (1+ index) :end in-buffer-length))
(setf index (- in-length index))
#+(or debug-frc-sr)
(format t "ibuf after = ~A~%" ibuf)
(flet
((get-octets (start)
(funcall (lisp-stream-n-bin stream) stream
ibuf start
(- in-buffer-length start)
nil))
(handle-eof ()
;; Nothing left in the stream, so update our pointers to
;; indicate we've read everything and call the stream-in
;; function so that we do the right thing for eof.
(setf (lisp-stream-in-index stream) in-buffer-length)
(setf (lisp-stream-string-index stream)
(lisp-stream-string-buffer-len stream))
(funcall (lisp-stream-in stream) stream eof-errorp eof-value)))
(let ((count (get-octets index)))
(declare (type (integer 0 #.in-buffer-length) count))
#+(or debug-frc-sr)
(progn
(format t "count = ~D~%" count)
(format t "new ibuf = ~A~%" ibuf))
(cond ((zerop count)
(handle-eof))
(t
(let ((sbuf (lisp-stream-string-buffer stream))
(slen (lisp-stream-string-buffer-len stream)))
(declare (simple-string sbuf)
(type (integer 0 #.(1+ in-buffer-length)) slen)
(optimize (speed 3)))
;; Update in-length. This is needed if we change the
;; external-format of the stream because we need to
;; know how many octets are valid (in case
;; end-of-file was reached)
(setf (fd-stream-in-length stream) (+ count index))
#+(or debug-frc-sr)
(format t "in-length = ~D~%" (fd-stream-in-length stream))
#+(or debug-frc-sr)
(format t "slen = ~A~%" slen)
;; Copy the last read character to the beginning of the
;; buffer to support unreading.
(when (plusp slen)
(setf (schar sbuf 0) (schar sbuf (1- slen))))
#+(or debug-frc-sr)
(progn
(format t "sbuf[0] = ~S~%" (schar sbuf 0))
(format t "index = ~S~%" index))
;; Convert all the octets, including the ones that we
;; haven't processed yet and the ones we just read in.
(flet
((convert-buffer ()
(let ((old-state (fd-stream-oc-state stream)))
(multiple-value-bind (s char-count octet-count new-state)
(stream::octets-to-string-counted
ibuf
(fd-stream-octet-count stream)
:start 0
:end (fd-stream-in-length stream)
:state (fd-stream-oc-state stream)
:string sbuf
:s-start 1
:external-format (fd-stream-external-format stream)
:error (fd-stream-octets-to-char-error stream))
(declare (ignore s)
(type (integer 0 #.in-buffer-length) char-count octet-count))
(format t "char-count = ~A~%" char-count)
(format t "octet-count = ~A~%" octet-count)
(format t "in-index = ~A~%" (lisp-stream-in-index stream))
(format t "new state = ~S~%" new-state))
;; FIXME: We need to know if a BOM character was read so that
;; we can adjust the octet count correctly because
;; OCTETS-TO-CHAR does not include the BOM in the number of
;; octets processed. To do that, we look into the state, and
;; thus is very fragile. OCTETS-TO-CHAR and thus
;; OCTETS-TO-STRING-COUNTED should indicate that instead of
;; doing it here.
;; So far, only utf-16 and utf-32 needs to handle BOM
;; specially. In both of these cases, (cadr state) contains
;; information about whether a BOM character was read or not.
;; If a BOM was read, then we need to increment the
;; octet-count by 2 for the BOM because OCTETS-TO-STRING
;; doesn't include that in its count.
;;
;; But we could have a composing external format too, like
;; :crlf, so what we really want to look at is the last
;; element of the state.
(not (eq (car (last old-state))
(car (last new-state)))))
#+debug-frc-sr
(format t "state changed from ~S to ~S~%" old-state new-state)
;; See utf-16.lisp and utf-32.lisp. The part of the state
;; we're interested in encodes the endianness and the size
;; of the BOM in octets.
(incf octet-count (abs (the (integer -4 4)
(car (last new-state))))))
(when (> char-count 0)
(setf (fd-stream-oc-state stream) new-state)
(setf (lisp-stream-string-buffer-len stream) (1+ char-count))
(setf (lisp-stream-string-index stream) 2)
(setf (lisp-stream-in-index stream) octet-count)
#+(or debug-frc-sr)
(progn
(format t "new in-index = ~A~%" (lisp-stream-in-index stream))
(format t "new sbuf = ~S~%"
(subseq sbuf 0 (1+ char-count))))
(schar sbuf 1))))))
(let ((out (convert-buffer)))
(or out
;; There weren't enough octets to convert at
;; least one character. Try to read some more
;; octets and try again. (If we still fail,
;; what should we do then? Currently, just
;; just return NIL and let other parts of Lisp
;; catch that.)
;;
;; The in buffer holds unread octets up to
;; index in-length. So start reading octets there.
(let* ((index (fd-stream-in-length stream))
(count (get-octets index)))
(declare (type (integer 0 #.in-buffer-length) count index))
(cond ((zerop count)
(handle-eof))
(t
;; Adjust in-length to the total
;; number of octets that are now in
;; the buffer.
(setf (fd-stream-in-length stream) (+ count index))
(convert-buffer))))))))))))))
;;; FAST-READ-BYTE-REFILL -- Interface
;;;
;;; Similar to FAST-READ-CHAR-REFILL, but we don't have to leave room for
;;; unreading.
;;;
(defun fast-read-byte-refill (stream eof-errorp eof-value)
(let* ((ibuf (lisp-stream-in-buffer stream))
(count (funcall (lisp-stream-n-bin stream) stream
ibuf 0 in-buffer-length
nil))
(start (- in-buffer-length count)))
(declare (type index start count))
(cond ((zerop count)
(setf (lisp-stream-in-index stream) in-buffer-length)
(funcall (lisp-stream-bin stream) stream eof-errorp eof-value))
(t
(unless (zerop start)
(bit-bash-copy ibuf (* vm:vector-data-offset vm:word-bits)
ibuf (+ (the index (* start vm:byte-bits))
(* vm:vector-data-offset vm:word-bits))
(* count vm:byte-bits)))
;;; Output functions:
(defun write-char (character &optional (stream *standard-output*))
"Outputs the Character to the Stream."
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%write-char stream character)
;; lisp-stream
(funcall (lisp-stream-out stream) stream character)
;; fundamental-stream
(stream-write-char stream character)))
character)
(defun terpri (&optional (stream *standard-output*))
"Outputs a new line to the Stream."
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%write-char stream #\Newline)
;; lisp-stream
(funcall (lisp-stream-out stream) stream #\Newline)
;; fundamental-stream
(stream-terpri stream)))
nil)
(defun fresh-line (&optional (stream *standard-output*))
"Outputs a new line to the Stream if it is not positioned at the beginning of
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%fresh-line stream)
;; lisp-stream
(when (/= (or (charpos stream) 1) 0)
(funcall (lisp-stream-out stream) stream #\newline)
t)
;; fundamental-stream
(stream-fresh-line stream))))
(defun write-string (string &optional (stream *standard-output*)
"Outputs the String to the given Stream."
(write-string* string stream start (or end (length (the vector string)))))
(defun write-string* (string &optional (stream *standard-output*)
(start 0) (end (length (the vector string))))
(declare (type streamlike stream) (fixnum start end))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(if (array-header-p string)
(with-array-data ((data string) (offset-start start)
(offset-end end))
(stream::%write-string stream data offset-start offset-end))
(stream::%write-string stream string start end))
(if (array-header-p string)
(with-array-data ((data string) (offset-start start)
(offset-end end))
(funcall (lisp-stream-sout stream)
stream data offset-start offset-end))
(funcall (lisp-stream-sout stream) stream string start end))
;; fundamental-stream
(stream-write-string stream string start end)))
string)
(defun write-line (string &optional (stream *standard-output*)
&key (start 0) (end (length string)))
"Outputs the String to the given Stream, followed by a newline character."
(write-line* string stream start (or end (length string))))
(defun write-line* (string &optional (stream *standard-output*)
(start 0) (end (length string)))
(declare (type streamlike stream) (fixnum start end))
(let ((stream (out-synonym-of stream)))
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
(stream-dispatch stream
;; simple-stream
(progn
(if (array-header-p string)
(with-array-data ((data string) (offset-start start)
(offset-end end))
(stream::%write-string stream data offset-start offset-end))
(stream::%write-string stream string start end))
(stream::%write-char stream #\Newline))
;; lisp-stream
(progn
(if (array-header-p string)
(with-array-data ((data string) (offset-start start)
(offset-end end))
(funcall (lisp-stream-sout stream) stream data offset-start
offset-end))
(funcall (lisp-stream-sout stream) stream string start end))
(funcall (lisp-stream-out stream) stream #\newline))
;; fundamental-stream
(progn
(stream-write-string stream string start end)
(stream-write-char stream #\Newline)))
"Returns the number of characters on the current line of output of the given
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%charpos stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :charpos)
;; fundamental-stream
(stream-line-column stream))))
"Returns the number of characters that will fit on a line of output on the
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%line-length stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :line-length)
;; fundamental-stream
(stream-line-length stream))))
(defun finish-output (&optional (stream *standard-output*))
"Attempts to ensure that all output sent to the Stream has reached its
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%finish-output stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :finish-output)
;; fundamental-stream
(stream-finish-output stream)))
nil)
(defun force-output (&optional (stream *standard-output*))
"Attempts to force any buffered output to be sent."
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%force-output stream)
;; lisp-stream-misc
(funcall (lisp-stream-misc stream) stream :force-output)
;; fundamental-stream
(stream-force-output stream)))
nil)
(defun clear-output (&optional (stream *standard-output*))
"Clears the given output Stream."
(declare (type streamlike stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%clear-output stream)
;; lisp-stream
(funcall (lisp-stream-misc stream) stream :clear-output)
;; fundamental-stream
(stream-clear-output stream)))
"Outputs the Integer to the binary Stream."
(declare (type stream stream))
(let ((stream (out-synonym-of stream)))
(stream-dispatch stream
;; simple-stream
(stream::%write-byte stream integer)
;; lisp-stream
(funcall (lisp-stream-bout stream) stream integer)
;; fundamental-stream
(stream-write-byte stream integer)))
;;; Stream-misc-dispatch
;;;
;;; Called from lisp-stream routines that encapsulate CLOS streams to
;;; handle the misc routines and dispatch to the appropriate Gray
;;; stream functions.
;;;
(defun stream-misc-dispatch (stream operation &optional arg1 arg2)
(declare (type fundamental-stream stream)
(ignore arg2))
(case operation
(:listen
;; Return true if input available, :eof for end-of-file, otherwise Nil.
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
(let ((char (stream-read-char-no-hang stream)))
(when (characterp char)
(stream-unread-char stream char))
char))
(:unread
(stream-unread-char stream arg1))
(:close
(close stream))
(:clear-input
(stream-clear-input stream))
(:force-output
(stream-force-output stream))
(:finish-output
(stream-finish-output stream))
(:element-type
(stream-element-type stream))
(:interactive-p
(interactive-stream-p stream))
(:line-length
(stream-line-length stream))
(:charpos
(stream-line-column stream))
(:file-length
(file-length stream))
(:file-position
(file-position stream arg1))))
(out #'broadcast-out)
(bout #'broadcast-bout)
(sout #'broadcast-sout)
(misc #'broadcast-misc))
(:print-function %print-broadcast-stream)
(:constructor %make-broadcast-stream (&rest streams)))
(streams () :type list :read-only t))
(defun make-broadcast-stream (&rest streams)
"Returns an output stream which sends its output to all of the given
streams."
(dolist (s streams)
(unless (output-stream-p s)
(ill-out-any s)))
(apply #'%make-broadcast-stream streams))
(defun %print-broadcast-stream (s stream d)
(declare (ignore s d))
(write-string "#<Broadcast Stream>" stream))
(macrolet ((out-fun (fun method stream-method &rest args)
`(defun ,fun (stream ,@args)
(dolist (stream (broadcast-stream-streams stream))
(stream-dispatch stream
;; simple-stream
(,stream-method stream ,@args) ; use gray-compat for now
;; lisp-stream
(funcall (,method stream) stream ,@args)
;; fundamental-stream
(,stream-method stream ,@args))))))
(out-fun broadcast-out lisp-stream-out stream-write-char char)
(out-fun broadcast-bout lisp-stream-bout stream-write-byte byte)
(out-fun broadcast-sout lisp-stream-sout stream-write-string
string start end))
(defun broadcast-misc (stream operation &optional arg1 arg2)
(let ((streams (broadcast-stream-streams stream)))
(case operation
(:charpos
(let ((charpos (charpos stream)))
(if charpos (return charpos)))))
(:line-length
(let ((min nil))
(dolist (stream streams min)
(let ((res (line-length stream)))
;; CLHS: The functions file-length, file-position, file-string-length, and
;; stream-external-format return the value from the last component
;; stream; if there are no component streams, file-length and
;; file-position return 0, file-string-length returns 1, and
;; stream-external-format returns :default.
(:file-length
(if (null streams) 0
(pushnew (stream-element-type stream) res :test #'equal)))
;; ANSI-specified version (under System Class BROADCAST-STREAM)
(let ((res t))
(do ((streams streams (cdr streams)))
((null streams) res)
(when (null (cdr streams))
(setq res (stream-element-type (car streams)))))))
(setq res
(if (lisp-stream-p stream)
(funcall (lisp-stream-misc stream) stream operation
arg1 arg2)
(stream-misc-dispatch stream operation arg1 arg2)))))))))
(in #'synonym-in)
(bin #'synonym-bin)
(n-bin #'synonym-n-bin)
(out #'synonym-out)
(bout #'synonym-bout)
(sout #'synonym-sout)
(misc #'synonym-misc))
(:print-function %print-synonym-stream)
(:constructor make-synonym-stream (symbol)))
;; This is the symbol, the value of which is the stream we are synonym to.
(symbol nil :type symbol :read-only t))
(defun %print-synonym-stream (s stream d)
(declare (ignore d))
(format stream "#<Synonym Stream to ~S>" (synonym-stream-symbol s)))
(setf (documentation 'make-synonym-stream 'function)
_N"Returns a stream which performs its operations on the stream which is the
value of the dynamic variable named by Symbol.")
;;; The output simple output methods just call the corresponding method
;;; in the synonymed stream.
;;;
(macrolet ((out-fun (name slot stream-method &rest args)
(declare (optimize (safety 1)))
(if (lisp-stream-p syn)
(funcall (,slot syn) syn ,@args)
(,stream-method syn ,@args))))))
(out-fun synonym-out lisp-stream-out stream-write-char ch)
(out-fun synonym-bout lisp-stream-bout stream-write-byte n)
(out-fun synonym-sout lisp-stream-sout stream-write-string string start end))
;;; Bind synonym stream to this so that SPIO can turn on the right frob in
;;; the icon when we are in a terminal input wait.
;;;
(defvar *previous-stream* nil)
;;; For the input methods, we just call the corresponding function on the
;;; synonymed stream. These functions deal with getting input out of
;;; the In-Buffer if there is any.
;;;
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(declare (optimize (safety 1)))
(let ((*previous-stream* stream))
(,fun (symbol-value (synonym-stream-symbol stream)) ,@args)))))
(in-fun synonym-in read-char eof-errorp eof-value)
(in-fun synonym-bin read-byte eof-errorp eof-value)
(in-fun synonym-n-bin read-n-bytes buffer start numbytes eof-errorp))
;;; Synonym-Misc -- Internal
;;;
;;; We have to special-case the operations which could look at stuff in
;;; the in-buffer.
;;;
(defun synonym-misc (stream operation &optional arg1 arg2)
(declare (optimize (safety 1)))
(let ((syn (symbol-value (synonym-stream-symbol stream)))
(*previous-stream* stream))
(if (lisp-stream-p syn)
(case operation
(:listen (or (/= (the fixnum (lisp-stream-in-index syn))
in-buffer-length)
(funcall (lisp-stream-misc syn) syn :listen)))
(:clear-input (clear-input syn))
(:unread (unread-char arg1 syn))
(t
(funcall (lisp-stream-misc syn) syn operation arg1 arg2)))
(stream-misc-dispatch syn operation arg1 arg2))))
(in #'two-way-in)
(bin #'two-way-bin)
(n-bin #'two-way-n-bin)
(out #'two-way-out)
(bout #'two-way-bout)
(sout #'two-way-sout)
(misc #'two-way-misc))
(:print-function %print-two-way-stream)
(:constructor %make-two-way-stream (input-stream output-stream)))
(input-stream (required-argument) :type stream :read-only t)
(output-stream (required-argument) :type stream :read-only t))
(defun %print-two-way-stream (s stream d)
(declare (ignore d))
(format stream "#<Two-Way Stream, Input = ~S, Output = ~S>"
(two-way-stream-input-stream s)
(two-way-stream-output-stream s)))
(defun make-two-way-stream (input-stream output-stream)
"Returns a bidirectional stream which gets its input from Input-Stream and
sends its output to Output-Stream."
(unless (input-stream-p input-stream)
(ill-in-any input-stream))
(unless (output-stream-p output-stream)
(ill-out-any output-stream))
(%make-two-way-stream input-stream output-stream))
(macrolet ((out-fun (name slot stream-method &rest args)
`(defun ,name (stream ,@args)
(let ((syn (two-way-stream-output-stream stream)))
(if (lisp-stream-p syn)
(funcall (,slot syn) syn ,@args)
(,stream-method syn ,@args))))))
(out-fun two-way-out lisp-stream-out stream-write-char ch)
(out-fun two-way-bout lisp-stream-bout stream-write-byte n)
(out-fun two-way-sout lisp-stream-sout stream-write-string string start end))
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(force-output (two-way-stream-output-stream stream))
(,fun (two-way-stream-input-stream stream) ,@args))))
(in-fun two-way-in read-char eof-errorp eof-value)
(in-fun two-way-bin read-byte eof-errorp eof-value)
(in-fun two-way-n-bin read-n-bytes buffer start numbytes eof-errorp))
(defun two-way-misc (stream operation &optional arg1 arg2)
(let* ((in (two-way-stream-input-stream stream))
(out (two-way-stream-output-stream stream))
(in-lisp-stream-p (lisp-stream-p in))
(out-lisp-stream-p (lisp-stream-p out)))
(:listen
(if in-lisp-stream-p
(or (/= (the fixnum (lisp-stream-in-index in)) in-buffer-length)
(funcall (lisp-stream-misc in) in :listen))
(stream-listen in)))
(if out-lisp-stream-p
(funcall (lisp-stream-misc out) out operation arg1 arg2)
(stream-misc-dispatch out operation arg1 arg2)))
(:clear-input (clear-input in))
(:unread (unread-char arg1 in))
(let ((in-type (stream-element-type in))
(out-type (stream-element-type out)))
(if (equal in-type out-type)
in-type `(and ,in-type ,out-type))))
(:file-length
(error 'type-error :datum stream :expected-type 'file-stream))
(:charpos
(charpos out))
(:line-length
(line-length out))
(or (if in-lisp-stream-p
(funcall (lisp-stream-misc in) in operation arg1 arg2)
(stream-misc-dispatch in operation arg1 arg2))
(if out-lisp-stream-p
(funcall (lisp-stream-misc out) out operation arg1 arg2)
(stream-misc-dispatch out operation arg1 arg2)))))))
;;;; Concatenated Streams:
(defstruct (concatenated-stream
(misc #'concatenated-misc))
(:print-function %print-concatenated-stream)
(:constructor %make-concatenated-stream (&rest streams)))
;; This is a list of all the streams. The car of this is the stream
;; we are reading from now.
(streams nil :type list))
(defun %print-concatenated-stream (s stream d)
(declare (ignore d))
(format stream "#<Concatenated Stream, Streams = ~S>"
(concatenated-stream-streams s)))
(defun make-concatenated-stream (&rest streams)
"Returns a stream which takes its input from each of the Streams in turn,
going on to the next at EOF."
(dolist (s streams)
(unless (input-stream-p s)
(ill-in-any s)))
(apply #'%make-concatenated-stream streams))
(macrolet ((in-fun (name fun)
`(defun ,name (stream eof-errorp eof-value)
(do ((current (concatenated-stream-streams stream)
(cdr current)))
((null current)
(eof-or-lose stream eof-errorp eof-value))
(let* ((stream (car current))
(result (,fun stream nil nil)))
(when result (return result)))
(setf (concatenated-stream-streams stream) (cdr current))))))
(in-fun concatenated-in read-char)
(in-fun concatenated-bin read-byte))
(defun concatenated-n-bin (stream buffer start numbytes eof-errorp)
(do ((current (concatenated-stream-streams stream) (cdr current))
(current-start start)
(remaining-bytes numbytes))
((null current)
(if eof-errorp
(error 'end-of-file :stream stream)
(- numbytes remaining-bytes)))
(let* ((stream (car current))
(bytes-read (read-n-bytes stream buffer current-start
remaining-bytes nil)))
(incf current-start bytes-read)
(decf remaining-bytes bytes-read)
(when (zerop remaining-bytes) (return numbytes)))
(setf (concatenated-stream-streams stream) (cdr current))))
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
(let ((current (first (concatenated-stream-streams stream))))
(case operation
(:listen
(if current
(loop
(let ((stuff (if (lisp-stream-p current)
(funcall (lisp-stream-misc current) current
:listen)
(stream-misc-dispatch current :listen))))
(cond ((eq stuff :eof)
;; Advance current, and try again.
(pop (concatenated-stream-streams stream))
(setf current (first (concatenated-stream-streams stream)))
(unless current (return :eof)))
(stuff
;; Stuff's available.
(return t))
(t
;; Nothing available yet.
(return nil)))))
:eof))
(:close
(set-closed-flame stream))
(:clear-input
(when current (clear-input current)))
(:unread
(when current (unread-char arg1 current)))
(:file-length
(error 'type-error :datum stream :expected-type 'file-stream))
(t
(if (lisp-stream-p current)
(funcall (lisp-stream-misc current) current operation arg1 arg2)
(stream-misc-dispatch current operation arg1 arg2))))))
;;;; Echo Streams:
(defstruct (echo-stream
(:include two-way-stream
(in #'echo-in)
(bin #'echo-bin)
(misc #'echo-misc)
(n-bin #'echo-n-bin))
(:constructor %make-echo-stream (input-stream output-stream)))
(defun make-echo-stream (input-stream output-stream)
"Returns an echo stream that takes input from Input-stream and sends
output to Output-stream"
(unless (input-stream-p input-stream)
(ill-in-any input-stream))
(unless (output-stream-p output-stream)
(ill-out-any output-stream))
(%make-echo-stream input-stream output-stream))
(macrolet ((in-fun (name fun out-slot stream-method)
`(defun ,name (stream eof-errorp eof-value)
(or (pop (echo-stream-unread-stuff stream))
(let* ((in (echo-stream-input-stream stream))
(out (echo-stream-output-stream stream))
(result (,fun in nil :eof)))
(cond ((eq result :eof)
(eof-or-lose stream eof-errorp eof-value))
(t
(if (lisp-stream-p out)
(funcall (,out-slot out) out result)
(,stream-method out result))
result)))))))
(in-fun echo-in read-char lisp-stream-out stream-write-char)
(in-fun echo-bin read-byte lisp-stream-bout stream-write-byte))
(defun echo-misc (stream operation &optional arg1 arg2)
(let* ((in (two-way-stream-input-stream stream))
(out (two-way-stream-output-stream stream)))
(:listen
(or (not (null (echo-stream-unread-stuff stream)))
(if (lisp-stream-p in)
(or (/= (the fixnum (lisp-stream-in-index in)) in-buffer-length)
(funcall (lisp-stream-misc in) in :listen))
(stream-misc-dispatch in :listen))))
(:unread (push arg1 (echo-stream-unread-stuff stream)))
(let ((in-type (stream-element-type in))
(out-type (stream-element-type out)))
(if (equal in-type out-type)
in-type `(and ,in-type ,out-type))))
(:close
(set-closed-flame stream))
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
(:peek-char
;; For the special case of peeking into an echo-stream
;; arg1 is peek-type, arg2 is (eof-errorp eof-value)
;; returns peeked-char, eof-value, or errors end-of-file
(let ((unread-char-p nil))
(destructuring-bind (eof-errorp eof-value)
arg2
(flet ((outfn (c)
(unless unread-char-p
(if (lisp-stream-p out)
(funcall (lisp-stream-out out) out c)
;; gray-stream
(stream-write-char out c))))
(infn ()
;; Obtain input from unread buffer or input stream,
;; and set the flag appropriately.
(cond ((not (null (echo-stream-unread-stuff stream)))
(setf unread-char-p t)
(pop (echo-stream-unread-stuff stream)))
(t
(setf unread-char-p nil)
(read-char in eof-errorp :eof)))))
(generalized-peeking-mechanism
arg1 eof-value char
(infn)
:skipped-char-form (outfn char))))))
(:file-length
(error 'type-error :datum stream :expected-type 'file-stream))
(or (if (lisp-stream-p in)
(funcall (lisp-stream-misc in) in operation arg1 arg2)
(stream-misc-dispatch in operation arg1 arg2))
(if (lisp-stream-p out)
(funcall (lisp-stream-misc out) out operation arg1 arg2)
(stream-misc-dispatch out operation arg1 arg2)))))))
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
(defun echo-n-bin (stream buffer start numbytes eof-error-p)
(let ((new-start start)
(read 0))
(loop
(let ((thing (pop (echo-stream-unread-stuff stream))))
(cond
(thing
(setf (aref buffer new-start) thing)
(incf new-start)
(incf read)
(when (= read numbytes)
(return-from echo-n-bin numbytes)))
(t (return nil)))))
(let ((bytes-read (read-n-bytes (echo-stream-input-stream stream) buffer
new-start (- numbytes read) nil)))
(cond
((not eof-error-p)
(write-sequence buffer (echo-stream-output-stream stream)
:start new-start :end (+ new-start bytes-read))
(+ bytes-read read))
((> numbytes (+ read bytes-read))
(write-sequence buffer (echo-stream-output-stream stream)
:start new-start :end (+ new-start bytes-read))
(error 'end-of-file :stream stream))
(t
(write-sequence buffer (echo-stream-output-stream stream)
:start new-start :end (+ new-start bytes-read))
numbytes)))))
(defun %print-echo-stream (s stream d)
(declare (ignore d))
(format stream "#<Echo Stream, Input = ~S, Output = ~S>"
(two-way-stream-input-stream s)
(two-way-stream-output-stream s)))
(setf (documentation 'make-echo-stream 'function)
_N"Returns a bidirectional stream which gets its input from Input-Stream and
sends its output to Output-Stream. In addition, all input is echoed to
the output stream")
;;;; Superclass of all string streams
(defstruct (string-stream
(:include lisp-stream)
(:constructor nil)
(:copier nil)))
;;;; String Input Streams:
(defstruct (string-input-stream
(in #'string-inch)
(bin #'string-binch)
(n-bin #'string-stream-read-n-bytes)
(misc #'string-in-misc))
(:print-function %print-string-input-stream)
;(:constructor nil)
(:constructor internal-make-string-input-stream
(string current end)))
(current nil :type index)
(end nil :type index))
(defun %print-string-input-stream (s stream d)
(declare (ignore s d))
(write-string "#<String-Input Stream>" stream))
(defun string-inch (stream eof-errorp eof-value)
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(declare (simple-string string) (fixnum index))
(cond ((= index (the index (string-input-stream-end stream)))
(eof-or-lose stream eof-errorp eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(aref string index)))))
(defun string-binch (stream eof-errorp eof-value)
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(declare (simple-string string)
(type index index))
(cond ((= index (the index (string-input-stream-end stream)))
(eof-or-lose stream eof-errorp eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(char-code (aref string index))))))
(defun string-stream-read-n-bytes (stream buffer start requested eof-errorp)
(declare (type string-input-stream stream)
(type index start requested))
(let* ((string (string-input-stream-string stream))
(index (string-input-stream-current stream))
(available (- (string-input-stream-end stream) index))
(copy (min available requested)))
(declare (simple-string string)
(type index index available copy))
(when (plusp copy)
(setf (string-input-stream-current stream)
(truly-the index (+ index copy)))
(system:without-gcing
(system-area-copy (vector-sap string)
(* index vm:byte-bits)
(if (typep buffer 'system-area-pointer)
buffer
(vector-sap buffer))
(* start vm:byte-bits)
(* copy vm:byte-bits))))
(if (and (> requested copy) eof-errorp)
(error 'end-of-file :stream stream)
copy)))
(:file-position
(setf (string-input-stream-current stream)
(case arg1
(:start 0)
(:end (length (string-input-stream-string stream)))
(t arg1)))
(string-input-stream-current stream)))
(error 'type-error :datum stream :expected-type 'file-stream))
(:listen (or (/= (the fixnum (string-input-stream-current stream))
(the fixnum (string-input-stream-end stream)))
:eof))
(:element-type 'base-char)
(:close
(set-closed-flame stream))))
(defun make-string-input-stream (string &optional
(start 0) (end (length string)))
"Returns an input stream which will supply the characters of String between
(declare (type string string)
(type index start)
(internal-make-string-input-stream (coerce string 'simple-string)
;;;; String Output Streams:
(defstruct (string-output-stream
(out #'string-ouch)
(sout #'string-sout)
(misc #'string-out-misc))
(:print-function %print-string-output-stream)
(:constructor %make-string-output-stream ()))
;; The string we throw stuff in.
(string (make-string 40) :type simple-string)
;; Index of the next location to use.
(index 0 :type fixnum))
(defun %print-string-output-stream (s stream d)
(declare (ignore s d))
(write-string "#<String-Output Stream>" stream))
(defun make-string-output-stream (&key (element-type 'character))
"Returns an Output stream which will accumulate all output given to it for
the benefit of the function Get-Output-Stream-String."
(declare (ignore element-type))
(%make-string-output-stream))
(defun string-ouch (stream character)
(let ((current (string-output-stream-index stream))
(workspace (string-output-stream-string stream)))
(declare (simple-string workspace) (fixnum current))
(if (= current (the fixnum (length workspace)))
(let ((new-workspace (make-string (* current 2))))
(replace new-workspace workspace)
(setf (aref new-workspace current) character)
(setf (string-output-stream-string stream) new-workspace))
(setf (aref workspace current) character))
(setf (string-output-stream-index stream) (1+ current))))
(defun string-sout (stream string start end)
(declare (simple-string string) (fixnum start end))
(let* ((current (string-output-stream-index stream))
(length (- end start))
(dst-end (+ length current))
(workspace (string-output-stream-string stream)))
(declare (simple-string workspace)
(fixnum current length dst-end))
(if (> dst-end (the fixnum (length workspace)))
(let ((new-workspace (make-string (+ (* current 2) length))))
(replace new-workspace workspace :end2 current)
(replace new-workspace string
:start1 current :end1 dst-end
:start2 start :end2 end)
(replace workspace string
:start1 current :end1 dst-end
:start2 start :end2 end))
(setf (string-output-stream-index stream) dst-end)))
(defun string-out-misc (stream operation &optional arg1 arg2)
(:file-position
(if (null arg1)
(:file-length
(error 'type-error :datum stream :expected-type 'file-stream))
(:charpos
(do ((index (1- (the fixnum (string-output-stream-index stream)))
(1- index))
(count 0 (1+ count))
(string (string-output-stream-string stream)))
((< index 0) count)
(declare (simple-string string)
(fixnum index count))
(if (char= (schar string index) #\newline)
(return count))))
(:element-type 'base-char)
(:close
(set-closed-flame stream))))
"Returns a string of all the characters sent to a stream made by
Make-String-Output-Stream since the last call to this function."
(declare (type string-output-stream stream))
(let* ((length (string-output-stream-index stream))
(result (make-string length)))
(replace result (string-output-stream-string stream))
(setf (string-output-stream-index stream) 0)
result))
"Dumps the characters buffer up in the In-Stream to the Out-Stream as
(write-string* (string-output-stream-string in-stream) out-stream
0 (string-output-stream-index in-stream))
(setf (string-output-stream-index in-stream) 0))
;;;; Fill-pointer streams:
;;;
;;; Fill pointer string output streams are not explicitly mentioned in
;;; the CLM, but they are required for the implementation of With-Output-To-String.
(defstruct (fill-pointer-output-stream
(out #'fill-pointer-ouch)
(sout #'fill-pointer-sout)
(misc #'fill-pointer-misc))
(:print-function
(lambda (s stream d)
(declare (ignore s d))
(write-string "#<Fill-Pointer String Output Stream>" stream)))
(:constructor make-fill-pointer-output-stream (string)))
;; The string we throw stuff in.
string)
(defun fill-pointer-ouch (stream character)
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer))
(current+1 (1+ current)))
(declare (fixnum current))
(with-array-data ((workspace buffer) (start) (end))
(declare (simple-string workspace))
(let ((offset-current (+ start current)))
(declare (fixnum offset-current))
(if (= offset-current end)
(let* ((new-length (if (zerop current) 1 (* current 2)))
(new-workspace (make-string new-length)))
(declare (simple-string new-workspace))
(%primitive byte-blt workspace (* vm:char-bytes start)
new-workspace 0 (* vm:char-bytes current))
(setf workspace new-workspace)
(setf offset-current current)
(set-array-header buffer workspace new-length
current+1 0 new-length nil))
(setf (fill-pointer buffer) current+1))
(setf (schar workspace offset-current) character)))
current+1))
(defun fill-pointer-sout (stream string start end)
(declare (simple-string string) (fixnum start end))
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer))
(string-len (- end start))
(dst-end (+ string-len current)))
(declare (fixnum current dst-end string-len))
(with-array-data ((workspace buffer) (dst-start) (dst-length))
(declare (simple-string workspace))
(let ((offset-dst-end (+ dst-start dst-end))
(offset-current (+ dst-start current)))
(declare (fixnum offset-dst-end offset-current))
(if (> offset-dst-end dst-length)
(let* ((new-length (+ (the fixnum (* current 2)) string-len))
(new-workspace (make-string new-length)))
(declare (simple-string new-workspace))
(%primitive byte-blt workspace (* vm:char-bytes dst-start)
new-workspace 0 (* vm:char-bytes current))
(setf workspace new-workspace)
(setf offset-current current)
(setf offset-dst-end dst-end)
(set-array-header buffer workspace new-length
dst-end 0 new-length nil))
(setf (fill-pointer buffer) dst-end))
(%primitive byte-blt string (* vm:char-bytes start)
workspace (* vm:char-bytes offset-current)
(* vm:char-bytes offset-dst-end))))
dst-end))
(defun fill-pointer-misc (stream operation &optional arg1 arg2)
(declare (ignore arg1 arg2))
(case operation
(:charpos
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer)))
(with-array-data ((string buffer) (start) (end current))
(declare (simple-string string) (ignore start))
(let ((found (position #\newline string :test #'char=
:end end :from-end t)))
(if found
;; END points to where the next character goes, not the
;; last character. FOUND is where the newline is.
;; Subtract 1 to adjust for the difference.
(- end (the fixnum found) 1)
(:element-type 'base-char)))
(out #'indenting-out)
(sout #'indenting-sout)
(misc #'indenting-misc))
(:print-function %print-indenting-stream)
(:constructor make-indenting-stream (stream)))
;; The stream we're based on:
stream
;; How much we indent on each line:
(indentation 0))
(setf (documentation 'make-indenting-stream 'function)
_N"Returns an output stream which indents its output by some amount.")
(defun %print-indenting-stream (s stream d)
(declare (ignore s d))
(write-string "#<Indenting Stream>" stream))
;;; Indenting-Indent writes the right number of spaces needed to indent
;;; output on the given Stream based on the specified Sub-Stream.
(defmacro indenting-indent (stream sub-stream)
`(do ((i 0 (+ i 60))
(indentation (indenting-stream-indentation ,stream)))
((>= i indentation))
(write-string*
" "
,sub-stream 0 (min 60 (- indentation i)))))
;;; Indenting-Out writes a character to an indenting stream.
(defun indenting-out (stream char)
(let ((sub-stream (indenting-stream-stream stream)))
(if (char= char #\newline)
(indenting-indent stream sub-stream))))
;;; Indenting-Sout writes a string to an indenting stream.
(defun indenting-sout (stream string start end)
(declare (simple-string string) (fixnum start end))
(do ((i start)
(sub-stream (indenting-stream-stream stream)))
((= i end))
(let ((newline (position #\newline string :start i :end end)))
(cond (newline
(indenting-indent stream sub-stream)
(setq i (+ newline 1)))
(t
(setq i end))))))
;;; Indenting-Misc just treats just the :Line-Length message differently.
;;; Indenting-Charpos says the charpos is the charpos of the base stream minus
;;; the stream's indentation.
(defun indenting-misc (stream operation &optional arg1 arg2)
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
(if (lisp-stream-p sub-stream)
(let ((method (lisp-stream-misc sub-stream)))
(case operation
(:line-length
(let ((line-length (funcall method sub-stream operation)))
(if line-length
(- line-length (indenting-stream-indentation stream)))))
(:charpos
(let ((charpos (funcall method sub-stream operation)))
(if charpos
(- charpos (indenting-stream-indentation stream)))))
(t
(funcall method sub-stream operation arg1 arg2))))
;; Fundamental-stream.
(case operation
(:line-length
(let ((line-length (stream-line-length sub-stream)))
(if line-length
(- line-length (indenting-stream-indentation stream)))))
(:charpos
(let ((charpos (stream-line-column sub-stream)))
(if charpos
(- charpos (indenting-stream-indentation stream)))))
(t
(stream-misc-dispatch sub-stream operation arg1 arg2))))))
(declaim (maybe-inline read-char unread-char read-byte listen))
;;;; Case frobbing streams, used by format ~(...~).
(defstruct (case-frob-stream
(:misc #'case-frob-misc))
(:constructor %make-case-frob-stream (target out sout)))
(target (required-argument) :type stream))
(defun make-case-frob-stream (target kind)
"Returns a stream that sends all output to the stream TARGET, but modifies
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
the case of letters, depending on KIND, which should be one of:
:upcase - convert to upper case.
:downcase - convert to lower case.
:capitalize - convert the first letter of words to upper case and the
rest of the word to lower case.
:capitalize-first - convert the first letter of the first word to upper
case and everything else to lower case."
(declare (type stream target)
(type (member :upcase :downcase :capitalize :capitalize-first)
kind)
(values stream))
(if (case-frob-stream-p target)
;; If we are going to be writing to a stream that already does case
;; frobbing, why bother frobbing the case just so it can frob it
;; again?
target
(multiple-value-bind
(out sout)
(ecase kind
(:upcase
(values #'case-frob-upcase-out
#'case-frob-upcase-sout))
(:downcase
(values #'case-frob-downcase-out
#'case-frob-downcase-sout))
(:capitalize
(values #'case-frob-capitalize-out
#'case-frob-capitalize-sout))
(:capitalize-first
(values #'case-frob-capitalize-first-out
#'case-frob-capitalize-first-sout)))
(%make-case-frob-stream target out sout))))
(defun case-frob-misc (stream op &optional arg1 arg2)
(declare (type case-frob-stream stream))
(case op
(:close)
(t
(let ((target (case-frob-stream-target stream)))
(if (lisp-stream-p target)
(funcall (lisp-stream-misc target) target op arg1 arg2)
(stream-misc-dispatch target op arg1 arg2))))))
(defun case-frob-upcase-out (stream char)
(declare (type case-frob-stream stream)
(let ((target (case-frob-stream-target stream))
(char (char-upcase char)))
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char))))
(defun case-frob-upcase-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-base-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(len (length str))
(end (or end len))
(string (if (and (zerop start) (= len end))
(string-upcase str)
(nstring-upcase (subseq str start end))))
(string-len (- end start)))
(if (lisp-stream-p target)
(funcall (lisp-stream-sout target) target string 0 string-len)
(stream-write-string target string 0 string-len))))
(defun case-frob-downcase-out (stream char)
(declare (type case-frob-stream stream)
(let ((target (case-frob-stream-target stream))
(char (char-downcase char)))
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char))))
(defun case-frob-downcase-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-base-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(len (length str))
(end (or end len))
(string (if (and (zerop start) (= len end))
(string-downcase str)
(nstring-downcase (subseq str start end))))
(string-len (- end start)))
(if (lisp-stream-p target)
(funcall (lisp-stream-sout target) target string 0 string-len)
(stream-write-string target string 0 string-len))))
(defun case-frob-capitalize-out (stream char)
(declare (type case-frob-stream stream)
(let ((target (case-frob-stream-target stream)))
(cond ((alphanumericp char)
(let ((char (char-upcase char)))
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char)))
(setf (case-frob-stream-out stream) #'case-frob-capitalize-aux-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-aux-sout))
(t
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char))))))
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
(defun case-frob-capitalize-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-base-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(str (subseq str start end))
(len (length str))
(inside-word nil))
(dotimes (i len)
(let ((char (schar str i)))
(cond ((not (alphanumericp char))
(setf inside-word nil))
(inside-word
(setf (schar str i) (char-downcase char)))
(t
(setf inside-word t)
(setf (schar str i) (char-upcase char))))))
(when inside-word
(setf (case-frob-stream-out stream)
#'case-frob-capitalize-aux-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-aux-sout))
(if (lisp-stream-p target)
(funcall (lisp-stream-sout target) target str 0 len)
(stream-write-string target str 0 len))))
(defun case-frob-capitalize-aux-out (stream char)
(declare (type case-frob-stream stream)
(let ((target (case-frob-stream-target stream)))
(cond ((alphanumericp char)
(let ((char (char-downcase char)))
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char))))
(if (lisp-stream-p target)
(funcall (lisp-stream-out target) target char)
(stream-write-char target char))
(setf (case-frob-stream-out stream)
#'case-frob-capitalize-out)
(setf (case-frob-stream-sout stream)
Loading
Loading full blame...