;;;; more information.
(in-package "SB-GRAY")
+
+;;; BUG-OR-ERROR: because we have extensible streams, wherewith the
+;;; user is responsible for some of the protocol implementation, it's
+;;; not necessarily a bug in SBCL itself if we fall through to one of
+;;; these default methods.
+;;;
+;;; FIXME: there's a lot of similarity in these Gray stream
+;;; implementation generic functions. All of them could (maybe
+;;; should?) have two default methods: one on STREAM calling
+;;; BUG-OR-ERROR, and one on T signalling a TYPE-ERROR.
+(defmacro bug-or-error (stream fun)
+ `(error
+ "~@<The stream ~S has no suitable method for ~S, ~
+ and so has fallen through to this method. If you think that this is ~
+ a bug, please report it to the applicable authority (bugs in SBCL itself ~
+ should go to the mailing lists referenced from ~
+ <http://www.sbcl.org/>).~@:>"
+ ,stream ,fun))
\f
(fmakunbound 'stream-element-type)
STREAM. The class FUNDAMENTAL-CHARACTER-STREAM provides a default method
which returns CHARACTER."))
-(defmethod stream-element-type ((stream lisp-stream))
- (funcall (lisp-stream-misc stream) stream :element-type))
+(defmethod stream-element-type ((stream ansi-stream))
+ (ansi-stream-element-type stream))
(defmethod stream-element-type ((stream fundamental-character-stream))
'character)
+
+(defmethod stream-element-type ((stream stream))
+ (bug-or-error stream 'stream-element-type))
+
+(defmethod stream-element-type ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
\f
(defgeneric pcl-open-stream-p (stream)
#+sb-doc
by class FUNDAMENTAL-STREAM which returns true if CLOSE has not been
called on the stream."))
-(defmethod pcl-open-stream-p ((stream lisp-stream))
- (not (eq (lisp-stream-in stream) #'closed-flame)))
+(defmethod pcl-open-stream-p ((stream ansi-stream))
+ (ansi-stream-open-stream-p stream))
(defmethod pcl-open-stream-p ((stream fundamental-stream))
(stream-open-p stream))
+(defmethod pcl-open-stream-p ((stream stream))
+ (bug-or-error stream 'open-stream-p))
+
+(defmethod pcl-open-stream-p ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
+
;;; bootstrapping hack
(pcl-open-stream-p (make-string-output-stream))
(setf (fdefinition 'open-stream-p) #'pcl-open-stream-p)
inquiries may still be made. If :ABORT is true, an attempt is made
to clean up the side effects of having created the stream."))
-(defmethod pcl-close ((stream lisp-stream) &key abort)
- (when (open-stream-p stream)
- (funcall (lisp-stream-misc stream) stream :close abort))
- t)
+(defmethod pcl-close ((stream ansi-stream) &key abort)
+ (ansi-stream-close stream abort))
(defmethod pcl-close ((stream fundamental-stream) &key abort)
(declare (ignore abort))
(setf (stream-open-p stream) nil)
t)
-(setf (fdefinition 'close) #'pcl-close)
+(progn
+ ;; KLUDGE: Get in a call to PCL-CLOSE with a string-output-stream before
+ ;; setting it as CLOSE. Otherwise using NAMED-LAMBDAs as DFUNs causes a
+ ;; vicious metacircle from FORMAT NIL somewhere in the compiler. This is
+ ;; enough to get the dispatch settled down before we need it.
+ (pcl-close (make-string-output-stream))
+ (setf (fdefinition 'close) #'pcl-close))
\f
-(fmakunbound 'input-stream-p)
+(let ()
+ (fmakunbound 'input-stream-p)
-(defgeneric input-stream-p (stream)
- #+sb-doc
- (:documentation "Can STREAM perform input operations?"))
+ (defgeneric input-stream-p (stream)
+ #+sb-doc
+ (:documentation "Can STREAM perform input operations?"))
-(defmethod input-stream-p ((stream lisp-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)))))
+ (defmethod input-stream-p ((stream ansi-stream))
+ (ansi-stream-input-stream-p stream))
-(defmethod input-stream-p ((stream fundamental-input-stream))
- t)
+ (defmethod input-stream-p ((stream fundamental-stream))
+ nil)
+
+ (defmethod input-stream-p ((stream fundamental-input-stream))
+ t)
+
+ (defmethod input-stream-p ((stream stream))
+ (bug-or-error stream 'input-stream-p))
+
+ (defmethod input-stream-p ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream)))
\f
-(fmakunbound 'output-stream-p)
+(let ()
+ (fmakunbound 'interactive-stream-p)
-(defgeneric output-stream-p (stream)
- #+sb-doc
- (:documentation "Can STREAM perform output operations?"))
+ (defgeneric interactive-stream-p (stream)
+ #+sb-doc
+ (:documentation "Is STREAM an interactive stream?"))
-(defmethod output-stream-p ((stream lisp-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)))))
+ (defmethod interactive-stream-p ((stream ansi-stream))
+ (funcall (ansi-stream-misc stream) stream :interactive-p))
-(defmethod output-stream-p ((stream fundamental-output-stream))
- t)
+ (defmethod interactive-stream-p ((stream fundamental-stream))
+ nil)
+
+ (defmethod interactive-stream-p ((stream stream))
+ (bug-or-error stream 'interactive-stream-p))
+
+ (defmethod interactive-stream-p ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream)))
+\f
+(let ()
+ (fmakunbound 'output-stream-p)
+
+ (defgeneric output-stream-p (stream)
+ #+sb-doc
+ (:documentation "Can STREAM perform output operations?"))
+
+ (defmethod output-stream-p ((stream ansi-stream))
+ (ansi-stream-output-stream-p stream))
+
+ (defmethod output-stream-p ((stream fundamental-stream))
+ nil)
+
+ (defmethod output-stream-p ((stream fundamental-output-stream))
+ t)
+
+ (defmethod output-stream-p ((stream stream))
+ (bug-or-error stream 'output-stream-p))
+
+ (defmethod output-stream-p ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream)))
\f
;;; character input streams
;;;
(defgeneric stream-unread-char (stream character)
#+sb-doc
(:documentation
- "Un-do the last call to STREAM-READ-CHAR, as in UNREAD-CHAR.
+ "Undo the last call to STREAM-READ-CHAR, as in UNREAD-CHAR.
Return NIL. Every subclass of FUNDAMENTAL-CHARACTER-INPUT-STREAM
must define a method for this function."))
(defmethod stream-read-line ((stream fundamental-character-input-stream))
(let ((res (make-string 80))
- (len 80)
- (index 0))
+ (len 80)
+ (index 0))
(loop
(let ((ch (stream-read-char stream)))
(cond ((eq ch :eof)
- (return (values (shrink-vector res index) t)))
- (t
- (when (char= ch #\newline)
- (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)))))))
+ (return (values (%shrink-vector res index) t)))
+ (t
+ (when (char= ch #\newline)
+ (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)))))))
(defgeneric stream-clear-input (stream)
#+sb-doc
(:documentation
- "Implements CLEAR-INPUT for the stream, returning NIL. The default
- method does nothing."))
+ "This is like CL:CLEAR-INPUT, but for Gray streams, returning NIL.
+ The default method does nothing."))
(defmethod stream-clear-input ((stream fundamental-character-input-stream))
nil)
+(defmethod stream-clear-input ((stream stream))
+ (bug-or-error stream 'stream-clear-input))
+(defmethod stream-clear-input ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
+
+(defgeneric stream-read-sequence (stream seq &optional start end)
+ #+sb-doc
+ (:documentation
+ "This is like CL:READ-SEQUENCE, but for Gray streams."))
+
+;;; Destructively modify SEQ by reading elements from STREAM. That
+;;; part of SEQ bounded by START and END is destructively modified by
+;;; copying successive elements into it from STREAM. If the end of
+;;; file for STREAM is reached before copying all elements of the
+;;; subsequence, then the extra elements near the end of sequence are
+;;; not updated, and the index of the next element is returned.
+(defun basic-io-type-stream-read-sequence (stream seq start end read-fun)
+ (declare (type sequence seq)
+ (type stream stream)
+ (type index start)
+ (type sequence-end end)
+ (type function read-fun)
+ (values index))
+ (let ((end (or end (length seq))))
+ (declare (type index end))
+ (etypecase seq
+ (list
+ (do ((rem (nthcdr start seq) (rest rem))
+ (i start (1+ i)))
+ ((or (endp rem) (>= i end)) i)
+ (declare (type list rem)
+ (type index i))
+ (let ((el (funcall read-fun stream)))
+ (when (eq el :eof)
+ (return i))
+ (setf (first rem) el))))
+ (vector
+ (with-array-data ((data seq) (offset-start start) (offset-end end))
+ (do ((i offset-start (1+ i)))
+ ((>= i offset-end) end)
+ (declare (type index i))
+ (let ((el (funcall read-fun stream)))
+ (when (eq el :eof)
+ (return (+ start (- i offset-start))))
+ (setf (aref data i) el))))))))
+
+(defmethod stream-read-sequence ((stream fundamental-character-input-stream)
+ (seq sequence)
+ &optional (start 0) (end nil))
+ (basic-io-type-stream-read-sequence stream seq start end
+ #'stream-read-char))
+
+(defmethod stream-read-sequence ((stream fundamental-binary-input-stream)
+ (seq sequence)
+ &optional (start 0) (end nil))
+ (basic-io-type-stream-read-sequence stream seq start end
+ #'stream-read-byte))
+
\f
;;; character output streams
;;;
(defmethod stream-start-line-p ((stream fundamental-character-output-stream))
(eql (stream-line-column stream) 0))
-(defgeneric stream-write-string (stream string &optional (start 0) end)
+(defgeneric stream-write-string (stream string &optional start end)
#+sb-doc
(:documentation
"This is used by WRITE-STRING. It writes the string to the stream,
STREAM-WRITE-CHAR."))
(defmethod stream-write-string ((stream fundamental-character-output-stream)
- string &optional (start 0) end)
+ string &optional (start 0) end)
(declare (string string)
- (fixnum start))
+ (fixnum start))
(let ((end (or end (length string))))
(declare (fixnum end))
(do ((pos start (1+ pos)))
- ((>= pos end))
+ ((>= pos end))
(declare (type index pos))
(stream-write-char stream (aref string pos))))
string)
#+sb-doc
(:documentation
"Outputs a new line to the Stream if it is not positioned at the
- begining of a line. Returns T if it output a new line, nil
+ beginning of a line. Returns T if it output a new line, nil
otherwise. Used by FRESH-LINE. The default method uses
STREAM-START-LINE-P and STREAM-TERPRI."))
(defmethod stream-finish-output ((stream fundamental-output-stream))
nil)
+(defmethod stream-finish-output ((stream stream))
+ (bug-or-error stream 'stream-finish-output))
+(defmethod stream-finish-output ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
(defgeneric stream-force-output (stream)
#+sb-doc
(defmethod stream-force-output ((stream fundamental-output-stream))
nil)
+(defmethod stream-force-output ((stream stream))
+ (bug-or-error stream 'stream-force-output))
+(defmethod stream-force-output ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
(defgeneric stream-clear-output (stream)
#+sb-doc
(:documentation
- "Clears the given output Stream. Implements CLEAR-OUTPUT. The
- default method does nothing."))
+ "This is like CL:CLEAR-OUTPUT, but for Gray streams: clear the given
+ output STREAM. The default method does nothing."))
(defmethod stream-clear-output ((stream fundamental-output-stream))
nil)
+(defmethod stream-clear-output ((stream stream))
+ (bug-or-error stream 'stream-clear-output))
+(defmethod stream-clear-output ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
(defgeneric stream-advance-to-column (stream column)
#+sb-doc
(:documentation
- "Writes enough blank space so that the next character will be
+ "Write enough blank space so that the next character will be
written at the specified column. Returns true if the operation is
successful, or NIL if it is not supported for this stream. This is
intended for use by by PPRINT and FORMAT ~T. The default method uses
#\SPACE character; it returns NIL if STREAM-LINE-COLUMN returns NIL."))
(defmethod stream-advance-to-column ((stream fundamental-character-output-stream)
- column)
+ column)
(let ((current-column (stream-line-column stream)))
(when current-column
(let ((fill (- column current-column)))
- (dotimes (i fill)
- (stream-write-char stream #\Space)))
+ (dotimes (i fill)
+ (stream-write-char stream #\Space)))
T)))
+
+(defgeneric stream-write-sequence (stream seq &optional start end)
+ #+sb-doc
+ (:documentation
+ "This is like CL:WRITE-SEQUENCE, but for Gray streams."))
+
+;;; Write the elements of SEQ bounded by START and END to STREAM.
+(defun basic-io-type-stream-write-sequence (stream seq start end write-fun)
+ (declare (type sequence seq)
+ (type stream stream)
+ (type index start)
+ (type sequence-end end)
+ (type function write-fun)
+ (values sequence))
+ (let ((end (or end (length seq))))
+ (declare (type index start end))
+ (etypecase seq
+ (list
+ (do ((rem (nthcdr start seq) (rest rem))
+ (i start (1+ i)))
+ ((or (endp rem) (>= i end)) seq)
+ (declare (type list rem)
+ (type index i))
+ (funcall write-fun stream (first rem))))
+ (vector
+ (do ((i start (1+ i)))
+ ((>= i end) seq)
+ (declare (type index i))
+ (funcall write-fun stream (aref seq i)))))))
+
+(defmethod stream-write-sequence ((stream fundamental-character-output-stream)
+ (seq sequence)
+ &optional (start 0) (end nil))
+ (typecase seq
+ (string
+ (stream-write-string stream seq start end))
+ (t
+ (basic-io-type-stream-write-sequence stream seq start end
+ #'stream-write-char))))
+
\f
;;; binary streams
;;;
"Used by READ-BYTE; returns either an integer, or the symbol :EOF
if the stream is at end-of-file."))
+(defmethod stream-read-byte ((stream stream))
+ (bug-or-error stream 'stream-read-byte))
+(defmethod stream-read-byte ((non-stream t))
+ (error 'type-error :datum non-stream :expected-type 'stream))
+
(defgeneric stream-write-byte (stream integer)
#+sb-doc
(:documentation
"Implements WRITE-BYTE; writes the integer to the stream and
returns the integer as the result."))
+
+(defmethod stream-write-byte ((stream stream) integer)
+ (bug-or-error stream 'stream-write-byte))
+(defmethod stream-write-byte ((non-stream t) integer)
+ (error 'type-error :datum non-stream :expected-type 'stream))
+
+;; Provide a reasonable default for binary Gray streams. We might be
+;; able to do better by specializing on the sequence type, but at
+;; least the behaviour is reasonable. --tony 2003/05/08.
+(defmethod stream-write-sequence ((stream fundamental-binary-output-stream)
+ (seq sequence)
+ &optional (start 0) (end nil))
+ (basic-io-type-stream-write-sequence stream seq start end
+ #'stream-write-byte))
+
+(defgeneric stream-file-position (stream &optional position-spec)
+ #+sb-doc
+ (:documentation
+ "Used by FILE-POSITION. Returns or changes the current position within STREAM."))
+
+(defmethod stream-file-position ((stream ansi-stream) &optional position-spec)
+ (ansi-stream-file-position stream position-spec))
+
+(defmethod stream-file-position ((stream t) &optional position-spec)
+ (declare (ignore stream position-spec))
+ nil)
+
\f
+;;; This is not in the Gray stream proposal, so it is left here
+;;; as example code.
#|
-This is not in the gray-stream proposal, so it is left here
-as example code.
;;; example character output stream encapsulating a lisp-stream
(defun make-character-output-stream (lisp-stream)
(declare (type lisp-stream lisp-stream))
(output-stream-p (character-input-stream-lisp-stream stream)))
(defmethod stream-read-char ((stream character-input-stream))
- (read-char (character-input-stream-lisp-stream stream)))
+ (read-char (character-input-stream-lisp-stream stream) nil :eof))
(defmethod stream-unread-char ((stream character-input-stream) character)
(unread-char character (character-input-stream-lisp-stream stream)))
projects / sbcl.git / blobdiff