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 "~S is closed." stream))
  57 (defun no-op-placeholder (&rest ignore)
  58   (declare (ignore ignore)))
  59 \f
  60 ;;; stream manipulation functions
  61
  62 (declaim (inline ansi-stream-input-stream-p))
  63 (defun ansi-stream-input-stream-p (stream)
  64   (declare (type ansi-stream stream))
  65
  66   (when (synonym-stream-p stream)
  67     (setf stream
  68           (symbol-value (synonym-stream-symbol stream))))
  69
  70   (and (not (eq (ansi-stream-in stream) #'closed-flame))
  71        ;;; KLUDGE: It's probably not good to have EQ tests on function
  72        ;;; values like this. What if someone's redefined the function?
  73        ;;; Is there a better way? (Perhaps just VALID-FOR-INPUT and
  74        ;;; VALID-FOR-OUTPUT flags? -- WHN 19990902
  75        (or (not (eq (ansi-stream-in stream) #'ill-in))
  76            (not (eq (ansi-stream-bin stream) #'ill-bin)))))
  77
  78 (defun input-stream-p (stream)
  79   (declare (type stream stream))
  80   (and (ansi-stream-p stream)
  81        (ansi-stream-input-stream-p stream)))
  82
  83 (declaim (inline ansi-stream-output-stream-p))
  84 (defun ansi-stream-output-stream-p (stream)
  85   (declare (type ansi-stream stream))
  86
  87   (when (synonym-stream-p stream)
  88     (setf stream (symbol-value
  89                   (synonym-stream-symbol stream))))
  90
  91   (and (not (eq (ansi-stream-in stream) #'closed-flame))
  92        (or (not (eq (ansi-stream-out stream) #'ill-out))
  93            (not (eq (ansi-stream-bout stream) #'ill-bout)))))
  94
  95 (defun output-stream-p (stream)
  96   (declare (type stream stream))
  97
  98   (and (ansi-stream-p stream)
  99        (ansi-stream-output-stream-p stream)))
 100
 101 (declaim (inline ansi-stream-open-stream-p))
 102 (defun ansi-stream-open-stream-p (stream)
 103   (declare (type ansi-stream stream))
 104   ;; CLHS 22.1.4 lets us not worry about synonym streams here.
 105   (not (eq (ansi-stream-in stream) #'closed-flame)))
 106
 107 (defun open-stream-p (stream)
 108   (ansi-stream-open-stream-p stream))
 109
 110 (declaim (inline ansi-stream-element-type))
 111 (defun ansi-stream-element-type (stream)
 112   (declare (type ansi-stream stream))
 113   (funcall (ansi-stream-misc stream) stream :element-type))
 114
 115 (defun stream-element-type (stream)
 116   (ansi-stream-element-type stream))
 117
 118 (defun interactive-stream-p (stream)
 119   (declare (type stream stream))
 120   (funcall (ansi-stream-misc stream) stream :interactive-p))
 121
 122 (declaim (inline ansi-stream-close))
 123 (defun ansi-stream-close (stream abort)
 124   (declare (type ansi-stream stream))
 125   (when (open-stream-p stream)
 126     (funcall (ansi-stream-misc stream) stream :close abort))
 127   t)
 128
 129 (defun close (stream &key abort)
 130   (ansi-stream-close stream abort))
 131
 132 (defun set-closed-flame (stream)
 133   (setf (ansi-stream-in stream) #'closed-flame)
 134   (setf (ansi-stream-bin stream) #'closed-flame)
 135   (setf (ansi-stream-n-bin stream) #'closed-flame)
 136   (setf (ansi-stream-in stream) #'closed-flame)
 137   (setf (ansi-stream-out stream) #'closed-flame)
 138   (setf (ansi-stream-bout stream) #'closed-flame)
 139   (setf (ansi-stream-sout stream) #'closed-flame)
 140   (setf (ansi-stream-misc stream) #'closed-flame))
 141 \f
 142 ;;;; file position and file length
 143
 144 ;;; Call the MISC method with the :FILE-POSITION operation.
 145 (defun file-position (stream &optional position)
 146   (declare (type stream stream))
 147   (declare (type (or index (alien sb!unix:off-t) (member nil :start :end)) position))
 148   (cond
 149    (position
 150     (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 151     (funcall (ansi-stream-misc stream) stream :file-position position))
 152    (t
 153     (let ((res (funcall (ansi-stream-misc stream) stream :file-position nil)))
 154       (when res
 155         (- res
 156            (- +ansi-stream-in-buffer-length+
 157               (ansi-stream-in-index stream))))))))
 158
 159 ;;; This is a literal translation of the ANSI glossary entry "stream
 160 ;;; associated with a file".
 161 ;;;
 162 ;;; KLUDGE: Note that since Unix famously thinks "everything is a
 163 ;;; file", and in particular stdin, stdout, and stderr are files, we
 164 ;;; end up with this test being satisfied for weird things like
 165 ;;; *STANDARD-OUTPUT* (to a tty). That seems unlikely to be what the
 166 ;;; ANSI spec really had in mind, especially since this is used as a
 167 ;;; qualification for operations like FILE-LENGTH (so that ANSI was
 168 ;;; probably thinking of something like what Unix calls block devices)
 169 ;;; but I can't see any better way to do it. -- WHN 2001-04-14
 170 (defun stream-associated-with-file-p (x)
 171   "Test for the ANSI concept \"stream associated with a file\"."
 172   (or (typep x 'file-stream)
 173       (and (synonym-stream-p x)
 174            (stream-associated-with-file-p (symbol-value
 175                                            (synonym-stream-symbol x))))))
 176
 177 (defun stream-must-be-associated-with-file (stream)
 178   (declare (type stream stream))
 179   (unless (stream-associated-with-file-p stream)
 180     (error 'simple-type-error
 181            ;; KLUDGE: The ANSI spec for FILE-LENGTH specifically says
 182            ;; this should be TYPE-ERROR. But what then can we use for
 183            ;; EXPECTED-TYPE? This SATISFIES type (with a nonstandard
 184            ;; private predicate function..) is ugly and confusing, but
 185            ;; I can't see any other way. -- WHN 2001-04-14
 186            :expected-type '(satisfies stream-associated-with-file-p)
 187            :format-control
 188            "~@<The stream ~2I~_~S ~I~_isn't associated with a file.~:>"
 189            :format-arguments (list stream))))
 190
 191 ;;; like FILE-POSITION, only using :FILE-LENGTH
 192 (defun file-length (stream)
 193   ;; FIXME: The following declaration uses yet undefined types, which
 194   ;; cause cross-compiler hangup.
 195   ;;
 196   ;; (declare (type (or file-stream synonym-stream) stream))
 197   (stream-must-be-associated-with-file stream)
 198   (funcall (ansi-stream-misc stream) stream :file-length))
 199 \f
 200 ;;;; input functions
 201
 202 (defun read-line (&optional (stream *standard-input*) (eof-error-p t) eof-value
 203                             recursive-p)
 204   (declare (ignore recursive-p))
 205   (let ((stream (in-synonym-of stream)))
 206     (if (ansi-stream-p stream)
 207         (prepare-for-fast-read-char stream
 208           (let ((res (make-string 80))
 209                 (len 80)
 210                 (index 0))
 211             (loop
 212              (let ((ch (fast-read-char nil nil)))
 213                (cond (ch
 214                       (when (char= ch #\newline)
 215                         (done-with-fast-read-char)
 216                         (return (values (shrink-vector res index) nil)))
 217                       (when (= index len)
 218                         (setq len (* len 2))
 219                         (let ((new (make-string len)))
 220                           (replace new res)
 221                           (setq res new)))
 222                       (setf (schar res index) ch)
 223                       (incf index))
 224                      ((zerop index)
 225                       (done-with-fast-read-char)
 226                       (return (values (eof-or-lose stream
 227                                                    eof-error-p
 228                                                    eof-value)
 229                                       t)))
 230                      ;; Since FAST-READ-CHAR already hit the eof char, we
 231                      ;; shouldn't do another READ-CHAR.
 232                      (t
 233                       (done-with-fast-read-char)
 234                       (return (values (shrink-vector res index) t))))))))
 235         ;; must be Gray streams FUNDAMENTAL-STREAM
 236         (multiple-value-bind (string eof) (stream-read-line stream)
 237           (if (and eof (zerop (length string)))
 238               (values (eof-or-lose stream eof-error-p eof-value) t)
 239               (values string eof))))))
 240
 241 ;;; We proclaim them INLINE here, then proclaim them MAYBE-INLINE at EOF,
 242 ;;; so, except in this file, they are not inline by default, but they can be.
 243 #!-sb-fluid (declaim (inline read-char unread-char read-byte listen))
 244
 245 (defun read-char (&optional (stream *standard-input*)
 246                             (eof-error-p t)
 247                             eof-value
 248                             recursive-p)
 249   (declare (ignore recursive-p))
 250   (let ((stream (in-synonym-of stream)))
 251     (if (ansi-stream-p stream)
 252         (prepare-for-fast-read-char stream
 253           (prog1
 254               (fast-read-char eof-error-p eof-value)
 255             (done-with-fast-read-char)))
 256         ;; must be Gray streams FUNDAMENTAL-STREAM
 257         (let ((char (stream-read-char stream)))
 258           (if (eq char :eof)
 259               (eof-or-lose stream eof-error-p eof-value)
 260               char)))))
 261
 262 (defun unread-char (character &optional (stream *standard-input*))
 263   (let ((stream (in-synonym-of stream)))
 264     (if (ansi-stream-p stream)
 265         (let ((index (1- (ansi-stream-in-index stream)))
 266               (buffer (ansi-stream-in-buffer stream)))
 267           (declare (fixnum index))
 268           (when (minusp index) (error "nothing to unread"))
 269           (cond (buffer
 270                  (setf (aref buffer index) (char-code character))
 271                  (setf (ansi-stream-in-index stream) index))
 272                 (t
 273                  (funcall (ansi-stream-misc stream) stream
 274                           :unread character))))
 275         ;; must be Gray streams FUNDAMENTAL-STREAM
 276         (stream-unread-char stream character)))
 277   nil)
 278
 279 (defun listen (&optional (stream *standard-input*))
 280   (let ((stream (in-synonym-of stream)))
 281     (if (ansi-stream-p stream)
 282         (or (/= (the fixnum (ansi-stream-in-index stream))
 283                 +ansi-stream-in-buffer-length+)
 284             ;; Test for T explicitly since misc methods return :EOF sometimes.
 285             (eq (funcall (ansi-stream-misc stream) stream :listen) t))
 286         ;; Fall through to Gray streams FUNDAMENTAL-STREAM case.
 287         (stream-listen stream))))
 288
 289 (defun read-char-no-hang (&optional (stream *standard-input*)
 290                                     (eof-error-p t)
 291                                     eof-value
 292                                     recursive-p)
 293   (declare (ignore recursive-p))
 294   (let ((stream (in-synonym-of stream)))
 295     (if (ansi-stream-p stream)
 296         (if (funcall (ansi-stream-misc stream) stream :listen)
 297             ;; On T or :EOF get READ-CHAR to do the work.
 298             (read-char stream eof-error-p eof-value)
 299             nil)
 300         ;; must be Gray streams FUNDAMENTAL-STREAM
 301         (let ((char (stream-read-char-no-hang stream)))
 302           (if (eq char :eof)
 303               (eof-or-lose stream eof-error-p eof-value)
 304               char)))))
 305
 306 (defun clear-input (&optional (stream *standard-input*))
 307   (let ((stream (in-synonym-of stream)))
 308     (cond ((ansi-stream-p stream)
 309            (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 310            (funcall (ansi-stream-misc stream) stream :clear-input))
 311           (t
 312            (stream-clear-input stream))))
 313   nil)
 314 \f
 315 (declaim (maybe-inline read-byte))
 316 (defun read-byte (stream &optional (eof-error-p t) eof-value)
 317   (let ((stream (in-synonym-of stream)))
 318     (if (ansi-stream-p stream)
 319         (prepare-for-fast-read-byte stream
 320           (prog1
 321               (fast-read-byte eof-error-p eof-value t)
 322             (done-with-fast-read-byte)))
 323         ;; must be Gray streams FUNDAMENTAL-STREAM
 324         (let ((char (stream-read-byte stream)))
 325           (if (eq char :eof)
 326               (eof-or-lose stream eof-error-p eof-value)
 327               char)))))
 328
 329 ;;; Read NUMBYTES bytes into BUFFER beginning at START, and return the
 330 ;;; number of bytes read.
 331 ;;;
 332 ;;; Note: CMU CL's version of this had a special interpretation of
 333 ;;; EOF-ERROR-P which SBCL does not have. (In the EOF-ERROR-P=NIL
 334 ;;; case, CMU CL's version would return as soon as any data became
 335 ;;; available.) This could be useful behavior for things like pipes in
 336 ;;; some cases, but it wasn't being used in SBCL, so it was dropped.
 337 ;;; If we ever need it, it could be added later as a new variant N-BIN
 338 ;;; method (perhaps N-BIN-ASAP?) or something.
 339 (defun read-n-bytes (stream buffer start numbytes &optional (eof-error-p t))
 340   (declare (type ansi-stream stream)
 341            (type index numbytes start)
 342            (type (or (simple-array * (*)) system-area-pointer) buffer))
 343   (let* ((stream (in-synonym-of stream ansi-stream))
 344          (in-buffer (ansi-stream-in-buffer stream))
 345          (index (ansi-stream-in-index stream))
 346          (num-buffered (- +ansi-stream-in-buffer-length+ index)))
 347     (declare (fixnum index num-buffered))
 348     (cond
 349      ((not in-buffer)
 350       (funcall (ansi-stream-n-bin stream)
 351                stream
 352                buffer
 353                start
 354                numbytes
 355                eof-error-p))
 356      ((<= numbytes num-buffered)
 357       (%byte-blt in-buffer index
 358                  buffer start (+ start numbytes))
 359       (setf (ansi-stream-in-index stream) (+ index numbytes))
 360       numbytes)
 361      (t
 362       (let ((end (+ start num-buffered)))
 363         (%byte-blt in-buffer index buffer start end)
 364         (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 365         (+ (funcall (ansi-stream-n-bin stream)
 366                     stream
 367                     buffer
 368                     end
 369                     (- numbytes num-buffered)
 370                     eof-error-p)
 371            num-buffered))))))
 372
 373 ;;; the amount of space we leave at the start of the in-buffer for
 374 ;;; unreading
 375 ;;;
 376 ;;; (It's 4 instead of 1 to allow word-aligned copies.)
 377 (defconstant +ansi-stream-in-buffer-extra+
 378   4) ; FIXME: should be symbolic constant
 379
 380 ;;; This function is called by the FAST-READ-CHAR expansion to refill
 381 ;;; the IN-BUFFER for text streams. There is definitely an IN-BUFFER,
 382 ;;; and hence must be an N-BIN method.
 383 (defun fast-read-char-refill (stream eof-error-p eof-value)
 384   (let* ((ibuf (ansi-stream-in-buffer stream))
 385          (count (funcall (ansi-stream-n-bin stream)
 386                          stream
 387                          ibuf
 388                          +ansi-stream-in-buffer-extra+
 389                          (- +ansi-stream-in-buffer-length+
 390                             +ansi-stream-in-buffer-extra+)
 391                          nil))
 392          (start (- +ansi-stream-in-buffer-length+ count)))
 393     (declare (type index start count))
 394     (cond ((zerop count)
 395            (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 396            (funcall (ansi-stream-in stream) stream eof-error-p eof-value))
 397           (t
 398            (when (/= start +ansi-stream-in-buffer-extra+)
 399              (bit-bash-copy ibuf (+ (* +ansi-stream-in-buffer-extra+
 400                                        sb!vm:n-byte-bits)
 401                                     (* sb!vm:vector-data-offset
 402                                        sb!vm:n-word-bits))
 403                             ibuf (+ (the index (* start sb!vm:n-byte-bits))
 404                                     (* sb!vm:vector-data-offset
 405                                        sb!vm:n-word-bits))
 406                             (* count sb!vm:n-byte-bits)))
 407            (setf (ansi-stream-in-index stream) (1+ start))
 408            (code-char (aref ibuf start))))))
 409
 410 ;;; This is similar to FAST-READ-CHAR-REFILL, but we don't have to
 411 ;;; leave room for unreading.
 412 (defun fast-read-byte-refill (stream eof-error-p eof-value)
 413   (let* ((ibuf (ansi-stream-in-buffer stream))
 414          (count (funcall (ansi-stream-n-bin stream) stream
 415                          ibuf 0 +ansi-stream-in-buffer-length+
 416                          nil))
 417          (start (- +ansi-stream-in-buffer-length+ count)))
 418     (declare (type index start count))
 419     (cond ((zerop count)
 420            (setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
 421            (funcall (ansi-stream-bin stream) stream eof-error-p eof-value))
 422           (t
 423            (unless (zerop start)
 424              (bit-bash-copy ibuf (* sb!vm:vector-data-offset sb!vm:n-word-bits)
 425                             ibuf (+ (the index (* start sb!vm:n-byte-bits))
 426                                     (* sb!vm:vector-data-offset
 427                                        sb!vm:n-word-bits))
 428                             (* count sb!vm:n-byte-bits)))
 429            (setf (ansi-stream-in-index stream) (1+ start))
 430            (aref ibuf start)))))
 431 \f
 432 ;;; output functions
 433
 434 (defun write-char (character &optional (stream *standard-output*))
 435   (with-out-stream stream (ansi-stream-out character)
 436                    (stream-write-char character))
 437   character)
 438
 439 (defun terpri (&optional (stream *standard-output*))
 440   (with-out-stream stream (ansi-stream-out #\newline) (stream-terpri))
 441   nil)
 442
 443 (defun fresh-line (&optional (stream *standard-output*))
 444   (let ((stream (out-synonym-of stream)))
 445     (if (ansi-stream-p stream)
 446         (when (/= (or (charpos stream) 1) 0)
 447           (funcall (ansi-stream-out stream) stream #\newline)
 448           t)
 449         ;; must be Gray streams FUNDAMENTAL-STREAM
 450         (stream-fresh-line stream))))
 451
 452 (defun write-string (string &optional (stream *standard-output*)
 453                             &key (start 0) end)
 454   (declare (type string string))
 455   ;; Note that even though you might expect, based on the behavior of
 456   ;; things like AREF, that the correct upper bound here is
 457   ;; (ARRAY-DIMENSION STRING 0), the ANSI glossary definitions for
 458   ;; "bounding index" and "length" indicate that in this case (i.e.
 459   ;; for the ANSI-specified functions WRITE-STRING [and WRITE-LINE]),
 460   ;; (LENGTH STRING) is the required upper bound. A foolish
 461   ;; consistency is the hobgoblin of lesser languages..
 462   (%write-string string stream start (%check-vector-sequence-bounds
 463                                       string start end))
 464   string)
 465
 466 (defun %write-string (string stream start end)
 467   (declare (type string string))
 468   (declare (type stream-designator stream))
 469   (declare (type index start end))
 470   (let ((stream (out-synonym-of stream)))
 471     (cond ((ansi-stream-p stream)
 472            (if (array-header-p string)
 473                (with-array-data ((data string) (offset-start start)
 474                                  (offset-end end))
 475                  (funcall (ansi-stream-sout stream)
 476                           stream data offset-start offset-end))
 477                (funcall (ansi-stream-sout stream) stream string start end))
 478            string)
 479           (t ; must be Gray streams FUNDAMENTAL-STREAM
 480            (stream-write-string stream string start end)))))
 481
 482 ;;; A wrapper function for all those (MACROLET OUT-FUN) definitions,
 483 ;;; which cannot deal with keyword arguments.
 484 (declaim (inline write-string-no-key))
 485 (defun write-string-no-key (string stream start end)
 486   (write-string string stream :start start :end end))
 487
 488 (defun write-line (string &optional (stream *standard-output*)
 489                           &key (start 0) end)
 490   (declare (type string string))
 491   ;; FIXME: Why is there this difference between the treatments of the
 492   ;; STREAM argument in WRITE-STRING and WRITE-LINE?
 493   (let ((defaulted-stream (out-synonym-of stream)))
 494     (%write-string string defaulted-stream start (%check-vector-sequence-bounds
 495                                                   string start end))
 496     (write-char #\newline defaulted-stream))
 497   string)
 498
 499 (defun charpos (&optional (stream *standard-output*))
 500   (with-out-stream stream (ansi-stream-misc :charpos) (stream-line-column)))
 501
 502 (defun line-length (&optional (stream *standard-output*))
 503   (with-out-stream stream (ansi-stream-misc :line-length)
 504                    (stream-line-length)))
 505
 506 (defun finish-output (&optional (stream *standard-output*))
 507   (with-out-stream stream (ansi-stream-misc :finish-output)
 508                    (stream-finish-output))
 509   nil)
 510
 511 (defun force-output (&optional (stream *standard-output*))
 512   (with-out-stream stream (ansi-stream-misc :force-output)
 513                    (stream-force-output))
 514   nil)
 515
 516 (defun clear-output (&optional (stream *standard-output*))
 517   (with-out-stream stream (ansi-stream-misc :clear-output)
 518                    (stream-force-output))
 519   nil)
 520
 521 (defun write-byte (integer stream)
 522   (with-out-stream stream (ansi-stream-bout integer)
 523                    (stream-write-byte integer))
 524   integer)
 525 \f
 526
 527 ;;; (These were inline throughout this file, but that's not appropriate
 528 ;;; globally.  And we must not inline them in the rest of this file if
 529 ;;; dispatch to gray or simple streams is to work, since both redefine
 530 ;;; these functions later.)
 531 (declaim (maybe-inline read-char unread-char read-byte listen))
 532
 533 ;;; This is called from ANSI-STREAM routines that encapsulate CLOS
 534 ;;; streams to handle the misc routines and dispatch to the
 535 ;;; appropriate SIMPLE- or FUNDAMENTAL-STREAM functions.
 536 (defun stream-misc-dispatch (stream operation &optional arg1 arg2)
 537   (declare (type stream stream) (ignore arg2))
 538   (ecase operation
 539     (:listen
 540      ;; Return T if input available, :EOF for end-of-file, otherwise NIL.
 541      (let ((char (read-char-no-hang stream nil :eof)))
 542        (when (characterp char)
 543          (unread-char char stream))
 544        char))
 545     (:unread
 546      (unread-char arg1 stream))
 547     (:close
 548      (close stream))
 549     (:clear-input
 550      (clear-input stream))
 551     (:force-output
 552      (force-output stream))
 553     (:finish-output
 554      (finish-output stream))
 555     (:element-type
 556      (stream-element-type stream))
 557     (:interactive-p
 558      (interactive-stream-p stream))
 559     (:line-length
 560      (line-length stream))
 561     (:charpos
 562      (charpos stream))
 563     (:file-length
 564      (file-length stream))
 565     (:file-position
 566      (file-position stream arg1))))
 567 \f
 568 ;;;; broadcast streams
 569
 570 (defstruct (broadcast-stream (:include ansi-stream
 571                                        (out #'broadcast-out)
 572                                        (bout #'broadcast-bout)
 573                                        (sout #'broadcast-sout)
 574                                        (misc #'broadcast-misc))
 575                              (:constructor %make-broadcast-stream
 576                                            (&rest streams))
 577                              (:copier nil))
 578   ;; a list of all the streams we broadcast to
 579   (streams () :type list :read-only t))
 580
 581 (defun make-broadcast-stream (&rest streams)
 582   (dolist (stream streams)
 583     (unless (output-stream-p stream)
 584       (error 'type-error
 585              :datum stream
 586              :expected-type '(satisfies output-stream-p))))
 587   (apply #'%make-broadcast-stream streams))
 588
 589 (macrolet ((out-fun (name fun &rest args)
 590              `(defun ,name (stream ,@args)
 591                 (dolist (stream (broadcast-stream-streams stream))
 592                   (,fun ,(car args) stream ,@(cdr args))))))
 593   (out-fun broadcast-out write-char char)
 594   (out-fun broadcast-bout write-byte byte)
 595   (out-fun broadcast-sout write-string-no-key string start end))
 596
 597 (defun broadcast-misc (stream operation &optional arg1 arg2)
 598   (let ((streams (broadcast-stream-streams stream)))
 599     (case operation
 600       ;; FIXME: This may not be the best place to note this, but I
 601       ;; think the :CHARPOS protocol needs revision.  Firstly, I think
 602       ;; this is the last place where a NULL return value was possible
 603       ;; (before adjusting it to be 0), so a bunch of conditionals IF
 604       ;; CHARPOS can be removed; secondly, it is my belief that
 605       ;; FD-STREAMS, when running FILE-POSITION, do not update the
 606       ;; CHARPOS, and consequently there will be much wrongness.
 607       ;;
 608       ;; FIXME: see also TWO-WAY-STREAM treatment of :CHARPOS -- why
 609       ;; is it testing the :charpos of an input stream?
 610       ;;
 611       ;; -- CSR, 2004-02-04
 612       (:charpos
 613        (dolist (stream streams 0)
 614          (let ((charpos (charpos stream)))
 615            (if charpos (return charpos)))))
 616       (:line-length
 617        (let ((min nil))
 618          (dolist (stream streams min)
 619            (let ((res (line-length stream)))
 620              (when res (setq min (if min (min res min) res)))))))
 621       (:element-type
 622        #+nil ; old, arguably more logical, version
 623        (let (res)
 624          (dolist (stream streams (if (> (length res) 1) `(and ,@res) t))
 625            (pushnew (stream-element-type stream) res :test #'equal)))
 626        ;; ANSI-specified version (under System Class BROADCAST-STREAM)
 627        (let ((res t))
 628          (do ((streams streams (cdr streams)))
 629              ((null streams) res)
 630            (when (null (cdr streams))
 631              (setq res (stream-element-type (car streams)))))))
 632       (:close
 633        (set-closed-flame stream))
 634       (t
 635        (let ((res nil))
 636          (dolist (stream streams res)
 637            (setq res
 638                  (if (ansi-stream-p stream)
 639                      (funcall (ansi-stream-misc stream) stream operation
 640                               arg1 arg2)
 641                      (stream-misc-dispatch stream operation arg1 arg2)))))))))
 642 \f
 643 ;;;; synonym streams
 644
 645 (defstruct (synonym-stream (:include ansi-stream
 646                                      (in #'synonym-in)
 647                                      (bin #'synonym-bin)
 648                                      (n-bin #'synonym-n-bin)
 649                                      (out #'synonym-out)
 650                                      (bout #'synonym-bout)
 651                                      (sout #'synonym-sout)
 652                                      (misc #'synonym-misc))
 653                            (:constructor make-synonym-stream (symbol))
 654                            (:copier nil))
 655   ;; This is the symbol, the value of which is the stream we are synonym to.
 656   (symbol nil :type symbol :read-only t))
 657 (def!method print-object ((x synonym-stream) stream)
 658   (print-unreadable-object (x stream :type t :identity t)
 659     (format stream ":SYMBOL ~S" (synonym-stream-symbol x))))
 660
 661 ;;; The output simple output methods just call the corresponding
 662 ;;; function on the synonymed stream.
 663 (macrolet ((out-fun (name fun &rest args)
 664              `(defun ,name (stream ,@args)
 665                 (declare (optimize (safety 1)))
 666                 (let ((syn (symbol-value (synonym-stream-symbol stream))))
 667                   (,fun ,(car args) syn ,@(cdr args))))))
 668   (out-fun synonym-out write-char ch)
 669   (out-fun synonym-bout write-byte n)
 670   (out-fun synonym-sout write-string-no-key string start end))
 671
 672 ;;; For the input methods, we just call the corresponding function on the
 673 ;;; synonymed stream. These functions deal with getting input out of
 674 ;;; the In-Buffer if there is any.
 675 (macrolet ((in-fun (name fun &rest args)
 676              `(defun ,name (stream ,@args)
 677                 (declare (optimize (safety 1)))
 678                 (,fun (symbol-value (synonym-stream-symbol stream))
 679                       ,@args))))
 680   (in-fun synonym-in read-char eof-error-p eof-value)
 681   (in-fun synonym-bin read-byte eof-error-p eof-value)
 682   (in-fun synonym-n-bin read-n-bytes buffer start numbytes eof-error-p))
 683
 684 (defun synonym-misc (stream operation &optional arg1 arg2)
 685   (declare (optimize (safety 1)))
 686   (let ((syn (symbol-value (synonym-stream-symbol stream))))
 687     (if (ansi-stream-p syn)
 688         ;; We have to special-case some operations which interact with
 689         ;; the in-buffer of the wrapped stream, since just calling
 690         ;; ANSI-STREAM-MISC on them
 691         (case operation
 692           (:listen (or (/= (the fixnum (ansi-stream-in-index syn))
 693                            +ansi-stream-in-buffer-length+)
 694                        (funcall (ansi-stream-misc syn) syn :listen)))
 695           (:clear-input (clear-input syn))
 696           (:unread (unread-char arg1 syn))
 697           (t
 698            (funcall (ansi-stream-misc syn) syn operation arg1 arg2)))
 699         (stream-misc-dispatch syn operation arg1 arg2))))
 700 \f
 701 ;;;; two-way streams
 702
 703 (defstruct (two-way-stream
 704             (:include ansi-stream
 705                       (in #'two-way-in)
 706                       (bin #'two-way-bin)
 707                       (n-bin #'two-way-n-bin)
 708                       (out #'two-way-out)
 709                       (bout #'two-way-bout)
 710                       (sout #'two-way-sout)
 711                       (misc #'two-way-misc))
 712             (:constructor %make-two-way-stream (input-stream output-stream))
 713             (:copier nil))
 714   (input-stream (missing-arg) :type stream :read-only t)
 715   (output-stream (missing-arg) :type stream :read-only t))
 716 (defprinter (two-way-stream) input-stream output-stream)
 717
 718 (defun make-two-way-stream (input-stream output-stream)
 719   #!+sb-doc
 720   "Return a bidirectional stream which gets its input from INPUT-STREAM and
 721    sends its output to OUTPUT-STREAM."
 722   ;; FIXME: This idiom of the-real-stream-of-a-possibly-synonym-stream
 723   ;; should be encapsulated in a function, and used here and most of
 724   ;; the other places that SYNONYM-STREAM-P appears.
 725   (unless (output-stream-p output-stream)
 726     (error 'type-error
 727            :datum output-stream
 728            :expected-type '(satisfies output-stream-p)))
 729   (unless (input-stream-p input-stream)
 730     (error 'type-error
 731            :datum input-stream
 732            :expected-type '(satisfies input-stream-p)))
 733   (funcall #'%make-two-way-stream input-stream output-stream))
 734
 735 (macrolet ((out-fun (name fun &rest args)
 736              `(defun ,name (stream ,@args)
 737                 (let ((syn (two-way-stream-output-stream stream)))
 738                   (,fun ,(car args) syn ,@(cdr args))))))
 739   (out-fun two-way-out write-char ch)
 740   (out-fun two-way-bout write-byte n)
 741   (out-fun two-way-sout write-string-no-key string start end))
 742
 743 (macrolet ((in-fun (name fun &rest args)
 744              `(defun ,name (stream ,@args)
 745                 (force-output (two-way-stream-output-stream stream))
 746                 (,fun (two-way-stream-input-stream stream) ,@args))))
 747   (in-fun two-way-in read-char eof-error-p eof-value)
 748   (in-fun two-way-bin read-byte eof-error-p eof-value)
 749   (in-fun two-way-n-bin read-n-bytes buffer start numbytes eof-error-p))
 750
 751 (defun two-way-misc (stream operation &optional arg1 arg2)
 752   (let* ((in (two-way-stream-input-stream stream))
 753          (out (two-way-stream-output-stream stream))
 754          (in-ansi-stream-p (ansi-stream-p in))
 755          (out-ansi-stream-p (ansi-stream-p out)))
 756     (case operation
 757       (:listen
 758        (if in-ansi-stream-p
 759            (or (/= (the fixnum (ansi-stream-in-index in))
 760                    +ansi-stream-in-buffer-length+)
 761                (funcall (ansi-stream-misc in) in :listen))
 762            (stream-listen in)))
 763       ((:finish-output :force-output :clear-output)
 764        (if out-ansi-stream-p
 765            (funcall (ansi-stream-misc out) out operation arg1 arg2)
 766            (stream-misc-dispatch out operation arg1 arg2)))
 767       (:clear-input (clear-input in))
 768       (:unread (unread-char arg1 in))
 769       (:element-type
 770        (let ((in-type (stream-element-type in))
 771              (out-type (stream-element-type out)))
 772          (if (equal in-type out-type)
 773              in-type `(and ,in-type ,out-type))))
 774       (:close
 775        (set-closed-flame stream))
 776       (t
 777        (or (if in-ansi-stream-p
 778                (funcall (ansi-stream-misc in) in operation arg1 arg2)
 779                (stream-misc-dispatch in operation arg1 arg2))
 780            (if out-ansi-stream-p
 781                (funcall (ansi-stream-misc out) out operation arg1 arg2)
 782                (stream-misc-dispatch out operation arg1 arg2)))))))
 783 \f
 784 ;;;; concatenated streams
 785
 786 (defstruct (concatenated-stream
 787             (:include ansi-stream
 788                       (in #'concatenated-in)
 789                       (bin #'concatenated-bin)
 790                       (n-bin #'concatenated-n-bin)
 791                       (misc #'concatenated-misc))
 792             (:constructor %make-concatenated-stream
 793                           (&rest streams &aux (current streams)))
 794             (:copier nil))
 795   ;; The car of this is the substream we are reading from now.
 796   (streams nil :type list))
 797 (def!method print-object ((x concatenated-stream) stream)
 798   (print-unreadable-object (x stream :type t :identity t)
 799     (format stream
 800             ":STREAMS ~S"
 801             (concatenated-stream-streams x))))
 802
 803 (defun make-concatenated-stream (&rest streams)
 804   #!+sb-doc
 805   "Return a stream which takes its input from each of the streams in turn,
 806    going on to the next at EOF."
 807   (dolist (stream streams)
 808     (unless (input-stream-p stream)
 809       (error 'type-error
 810              :datum stream
 811              :expected-type '(satisfies input-stream-p))))
 812   (apply #'%make-concatenated-stream streams))
 813
 814 (macrolet ((in-fun (name fun)
 815              `(defun ,name (stream eof-error-p eof-value)
 816                 (do ((streams (concatenated-stream-streams stream)
 817                               (cdr streams)))
 818                     ((null streams)
 819                      (eof-or-lose stream eof-error-p eof-value))
 820                   (let* ((stream (car streams))
 821                          (result (,fun stream nil nil)))
 822                     (when result (return result)))
 823                   (pop (concatenated-stream-streams stream))))))
 824   (in-fun concatenated-in read-char)
 825   (in-fun concatenated-bin read-byte))
 826
 827 (defun concatenated-n-bin (stream buffer start numbytes eof-errorp)
 828   (do ((streams (concatenated-stream-streams stream) (cdr streams))
 829        (current-start start)
 830        (remaining-bytes numbytes))
 831       ((null streams)
 832        (if eof-errorp
 833            (error 'end-of-file :stream stream)
 834            (- numbytes remaining-bytes)))
 835     (let* ((stream (car streams))
 836            (bytes-read (read-n-bytes stream buffer current-start
 837                                      remaining-bytes nil)))
 838       (incf current-start bytes-read)
 839       (decf remaining-bytes bytes-read)
 840       (when (zerop remaining-bytes) (return numbytes)))
 841     (setf (concatenated-stream-streams stream) (cdr streams))))
 842
 843 (defun concatenated-misc (stream operation &optional arg1 arg2)
 844   (let* ((left (concatenated-stream-streams stream))
 845          (current (car left)))
 846     (case operation
 847       (:listen
 848        (unless left
 849          (return-from concatenated-misc :eof))
 850        (loop
 851         (let ((stuff (if (ansi-stream-p current)
 852                          (funcall (ansi-stream-misc current) current
 853                                   :listen)
 854                          (stream-misc-dispatch current :listen))))
 855           (cond ((eq stuff :eof)
 856                  ;; Advance STREAMS, and try again.
 857                  (pop (concatenated-stream-streams stream))
 858                  (setf current
 859                        (car (concatenated-stream-streams stream)))
 860                  (unless current
 861                    ;; No further streams. EOF.
 862                    (return :eof)))
 863                 (stuff
 864                  ;; Stuff's available.
 865                  (return t))
 866                 (t
 867                  ;; Nothing is available yet.
 868                  (return nil))))))
 869       (:clear-input (when left (clear-input current)))
 870       (:unread (when left (unread-char arg1 current)))
 871       (:close
 872        (set-closed-flame stream))
 873       (t
 874        (when left
 875          (if (ansi-stream-p current)
 876              (funcall (ansi-stream-misc current) current operation arg1 arg2)
 877              (stream-misc-dispatch current operation arg1 arg2)))))))
 878 \f
 879 ;;;; echo streams
 880
 881 (defstruct (echo-stream
 882             (:include two-way-stream
 883                       (in #'echo-in)
 884                       (bin #'echo-bin)
 885                       (misc #'echo-misc)
 886                       (n-bin #'ill-bin))
 887             (:constructor %make-echo-stream (input-stream output-stream))
 888             (:copier nil))
 889   unread-stuff)
 890 (def!method print-object ((x echo-stream) stream)
 891   (print-unreadable-object (x stream :type t :identity t)
 892     (format stream
 893             ":INPUT-STREAM ~S :OUTPUT-STREAM ~S"
 894             (two-way-stream-input-stream x)
 895             (two-way-stream-output-stream x))))
 896
 897 (defun make-echo-stream (input-stream output-stream)
 898   #!+sb-doc
 899   "Return a bidirectional stream which gets its input from INPUT-STREAM and
 900    sends its output to OUTPUT-STREAM. In addition, all input is echoed to
 901    the output stream."
 902   (unless (output-stream-p output-stream)
 903     (error 'type-error
 904            :datum output-stream
 905            :expected-type '(satisfies output-stream-p)))
 906   (unless (input-stream-p input-stream)
 907     (error 'type-error
 908            :datum input-stream
 909            :expected-type '(satisfies input-stream-p)))
 910   (funcall #'%make-echo-stream input-stream output-stream))
 911
 912 (macrolet ((in-fun (name in-fun out-fun &rest args)
 913              `(defun ,name (stream ,@args)
 914                 (or (pop (echo-stream-unread-stuff stream))
 915                     (let* ((in (echo-stream-input-stream stream))
 916                            (out (echo-stream-output-stream stream))
 917                            (result (if eof-error-p
 918                                        (,in-fun in ,@args)
 919                                        (,in-fun in nil in))))
 920                       (cond
 921                         ((eql result in) eof-value)
 922                         (t (,out-fun result out) result)))))))
 923   (in-fun echo-in read-char write-char eof-error-p eof-value)
 924   (in-fun echo-bin read-byte write-byte eof-error-p eof-value))
 925 \f
 926 ;;;; base STRING-STREAM stuff
 927
 928 (defstruct (string-stream
 929              (:include ansi-stream)
 930              (:constructor nil)
 931              (:copier nil))
 932   ;; FIXME: This type declaration is true, and will probably continue
 933   ;; to be true.  However, note well the comments in DEFTRANSFORM
 934   ;; REPLACE, implying that performance of REPLACE is somewhat
 935   ;; critical to performance of string streams.  If (VECTOR CHARACTER)
 936   ;; ever becomes different from (VECTOR BASE-CHAR), the transform
 937   ;; probably needs to be extended.
 938   (string (missing-arg) :type (vector character)))
 939 \f
 940 ;;;; STRING-INPUT-STREAM stuff
 941
 942 (defstruct (string-input-stream
 943              (:include string-stream
 944                        (in #'string-inch)
 945                        (bin #'ill-bin)
 946                        (n-bin #'string-stream-read-n-bytes)
 947                        (misc #'string-in-misc)
 948                        (string (missing-arg) :type simple-string))
 949              (:constructor internal-make-string-input-stream
 950                            (string current end))
 951              (:copier nil))
 952   (current (missing-arg) :type index)
 953   (end (missing-arg) :type index))
 954
 955 (defun string-inch (stream eof-error-p eof-value)
 956   (declare (type string-input-stream stream))
 957   (let ((string (string-input-stream-string stream))
 958         (index (string-input-stream-current stream)))
 959     (cond ((>= index (the index (string-input-stream-end stream)))
 960            (eof-or-lose stream eof-error-p eof-value))
 961           (t
 962            (setf (string-input-stream-current stream) (1+ index))
 963            (char string index)))))
 964
 965 (defun string-binch (stream eof-error-p eof-value)
 966   (declare (type string-input-stream stream))
 967   (let ((string (string-input-stream-string stream))
 968         (index (string-input-stream-current stream)))
 969     (cond ((>= index (the index (string-input-stream-end stream)))
 970            (eof-or-lose stream eof-error-p eof-value))
 971           (t
 972            (setf (string-input-stream-current stream) (1+ index))
 973            (char-code (char string index))))))
 974
 975 (defun string-stream-read-n-bytes (stream buffer start requested eof-error-p)
 976   (declare (type string-input-stream stream)
 977            (type index start requested))
 978   (let* ((string (string-input-stream-string stream))
 979          (index (string-input-stream-current stream))
 980          (available (- (string-input-stream-end stream) index))
 981          (copy (min available requested)))
 982     (declare (type simple-string string))
 983     (when (plusp copy)
 984       (setf (string-input-stream-current stream)
 985             (truly-the index (+ index copy)))
 986       (sb!sys:without-gcing
 987        (system-area-copy (vector-sap string)
 988                          (* index sb!vm:n-byte-bits)
 989                          (if (typep buffer 'system-area-pointer)
 990                              buffer
 991                              (vector-sap buffer))
 992                          (* start sb!vm:n-byte-bits)
 993                          (* copy sb!vm:n-byte-bits))))
 994     (if (and (> requested copy) eof-error-p)
 995         (error 'end-of-file :stream stream)
 996         copy)))
 997
 998 (defun string-in-misc (stream operation &optional arg1 arg2)
 999   (declare (type string-input-stream stream)
1000            (ignore arg2))
1001   (case operation
1002     (:file-position
1003      (if arg1
1004          (setf (string-input-stream-current stream)
1005                (case arg1
1006                  (:start 0)
1007                  (:end (string-input-stream-end stream))
1008                  ;; We allow moving position beyond EOF. Errors happen
1009                  ;; on read, not move -- or the user may extend the
1010                  ;; input string.
1011                  (t arg1)))
1012          (string-input-stream-current stream)))
1013     ;; According to ANSI: "Should signal an error of type type-error
1014     ;; if stream is not a stream associated with a file."
1015     ;; This is checked by FILE-LENGTH, so no need to do it here either.
1016     ;; (:file-length (length (string-input-stream-string stream)))
1017     (:unread (decf (string-input-stream-current stream)))
1018     (:close (set-closed-flame stream))
1019     (:listen (or (/= (the index (string-input-stream-current stream))
1020                      (the index (string-input-stream-end stream)))
1021                  :eof))
1022     (:element-type (array-element-type (string-input-stream-string stream)))))
1023
1024 (defun make-string-input-stream (string &optional (start 0) end)
1025   #!+sb-doc
1026   "Return an input stream which will supply the characters of STRING between
1027   START and END in order."
1028   (declare (type string string)
1029            (type index start)
1030            (type (or index null) end))
1031   (let* ((string (coerce string '(simple-array character (*))))
1032          (end (%check-vector-sequence-bounds string start end)))
1033     (with-array-data ((string string) (start start) (end end))
1034       (internal-make-string-input-stream
1035        string ;; now simple
1036        start
1037        end))))
1038 \f
1039 ;;;; STRING-OUTPUT-STREAM stuff
1040
1041 (defstruct (string-output-stream
1042             (:include string-stream
1043                       (out #'string-ouch)
1044                       (sout #'string-sout)
1045                       (misc #'string-out-misc)
1046                       ;; The string we throw stuff in.
1047                       (string (missing-arg)
1048                               :type (simple-array character (*))))
1049             (:constructor make-string-output-stream
1050                           (&key (element-type 'character)
1051                            &aux (string (make-string 40))))
1052             (:copier nil))
1053   ;; Index of the next location to use.
1054   (index 0 :type fixnum)
1055   ;; Index cache for string-output-stream-last-index
1056   (index-cache 0 :type fixnum)
1057   ;; Requested element type
1058   (element-type 'character))
1059
1060 #!+sb-doc
1061 (setf (fdocumentation 'make-string-output-stream 'function)
1062   "Return an output stream which will accumulate all output given it for
1063    the benefit of the function GET-OUTPUT-STREAM-STRING.")
1064
1065 (defun string-output-stream-last-index (stream)
1066   (max (string-output-stream-index stream)
1067        (string-output-stream-index-cache stream)))
1068
1069 (defun string-ouch (stream character)
1070   (let ((current (string-output-stream-index stream))
1071         (workspace (string-output-stream-string stream)))
1072     (declare (type (simple-array character (*)) workspace)
1073              (type fixnum current))
1074     (if (= current (the fixnum (length workspace)))
1075         (let ((new-workspace (make-string (* current 2))))
1076           (replace new-workspace workspace)
1077           (setf (aref new-workspace current) character
1078                 (string-output-stream-string stream) new-workspace))
1079         (setf (aref workspace current) character))
1080     (setf (string-output-stream-index stream) (1+ current))))
1081
1082 (defun string-sout (stream string start end)
1083   (declare (type simple-string string)
1084            (type fixnum start end))
1085   (let* ((string (if (typep string '(simple-array character (*)))
1086                      string
1087                      (coerce string '(simple-array character (*)))))
1088          (current (string-output-stream-index stream))
1089          (length (- end start))
1090          (dst-end (+ length current))
1091          (workspace (string-output-stream-string stream)))
1092     (declare (type (simple-array character (*)) workspace string)
1093              (type fixnum current length dst-end))
1094     (if (> dst-end (the fixnum (length workspace)))
1095         (let ((new-workspace (make-string (+ (* current 2) length))))
1096           (replace new-workspace workspace :end2 current)
1097           (replace new-workspace string
1098                    :start1 current :end1 dst-end
1099                    :start2 start :end2 end)
1100           (setf (string-output-stream-string stream) new-workspace))
1101         (replace workspace string
1102                  :start1 current :end1 dst-end
1103                  :start2 start :end2 end))
1104     (setf (string-output-stream-index stream) dst-end)))
1105
1106 (defun string-out-misc (stream operation &optional arg1 arg2)
1107   (declare (ignore arg2))
1108   (case operation
1109     (:file-position
1110      (if arg1
1111          (let ((end (string-output-stream-last-index stream)))
1112            (setf (string-output-stream-index-cache stream) end
1113                  (string-output-stream-index stream)
1114                  (case arg1
1115                    (:start 0)
1116                    (:end end)
1117                    (t
1118                     ;; We allow moving beyond the end of stream,
1119                     ;; implicitly extending the output stream.
1120                     (let ((buffer (string-output-stream-string stream)))
1121                       (when (> arg1 (length buffer))
1122                         (setf (string-output-stream-string stream)
1123                               (make-string
1124                                arg1 :element-type (array-element-type buffer))
1125                               (subseq (string-output-stream-string stream)
1126                                       0 end)
1127                               (subseq buffer 0 end))))
1128                       arg1))))
1129          (string-output-stream-index stream)))
1130     (:close (set-closed-flame stream))
1131     (:charpos
1132      (do ((index (1- (the fixnum (string-output-stream-index stream)))
1133                  (1- index))
1134           (count 0 (1+ count))
1135           (string (string-output-stream-string stream)))
1136          ((< index 0) count)
1137        (declare (type (simple-array character (*)) string)
1138                 (type fixnum index count))
1139        (if (char= (schar string index) #\newline)
1140            (return count))))
1141     (:element-type (array-element-type (string-output-stream-string stream)))))
1142
1143 ;;; Return a string of all the characters sent to a stream made by
1144 ;;; MAKE-STRING-OUTPUT-STREAM since the last call to this function.
1145 (defun get-output-stream-string (stream)
1146   (declare (type string-output-stream stream))
1147   (let* ((length (string-output-stream-last-index stream))
1148          (element-type (string-output-stream-element-type stream))
1149          (result
1150           (case element-type
1151             ;; Overwhelmingly common case; can be inlined.
1152             ((character) (make-string length))
1153             (t (make-string length :element-type element-type)))))
1154     ;; For the benefit of the REPLACE transform, let's do this, so
1155     ;; that the common case isn't ludicrously expensive.
1156     (etypecase result
1157       ((simple-array character (*))
1158        (replace result (string-output-stream-string stream)))
1159       ((simple-array nil (*))
1160        (replace result (string-output-stream-string stream))))
1161     (setf (string-output-stream-index stream) 0
1162           (string-output-stream-index-cache stream) 0)
1163     result))
1164
1165 ;;; Dump the characters buffer up in IN-STREAM to OUT-STREAM as
1166 ;;; GET-OUTPUT-STREAM-STRING would return them.
1167 (defun dump-output-stream-string (in-stream out-stream)
1168   (%write-string (string-output-stream-string in-stream)
1169                  out-stream
1170                  0
1171                  (string-output-stream-last-index in-stream))
1172   (setf (string-output-stream-index in-stream) 0
1173         (string-output-stream-index-cache in-stream) 0))
1174 \f
1175 ;;;; fill-pointer streams
1176
1177 ;;; Fill pointer STRING-OUTPUT-STREAMs are not explicitly mentioned in
1178 ;;; the CLM, but they are required for the implementation of
1179 ;;; WITH-OUTPUT-TO-STRING.
1180
1181 (deftype string-with-fill-pointer ()
1182   '(and (vector character)
1183         (satisfies array-has-fill-pointer-p)))
1184
1185 (defstruct (fill-pointer-output-stream
1186             (:include string-stream
1187                       (out #'fill-pointer-ouch)
1188                       (sout #'fill-pointer-sout)
1189                       (misc #'fill-pointer-misc)
1190                       ;; a string with a fill pointer where we stuff
1191                       ;; the stuff we write
1192                       (string (missing-arg)
1193                               :type string-with-fill-pointer
1194                               :read-only t))
1195             (:constructor make-fill-pointer-output-stream (string))
1196             (:copier nil)))
1197
1198 (defun fill-pointer-ouch (stream character)
1199   (let* ((buffer (fill-pointer-output-stream-string stream))
1200          (current (fill-pointer buffer))
1201          (current+1 (1+ current)))
1202     (declare (fixnum current))
1203     (with-array-data ((workspace buffer) (start) (end))
1204       (declare (type (simple-array character (*)) workspace))
1205       (let ((offset-current (+ start current)))
1206         (declare (fixnum offset-current))
1207         (if (= offset-current end)
1208             (let* ((new-length (1+ (* current 2)))
1209                    (new-workspace (make-string new-length)))
1210               (declare (simple-string new-workspace))
1211               (%byte-blt workspace start
1212                          new-workspace 0 current)
1213               (setf workspace new-workspace
1214                     offset-current current)
1215               (set-array-header buffer workspace new-length
1216                                 current+1 0 new-length nil))
1217             (setf (fill-pointer buffer) current+1))
1218         (setf (schar workspace offset-current) character)))
1219     current+1))
1220
1221 (defun fill-pointer-sout (stream string start end)
1222   (declare (simple-string string) (fixnum start end))
1223   (let* ((string (if (typep string '(simple-array character (*)))
1224                      string
1225                      (coerce string '(simple-array character (*)))))
1226          (buffer (fill-pointer-output-stream-string stream))
1227          (current (fill-pointer buffer))
1228          (string-len (- end start))
1229          (dst-end (+ string-len current)))
1230     (declare (fixnum current dst-end string-len))
1231     (with-array-data ((workspace buffer) (dst-start) (dst-length))
1232       (declare (type (simple-array character (*)) workspace))
1233       (let ((offset-dst-end (+ dst-start dst-end))
1234             (offset-current (+ dst-start current)))
1235         (declare (fixnum offset-dst-end offset-current))
1236         (if (> offset-dst-end dst-length)
1237             (let* ((new-length (+ (the fixnum (* current 2)) string-len))
1238                    (new-workspace (make-string new-length)))
1239               (declare (type (simple-array character (*)) new-workspace))
1240               (%byte-blt workspace dst-start
1241                          new-workspace 0 current)
1242               (setf workspace new-workspace)
1243               (setf offset-current current)
1244               (setf offset-dst-end dst-end)
1245               (set-array-header buffer
1246                                 workspace
1247                                 new-length
1248                                 dst-end
1249                                 0
1250                                 new-length
1251                                 nil))
1252             (setf (fill-pointer buffer) dst-end))
1253         (%byte-blt string start
1254                    workspace offset-current offset-dst-end)))
1255     dst-end))
1256
1257 (defun fill-pointer-misc (stream operation &optional arg1 arg2)
1258   (declare (ignore arg1 arg2))
1259   (case operation
1260     (:file-position
1261      (let ((buffer (fill-pointer-output-stream-string stream)))
1262        (if arg1
1263            (setf (fill-pointer buffer)
1264                  (case arg1
1265                    (:start 0)
1266                    ;; Fill-pointer is always at fill-pointer we will
1267                    ;; make :END move to the end of the actual string.
1268                    (:end (array-total-size buffer))
1269                    ;; We allow moving beyond the end of string if the
1270                    ;; string is adjustable.
1271                    (t (when (>= arg1 (array-total-size buffer))
1272                         (if (adjustable-array-p buffer)
1273                             (adjust-array buffer arg1)
1274                             (error "Cannot move FILE-POSITION beyond the end ~
1275                                     of WITH-OUTPUT-TO-STRING stream ~
1276                                     constructed with non-adjustable string.")))
1277                       arg1)))
1278            (fill-pointer buffer))))
1279     (:charpos
1280      (let* ((buffer (fill-pointer-output-stream-string stream))
1281             (current (fill-pointer buffer)))
1282        (with-array-data ((string buffer) (start) (end current))
1283          (declare (simple-string string) (ignore start))
1284          (let ((found (position #\newline string :test #'char=
1285                                 :end end :from-end t)))
1286            (if found
1287                (- end (the fixnum found))
1288                current)))))
1289      (:element-type (array-element-type
1290                      (fill-pointer-output-stream-string stream)))))
1291 \f
1292 ;;;; indenting streams
1293
1294 (defstruct (indenting-stream (:include ansi-stream
1295                                        (out #'indenting-out)
1296                                        (sout #'indenting-sout)
1297                                        (misc #'indenting-misc))
1298                              (:constructor make-indenting-stream (stream))
1299                              (:copier nil))
1300   ;; the stream we're based on
1301   stream
1302   ;; how much we indent on each line
1303   (indentation 0))
1304
1305 #!+sb-doc
1306 (setf (fdocumentation 'make-indenting-stream 'function)
1307  "Return an output stream which indents its output by some amount.")
1308
1309 ;;; INDENTING-INDENT writes the correct number of spaces needed to indent
1310 ;;; output on the given STREAM based on the specified SUB-STREAM.
1311 (defmacro indenting-indent (stream sub-stream)
1312   ;; KLUDGE: bare magic number 60
1313   `(do ((i 0 (+ i 60))
1314         (indentation (indenting-stream-indentation ,stream)))
1315        ((>= i indentation))
1316      (%write-string
1317       "                                                     "
1318       ,sub-stream
1319       0
1320       (min 60 (- indentation i)))))
1321
1322 ;;; INDENTING-OUT writes a character to an indenting stream.
1323 (defun indenting-out (stream char)
1324   (let ((sub-stream (indenting-stream-stream stream)))
1325     (write-char char sub-stream)
1326     (if (char= char #\newline)
1327         (indenting-indent stream sub-stream))))
1328
1329 ;;; INDENTING-SOUT writes a string to an indenting stream.
1330 (defun indenting-sout (stream string start end)
1331   (declare (simple-string string) (fixnum start end))
1332   (do ((i start)
1333        (sub-stream (indenting-stream-stream stream)))
1334       ((= i end))
1335     (let ((newline (position #\newline string :start i :end end)))
1336       (cond (newline
1337              (%write-string string sub-stream i (1+ newline))
1338              (indenting-indent stream sub-stream)
1339              (setq i (+ newline 1)))
1340             (t
1341              (%write-string string sub-stream i end)
1342              (setq i end))))))
1343
1344 ;;; INDENTING-MISC just treats just the :LINE-LENGTH message
1345 ;;; differently. INDENTING-CHARPOS says the charpos is the charpos of
1346 ;;; the base stream minus the stream's indentation.
1347 (defun indenting-misc (stream operation &optional arg1 arg2)
1348   (let ((sub-stream (indenting-stream-stream stream)))
1349     (if (ansi-stream-p sub-stream)
1350         (let ((method (ansi-stream-misc sub-stream)))
1351           (case operation
1352             (:line-length
1353              (let ((line-length (funcall method sub-stream operation)))
1354                (if line-length
1355                    (- line-length (indenting-stream-indentation stream)))))
1356             (:charpos
1357              (let ((charpos (funcall method sub-stream operation)))
1358                (if charpos
1359                    (- charpos (indenting-stream-indentation stream)))))
1360             (t
1361              (funcall method sub-stream operation arg1 arg2))))
1362         ;; must be Gray streams FUNDAMENTAL-STREAM
1363         (case operation
1364           (:line-length
1365            (let ((line-length (stream-line-length sub-stream)))
1366              (if line-length
1367                  (- line-length (indenting-stream-indentation stream)))))
1368           (:charpos
1369            (let ((charpos (stream-line-column sub-stream)))
1370              (if charpos
1371                  (- charpos (indenting-stream-indentation stream)))))
1372           (t
1373            (stream-misc-dispatch sub-stream operation arg1 arg2))))))
1374
1375 (declaim (maybe-inline read-char unread-char read-byte listen))
1376 \f
1377 ;;;; case frobbing streams, used by FORMAT ~(...~)
1378
1379 (defstruct (case-frob-stream
1380             (:include ansi-stream
1381                       (misc #'case-frob-misc))
1382             (:constructor %make-case-frob-stream (target out sout))
1383             (:copier nil))
1384   (target (missing-arg) :type stream))
1385
1386 (defun make-case-frob-stream (target kind)
1387   #!+sb-doc
1388   "Return a stream that sends all output to the stream TARGET, but modifies
1389    the case of letters, depending on KIND, which should be one of:
1390      :upcase - convert to upper case.
1391      :downcase - convert to lower case.
1392      :capitalize - convert the first letter of words to upper case and the
1393         rest of the word to lower case.
1394      :capitalize-first - convert the first letter of the first word to upper
1395         case and everything else to lower case."
1396   (declare (type stream target)
1397            (type (member :upcase :downcase :capitalize :capitalize-first)
1398                  kind)
1399            (values stream))
1400   (if (case-frob-stream-p target)
1401       ;; If we are going to be writing to a stream that already does
1402       ;; case frobbing, why bother frobbing the case just so it can
1403       ;; frob it again?
1404       target
1405       (multiple-value-bind (out sout)
1406           (ecase kind
1407             (:upcase
1408              (values #'case-frob-upcase-out
1409                      #'case-frob-upcase-sout))
1410             (:downcase
1411              (values #'case-frob-downcase-out
1412                      #'case-frob-downcase-sout))
1413             (:capitalize
1414              (values #'case-frob-capitalize-out
1415                      #'case-frob-capitalize-sout))
1416             (:capitalize-first
1417              (values #'case-frob-capitalize-first-out
1418                      #'case-frob-capitalize-first-sout)))
1419         (%make-case-frob-stream target out sout))))
1420
1421 (defun case-frob-misc (stream op &optional arg1 arg2)
1422   (declare (type case-frob-stream stream))
1423   (case op
1424     (:close
1425      (set-closed-flame stream))
1426     (t
1427      (let ((target (case-frob-stream-target stream)))
1428        (if (ansi-stream-p target)
1429            (funcall (ansi-stream-misc target) target op arg1 arg2)
1430            (stream-misc-dispatch target op arg1 arg2))))))
1431
1432 (defun case-frob-upcase-out (stream char)
1433   (declare (type case-frob-stream stream)
1434            (type base-char char))
1435   (let ((target (case-frob-stream-target stream))
1436         (char (char-upcase char)))
1437     (if (ansi-stream-p target)
1438         (funcall (ansi-stream-out target) target char)
1439         (stream-write-char target char))))
1440
1441 (defun case-frob-upcase-sout (stream str start end)
1442   (declare (type case-frob-stream stream)
1443            (type simple-base-string str)
1444            (type index start)
1445            (type (or index null) end))
1446   (let* ((target (case-frob-stream-target stream))
1447          (len (length str))
1448          (end (or end len))
1449          (string (if (and (zerop start) (= len end))
1450                      (string-upcase str)
1451                      (nstring-upcase (subseq str start end))))
1452          (string-len (- end start)))
1453     (if (ansi-stream-p target)
1454         (funcall (ansi-stream-sout target) target string 0 string-len)
1455         (stream-write-string target string 0 string-len))))
1456
1457 (defun case-frob-downcase-out (stream char)
1458   (declare (type case-frob-stream stream)
1459            (type base-char char))
1460   (let ((target (case-frob-stream-target stream))
1461         (char (char-downcase char)))
1462     (if (ansi-stream-p target)
1463         (funcall (ansi-stream-out target) target char)
1464         (stream-write-char target char))))
1465
1466 (defun case-frob-downcase-sout (stream str start end)
1467   (declare (type case-frob-stream stream)
1468            (type simple-base-string str)
1469            (type index start)
1470            (type (or index null) end))
1471   (let* ((target (case-frob-stream-target stream))
1472          (len (length str))
1473          (end (or end len))
1474          (string (if (and (zerop start) (= len end))
1475                      (string-downcase str)
1476                      (nstring-downcase (subseq str start end))))
1477          (string-len (- end start)))
1478     (if (ansi-stream-p target)
1479         (funcall (ansi-stream-sout target) target string 0 string-len)
1480         (stream-write-string target string 0 string-len))))
1481
1482 (defun case-frob-capitalize-out (stream char)
1483   (declare (type case-frob-stream stream)
1484            (type base-char char))
1485   (let ((target (case-frob-stream-target stream)))
1486     (cond ((alphanumericp char)
1487            (let ((char (char-upcase char)))
1488              (if (ansi-stream-p target)
1489                  (funcall (ansi-stream-out target) target char)
1490                  (stream-write-char target char)))
1491            (setf (case-frob-stream-out stream) #'case-frob-capitalize-aux-out)
1492            (setf (case-frob-stream-sout stream)
1493                  #'case-frob-capitalize-aux-sout))
1494           (t
1495            (if (ansi-stream-p target)
1496                (funcall (ansi-stream-out target) target char)
1497                (stream-write-char target char))))))
1498
1499 (defun case-frob-capitalize-sout (stream str start end)
1500   (declare (type case-frob-stream stream)
1501            (type simple-base-string str)
1502            (type index start)
1503            (type (or index null) end))
1504   (let* ((target (case-frob-stream-target stream))
1505          (str (subseq str start end))
1506          (len (length str))
1507          (inside-word nil))
1508     (dotimes (i len)
1509       (let ((char (schar str i)))
1510         (cond ((not (alphanumericp char))
1511                (setf inside-word nil))
1512               (inside-word
1513                (setf (schar str i) (char-downcase char)))
1514               (t
1515                (setf inside-word t)
1516                (setf (schar str i) (char-upcase char))))))
1517     (when inside-word
1518       (setf (case-frob-stream-out stream)
1519             #'case-frob-capitalize-aux-out)
1520       (setf (case-frob-stream-sout stream)
1521             #'case-frob-capitalize-aux-sout))
1522     (if (ansi-stream-p target)
1523         (funcall (ansi-stream-sout target) target str 0 len)
1524         (stream-write-string target str 0 len))))
1525
1526 (defun case-frob-capitalize-aux-out (stream char)
1527   (declare (type case-frob-stream stream)
1528            (type base-char char))
1529   (let ((target (case-frob-stream-target stream)))
1530     (cond ((alphanumericp char)
1531            (let ((char (char-downcase char)))
1532              (if (ansi-stream-p target)
1533                  (funcall (ansi-stream-out target) target char)
1534                  (stream-write-char target char))))
1535           (t
1536            (if (ansi-stream-p target)
1537                (funcall (ansi-stream-out target) target char)
1538                (stream-write-char target char))
1539            (setf (case-frob-stream-out stream)
1540                  #'case-frob-capitalize-out)
1541            (setf (case-frob-stream-sout stream)
1542                  #'case-frob-capitalize-sout)))))
1543
1544 (defun case-frob-capitalize-aux-sout (stream str start end)
1545   (declare (type case-frob-stream stream)
1546            (type simple-base-string str)
1547            (type index start)
1548            (type (or index null) end))
1549   (let* ((target (case-frob-stream-target stream))
1550          (str (subseq str start end))
1551          (len (length str))
1552          (inside-word t))
1553     (dotimes (i len)
1554       (let ((char (schar str i)))
1555         (cond ((not (alphanumericp char))
1556                (setf inside-word nil))
1557               (inside-word
1558                (setf (schar str i) (char-downcase char)))
1559               (t
1560                (setf inside-word t)
1561                (setf (schar str i) (char-upcase char))))))
1562     (unless inside-word
1563       (setf (case-frob-stream-out stream)
1564             #'case-frob-capitalize-out)
1565       (setf (case-frob-stream-sout stream)
1566             #'case-frob-capitalize-sout))
1567     (if (ansi-stream-p target)
1568         (funcall (ansi-stream-sout target) target str 0 len)
1569         (stream-write-string target str 0 len))))
1570
1571 (defun case-frob-capitalize-first-out (stream char)
1572   (declare (type case-frob-stream stream)
1573            (type base-char char))
1574   (let ((target (case-frob-stream-target stream)))
1575     (cond ((alphanumericp char)
1576            (let ((char (char-upcase char)))
1577              (if (ansi-stream-p target)
1578                  (funcall (ansi-stream-out target) target char)
1579                  (stream-write-char target char)))
1580            (setf (case-frob-stream-out stream)
1581                  #'case-frob-downcase-out)
1582            (setf (case-frob-stream-sout stream)
1583                  #'case-frob-downcase-sout))
1584           (t
1585            (if (ansi-stream-p target)
1586                (funcall (ansi-stream-out target) target char)
1587                (stream-write-char target char))))))
1588
1589 (defun case-frob-capitalize-first-sout (stream str start end)
1590   (declare (type case-frob-stream stream)
1591            (type simple-base-string str)
1592            (type index start)
1593            (type (or index null) end))
1594   (let* ((target (case-frob-stream-target stream))
1595          (str (subseq str start end))
1596          (len (length str)))
1597     (dotimes (i len)
1598       (let ((char (schar str i)))
1599         (when (alphanumericp char)
1600           (setf (schar str i) (char-upcase char))
1601           (do ((i (1+ i) (1+ i)))
1602               ((= i len))
1603             (setf (schar str i) (char-downcase (schar str i))))
1604           (setf (case-frob-stream-out stream)
1605                 #'case-frob-downcase-out)
1606           (setf (case-frob-stream-sout stream)
1607                 #'case-frob-downcase-sout)
1608           (return))))
1609     (if (ansi-stream-p target)
1610         (funcall (ansi-stream-sout target) target str 0 len)
1611         (stream-write-string target str 0 len))))
1612 \f
1613 ;;;; READ-SEQUENCE
1614
1615 (defun read-sequence (seq stream &key (start 0) end)
1616   #!+sb-doc
1617   "Destructively modify SEQ by reading elements from STREAM.
1618   That part of SEQ bounded by START and END is destructively modified by
1619   copying successive elements into it from STREAM. If the end of file
1620   for STREAM is reached before copying all elements of the subsequence,
1621   then the extra elements near the end of sequence are not updated, and
1622   the index of the next element is returned."
1623   (declare (type sequence seq)
1624            (type stream stream)
1625            (type index start)
1626            (type sequence-end end)
1627            (values index))
1628   (if (ansi-stream-p stream)
1629       (ansi-stream-read-sequence seq stream start end)
1630       ;; must be Gray streams FUNDAMENTAL-STREAM
1631       (stream-read-sequence stream seq start end)))
1632
1633 (defun ansi-stream-read-sequence (seq stream start %end)
1634   (declare (type sequence seq)
1635            (type ansi-stream stream)
1636            (type index start)
1637            (type sequence-end %end)
1638            (values index))
1639   (let ((end (or %end (length seq))))
1640     (declare (type index end))
1641     (etypecase seq
1642       (list
1643        (let ((read-function
1644               (if (subtypep (stream-element-type stream) 'character)
1645                   #'read-char
1646                   #'read-byte)))
1647          (do ((rem (nthcdr start seq) (rest rem))
1648               (i start (1+ i)))
1649              ((or (endp rem) (>= i end)) i)
1650            (declare (type list rem)
1651                     (type index i))
1652            (let ((el (funcall read-function stream nil :eof)))
1653              (when (eq el :eof)
1654                (return i))
1655              (setf (first rem) el)))))
1656       (vector
1657        (with-array-data ((data seq) (offset-start start) (offset-end end))
1658          (typecase data
1659            ((or (simple-array (unsigned-byte 8) (*))
1660                 (simple-array (signed-byte 8) (*))
1661                 simple-string)
1662             (let* ((numbytes (- end start))
1663                    (bytes-read (sb!sys:read-n-bytes stream
1664                                                     data
1665                                                     offset-start
1666                                                     numbytes
1667                                                     nil)))
1668               (if (< bytes-read numbytes)
1669                   (+ start bytes-read)
1670                   end)))
1671            (t
1672             (let ((read-function
1673                    (if (subtypep (stream-element-type stream) 'character)
1674                        #'read-char
1675                        #'read-byte)))
1676               (do ((i offset-start (1+ i)))
1677                   ((>= i offset-end) end)
1678                 (declare (type index i))
1679                 (let ((el (funcall read-function stream nil :eof)))
1680                   (when (eq el :eof)
1681                     (return (+ start (- i offset-start))))
1682                   (setf (aref data i) el)))))))))))
1683 \f
1684 ;;;; WRITE-SEQUENCE
1685
1686 (defun write-sequence (seq stream &key (start 0) (end nil))
1687   #!+sb-doc
1688   "Write the elements of SEQ bounded by START and END to STREAM."
1689   (declare (type sequence seq)
1690            (type stream stream)
1691            (type index start)
1692            (type sequence-end end)
1693            (values sequence))
1694   (if (ansi-stream-p stream)
1695       (ansi-stream-write-sequence seq stream start end)
1696       ;; must be Gray-streams FUNDAMENTAL-STREAM
1697       (stream-write-sequence stream seq start end)))
1698
1699 (defun ansi-stream-write-sequence (seq stream start %end)
1700   (declare (type sequence seq)
1701            (type ansi-stream stream)
1702            (type index start)
1703            (type sequence-end %end)
1704            (values sequence))
1705   (let ((end (or %end (length seq))))
1706     (declare (type index end))
1707     (etypecase seq
1708       (list
1709        (let ((write-function
1710               (if (subtypep (stream-element-type stream) 'character)
1711                   #'write-char
1712                   #'write-byte)))
1713          (do ((rem (nthcdr start seq) (rest rem))
1714               (i start (1+ i)))
1715              ((or (endp rem) (>= i end)) seq)
1716            (declare (type list rem)
1717                     (type index i))
1718            (funcall write-function (first rem) stream))))
1719       (string
1720        (%write-string seq stream start end))
1721       (vector
1722        (let ((write-function
1723               (if (subtypep (stream-element-type stream) 'character)
1724                   #'write-char
1725                   #'write-byte)))
1726          (do ((i start (1+ i)))
1727              ((>= i end) seq)
1728            (declare (type index i))
1729            (funcall write-function (aref seq i) stream)))))))
1730 \f
1731 ;;;; etc.