src/code/stream.lisp

   1 ;;;; os-independent stream functions
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!IMPL")
  13
  14 ;;;; standard streams
  15
  16 ;;; The initialization of these streams is performed by
  17 ;;; STREAM-COLD-INIT-OR-RESET.
  18 (defvar *terminal-io* () #!+sb-doc "terminal I/O stream")
  19 (defvar *standard-input* () #!+sb-doc "default input stream")
  20 (defvar *standard-output* () #!+sb-doc "default output stream")
  21 (defvar *error-output* () #!+sb-doc "error output stream")
  22 (defvar *query-io* () #!+sb-doc "query I/O stream")
  23 (defvar *trace-output* () #!+sb-doc "trace output stream")
  24 (defvar *debug-io* () #!+sb-doc "interactive debugging stream")
  25
  26 (defun ill-in (stream &rest ignore)
  27   (declare (ignore ignore))
  28   (error 'simple-type-error
  29          :datum stream
  30          :expected-type '(satisfies input-stream-p)
  31          :format-control "~S is not a character input stream."
  32          :format-arguments (list stream)))
  33 (defun ill-out (stream &rest ignore)
  34   (declare (ignore ignore))
  35   (error 'simple-type-error
  36          :datum stream
  37          :expected-type '(satisfies output-stream-p)
  38          :format-control "~S is not a character output stream."
  39          :format-arguments (list stream)))
  40 (defun ill-bin (stream &rest ignore)
  41   (declare (ignore ignore))
  42   (error 'simple-type-error
  43          :datum stream
  44          :expected-type '(satisfies input-stream-p)
  45          :format-control "~S is not a binary input stream."
  46          :format-arguments (list stream)))
  47 (defun ill-bout (stream &rest ignore)
  48   (declare (ignore ignore))
  49   (error 'simple-type-error
  50          :datum stream
  51          :expected-type '(satisfies output-stream-p)
  52          :format-control "~S is not a binary output stream."
  53          :format-arguments (list stream)))
  54 (defun closed-flame (stream &rest ignore)
  55   (declare (ignore ignore))
  56   (error 'closed-stream-error :stream stream))
  57 (defun no-op-placeholder (&rest ignore)
  58   (declare (ignore ignore)))
  59 \f
  60 ;;; stream manipulation functions
  61
  62 (defun ansi-stream-input-stream-p (stream)
  63   (declare (type ansi-stream stream))
  64   (if (synonym-stream-p stream)
  65       (input-stream-p (symbol-value (synonym-stream-symbol stream)))
  66       (and (not (eq (ansi-stream-in stream) #'closed-flame))
  67        ;;; KLUDGE: It's probably not good to have EQ tests on function
  68        ;;; values like this. What if someone's redefined the function?
  69        ;;; Is there a better way? (Perhaps just VALID-FOR-INPUT and
  70        ;;; VALID-FOR-OUTPUT flags? -- WHN 19990902
  71            (or (not (eq (ansi-stream-in stream) #'ill-in))
  72                (not (eq (ansi-stream-bin stream) #'ill-bin))))))
  73
  74 (defun input-stream-p (stream)
  75   (declare (type stream stream))
  76   (and (ansi-stream-p stream)
  77        (ansi-stream-input-stream-p stream)))
  78
  79 (defun ansi-stream-output-stream-p (stream)
  80   (declare (type ansi-stream stream))
  81   (if (synonym-stream-p stream)
  82       (output-stream-p (symbol-value (synonym-stream-symbol stream)))
  83       (and (not (eq (ansi-stream-in stream) #'closed-flame))
  84            (or (not (eq (ansi-stream-out stream) #'ill-out))
  85                (not (eq (ansi-stream-bout stream) #'ill-bout))))))
  86
  87 (defun output-stream-p (stream)
  88   (declare (type stream stream))
  89
  90   (and (ansi-stream-p stream)
  91        (ansi-stream-output-stream-p stream)))
  92
  93 (declaim (inline ansi-stream-open-stream-p))
  94 (defun ansi-stream-open-stream-p (stream)
  95   (declare (type ansi-stream stream))
  96   ;; CLHS 22.1.4 lets us not worry about synonym streams here.
  97   (not (eq (ansi-stream-in stream) #'closed-flame)))
  98
  99 (defun open-stream-p (stream)
 100   (ansi-stream-open-stream-p stream))
 101
 102 (declaim (inline ansi-stream-element-type))
 103 (defun ansi-stream-element-type (stream)
 104   (declare (type ansi-stream stream))
 105   (funcall (ansi-stream-misc stream) stream :element-type))
 106
 107 (defun stream-element-type (stream)
 108   (ansi-stream-element-type stream))
 109
 110 (defun stream-external-format (stream)
 111   (funcall (ansi-stream-misc stream) stream :external-format))
 112
 113 (defun interactive-stream-p (stream)
 114   (declare (type stream stream))
 115   (funcall (ansi-stream-misc stream) stream :interactive-p))
 116
 117 (declaim (inline ansi-stream-close))
 118 (defun ansi-stream-close (stream abort)
 119   (declare (type ansi-stream stream))
 120   (when (open-stream-p stream)
 121     (funcall (ansi-stream-misc stream) stream :close abort))
 122   t)
 123
 124 (defun close (stream &key abort)
 125   (ansi-stream-close stream abort))
 126
 127 (defun set-closed-flame (stream)
 128   (setf (ansi-stream-in stream) #'closed-flame)
 129   (setf (ansi-stream-bin stream) #'closed-flame)
 130   (setf (ansi-stream-n-bin stream) #'closed-flame)
 131   (setf (ansi-stream-out stream) #'closed-flame)
 132   (setf (ansi-stream-bout stream) #'closed-flame)
 133   (setf (ansi-stream-sout stream) #'closed-flame)
 134   (setf (ansi-stream-misc stream) #'closed-flame))
 135 \f
 136 ;;;; file position and file length
 137 (defun external-format-char-size (external-format)
 138   (let ((ef-entry (find-external-format external-format)))
 139     (if (variable-width-external-format-p ef-entry)
 140         (bytes-for-char-fun ef-entry)
 141         (funcall (bytes-for-char-fun ef-entry) #\x))))
 142
 143 ;;; Call the MISC method with the :FILE-POSITION operation.
 144 #!-sb-fluid (declaim (inline ansi-stream-file-position))
 145 (defun ansi-stream-file-position (stream position)
 146   (declare (type stream stream))
 147   (declare (type (or index (alien sb!unix:off-t) (member nil :start :end))
 148                  position))
 149   ;; FIXME: It woud be good to comment on the stuff that is done here...
 150   ;; FIXME: This doesn't look interrupt safe.
 151   (cond
 152     (position
 153      (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 154      (funcall (ansi-stream-misc stream) stream :file-position position))
 155     (t
 156      (let ((res (funcall (ansi-stream-misc stream) stream :file-position nil)))
 157        (when res
 158          #!-sb-unicode
 159          (- res
 160             (- +ansi-stream-in-buffer-length+
 161                (ansi-stream-in-index stream)))
 162          #!+sb-unicode
 163          (let ((char-size (if (fd-stream-p stream)
 164                               (fd-stream-char-size stream)
 165                               (external-format-char-size (stream-external-format stream)))))
 166            (- res
 167               (etypecase char-size
 168                 (function
 169                  (loop with buffer = (ansi-stream-cin-buffer stream)
 170                        with start = (ansi-stream-in-index stream)
 171                        for i from start below +ansi-stream-in-buffer-length+
 172                        sum (funcall char-size (aref buffer i))))
 173                 (fixnum
 174                  (* char-size
 175                     (- +ansi-stream-in-buffer-length+
 176                        (ansi-stream-in-index stream))))))))))))
 177
 178 (defun file-position (stream &optional position)
 179   (if (ansi-stream-p stream)
 180       (ansi-stream-file-position stream position)
 181       (stream-file-position stream position)))
 182
 183 ;;; This is a literal translation of the ANSI glossary entry "stream
 184 ;;; associated with a file".
 185 ;;;
 186 ;;; KLUDGE: Note that since Unix famously thinks "everything is a
 187 ;;; file", and in particular stdin, stdout, and stderr are files, we
 188 ;;; end up with this test being satisfied for weird things like
 189 ;;; *STANDARD-OUTPUT* (to a tty). That seems unlikely to be what the
 190 ;;; ANSI spec really had in mind, especially since this is used as a
 191 ;;; qualification for operations like FILE-LENGTH (so that ANSI was
 192 ;;; probably thinking of something like what Unix calls block devices)
 193 ;;; but I can't see any better way to do it. -- WHN 2001-04-14
 194 (defun stream-associated-with-file-p (x)
 195   "Test for the ANSI concept \"stream associated with a file\"."
 196   (or (typep x 'file-stream)
 197       (and (synonym-stream-p x)
 198            (stream-associated-with-file-p (symbol-value
 199                                            (synonym-stream-symbol x))))))
 200
 201 (defun stream-must-be-associated-with-file (stream)
 202   (declare (type stream stream))
 203   (unless (stream-associated-with-file-p stream)
 204     (error 'simple-type-error
 205            ;; KLUDGE: The ANSI spec for FILE-LENGTH specifically says
 206            ;; this should be TYPE-ERROR. But what then can we use for
 207            ;; EXPECTED-TYPE? This SATISFIES type (with a nonstandard
 208            ;; private predicate function..) is ugly and confusing, but
 209            ;; I can't see any other way. -- WHN 2001-04-14
 210            :datum stream
 211            :expected-type '(satisfies stream-associated-with-file-p)
 212            :format-control
 213            "~@<The stream ~2I~_~S ~I~_isn't associated with a file.~:>"
 214            :format-arguments (list stream))))
 215
 216 ;;; like FILE-POSITION, only using :FILE-LENGTH
 217 (defun file-length (stream)
 218   ;; FIXME: The following declaration uses yet undefined types, which
 219   ;; cause cross-compiler hangup.
 220   ;;
 221   ;; (declare (type (or file-stream synonym-stream) stream))
 222   ;;
 223   ;; The description for FILE-LENGTH says that an error must be raised
 224   ;; for streams not associated with files (which broadcast streams
 225   ;; aren't according to the glossary). However, the behaviour of
 226   ;; FILE-LENGTH for broadcast streams is explicitly described in the
 227   ;; BROADCAST-STREAM entry.
 228   (unless (typep stream 'broadcast-stream)
 229     (stream-must-be-associated-with-file stream))
 230   (funcall (ansi-stream-misc stream) stream :file-length))
 231
 232 (defun file-string-length (stream object)
 233   (funcall (ansi-stream-misc stream) stream :file-string-length object))
 234 \f
 235 ;;;; input functions
 236
 237 (defun ansi-stream-read-line-from-frc-buffer (stream eof-error-p eof-value)
 238   (prepare-for-fast-read-char stream
 239     (declare (ignore %frc-method%))
 240     (let ((chunks-total-length 0)
 241           (chunks nil))
 242       (declare (type index chunks-total-length)
 243                (list chunks))
 244       (labels ((refill-buffer ()
 245                  (prog1
 246                      (fast-read-char-refill stream nil nil)
 247                    (setf %frc-index% (ansi-stream-in-index %frc-stream%))))
 248                (newline-position ()
 249                  (position #\Newline (the (simple-array character (*))
 250                                        %frc-buffer%)
 251                            :test #'char=
 252                            :start %frc-index%))
 253                (make-and-return-result-string (pos)
 254                  (let* ((len (+ (- (or pos %frc-index%)
 255                                    %frc-index%)
 256                                 chunks-total-length))
 257                         (res (make-string len))
 258                         (start 0))
 259                    (declare (type index start))
 260                    (when chunks
 261                      (dolist (chunk (nreverse chunks))
 262                        (declare (type (simple-array character) chunk))
 263                        (replace res chunk :start1 start)
 264                        (incf start (length chunk))))
 265                    (unless (null pos)
 266                      (replace res %frc-buffer%
 267                               :start1 start
 268                               :start2 %frc-index% :end2 pos)
 269                      (setf %frc-index% (1+ pos)))
 270                    (done-with-fast-read-char)
 271                    (return-from ansi-stream-read-line-from-frc-buffer (values res (null pos)))))
 272                (add-chunk ()
 273                  (let* ((end (length %frc-buffer%))
 274                         (len (- end %frc-index%))
 275                         (chunk (make-string len)))
 276                    (replace chunk %frc-buffer% :start2 %frc-index% :end2 end)
 277                    (push chunk chunks)
 278                    (incf chunks-total-length len)
 279                    (when (refill-buffer)
 280                      (make-and-return-result-string nil)))))
 281         (declare (inline make-and-return-result-string
 282                          refill-buffer))
 283         (when (and (= %frc-index% +ansi-stream-in-buffer-length+)
 284                    (refill-buffer))
 285           ;; EOF had been reached before we read anything
 286           ;; at all. Return the EOF value or signal the error.
 287           (done-with-fast-read-char)
 288           (return-from ansi-stream-read-line-from-frc-buffer
 289             (values (eof-or-lose stream eof-error-p eof-value) t)))
 290         (loop
 291            (let ((pos (newline-position)))
 292              (if pos
 293                  (make-and-return-result-string pos)
 294                  (add-chunk))))))))
 295
 296 #!-sb-fluid (declaim (inline ansi-stream-read-line))
 297 (defun ansi-stream-read-line (stream eof-error-p eof-value recursive-p)
 298   (declare (ignore recursive-p))
 299   (if (ansi-stream-cin-buffer stream)
 300       ;; Stream has a fast-read-char buffer. Copy large chunks directly
 301       ;; out of the buffer.
 302       (ansi-stream-read-line-from-frc-buffer stream eof-error-p eof-value)
 303       ;; Slow path, character by character.
 304       (prepare-for-fast-read-char stream
 305         (let ((res (make-string 80))
 306               (len 80)
 307               (index 0))
 308           (loop
 309              (let ((ch (fast-read-char nil nil)))
 310                (cond (ch
 311                       (when (char= ch #\newline)
 312                         (done-with-fast-read-char)
 313                         (return (values (%shrink-vector res index) nil)))
 314                       (when (= index len)
 315                         (setq len (* len 2))
 316                         (let ((new (make-string len)))
 317                           (replace new res)
 318                           (setq res new)))
 319                       (setf (schar res index) ch)
 320                       (incf index))
 321                      ((zerop index)
 322                       (done-with-fast-read-char)
 323                       (return (values (eof-or-lose stream
 324                                                    eof-error-p
 325                                                    eof-value)
 326                                       t)))
 327                      ;; Since FAST-READ-CHAR already hit the eof char, we
 328                      ;; shouldn't do another READ-CHAR.
 329                      (t
 330                       (done-with-fast-read-char)
 331                       (return (values (%shrink-vector res index) t))))))))))
 332
 333 (defun read-line (&optional (stream *standard-input*) (eof-error-p t) eof-value
 334                             recursive-p)
 335   (let ((stream (in-synonym-of stream)))
 336     (if (ansi-stream-p stream)
 337         (ansi-stream-read-line stream eof-error-p eof-value recursive-p)
 338         ;; must be Gray streams FUNDAMENTAL-STREAM
 339         (multiple-value-bind (string eof) (stream-read-line stream)
 340           (if (and eof (zerop (length string)))
 341               (values (eof-or-lose stream eof-error-p eof-value) t)
 342               (values string eof))))))
 343
 344 ;;; We proclaim them INLINE here, then proclaim them NOTINLINE later on,
 345 ;;; so, except in this file, they are not inline by default, but they can be.
 346 #!-sb-fluid (declaim (inline read-char unread-char read-byte listen))
 347
 348 #!-sb-fluid (declaim (inline ansi-stream-read-char))
 349 (defun ansi-stream-read-char (stream eof-error-p eof-value recursive-p)
 350   (declare (ignore recursive-p))
 351   (prepare-for-fast-read-char stream
 352     (prog1
 353         (fast-read-char eof-error-p eof-value)
 354       (done-with-fast-read-char))))
 355
 356 (defun read-char (&optional (stream *standard-input*)
 357                             (eof-error-p t)
 358                             eof-value
 359                             recursive-p)
 360   (let ((stream (in-synonym-of stream)))
 361     (if (ansi-stream-p stream)
 362         (ansi-stream-read-char stream eof-error-p eof-value recursive-p)
 363         ;; must be Gray streams FUNDAMENTAL-STREAM
 364         (let ((char (stream-read-char stream)))
 365           (if (eq char :eof)
 366               (eof-or-lose stream eof-error-p eof-value)
 367               char)))))
 368
 369 #!-sb-fluid (declaim (inline ansi-stream-unread-char))
 370 (defun ansi-stream-unread-char (character stream)
 371   (let ((index (1- (ansi-stream-in-index stream)))
 372         (buffer (ansi-stream-cin-buffer stream)))
 373     (declare (fixnum index))
 374     (when (minusp index) (error "nothing to unread"))
 375     (cond (buffer
 376            (setf (aref buffer index) character)
 377            (setf (ansi-stream-in-index stream) index))
 378           (t
 379            (funcall (ansi-stream-misc stream) stream
 380                     :unread character)))))
 381
 382 (defun unread-char (character &optional (stream *standard-input*))
 383   (let ((stream (in-synonym-of stream)))
 384     (if (ansi-stream-p stream)
 385         (ansi-stream-unread-char character stream)
 386         ;; must be Gray streams FUNDAMENTAL-STREAM
 387         (stream-unread-char stream character)))
 388   nil)
 389
 390 #!-sb-fluid (declaim (inline ansi-stream-listen))
 391 (defun ansi-stream-listen (stream)
 392   (or (/= (the fixnum (ansi-stream-in-index stream))
 393           +ansi-stream-in-buffer-length+)
 394       ;; Handle :EOF return from misc methods specially
 395       (let ((result (funcall (ansi-stream-misc stream) stream :listen)))
 396         (if (eq result :eof)
 397             nil
 398             result))))
 399
 400 (defun listen (&optional (stream *standard-input*))
 401   (let ((stream (in-synonym-of stream)))
 402     (if (ansi-stream-p stream)
 403         (ansi-stream-listen stream)
 404         ;; Fall through to Gray streams FUNDAMENTAL-STREAM case.
 405         (stream-listen stream))))
 406
 407 #!-sb-fluid (declaim (inline ansi-stream-read-char-no-hang))
 408 (defun ansi-stream-read-char-no-hang (stream eof-error-p eof-value recursive-p)
 409   (if (funcall (ansi-stream-misc stream) stream :listen)
 410       ;; On T or :EOF get READ-CHAR to do the work.
 411       (ansi-stream-read-char stream eof-error-p eof-value recursive-p)
 412       nil))
 413
 414 (defun read-char-no-hang (&optional (stream *standard-input*)
 415                                     (eof-error-p t)
 416                                     eof-value
 417                                     recursive-p)
 418   (let ((stream (in-synonym-of stream)))
 419     (if (ansi-stream-p stream)
 420         (ansi-stream-read-char-no-hang stream eof-error-p eof-value
 421                                        recursive-p)
 422         ;; must be Gray streams FUNDAMENTAL-STREAM
 423         (let ((char (stream-read-char-no-hang stream)))
 424           (if (eq char :eof)
 425               (eof-or-lose stream eof-error-p eof-value)
 426               char)))))
 427
 428 #!-sb-fluid (declaim (inline ansi-stream-clear-input))
 429 (defun ansi-stream-clear-input (stream)
 430   (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 431   (funcall (ansi-stream-misc stream) stream :clear-input))
 432
 433 (defun clear-input (&optional (stream *standard-input*))
 434   (let ((stream (in-synonym-of stream)))
 435     (if (ansi-stream-p stream)
 436         (ansi-stream-clear-input stream)
 437         ;; must be Gray streams FUNDAMENTAL-STREAM
 438         (stream-clear-input stream)))
 439   nil)
 440 \f
 441 #!-sb-fluid (declaim (inline ansi-stream-read-byte))
 442 (defun ansi-stream-read-byte (stream eof-error-p eof-value recursive-p)
 443   ;; Why the "recursive-p" parameter?  a-s-r-b is funcall'ed from
 444   ;; a-s-read-sequence and needs a lambda list that's congruent with
 445   ;; that of a-s-read-char
 446   (declare (ignore recursive-p))
 447   (prepare-for-fast-read-byte stream
 448     (prog1
 449         (fast-read-byte eof-error-p eof-value t)
 450       (done-with-fast-read-byte))))
 451
 452 (defun read-byte (stream &optional (eof-error-p t) eof-value)
 453   (if (ansi-stream-p stream)
 454       (ansi-stream-read-byte stream eof-error-p eof-value nil)
 455       ;; must be Gray streams FUNDAMENTAL-STREAM
 456       (let ((char (stream-read-byte stream)))
 457         (if (eq char :eof)
 458             (eof-or-lose stream eof-error-p eof-value)
 459             char))))
 460
 461 ;;; Read NUMBYTES bytes into BUFFER beginning at START, and return the
 462 ;;; number of bytes read.
 463 ;;;
 464 ;;; Note: CMU CL's version of this had a special interpretation of
 465 ;;; EOF-ERROR-P which SBCL does not have. (In the EOF-ERROR-P=NIL
 466 ;;; case, CMU CL's version would return as soon as any data became
 467 ;;; available.) This could be useful behavior for things like pipes in
 468 ;;; some cases, but it wasn't being used in SBCL, so it was dropped.
 469 ;;; If we ever need it, it could be added later as a new variant N-BIN
 470 ;;; method (perhaps N-BIN-ASAP?) or something.
 471 #!-sb-fluid (declaim (inline read-n-bytes))
 472 (defun read-n-bytes (stream buffer start numbytes &optional (eof-error-p t))
 473   (if (ansi-stream-p stream)
 474       (ansi-stream-read-n-bytes stream buffer start numbytes eof-error-p)
 475       ;; We don't need to worry about element-type size here is that
 476       ;; callers are supposed to have checked everything is kosher.
 477       (let* ((end (+ start numbytes))
 478              (read-end (stream-read-sequence stream buffer start end)))
 479         (eof-or-lose stream (and eof-error-p (< read-end end)) (- read-end start)))))
 480
 481 (defun ansi-stream-read-n-bytes (stream buffer start numbytes eof-error-p)
 482   (declare (type ansi-stream stream)
 483            (type index numbytes start)
 484            (type (or (simple-array * (*)) system-area-pointer) buffer))
 485   (let* ((stream (in-synonym-of stream ansi-stream))
 486          (in-buffer (ansi-stream-in-buffer stream))
 487          (index (ansi-stream-in-index stream))
 488          (num-buffered (- +ansi-stream-in-buffer-length+ index)))
 489     (declare (fixnum index num-buffered))
 490     (cond
 491      ((not in-buffer)
 492       (funcall (ansi-stream-n-bin stream)
 493                stream
 494                buffer
 495                start
 496                numbytes
 497                eof-error-p))
 498      ((<= numbytes num-buffered)
 499       #+nil
 500       (let ((copy-function (typecase buffer
 501                              ((simple-array * (*)) #'ub8-bash-copy)
 502                              (system-area-pointer #'copy-ub8-to-system-area))))
 503         (funcall copy-function in-buffer index buffer start numbytes))
 504       (%byte-blt in-buffer index
 505                  buffer start (+ start numbytes))
 506       (setf (ansi-stream-in-index stream) (+ index numbytes))
 507       numbytes)
 508      (t
 509       (let ((end (+ start num-buffered)))
 510         #+nil
 511         (let ((copy-function (typecase buffer
 512                              ((simple-array * (*)) #'ub8-bash-copy)
 513                              (system-area-pointer #'copy-ub8-to-system-area))))
 514           (funcall copy-function in-buffer index buffer start num-buffered))
 515         (%byte-blt in-buffer index buffer start end)
 516         (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 517         (+ (funcall (ansi-stream-n-bin stream)
 518                     stream
 519                     buffer
 520                     end
 521                     (- numbytes num-buffered)
 522                     eof-error-p)
 523            num-buffered))))))
 524
 525 ;;; the amount of space we leave at the start of the in-buffer for
 526 ;;; unreading
 527 ;;;
 528 ;;; (It's 4 instead of 1 to allow word-aligned copies.)
 529 (defconstant +ansi-stream-in-buffer-extra+
 530   4) ; FIXME: should be symbolic constant
 531
 532 ;;; This function is called by the FAST-READ-CHAR expansion to refill
 533 ;;; the IN-BUFFER for text streams. There is definitely an IN-BUFFER,
 534 ;;; and hence must be an N-BIN method. It's also called by other stream
 535 ;;; functions which directly peek into the frc buffer.
 536 (defun fast-read-char-refill (stream eof-error-p eof-value)
 537   (let* ((ibuf (ansi-stream-cin-buffer stream))
 538          (count (funcall (ansi-stream-n-bin stream)
 539                          stream
 540                          ibuf
 541                          +ansi-stream-in-buffer-extra+
 542                          (- +ansi-stream-in-buffer-length+
 543                             +ansi-stream-in-buffer-extra+)
 544                          nil))
 545          (start (- +ansi-stream-in-buffer-length+ count)))
 546     (declare (type index start count))
 547     (cond ((zerop count)
 548            ;; An empty count does not necessarily mean that we reached
 549            ;; the EOF, it's also possible that it's e.g. due to a
 550            ;; invalid octet sequence in a multibyte stream. To handle
 551            ;; the resyncing case correctly we need to call the
 552            ;; single-character reading function and check whether an
 553            ;; EOF was really reached. If not, we can just fill the
 554            ;; buffer by one character, and hope that the next refill
 555            ;; will not need to resync.
 556            (let* ((value (funcall (ansi-stream-in stream) stream nil :eof))
 557                   (index (1- +ansi-stream-in-buffer-length+)))
 558              (case value
 559                ((:eof)
 560                 ;; Mark buffer as empty.
 561                 (setf (ansi-stream-in-index stream)
 562                       +ansi-stream-in-buffer-length+)
 563                 ;; EOF. Redo the read, this time with the real eof parameters.
 564                 (values t (funcall (ansi-stream-in stream)
 565                                    stream eof-error-p eof-value)))
 566                (otherwise
 567                 (setf (aref ibuf index) value)
 568                 (values nil (setf (ansi-stream-in-index stream) index))))))
 569           (t
 570            (when (/= start +ansi-stream-in-buffer-extra+)
 571              (#.(let* ((n-character-array-bits
 572                         (sb!vm:saetp-n-bits
 573                          (find 'character
 574                                sb!vm:*specialized-array-element-type-properties*
 575                                :key #'sb!vm:saetp-specifier)))
 576                        (bash-function (intern (format nil "UB~D-BASH-COPY" n-character-array-bits)
 577                                               (find-package "SB!KERNEL"))))
 578                   bash-function)
 579                 ibuf +ansi-stream-in-buffer-extra+
 580                 ibuf start
 581                 count))
 582            (values nil
 583                    (setf (ansi-stream-in-index stream) start))))))
 584
 585 ;;; This is similar to FAST-READ-CHAR-REFILL, but we don't have to
 586 ;;; leave room for unreading.
 587 (defun fast-read-byte-refill (stream eof-error-p eof-value)
 588   (let* ((ibuf (ansi-stream-in-buffer stream))
 589          (count (funcall (ansi-stream-n-bin stream) stream
 590                          ibuf 0 +ansi-stream-in-buffer-length+
 591                          nil))
 592          (start (- +ansi-stream-in-buffer-length+ count)))
 593     (declare (type index start count))
 594     (cond ((zerop count)
 595            (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 596            (funcall (ansi-stream-bin stream) stream eof-error-p eof-value))
 597           (t
 598            (unless (zerop start)
 599              (ub8-bash-copy ibuf 0
 600                             ibuf start
 601                             count))
 602            (setf (ansi-stream-in-index stream) (1+ start))
 603            (aref ibuf start)))))
 604 \f
 605 ;;; output functions
 606
 607 (defun write-char (character &optional (stream *standard-output*))
 608   (with-out-stream stream (ansi-stream-out character)
 609                    (stream-write-char character))
 610   character)
 611
 612 (defun terpri (&optional (stream *standard-output*))
 613   (with-out-stream stream (ansi-stream-out #\newline) (stream-terpri))
 614   nil)
 615
 616 #!-sb-fluid (declaim (inline ansi-stream-fresh-line))
 617 (defun ansi-stream-fresh-line (stream)
 618   (when (/= (or (charpos stream) 1) 0)
 619     (funcall (ansi-stream-out stream) stream #\newline)
 620     t))
 621
 622 (defun fresh-line (&optional (stream *standard-output*))
 623   (let ((stream (out-synonym-of stream)))
 624     (if (ansi-stream-p stream)
 625         (ansi-stream-fresh-line stream)
 626         ;; must be Gray streams FUNDAMENTAL-STREAM
 627         (stream-fresh-line stream))))
 628
 629 #!-sb-fluid (declaim (inline ansi-stream-write-string))
 630 (defun ansi-stream-write-string (string stream start end)
 631   (with-array-data ((data string) (offset-start start)
 632                     (offset-end end)
 633                     :check-fill-pointer t)
 634     (funcall (ansi-stream-sout stream)
 635              stream data offset-start offset-end)))
 636
 637 (defun %write-string (string stream start end)
 638   (let ((stream (out-synonym-of stream)))
 639     (if (ansi-stream-p stream)
 640         (ansi-stream-write-string string stream start end)
 641         ;; must be Gray streams FUNDAMENTAL-STREAM
 642         (stream-write-string stream string start end)))
 643   string)
 644
 645 (defun write-string (string &optional (stream *standard-output*)
 646                             &key (start 0) end)
 647   (declare (type string string))
 648   (declare (type stream-designator stream))
 649   (%write-string string stream start end))
 650
 651 ;;; A wrapper function for all those (MACROLET OUT-FUN) definitions,
 652 ;;; which cannot deal with keyword arguments. %WRITE-STRING cannot
 653 ;;; replace this, as this needs to deal with simple-strings as well.
 654 (declaim (inline write-string-no-key))
 655 (defun write-string-no-key (string stream start end)
 656   (write-string string stream :start start :end end))
 657
 658 (defun write-line (string &optional (stream *standard-output*)
 659                    &key (start 0) end)
 660   (declare (type string string))
 661   (declare (type stream-designator stream))
 662   (let ((stream (out-synonym-of stream)))
 663     (cond ((ansi-stream-p stream)
 664            (ansi-stream-write-string string stream start end)
 665            (funcall (ansi-stream-out stream) stream #\newline))
 666           (t
 667            (stream-write-string stream string start end)
 668            (stream-write-char stream #\newline))))
 669   string)
 670
 671 (defun charpos (&optional (stream *standard-output*))
 672   (with-out-stream stream (ansi-stream-misc :charpos) (stream-line-column)))
 673
 674 (defun line-length (&optional (stream *standard-output*))
 675   (with-out-stream stream (ansi-stream-misc :line-length)
 676                    (stream-line-length)))
 677
 678 (defun finish-output (&optional (stream *standard-output*))
 679   (with-out-stream stream (ansi-stream-misc :finish-output)
 680                    (stream-finish-output))
 681   nil)
 682
 683 (defun force-output (&optional (stream *standard-output*))
 684   (with-out-stream stream (ansi-stream-misc :force-output)
 685                    (stream-force-output))
 686   nil)
 687
 688 (defun clear-output (&optional (stream *standard-output*))
 689   (with-out-stream stream (ansi-stream-misc :clear-output)
 690                    (stream-force-output))
 691   nil)
 692
 693 (defun write-byte (integer stream)
 694   (with-out-stream/no-synonym stream (ansi-stream-bout integer)
 695                               (stream-write-byte integer))
 696   integer)
 697 \f
 698
 699 ;;; (These were inline throughout this file, but that's not appropriate
 700 ;;; globally.  And we must not inline them in the rest of this file if
 701 ;;; dispatch to gray or simple streams is to work, since both redefine
 702 ;;; these functions later.)
 703 (declaim (notinline read-char unread-char read-byte listen))
 704
 705 ;;; This is called from ANSI-STREAM routines that encapsulate CLOS
 706 ;;; streams to handle the misc routines and dispatch to the
 707 ;;; appropriate SIMPLE- or FUNDAMENTAL-STREAM functions.
 708 (defun stream-misc-dispatch (stream operation &optional arg1 arg2)
 709   (declare (type stream stream) (ignore arg2))
 710   (ecase operation
 711     (:listen
 712      ;; Return T if input available, :EOF for end-of-file, otherwise NIL.
 713      (let ((char (read-char-no-hang stream nil :eof)))
 714        (when (characterp char)
 715          (unread-char char stream))
 716        char))
 717     (:unread
 718      (unread-char arg1 stream))
 719     (:close
 720      (close stream))
 721     (:clear-input
 722      (clear-input stream))
 723     (:force-output
 724      (force-output stream))
 725     (:finish-output
 726      (finish-output stream))
 727     (:element-type
 728      (stream-element-type stream))
 729     (:stream-external-format
 730      (stream-external-format stream))
 731     (:interactive-p
 732      (interactive-stream-p stream))
 733     (:line-length
 734      (line-length stream))
 735     (:charpos
 736      (charpos stream))
 737     (:file-length
 738      (file-length stream))
 739     (:file-string-length
 740      (file-string-length stream arg1))
 741     (:file-position
 742      (file-position stream arg1))))
 743 \f
 744 ;;;; broadcast streams
 745
 746 (defstruct (broadcast-stream (:include ansi-stream
 747                                        (out #'broadcast-out)
 748                                        (bout #'broadcast-bout)
 749                                        (sout #'broadcast-sout)
 750                                        (misc #'broadcast-misc))
 751                              (:constructor %make-broadcast-stream
 752                                            (&rest streams))
 753                              (:copier nil))
 754   ;; a list of all the streams we broadcast to
 755   (streams () :type list :read-only t))
 756
 757 (defun make-broadcast-stream (&rest streams)
 758   (dolist (stream streams)
 759     (unless (output-stream-p stream)
 760       (error 'type-error
 761              :datum stream
 762              :expected-type '(satisfies output-stream-p))))
 763   (apply #'%make-broadcast-stream streams))
 764
 765 (macrolet ((out-fun (name fun &rest args)
 766              `(defun ,name (stream ,@args)
 767                 (dolist (stream (broadcast-stream-streams stream))
 768                   (,fun ,(car args) stream ,@(cdr args))))))
 769   (out-fun broadcast-out write-char char)
 770   (out-fun broadcast-bout write-byte byte)
 771   (out-fun broadcast-sout write-string-no-key string start end))
 772
 773 (defun broadcast-misc (stream operation &optional arg1 arg2)
 774   (let ((streams (broadcast-stream-streams stream)))
 775     (case operation
 776       ;; FIXME: This may not be the best place to note this, but I
 777       ;; think the :CHARPOS protocol needs revision.  Firstly, I think
 778       ;; this is the last place where a NULL return value was possible
 779       ;; (before adjusting it to be 0), so a bunch of conditionals IF
 780       ;; CHARPOS can be removed; secondly, it is my belief that
 781       ;; FD-STREAMS, when running FILE-POSITION, do not update the
 782       ;; CHARPOS, and consequently there will be much wrongness.
 783       ;;
 784       ;; FIXME: see also TWO-WAY-STREAM treatment of :CHARPOS -- why
 785       ;; is it testing the :charpos of an input stream?
 786       ;;
 787       ;; -- CSR, 2004-02-04
 788       (:charpos
 789        (dolist (stream streams 0)
 790          (let ((charpos (charpos stream)))
 791            (if charpos (return charpos)))))
 792       (:line-length
 793        (let ((min nil))
 794          (dolist (stream streams min)
 795            (let ((res (line-length stream)))
 796              (when res (setq min (if min (min res min) res)))))))
 797       (:element-type
 798        #+nil ; old, arguably more logical, version
 799        (let (res)
 800          (dolist (stream streams (if (> (length res) 1) `(and ,@res) t))
 801            (pushnew (stream-element-type stream) res :test #'equal)))
 802        ;; ANSI-specified version (under System Class BROADCAST-STREAM)
 803        (let ((res t))
 804          (do ((streams streams (cdr streams)))
 805              ((null streams) res)
 806            (when (null (cdr streams))
 807              (setq res (stream-element-type (car streams)))))))
 808       (:external-format
 809        (let ((res :default))
 810          (dolist (stream streams res)
 811            (setq res (stream-external-format stream)))))
 812       (:file-length
 813        (let ((last (last streams)))
 814          (if last
 815              (file-length (car last))
 816              0)))
 817       (:file-position
 818        (if arg1
 819            (let ((res (or (eql arg1 :start) (eql arg1 0))))
 820              (dolist (stream streams res)
 821                (setq res (file-position stream arg1))))
 822            (let ((res 0))
 823              (dolist (stream streams res)
 824                (setq res (file-position stream))))))
 825       (:file-string-length
 826        (let ((res 1))
 827          (dolist (stream streams res)
 828            (setq res (file-string-length stream arg1)))))
 829       (:close
 830        (set-closed-flame stream))
 831       (t
 832        (let ((res nil))
 833          (dolist (stream streams res)
 834            (setq res
 835                  (if (ansi-stream-p stream)
 836                      (funcall (ansi-stream-misc stream) stream operation
 837                               arg1 arg2)
 838                      (stream-misc-dispatch stream operation arg1 arg2)))))))))
 839 \f
 840 ;;;; synonym streams
 841
 842 (defstruct (synonym-stream (:include ansi-stream
 843                                      (in #'synonym-in)
 844                                      (bin #'synonym-bin)
 845                                      (n-bin #'synonym-n-bin)
 846                                      (out #'synonym-out)
 847                                      (bout #'synonym-bout)
 848                                      (sout #'synonym-sout)
 849                                      (misc #'synonym-misc))
 850                            (:constructor make-synonym-stream (symbol))
 851                            (:copier nil))
 852   ;; This is the symbol, the value of which is the stream we are synonym to.
 853   (symbol nil :type symbol :read-only t))
 854 (def!method print-object ((x synonym-stream) stream)
 855   (print-unreadable-object (x stream :type t :identity t)
 856     (format stream ":SYMBOL ~S" (synonym-stream-symbol x))))
 857
 858 ;;; The output simple output methods just call the corresponding
 859 ;;; function on the synonymed stream.
 860 (macrolet ((out-fun (name fun &rest args)
 861              `(defun ,name (stream ,@args)
 862                 (declare (optimize (safety 1)))
 863                 (let ((syn (symbol-value (synonym-stream-symbol stream))))
 864                   (,fun ,(car args) syn ,@(cdr args))))))
 865   (out-fun synonym-out write-char ch)
 866   (out-fun synonym-bout write-byte n)
 867   (out-fun synonym-sout write-string-no-key string start end))
 868
 869 ;;; For the input methods, we just call the corresponding function on the
 870 ;;; synonymed stream. These functions deal with getting input out of
 871 ;;; the In-Buffer if there is any.
 872 (macrolet ((in-fun (name fun &rest args)
 873              `(defun ,name (stream ,@args)
 874                 (declare (optimize (safety 1)))
 875                 (,fun (symbol-value (synonym-stream-symbol stream))
 876                       ,@args))))
 877   (in-fun synonym-in read-char eof-error-p eof-value)
 878   (in-fun synonym-bin read-byte eof-error-p eof-value)
 879   (in-fun synonym-n-bin read-n-bytes buffer start numbytes eof-error-p))
 880
 881 (defun synonym-misc (stream operation &optional arg1 arg2)
 882   (declare (optimize (safety 1)))
 883   (let ((syn (symbol-value (synonym-stream-symbol stream))))
 884     (if (ansi-stream-p syn)
 885         ;; We have to special-case some operations which interact with
 886         ;; the in-buffer of the wrapped stream, since just calling
 887         ;; ANSI-STREAM-MISC on them
 888         (case operation
 889           (:listen (or (/= (the fixnum (ansi-stream-in-index syn))
 890                            +ansi-stream-in-buffer-length+)
 891                        (funcall (ansi-stream-misc syn) syn :listen)))
 892           (:clear-input (clear-input syn))
 893           (:unread (unread-char arg1 syn))
 894           (t
 895            (funcall (ansi-stream-misc syn) syn operation arg1 arg2)))
 896         (stream-misc-dispatch syn operation arg1 arg2))))
 897 \f
 898 ;;;; two-way streams
 899
 900 (defstruct (two-way-stream
 901             (:include ansi-stream
 902                       (in #'two-way-in)
 903                       (bin #'two-way-bin)
 904                       (n-bin #'two-way-n-bin)
 905                       (out #'two-way-out)
 906                       (bout #'two-way-bout)
 907                       (sout #'two-way-sout)
 908                       (misc #'two-way-misc))
 909             (:constructor %make-two-way-stream (input-stream output-stream))
 910             (:copier nil))
 911   (input-stream (missing-arg) :type stream :read-only t)
 912   (output-stream (missing-arg) :type stream :read-only t))
 913 (defprinter (two-way-stream) input-stream output-stream)
 914
 915 (defun make-two-way-stream (input-stream output-stream)
 916   #!+sb-doc
 917   "Return a bidirectional stream which gets its input from INPUT-STREAM and
 918    sends its output to OUTPUT-STREAM."
 919   ;; FIXME: This idiom of the-real-stream-of-a-possibly-synonym-stream
 920   ;; should be encapsulated in a function, and used here and most of
 921   ;; the other places that SYNONYM-STREAM-P appears.
 922   (unless (output-stream-p output-stream)
 923     (error 'type-error
 924            :datum output-stream
 925            :expected-type '(satisfies output-stream-p)))
 926   (unless (input-stream-p input-stream)
 927     (error 'type-error
 928            :datum input-stream
 929            :expected-type '(satisfies input-stream-p)))
 930   (funcall #'%make-two-way-stream input-stream output-stream))
 931
 932 (macrolet ((out-fun (name fun &rest args)
 933              `(defun ,name (stream ,@args)
 934                 (let ((syn (two-way-stream-output-stream stream)))
 935                   (,fun ,(car args) syn ,@(cdr args))))))
 936   (out-fun two-way-out write-char ch)
 937   (out-fun two-way-bout write-byte n)
 938   (out-fun two-way-sout write-string-no-key string start end))
 939
 940 (macrolet ((in-fun (name fun &rest args)
 941              `(defun ,name (stream ,@args)
 942                 (force-output (two-way-stream-output-stream stream))
 943                 (,fun (two-way-stream-input-stream stream) ,@args))))
 944   (in-fun two-way-in read-char eof-error-p eof-value)
 945   (in-fun two-way-bin read-byte eof-error-p eof-value)
 946   (in-fun two-way-n-bin read-n-bytes buffer start numbytes eof-error-p))
 947
 948 (defun two-way-misc (stream operation &optional arg1 arg2)
 949   (let* ((in (two-way-stream-input-stream stream))
 950          (out (two-way-stream-output-stream stream))
 951          (in-ansi-stream-p (ansi-stream-p in))
 952          (out-ansi-stream-p (ansi-stream-p out)))
 953     (case operation
 954       (:listen
 955        (if in-ansi-stream-p
 956            (or (/= (the fixnum (ansi-stream-in-index in))
 957                    +ansi-stream-in-buffer-length+)
 958                (funcall (ansi-stream-misc in) in :listen))
 959            (listen in)))
 960       ((:finish-output :force-output :clear-output)
 961        (if out-ansi-stream-p
 962            (funcall (ansi-stream-misc out) out operation arg1 arg2)
 963            (stream-misc-dispatch out operation arg1 arg2)))
 964       (:clear-input (clear-input in))
 965       (:unread (unread-char arg1 in))
 966       (:element-type
 967        (let ((in-type (stream-element-type in))
 968              (out-type (stream-element-type out)))
 969          (if (equal in-type out-type)
 970              in-type `(and ,in-type ,out-type))))
 971       (:close
 972        (set-closed-flame stream))
 973       (t
 974        (or (if in-ansi-stream-p
 975                (funcall (ansi-stream-misc in) in operation arg1 arg2)
 976                (stream-misc-dispatch in operation arg1 arg2))
 977            (if out-ansi-stream-p
 978                (funcall (ansi-stream-misc out) out operation arg1 arg2)
 979                (stream-misc-dispatch out operation arg1 arg2)))))))
 980 \f
 981 ;;;; concatenated streams
 982
 983 (defstruct (concatenated-stream
 984             (:include ansi-stream
 985                       (in #'concatenated-in)
 986                       (bin #'concatenated-bin)
 987                       (n-bin #'concatenated-n-bin)
 988                       (misc #'concatenated-misc))
 989             (:constructor %make-concatenated-stream (&rest streams))
 990             (:copier nil))
 991   ;; The car of this is the substream we are reading from now.
 992   (streams nil :type list))
 993 (def!method print-object ((x concatenated-stream) stream)
 994   (print-unreadable-object (x stream :type t :identity t)
 995     (format stream
 996             ":STREAMS ~S"
 997             (concatenated-stream-streams x))))
 998
 999 (defun make-concatenated-stream (&rest streams)
1000   #!+sb-doc
1001   "Return a stream which takes its input from each of the streams in turn,
1002    going on to the next at EOF."
1003   (dolist (stream streams)
1004     (unless (input-stream-p stream)
1005       (error 'type-error
1006              :datum stream
1007              :expected-type '(satisfies input-stream-p))))
1008   (apply #'%make-concatenated-stream streams))
1009
1010 (macrolet ((in-fun (name fun)
1011              `(defun ,name (stream eof-error-p eof-value)
1012                 (do ((streams (concatenated-stream-streams stream)
1013                               (cdr streams)))
1014                     ((null streams)
1015                      (eof-or-lose stream eof-error-p eof-value))
1016                   (let* ((stream (car streams))
1017                          (result (,fun stream nil nil)))
1018                     (when result (return result)))
1019                   (pop (concatenated-stream-streams stream))))))
1020   (in-fun concatenated-in read-char)
1021   (in-fun concatenated-bin read-byte))
1022
1023 (defun concatenated-n-bin (stream buffer start numbytes eof-errorp)
1024   (do ((streams (concatenated-stream-streams stream) (cdr streams))
1025        (current-start start)
1026        (remaining-bytes numbytes))
1027       ((null streams)
1028        (if eof-errorp
1029            (error 'end-of-file :stream stream)
1030            (- numbytes remaining-bytes)))
1031     (let* ((stream (car streams))
1032            (bytes-read (read-n-bytes stream buffer current-start
1033                                      remaining-bytes nil)))
1034       (incf current-start bytes-read)
1035       (decf remaining-bytes bytes-read)
1036       (when (zerop remaining-bytes) (return numbytes)))
1037     (setf (concatenated-stream-streams stream) (cdr streams))))
1038
1039 (defun concatenated-misc (stream operation &optional arg1 arg2)
1040   (let* ((left (concatenated-stream-streams stream))
1041          (current (car left)))
1042     (case operation
1043       (:listen
1044        (unless left
1045          (return-from concatenated-misc :eof))
1046        (loop
1047         (let ((stuff (if (ansi-stream-p current)
1048                          (funcall (ansi-stream-misc current) current
1049                                   :listen)
1050                          (stream-misc-dispatch current :listen))))
1051           (cond ((eq stuff :eof)
1052                  ;; Advance STREAMS, and try again.
1053                  (pop (concatenated-stream-streams stream))
1054                  (setf current
1055                        (car (concatenated-stream-streams stream)))
1056                  (unless current
1057                    ;; No further streams. EOF.
1058                    (return :eof)))
1059                 (stuff
1060                  ;; Stuff's available.
1061                  (return t))
1062                 (t
1063                  ;; Nothing is available yet.
1064                  (return nil))))))
1065       (:clear-input (when left (clear-input current)))
1066       (:unread (when left (unread-char arg1 current)))
1067       (:close
1068        (set-closed-flame stream))
1069       (t
1070        (when left
1071          (if (ansi-stream-p current)
1072              (funcall (ansi-stream-misc current) current operation arg1 arg2)
1073              (stream-misc-dispatch current operation arg1 arg2)))))))
1074 \f
1075 ;;;; echo streams
1076
1077 (defstruct (echo-stream
1078             (:include two-way-stream
1079                       (in #'echo-in)
1080                       (bin #'echo-bin)
1081                       (misc #'echo-misc)
1082                       (n-bin #'echo-n-bin))
1083             (:constructor %make-echo-stream (input-stream output-stream))
1084             (:copier nil))
1085   unread-stuff)
1086 (def!method print-object ((x echo-stream) stream)
1087   (print-unreadable-object (x stream :type t :identity t)
1088     (format stream
1089             ":INPUT-STREAM ~S :OUTPUT-STREAM ~S"
1090             (two-way-stream-input-stream x)
1091             (two-way-stream-output-stream x))))
1092
1093 (defun make-echo-stream (input-stream output-stream)
1094   #!+sb-doc
1095   "Return a bidirectional stream which gets its input from INPUT-STREAM and
1096    sends its output to OUTPUT-STREAM. In addition, all input is echoed to
1097    the output stream."
1098   (unless (output-stream-p output-stream)
1099     (error 'type-error
1100            :datum output-stream
1101            :expected-type '(satisfies output-stream-p)))
1102   (unless (input-stream-p input-stream)
1103     (error 'type-error
1104            :datum input-stream
1105            :expected-type '(satisfies input-stream-p)))
1106   (funcall #'%make-echo-stream input-stream output-stream))
1107
1108 (macrolet ((in-fun (name in-fun out-fun &rest args)
1109              `(defun ,name (stream ,@args)
1110                 (or (pop (echo-stream-unread-stuff stream))
1111                     (let* ((in (echo-stream-input-stream stream))
1112                            (out (echo-stream-output-stream stream))
1113                            (result (if eof-error-p
1114                                        (,in-fun in ,@args)
1115                                        (,in-fun in nil in))))
1116                       (cond
1117                         ((eql result in) eof-value)
1118                         (t (,out-fun result out) result)))))))
1119   (in-fun echo-in read-char write-char eof-error-p eof-value)
1120   (in-fun echo-bin read-byte write-byte eof-error-p eof-value))
1121
1122 (defun echo-n-bin (stream buffer start numbytes eof-error-p)
1123   (let ((new-start start)
1124         (read 0))
1125     (loop
1126      (let ((thing (pop (echo-stream-unread-stuff stream))))
1127        (cond
1128          (thing
1129           (setf (aref buffer new-start) thing)
1130           (incf new-start)
1131           (incf read)
1132           (when (= read numbytes)
1133             (return-from echo-n-bin numbytes)))
1134          (t (return nil)))))
1135     (let ((bytes-read (read-n-bytes (echo-stream-input-stream stream) buffer
1136                                     new-start (- numbytes read) nil)))
1137       (cond
1138         ((not eof-error-p)
1139          (write-sequence buffer (echo-stream-output-stream stream)
1140                          :start new-start :end (+ new-start bytes-read))
1141          (+ bytes-read read))
1142         ((> numbytes (+ read bytes-read))
1143          (write-sequence buffer (echo-stream-output-stream stream)
1144                          :start new-start :end (+ new-start bytes-read))
1145          (error 'end-of-file :stream stream))
1146         (t
1147          (write-sequence buffer (echo-stream-output-stream stream)
1148                          :start new-start :end (+ new-start bytes-read))
1149          (aver (= numbytes (+ new-start bytes-read)))
1150          numbytes)))))
1151 \f
1152 ;;;; STRING-INPUT-STREAM stuff
1153
1154 (defstruct (string-input-stream
1155              (:include ansi-stream
1156                        (in #'string-inch)
1157                        (bin #'ill-bin)
1158                        (n-bin #'ill-bin)
1159                        (misc #'string-in-misc))
1160              (:constructor internal-make-string-input-stream
1161                            (string current end))
1162              (:copier nil))
1163   (string (missing-arg) :type simple-string)
1164   (current (missing-arg) :type index)
1165   (end (missing-arg) :type index))
1166
1167 (defun string-inch (stream eof-error-p eof-value)
1168   (declare (type string-input-stream stream))
1169   (let ((string (string-input-stream-string stream))
1170         (index (string-input-stream-current stream)))
1171     (cond ((>= index (the index (string-input-stream-end stream)))
1172            (eof-or-lose stream eof-error-p eof-value))
1173           (t
1174            (setf (string-input-stream-current stream) (1+ index))
1175            (char string index)))))
1176
1177 (defun string-binch (stream eof-error-p eof-value)
1178   (declare (type string-input-stream stream))
1179   (let ((string (string-input-stream-string stream))
1180         (index (string-input-stream-current stream)))
1181     (cond ((>= index (the index (string-input-stream-end stream)))
1182            (eof-or-lose stream eof-error-p eof-value))
1183           (t
1184            (setf (string-input-stream-current stream) (1+ index))
1185            (char-code (char string index))))))
1186
1187 (defun string-stream-read-n-bytes (stream buffer start requested eof-error-p)
1188   (declare (type string-input-stream stream)
1189            (type index start requested))
1190   (let* ((string (string-input-stream-string stream))
1191          (index (string-input-stream-current stream))
1192          (available (- (string-input-stream-end stream) index))
1193          (copy (min available requested)))
1194     (declare (type simple-string string))
1195     (when (plusp copy)
1196       (setf (string-input-stream-current stream)
1197             (truly-the index (+ index copy)))
1198       ;; FIXME: why are we VECTOR-SAP'ing things here?  what's the point?
1199       ;; and are there SB-UNICODE issues here as well?  --njf, 2005-03-24
1200       (with-pinned-objects (string buffer)
1201         (system-area-ub8-copy (vector-sap string)
1202                               index
1203                               (if (typep buffer 'system-area-pointer)
1204                                   buffer
1205                                   (vector-sap buffer))
1206                               start
1207                               copy)))
1208     (if (and (> requested copy) eof-error-p)
1209         (error 'end-of-file :stream stream)
1210         copy)))
1211
1212 (defun string-in-misc (stream operation &optional arg1 arg2)
1213   (declare (type string-input-stream stream)
1214            (ignore arg2))
1215   (case operation
1216     (:file-position
1217      (if arg1
1218          (setf (string-input-stream-current stream)
1219                (case arg1
1220                  (:start 0)
1221                  (:end (string-input-stream-end stream))
1222                  ;; We allow moving position beyond EOF. Errors happen
1223                  ;; on read, not move -- or the user may extend the
1224                  ;; input string.
1225                  (t arg1)))
1226          (string-input-stream-current stream)))
1227     ;; According to ANSI: "Should signal an error of type type-error
1228     ;; if stream is not a stream associated with a file."
1229     ;; This is checked by FILE-LENGTH, so no need to do it here either.
1230     ;; (:file-length (length (string-input-stream-string stream)))
1231     (:unread (decf (string-input-stream-current stream)))
1232     (:close (set-closed-flame stream))
1233     (:listen (or (/= (the index (string-input-stream-current stream))
1234                      (the index (string-input-stream-end stream)))
1235                  :eof))
1236     (:element-type (array-element-type (string-input-stream-string stream)))))
1237
1238 (defun make-string-input-stream (string &optional (start 0) end)
1239   #!+sb-doc
1240   "Return an input stream which will supply the characters of STRING between
1241   START and END in order."
1242   (declare (type string string)
1243            (type index start)
1244            (type (or index null) end))
1245   (let* ((string (coerce string '(simple-array character (*)))))
1246     ;; FIXME: Why WITH-ARRAY-DATA, since the array is already simple?
1247     (with-array-data ((string string) (start start) (end end))
1248       (internal-make-string-input-stream
1249        string ;; now simple
1250        start
1251        end))))
1252 \f
1253 ;;;; STRING-OUTPUT-STREAM stuff
1254 ;;;;
1255 ;;;; FIXME: This, like almost none of the stream code is particularly
1256 ;;;; interrupt or thread-safe. While it should not be possible to
1257 ;;;; corrupt the heap here, it certainly is possible to end up with
1258 ;;;; a string-output-stream whose internal state is messed up.
1259 ;;;;
1260 ;;;; FIXME: It would be nice to support space-efficient
1261 ;;;; string-output-streams with element-type base-char. This would
1262 ;;;; mean either a separate subclass, or typecases in functions.
1263
1264 (defparameter *string-output-stream-buffer-initial-size* 64)
1265
1266 #!-sb-fluid
1267 (declaim (inline string-output-string-stream-buffer
1268                  string-output-string-stream-pointer
1269                  string-output-string-stream-index))
1270 (defstruct (string-output-stream
1271             (:include ansi-stream
1272                       (out #'string-ouch)
1273                       (sout #'string-sout)
1274                       (misc #'string-out-misc))
1275             (:constructor make-string-output-stream
1276                           (&key (element-type 'character)
1277                            &aux (buffer
1278                                  (make-string
1279                                   *string-output-stream-buffer-initial-size*))))
1280             (:copier nil))
1281   ;; The string we throw stuff in.
1282   (buffer (missing-arg) :type (simple-array character (*)))
1283   ;; Chains of buffers to use
1284   (prev nil)
1285   (next nil)
1286   ;; Index of the next location to use in the current string.
1287   (pointer 0 :type index)
1288   ;; Global location in the stream
1289   (index 0 :type index)
1290   ;; Index cache: when we move backwards we save the greater of this
1291   ;; and index here, so the greater of index and this is always the
1292   ;; end of the stream.
1293   (index-cache 0 :type index)
1294   ;; Requested element type
1295   (element-type 'character))
1296
1297 #!+sb-doc
1298 (setf (fdocumentation 'make-string-output-stream 'function)
1299   "Return an output stream which will accumulate all output given it for the
1300 benefit of the function GET-OUTPUT-STREAM-STRING.")
1301
1302 ;;; Pushes the current segment onto the prev-list, and either pops
1303 ;;; or allocates a new one.
1304 (defun string-output-stream-new-buffer (stream size)
1305   (declare (index size))
1306   (/show0 "/string-output-stream-new-buffer")
1307   (push (string-output-stream-buffer stream)
1308         (string-output-stream-prev stream))
1309   (setf (string-output-stream-buffer stream)
1310         (or (pop (string-output-stream-next stream))
1311             ;; FIXME: This would be the correct place to detect that
1312             ;; more then FIXNUM characters are being written to the
1313             ;; stream, and do something about it.
1314             (make-string size))))
1315
1316 ;;; Moves to the end of the next segment or the current one if there are
1317 ;;; no more segments. Returns true as long as there are next segments.
1318 (defun string-output-stream-next-buffer (stream)
1319   (/show0 "/string-output-stream-next-buffer")
1320   (let* ((old (string-output-stream-buffer stream))
1321          (new (pop (string-output-stream-next stream)))
1322          (old-size (length old))
1323          (skipped (- old-size (string-output-stream-pointer stream))))
1324     (cond (new
1325            (let ((new-size (length new)))
1326              (push old (string-output-stream-prev stream))
1327              (setf (string-output-stream-buffer stream) new
1328                    (string-output-stream-pointer stream) new-size)
1329              (incf (string-output-stream-index stream) (+ skipped new-size)))
1330            t)
1331           (t
1332            (setf (string-output-stream-pointer stream) old-size)
1333            (incf (string-output-stream-index stream) skipped)
1334            nil))))
1335
1336 ;;; Moves to the start of the previous segment or the current one if there
1337 ;;; are no more segments. Returns true as long as there are prev segments.
1338 (defun string-output-stream-prev-buffer (stream)
1339   (/show0 "/string-output-stream-prev-buffer")
1340   (let ((old (string-output-stream-buffer stream))
1341         (new (pop (string-output-stream-prev stream)))
1342         (skipped (string-output-stream-pointer stream)))
1343     (cond (new
1344            (push old (string-output-stream-next stream))
1345            (setf (string-output-stream-buffer stream) new
1346                  (string-output-stream-pointer stream) 0)
1347            (decf (string-output-stream-index stream) (+ skipped (length new)))
1348            t)
1349           (t
1350            (setf (string-output-stream-pointer stream) 0)
1351            (decf (string-output-stream-index stream) skipped)
1352            nil))))
1353
1354 (defun string-ouch (stream character)
1355   (/show0 "/string-ouch")
1356   (let ((pointer (string-output-stream-pointer stream))
1357         (buffer (string-output-stream-buffer stream))
1358         (index (string-output-stream-index stream)))
1359     (cond ((= pointer (length buffer))
1360            (setf buffer (string-output-stream-new-buffer stream index)
1361                  (aref buffer 0) character
1362                  (string-output-stream-pointer stream) 1))
1363           (t
1364            (setf (aref buffer pointer) character
1365                  (string-output-stream-pointer stream) (1+ pointer))))
1366     (setf (string-output-stream-index stream) (1+ index))))
1367
1368 (defun string-sout (stream string start end)
1369   (declare (type simple-string string)
1370            (type index start end))
1371   (let* ((full-length (- end start))
1372          (length full-length)
1373          (buffer (string-output-stream-buffer stream))
1374          (pointer (string-output-stream-pointer stream))
1375          (space (- (length buffer) pointer))
1376          (here (min space length))
1377          (stop (+ start here))
1378          (overflow (- length space)))
1379     (declare (index length space here stop full-length)
1380              (fixnum overflow)
1381              (type (simple-array character (*)) buffer))
1382     (tagbody
1383      :more
1384        (when (plusp here)
1385          (etypecase string
1386            ((simple-array character (*))
1387             (replace buffer string :start1 pointer :start2 start :end2 stop))
1388            (simple-base-string
1389             (replace buffer string :start1 pointer :start2 start :end2 stop))
1390            ((simple-array nil (*))
1391             (replace buffer string :start1 pointer :start2 start :end2 stop)))
1392          (setf (string-output-stream-pointer stream) (+ here pointer)))
1393        (when (plusp overflow)
1394          (setf start stop
1395                length (- end start)
1396                buffer (string-output-stream-new-buffer
1397                        stream (max overflow (string-output-stream-index stream)))
1398                pointer 0
1399                space (length buffer)
1400                here (min space length)
1401                stop (+ start here)
1402                ;; there may be more overflow if we used a buffer
1403                ;; already allocated to the stream
1404                overflow (- length space))
1405          (go :more)))
1406     (incf (string-output-stream-index stream) full-length)))
1407
1408 ;;; Factored out of the -misc method due to size.
1409 (defun set-string-output-stream-file-position (stream pos)
1410   (let* ((index (string-output-stream-index stream))
1411          (end (max index (string-output-stream-index-cache stream))))
1412     (declare (index index end))
1413     (setf (string-output-stream-index-cache stream) end)
1414     (cond ((eq :start pos)
1415            (loop while (string-output-stream-prev-buffer stream)))
1416           ((eq :end pos)
1417            (loop while (string-output-stream-next-buffer stream))
1418            (let ((over (- (string-output-stream-index stream) end)))
1419              (decf (string-output-stream-pointer stream) over))
1420            (setf (string-output-stream-index stream) end))
1421           ((< pos index)
1422            (loop while (< pos index)
1423                  do (string-output-stream-prev-buffer stream)
1424                  (setf index (string-output-stream-index stream)))
1425            (let ((step (- pos index)))
1426              (incf (string-output-stream-pointer stream) step)
1427              (setf (string-output-stream-index stream) pos)))
1428           ((> pos index)
1429            ;; We allow moving beyond the end of stream, implicitly
1430            ;; extending the output stream.
1431            (let ((next (string-output-stream-next-buffer stream)))
1432              ;; Update after -next-buffer, INDEX is kept pointing at
1433              ;; the end of the current buffer.
1434              (setf index (string-output-stream-index stream))
1435              (loop while (and next (> pos index))
1436                    do (setf next (string-output-stream-next-buffer stream)
1437                             index (string-output-stream-index stream))))
1438            ;; Allocate new buffer if needed, or step back to
1439            ;; the desired index and set pointer and index
1440            ;; correctly.
1441            (let ((diff (- pos index)))
1442              (if (plusp diff)
1443                  (let* ((new (string-output-stream-new-buffer stream diff))
1444                         (size (length new)))
1445                    (aver (= pos (+ index size)))
1446                    (setf (string-output-stream-pointer stream) size
1447                          (string-output-stream-index stream) pos))
1448                  (let ((size (length (string-output-stream-buffer stream))))
1449                    (setf (string-output-stream-pointer stream) (+ size diff)
1450                          (string-output-stream-index stream) pos))))))))
1451
1452 (defun string-out-misc (stream operation &optional arg1 arg2)
1453   (declare (ignore arg2))
1454   (case operation
1455     (:charpos
1456      ;; Keeping this first is a silly micro-optimization: FRESH-LINE
1457      ;; makes this the most common one.
1458      (/show0 "/string-out-misc charpos")
1459      (prog ((pointer (string-output-stream-pointer stream))
1460             (buffer (string-output-stream-buffer stream))
1461             (prev (string-output-stream-prev stream))
1462             (base 0))
1463       :next
1464       (let ((pos (position #\newline buffer :from-end t :end pointer)))
1465         (when (or pos (not buffer))
1466           ;; If newline is at index I, and pointer at index I+N, charpos
1467           ;; is N-1. If there is no newline, and pointer is at index N,
1468           ;; charpos is N.
1469           (return (+ base (if pos (- pointer pos 1) pointer))))
1470         (setf base (+ base pointer)
1471               buffer (pop prev)
1472               pointer (length buffer))
1473         (/show0 "/string-out-misc charpos next")
1474         (go :next))))
1475     (:file-position
1476      (/show0 "/string-out-misc file-position")
1477      (when arg1
1478        (set-string-output-stream-file-position stream arg1))
1479      (string-output-stream-index stream))
1480     (:close
1481      (/show0 "/string-out-misc close")
1482      (set-closed-flame stream))
1483     (:element-type (string-output-stream-element-type stream))))
1484
1485 ;;; Return a string of all the characters sent to a stream made by
1486 ;;; MAKE-STRING-OUTPUT-STREAM since the last call to this function.
1487 (defun get-output-stream-string (stream)
1488   (declare (type string-output-stream stream))
1489   (let* ((length (max (string-output-stream-index stream)
1490                       (string-output-stream-index-cache stream)))
1491          (element-type (string-output-stream-element-type stream))
1492          (prev (string-output-stream-prev stream))
1493          (this (string-output-stream-buffer stream))
1494          (next (string-output-stream-next stream))
1495          (result
1496           (case element-type
1497             ;; overwhelmingly common case: can be inlined
1498             ;;
1499             ;; FIXME: If we were willing to use %SHRINK-VECTOR here,
1500             ;; and allocate new strings the size of 2 * index in
1501             ;; STRING-SOUT, we would not need to allocate one here in
1502             ;; the common case, but could just use the last one
1503             ;; allocated, and chop it down to size..
1504             ;;
1505             ((character) (make-string length))
1506             ;; slightly less common cases: inline it anyway
1507             ((base-char standard-char)
1508              (make-string length :element-type 'base-char))
1509             (t
1510              (make-string length :element-type element-type)))))
1511
1512     (setf (string-output-stream-index stream) 0
1513           (string-output-stream-index-cache stream) 0
1514           (string-output-stream-pointer stream) 0
1515           ;; throw them away for simplicity's sake: this way the rest of the
1516           ;; implementation can assume that the greater of INDEX and INDEX-CACHE
1517           ;; is always within the last buffer.
1518           (string-output-stream-prev stream) nil
1519           (string-output-stream-next stream) nil)
1520
1521     (flet ((replace-all (fun)
1522              (let ((start 0))
1523                (declare (index start))
1524                (setf prev (nreverse prev))
1525                (dolist (buffer prev)
1526                  (funcall fun buffer start)
1527                  (incf start (length buffer)))
1528                (funcall fun this start)
1529                (incf start (length this))
1530                (dolist (buffer next)
1531                  (funcall fun buffer start)
1532                  (incf start (length buffer)))
1533                ;; Hack: erase the pointers to strings, to make it less
1534                ;; likely that the conservative GC will accidentally
1535                ;; retain the buffers.
1536                (fill prev nil)
1537                (fill next nil))))
1538       (macrolet ((frob (type)
1539                    `(replace-all (lambda (buffer from)
1540                                    (declare (type ,type result)
1541                                             (type (simple-array character (*))
1542                                                   buffer))
1543                                    (replace result buffer :start1 from)))))
1544         (etypecase result
1545           ((simple-array character (*))
1546            (frob (simple-array character (*))))
1547           (simple-base-string
1548            (frob simple-base-string))
1549           ((simple-array nil (*))
1550            (frob (simple-array nil (*)))))))
1551
1552     result))
1553 \f
1554 ;;;; fill-pointer streams
1555
1556 ;;; Fill pointer STRING-OUTPUT-STREAMs are not explicitly mentioned in
1557 ;;; the CLM, but they are required for the implementation of
1558 ;;; WITH-OUTPUT-TO-STRING.
1559
1560 ;;; FIXME: need to support (VECTOR BASE-CHAR) and (VECTOR NIL),
1561 ;;; ideally without destroying all hope of efficiency.
1562 (deftype string-with-fill-pointer ()
1563   '(and (vector character)
1564         (satisfies array-has-fill-pointer-p)))
1565
1566 (defstruct (fill-pointer-output-stream
1567             (:include ansi-stream
1568                       (out #'fill-pointer-ouch)
1569                       (sout #'fill-pointer-sout)
1570                       (misc #'fill-pointer-misc))
1571             (:constructor make-fill-pointer-output-stream (string))
1572             (:copier nil))
1573   ;; a string with a fill pointer where we stuff the stuff we write
1574   (string (missing-arg) :type string-with-fill-pointer :read-only t))
1575
1576 (defun fill-pointer-ouch (stream character)
1577   (let* ((buffer (fill-pointer-output-stream-string stream))
1578          (current (fill-pointer buffer))
1579          (current+1 (1+ current)))
1580     (declare (fixnum current))
1581     (with-array-data ((workspace buffer) (start) (end))
1582       (declare (type (simple-array character (*)) workspace))
1583       (let ((offset-current (+ start current)))
1584         (declare (fixnum offset-current))
1585         (if (= offset-current end)
1586             (let* ((new-length (1+ (* current 2)))
1587                    (new-workspace (make-string new-length)))
1588               (declare (type (simple-array character (*)) new-workspace))
1589               (replace new-workspace workspace
1590                        :start2 start :end2 offset-current)
1591               (setf workspace new-workspace
1592                     offset-current current)
1593               (set-array-header buffer workspace new-length
1594                                 current+1 0 new-length nil))
1595             (setf (fill-pointer buffer) current+1))
1596         (setf (schar workspace offset-current) character)))
1597     current+1))
1598
1599 (defun fill-pointer-sout (stream string start end)
1600   (declare (simple-string string) (fixnum start end))
1601   (let* ((string (if (typep string '(simple-array character (*)))
1602                      string
1603                      (coerce string '(simple-array character (*)))))
1604          (buffer (fill-pointer-output-stream-string stream))
1605          (current (fill-pointer buffer))
1606          (string-len (- end start))
1607          (dst-end (+ string-len current)))
1608     (declare (fixnum current dst-end string-len))
1609     (with-array-data ((workspace buffer) (dst-start) (dst-length))
1610       (declare (type (simple-array character (*)) workspace))
1611       (let ((offset-dst-end (+ dst-start dst-end))
1612             (offset-current (+ dst-start current)))
1613         (declare (fixnum offset-dst-end offset-current))
1614         (if (> offset-dst-end dst-length)
1615             (let* ((new-length (+ (the fixnum (* current 2)) string-len))
1616                    (new-workspace (make-string new-length)))
1617               (declare (type (simple-array character (*)) new-workspace))
1618               (replace new-workspace workspace
1619                        :start2 dst-start :end2 offset-current)
1620               (setf workspace new-workspace
1621                     offset-current current
1622                     offset-dst-end dst-end)
1623               (set-array-header buffer workspace new-length
1624                                 dst-end 0 new-length nil))
1625             (setf (fill-pointer buffer) dst-end))
1626         (replace workspace string
1627                  :start1 offset-current :start2 start :end2 end)))
1628     dst-end))
1629
1630 (defun fill-pointer-misc (stream operation &optional arg1 arg2)
1631   (declare (ignore arg2))
1632   (case operation
1633     (:file-position
1634      (let ((buffer (fill-pointer-output-stream-string stream)))
1635        (if arg1
1636            (setf (fill-pointer buffer)
1637                  (case arg1
1638                    (:start 0)
1639                    ;; Fill-pointer is always at fill-pointer we will
1640                    ;; make :END move to the end of the actual string.
1641                    (:end (array-total-size buffer))
1642                    ;; We allow moving beyond the end of string if the
1643                    ;; string is adjustable.
1644                    (t (when (>= arg1 (array-total-size buffer))
1645                         (if (adjustable-array-p buffer)
1646                             (adjust-array buffer arg1)
1647                             (error "Cannot move FILE-POSITION beyond the end ~
1648                                     of WITH-OUTPUT-TO-STRING stream ~
1649                                     constructed with non-adjustable string.")))
1650                       arg1)))
1651            (fill-pointer buffer))))
1652     (:charpos
1653      (let* ((buffer (fill-pointer-output-stream-string stream))
1654             (current (fill-pointer buffer)))
1655        (with-array-data ((string buffer) (start) (end current))
1656          (declare (simple-string string) (ignore start))
1657          (let ((found (position #\newline string :test #'char=
1658                                 :end end :from-end t)))
1659            (if found
1660                (- end (the fixnum found))
1661                current)))))
1662      (:element-type (array-element-type
1663                      (fill-pointer-output-stream-string stream)))))
1664 \f
1665 ;;;; case frobbing streams, used by FORMAT ~(...~)
1666
1667 (defstruct (case-frob-stream
1668             (:include ansi-stream
1669                       (misc #'case-frob-misc))
1670             (:constructor %make-case-frob-stream (target out sout))
1671             (:copier nil))
1672   (target (missing-arg) :type stream))
1673
1674 (defun make-case-frob-stream (target kind)
1675   #!+sb-doc
1676   "Return a stream that sends all output to the stream TARGET, but modifies
1677    the case of letters, depending on KIND, which should be one of:
1678      :UPCASE - convert to upper case.
1679      :DOWNCASE - convert to lower case.
1680      :CAPITALIZE - convert the first letter of words to upper case and the
1681         rest of the word to lower case.
1682      :CAPITALIZE-FIRST - convert the first letter of the first word to upper
1683         case and everything else to lower case."
1684   (declare (type stream target)
1685            (type (member :upcase :downcase :capitalize :capitalize-first)
1686                  kind)
1687            (values stream))
1688   (if (case-frob-stream-p target)
1689       ;; If we are going to be writing to a stream that already does
1690       ;; case frobbing, why bother frobbing the case just so it can
1691       ;; frob it again?
1692       target
1693       (multiple-value-bind (out sout)
1694           (ecase kind
1695             (:upcase
1696              (values #'case-frob-upcase-out
1697                      #'case-frob-upcase-sout))
1698             (:downcase
1699              (values #'case-frob-downcase-out
1700                      #'case-frob-downcase-sout))
1701             (:capitalize
1702              (values #'case-frob-capitalize-out
1703                      #'case-frob-capitalize-sout))
1704             (:capitalize-first
1705              (values #'case-frob-capitalize-first-out
1706                      #'case-frob-capitalize-first-sout)))
1707         (%make-case-frob-stream target out sout))))
1708
1709 (defun case-frob-misc (stream op &optional arg1 arg2)
1710   (declare (type case-frob-stream stream))
1711   (case op
1712     (:close
1713      (set-closed-flame stream))
1714     (t
1715      (let ((target (case-frob-stream-target stream)))
1716        (if (ansi-stream-p target)
1717            (funcall (ansi-stream-misc target) target op arg1 arg2)
1718            (stream-misc-dispatch target op arg1 arg2))))))
1719
1720 (defun case-frob-upcase-out (stream char)
1721   (declare (type case-frob-stream stream)
1722            (type character char))
1723   (let ((target (case-frob-stream-target stream))
1724         (char (char-upcase char)))
1725     (if (ansi-stream-p target)
1726         (funcall (ansi-stream-out target) target char)
1727         (stream-write-char target char))))
1728
1729 (defun case-frob-upcase-sout (stream str start end)
1730   (declare (type case-frob-stream stream)
1731            (type simple-string str)
1732            (type index start)
1733            (type (or index null) end))
1734   (let* ((target (case-frob-stream-target stream))
1735          (len (length str))
1736          (end (or end len))
1737          (string (if (and (zerop start) (= len end))
1738                      (string-upcase str)
1739                      (nstring-upcase (subseq str start end))))
1740          (string-len (- end start)))
1741     (if (ansi-stream-p target)
1742         (funcall (ansi-stream-sout target) target string 0 string-len)
1743         (stream-write-string target string 0 string-len))))
1744
1745 (defun case-frob-downcase-out (stream char)
1746   (declare (type case-frob-stream stream)
1747            (type character char))
1748   (let ((target (case-frob-stream-target stream))
1749         (char (char-downcase char)))
1750     (if (ansi-stream-p target)
1751         (funcall (ansi-stream-out target) target char)
1752         (stream-write-char target char))))
1753
1754 (defun case-frob-downcase-sout (stream str start end)
1755   (declare (type case-frob-stream stream)
1756            (type simple-string str)
1757            (type index start)
1758            (type (or index null) end))
1759   (let* ((target (case-frob-stream-target stream))
1760          (len (length str))
1761          (end (or end len))
1762          (string (if (and (zerop start) (= len end))
1763                      (string-downcase str)
1764                      (nstring-downcase (subseq str start end))))
1765          (string-len (- end start)))
1766     (if (ansi-stream-p target)
1767         (funcall (ansi-stream-sout target) target string 0 string-len)
1768         (stream-write-string target string 0 string-len))))
1769
1770 (defun case-frob-capitalize-out (stream char)
1771   (declare (type case-frob-stream stream)
1772            (type character char))
1773   (let ((target (case-frob-stream-target stream)))
1774     (cond ((alphanumericp char)
1775            (let ((char (char-upcase char)))
1776              (if (ansi-stream-p target)
1777                  (funcall (ansi-stream-out target) target char)
1778                  (stream-write-char target char)))
1779            (setf (case-frob-stream-out stream) #'case-frob-capitalize-aux-out)
1780            (setf (case-frob-stream-sout stream)
1781                  #'case-frob-capitalize-aux-sout))
1782           (t
1783            (if (ansi-stream-p target)
1784                (funcall (ansi-stream-out target) target char)
1785                (stream-write-char target char))))))
1786
1787 (defun case-frob-capitalize-sout (stream str start end)
1788   (declare (type case-frob-stream stream)
1789            (type simple-string str)
1790            (type index start)
1791            (type (or index null) end))
1792   (let* ((target (case-frob-stream-target stream))
1793          (str (subseq str start end))
1794          (len (length str))
1795          (inside-word nil))
1796     (dotimes (i len)
1797       (let ((char (schar str i)))
1798         (cond ((not (alphanumericp char))
1799                (setf inside-word nil))
1800               (inside-word
1801                (setf (schar str i) (char-downcase char)))
1802               (t
1803                (setf inside-word t)
1804                (setf (schar str i) (char-upcase char))))))
1805     (when inside-word
1806       (setf (case-frob-stream-out stream)
1807             #'case-frob-capitalize-aux-out)
1808       (setf (case-frob-stream-sout stream)
1809             #'case-frob-capitalize-aux-sout))
1810     (if (ansi-stream-p target)
1811         (funcall (ansi-stream-sout target) target str 0 len)
1812         (stream-write-string target str 0 len))))
1813
1814 (defun case-frob-capitalize-aux-out (stream char)
1815   (declare (type case-frob-stream stream)
1816            (type character char))
1817   (let ((target (case-frob-stream-target stream)))
1818     (cond ((alphanumericp char)
1819            (let ((char (char-downcase char)))
1820              (if (ansi-stream-p target)
1821                  (funcall (ansi-stream-out target) target char)
1822                  (stream-write-char target char))))
1823           (t
1824            (if (ansi-stream-p target)
1825                (funcall (ansi-stream-out target) target char)
1826                (stream-write-char target char))
1827            (setf (case-frob-stream-out stream)
1828                  #'case-frob-capitalize-out)
1829            (setf (case-frob-stream-sout stream)
1830                  #'case-frob-capitalize-sout)))))
1831
1832 (defun case-frob-capitalize-aux-sout (stream str start end)
1833   (declare (type case-frob-stream stream)
1834            (type simple-string str)
1835            (type index start)
1836            (type (or index null) end))
1837   (let* ((target (case-frob-stream-target stream))
1838          (str (subseq str start end))
1839          (len (length str))
1840          (inside-word t))
1841     (dotimes (i len)
1842       (let ((char (schar str i)))
1843         (cond ((not (alphanumericp char))
1844                (setf inside-word nil))
1845               (inside-word
1846                (setf (schar str i) (char-downcase char)))
1847               (t
1848                (setf inside-word t)
1849                (setf (schar str i) (char-upcase char))))))
1850     (unless inside-word
1851       (setf (case-frob-stream-out stream)
1852             #'case-frob-capitalize-out)
1853       (setf (case-frob-stream-sout stream)
1854             #'case-frob-capitalize-sout))
1855     (if (ansi-stream-p target)
1856         (funcall (ansi-stream-sout target) target str 0 len)
1857         (stream-write-string target str 0 len))))
1858
1859 (defun case-frob-capitalize-first-out (stream char)
1860   (declare (type case-frob-stream stream)
1861            (type character char))
1862   (let ((target (case-frob-stream-target stream)))
1863     (cond ((alphanumericp char)
1864            (let ((char (char-upcase char)))
1865              (if (ansi-stream-p target)
1866                  (funcall (ansi-stream-out target) target char)
1867                  (stream-write-char target char)))
1868            (setf (case-frob-stream-out stream)
1869                  #'case-frob-downcase-out)
1870            (setf (case-frob-stream-sout stream)
1871                  #'case-frob-downcase-sout))
1872           (t
1873            (if (ansi-stream-p target)
1874                (funcall (ansi-stream-out target) target char)
1875                (stream-write-char target char))))))
1876
1877 (defun case-frob-capitalize-first-sout (stream str start end)
1878   (declare (type case-frob-stream stream)
1879            (type simple-string str)
1880            (type index start)
1881            (type (or index null) end))
1882   (let* ((target (case-frob-stream-target stream))
1883          (str (subseq str start end))
1884          (len (length str)))
1885     (dotimes (i len)
1886       (let ((char (schar str i)))
1887         (when (alphanumericp char)
1888           (setf (schar str i) (char-upcase char))
1889           (do ((i (1+ i) (1+ i)))
1890               ((= i len))
1891             (setf (schar str i) (char-downcase (schar str i))))
1892           (setf (case-frob-stream-out stream)
1893                 #'case-frob-downcase-out)
1894           (setf (case-frob-stream-sout stream)
1895                 #'case-frob-downcase-sout)
1896           (return))))
1897     (if (ansi-stream-p target)
1898         (funcall (ansi-stream-sout target) target str 0 len)
1899         (stream-write-string target str 0 len))))
1900 \f
1901 ;;;; READ-SEQUENCE
1902
1903 (defun read-sequence (seq stream &key (start 0) end)
1904   #!+sb-doc
1905   "Destructively modify SEQ by reading elements from STREAM.
1906   That part of SEQ bounded by START and END is destructively modified by
1907   copying successive elements into it from STREAM. If the end of file
1908   for STREAM is reached before copying all elements of the subsequence,
1909   then the extra elements near the end of sequence are not updated, and
1910   the index of the next element is returned."
1911   (declare (type sequence seq)
1912            (type stream stream)
1913            (type index start)
1914            (type sequence-end end)
1915            (values index))
1916   (if (ansi-stream-p stream)
1917       (ansi-stream-read-sequence seq stream start end)
1918       ;; must be Gray streams FUNDAMENTAL-STREAM
1919       (stream-read-sequence stream seq start end)))
1920
1921 (declaim (inline compatible-vector-and-stream-element-types-p))
1922 (defun compatible-vector-and-stream-element-types-p (vector stream)
1923   (declare (type vector vector)
1924            (type ansi-stream stream))
1925   (or (and (typep vector '(simple-array (unsigned-byte 8) (*)))
1926            (subtypep (stream-element-type stream) '(unsigned-byte 8)))
1927       (and (typep vector '(simple-array (signed-byte 8) (*)))
1928            (subtypep (stream-element-type stream) '(signed-byte 8)))))
1929
1930 (defun ansi-stream-read-sequence (seq stream start %end)
1931   (declare (type sequence seq)
1932            (type ansi-stream stream)
1933            (type index start)
1934            (type sequence-end %end)
1935            (values index))
1936   (let ((end (or %end (length seq))))
1937     (declare (type index end))
1938     (etypecase seq
1939       (list
1940        (let ((read-function
1941               (if (subtypep (stream-element-type stream) 'character)
1942                   #'ansi-stream-read-char
1943                   #'ansi-stream-read-byte)))
1944          (do ((rem (nthcdr start seq) (rest rem))
1945               (i start (1+ i)))
1946              ((or (endp rem) (>= i end)) i)
1947            (declare (type list rem)
1948                     (type index i))
1949            (let ((el (funcall read-function stream nil :eof nil)))
1950              (when (eq el :eof)
1951                (return i))
1952              (setf (first rem) el)))))
1953       (vector
1954        (with-array-data ((data seq) (offset-start start) (offset-end end)
1955                          :check-fill-pointer t)
1956          (cond ((compatible-vector-and-stream-element-types-p data stream)
1957                 (let* ((numbytes (- end start))
1958                        (bytes-read (read-n-bytes stream data offset-start
1959                                                  numbytes nil)))
1960                   (if (< bytes-read numbytes)
1961                       (+ start bytes-read)
1962                       end)))
1963                ((and (ansi-stream-cin-buffer stream)
1964                      (typep seq 'simple-string))
1965                 (ansi-stream-read-string-from-frc-buffer seq stream
1966                                                          start %end))
1967                (t
1968                 (let ((read-function
1969                        (if (subtypep (stream-element-type stream) 'character)
1970                            ;; If the stream-element-type is CHARACTER,
1971                            ;; this might be a bivalent stream. If the
1972                            ;; sequence is a specialized unsigned-byte
1973                            ;; vector, try to read use binary IO. It'll
1974                            ;; signal an error if stream is an pure
1975                            ;; character stream.
1976                            (if (subtypep (array-element-type data)
1977                                          'unsigned-byte)
1978                                #'ansi-stream-read-byte
1979                                #'ansi-stream-read-char)
1980                            #'ansi-stream-read-byte)))
1981                   (do ((i offset-start (1+ i)))
1982                       ((>= i offset-end) end)
1983                     (declare (type index i))
1984                     (let ((el (funcall read-function stream nil :eof nil)))
1985                       (when (eq el :eof)
1986                         (return (+ start (- i offset-start))))
1987                       (setf (aref data i) el)))))))))))
1988
1989 (defun ansi-stream-read-string-from-frc-buffer (seq stream start %end)
1990   (declare (type simple-string seq)
1991            (type ansi-stream stream)
1992            (type index start)
1993            (type (or null index) %end))
1994   (let ((needed (- (or %end (length seq))
1995                    start))
1996         (read 0))
1997     (prepare-for-fast-read-char stream
1998       (declare (ignore %frc-method%))
1999       (unless %frc-buffer%
2000         (return-from ansi-stream-read-string-from-frc-buffer nil))
2001       (labels ((refill-buffer ()
2002                  (prog1
2003                      (fast-read-char-refill stream nil nil)
2004                    (setf %frc-index% (ansi-stream-in-index %frc-stream%))))
2005                (add-chunk ()
2006                  (let* ((end (length %frc-buffer%))
2007                         (len (min (- end %frc-index%)
2008                                   (- needed read))))
2009                    (declare (type index end len read needed))
2010                    (string-dispatch (simple-base-string
2011                                      (simple-array character (*)))
2012                        seq
2013                      (replace seq %frc-buffer%
2014                               :start1 (+ start read)
2015                               :end1 (+ start read len)
2016                               :start2 %frc-index%
2017                               :end2 (+ %frc-index% len)))
2018                    (incf read len)
2019                    (incf %frc-index% len)
2020                    (when (or (eql needed read)
2021                              (refill-buffer))
2022                      (done-with-fast-read-char)
2023                      (return-from ansi-stream-read-string-from-frc-buffer
2024                        read)))))
2025         (declare (inline refill-buffer))
2026         (when (and (= %frc-index% +ansi-stream-in-buffer-length+)
2027                    (refill-buffer))
2028           ;; EOF had been reached before we read anything
2029           ;; at all. Return the EOF value or signal the error.
2030           (done-with-fast-read-char)
2031           (return-from ansi-stream-read-string-from-frc-buffer 0))
2032         (loop (add-chunk))))))
2033
2034 \f
2035 ;;;; WRITE-SEQUENCE
2036
2037 (defun write-sequence (seq stream &key (start 0) (end nil))
2038   #!+sb-doc
2039   "Write the elements of SEQ bounded by START and END to STREAM."
2040   (declare (type sequence seq)
2041            (type stream stream)
2042            (type index start)
2043            (type sequence-end end)
2044            (values sequence))
2045   (if (ansi-stream-p stream)
2046       (ansi-stream-write-sequence seq stream start end)
2047       ;; must be Gray-streams FUNDAMENTAL-STREAM
2048       (stream-write-sequence stream seq start end)))
2049
2050 (defun ansi-stream-write-sequence (seq stream start %end)
2051   (declare (type sequence seq)
2052            (type ansi-stream stream)
2053            (type index start)
2054            (type sequence-end %end)
2055            (values sequence))
2056   (let ((end (or %end (length seq))))
2057     (declare (type index end))
2058     (etypecase seq
2059       (list
2060        (let ((write-function
2061               (if (subtypep (stream-element-type stream) 'character)
2062                   (ansi-stream-out stream)
2063                   (ansi-stream-bout stream))))
2064          (do ((rem (nthcdr start seq) (rest rem))
2065               (i start (1+ i)))
2066              ((or (endp rem) (>= i end)))
2067            (declare (type list rem)
2068                     (type index i))
2069            (funcall write-function stream (first rem)))))
2070       (string
2071        (%write-string seq stream start end))
2072       (vector
2073        (with-array-data ((data seq) (offset-start start) (offset-end end)
2074                          :check-fill-pointer t)
2075          (labels
2076              ((output-seq-in-loop ()
2077                 (let ((write-function
2078                        (if (subtypep (stream-element-type stream) 'character)
2079                            (lambda (stream object)
2080                              ;; This might be a bivalent stream, so we need
2081                              ;; to dispatch on a per-element basis, rather
2082                              ;; than just based on the sequence or stream
2083                              ;; element types.
2084                              (if (characterp object)
2085                                  (funcall (ansi-stream-out stream)
2086                                           stream object)
2087                                  (funcall (ansi-stream-bout stream)
2088                                           stream object)))
2089                            (ansi-stream-bout stream))))
2090                   (do ((i offset-start (1+ i)))
2091                       ((>= i offset-end))
2092                     (declare (type index i))
2093                     (funcall write-function stream (aref data i))))))
2094            (if (and (fd-stream-p stream)
2095                     (compatible-vector-and-stream-element-types-p data stream))
2096                (buffer-output stream data offset-start offset-end)
2097                (output-seq-in-loop)))))))
2098   seq)
2099 \f
2100 ;;;; etc.