Newer
Older
;;; -*- Package: Lisp -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the CMU Common Lisp project at
;;; Carnegie Mellon University, and has been placed in the public domain.
;;;
(ext:file-comment
"$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/stream.lisp,v 1.29 1998/04/27 10:06:43 pw Exp $")
;;; **********************************************************************
;;;
;;; Stream functions for Spice Lisp.
;;; Written by Skef Wholey and Rob MacLachlan.
;;;
;;; This file contains the OS-independent stream functions.
(in-package "LISP")
(export '(broadcast-stream make-broadcast-stream broadcast-stream-streams
synonym-stream make-synonym-stream synonym-stream-symbol
concatenated-stream make-concatenated-stream
concatenated-stream-streams
two-way-stream make-two-way-stream two-way-stream-input-stream
two-way-stream-output-stream
echo-stream make-echo-stream echo-stream-input-stream
echo-stream-output-stream
make-string-input-stream make-string-output-stream
output-stream-p open-stream-p interactive-stream-p
open-stream-p close read-line read-char
unread-char peek-char listen read-char-no-hang clear-input read-byte
write-char write-string write-line terpri fresh-line
finish-output force-output clear-output write-byte
stream streamp string-stream
*standard-input* *standard-output*
*error-output* *query-io* *debug-io* *terminal-io* *trace-output*))
(in-package "EXT")
(export '(get-stream-command
stream-command stream-command-p stream-command-name
stream-command-args make-stream-command make-case-frob-stream))
(in-package "LISP")
(deftype string-stream ()
'(or string-input-stream string-output-stream
fill-pointer-output-stream))
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
;;;; Standard streams:
;;;
;;; The initialization of these streams is performed by Stream-Init,
;;; which lives in the file of machine-specific stream functions.
;;;
(defvar *terminal-io* () "Terminal I/O stream.")
(defvar *standard-input* () "Default input stream.")
(defvar *standard-output* () "Default output stream.")
(defvar *error-output* () "Error output stream.")
(defvar *query-io* () "Query I/O stream.")
(defvar *trace-output* () "Trace output stream.")
(defvar *debug-io* () "Interactive debugging stream.")
(defun ill-in (stream &rest ignore)
(declare (ignore ignore))
(error "~S is not a character input stream." stream))
(defun ill-out (stream &rest ignore)
(declare (ignore ignore))
(error "~S is not a character output stream." stream))
(defun ill-bin (stream &rest ignore)
(declare (ignore ignore))
(error "~S is not a binary input stream." stream))
(defun ill-bout (stream &rest ignore)
(declare (ignore ignore))
(error "~S is not a binary output stream." stream))
(defun closed-flame (stream &rest ignore)
(declare (ignore ignore))
(error "~S is closed." stream))
(defun do-nothing (&rest ignore)
(declare (ignore ignore)))
(defun %print-stream (structure stream d)
(declare (ignore d structure))
(write-string "#<Bare Stream>" stream))
;;; HOW THE STREAM STRUCTURE IS USED:
;;;
;;; Many of the slots of the stream structure contain functions
;;; which are called to perform some operation on the stream. Closed
;;; streams have #'Closed-Flame in all of their function slots. If
;;; one side of an I/O or echo stream is closed, the whole stream is
;;; considered closed. The functions in the operation slots take
;;; arguments as follows:
;;;
;;; In: Stream, Eof-Errorp, Eof-Value
;;; Bin: Stream, Eof-Errorp, Eof-Value
;;; N-Bin: Stream, Buffer, Start, Numbytes, Eof-Errorp
;;; Out: Stream, Character
;;; Bout: Stream, Integer
;;; Sout: Stream, String, Start, End
;;; Misc: Stream, Operation, &Optional Arg1, Arg2
;;;
;;; In order to save space, some of the less common stream operations
;;; are handled by just one function, the Misc method. This function
;;; is passed a keyword which indicates the operation to perform.
;;; The following keywords are used:
;;; :listen - Return the following values:
;;; t if any input waiting.
;;; :eof if at eof.
;;; nil if no input is available and not at eof.
;;; :unread - Unread the character Arg.
;;; :close - Do any stream specific stuff to close the stream.
;;; The methods are set to closed-flame by the close
;;; function, so that need not be done by this
;;; function.
;;; :clear-input - Clear any unread input
;;; :finish-output,
;;; :force-output - Cause output to happen
;;; :clear-output - Clear any undone output
;;; :element-type - Return the type of element the stream deals wit<h.
;;; :line-length - Return the length of a line of output.
;;; :charpos - Return current output position on the line.
;;; :file-length - Return the file length of a file stream.
;;; :file-position - Return or change the current position of a file stream.
;;; :file-name - Return the name of an associated file.
;;; :interactive-p - Is this an interactive device?
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
;;;
;;; In order to do almost anything useful, it is necessary to
;;; define a new type of structure that includes stream, so that the
;;; stream can have some state information.
;;;
;;; THE STREAM IN-BUFFER:
;;;
;;; The In-Buffer in the stream holds characters or bytes that
;;; are ready to be read by some input function. If there is any
;;; stuff in the In-Buffer, then the reading function can use it
;;; without calling any stream method. Any stream may put stuff in
;;; the In-Buffer, and may also assume that any input in the In-Buffer
;;; has been consumed before any in-method is called. If a text
;;; stream has in In-Buffer, then the first character should not be
;;; used to buffer normal input so that it is free for unreading into.
;;;
;;; The In-Buffer slot is a vector In-Buffer-Length long. The
;;; In-Index is the index in the In-Buffer of the first available
;;; object. The available objects are thus between In-Index and the
;;; length of the In-Buffer.
;;;
;;; When this buffer is only accessed by the normal stream
;;; functions, the number of function calls is halved, thus
;;; potentially doubling the speed of simple operations. If the
;;; Fast-Read-Char and Fast-Read-Byte macros are used, nearly all
;;; function call overhead is removed, vastly speeding up these
;;; important operations.
;;;
;;; If a stream does not have an In-Buffer, then the In-Buffer slot
;;; must be nil, and the In-Index must be In-Buffer-Length. These are
;;; the default values for the slots.
;;; Stream manipulation functions.
(defun input-stream-p (stream)
"Returns non-nil if the given Stream can perform input operations."
(and (streamp stream)
(not (eq (stream-in stream) #'closed-flame))
(or (not (eq (stream-in stream) #'ill-in))
(not (eq (stream-bin stream) #'ill-bin)))))
(defun output-stream-p (stream)
"Returns non-nil if the given Stream can perform output operations."
(and (streamp stream)
(not (eq (stream-in stream) #'closed-flame))
(or (not (eq (stream-out stream) #'ill-out))
(not (eq (stream-bout stream) #'ill-bout)))))
(defun open-stream-p (stream)
"Return true if Stream is not closed."
(declare (type stream stream))
(not (eq (stream-in stream) #'closed-flame)))
(defun stream-element-type (stream)
"Returns a type specifier for the kind of object returned by the Stream."
(declare (type stream stream))
(funcall (stream-misc stream) stream :element-type))
(defun interactive-stream-p (stream)
"Return true if Stream does I/O on a terminal or other interactive device."
(declare (type stream stream))
(funcall (stream-misc stream) stream :interactive-p))
(defun open-stream-p (stream)
"Return true if and only if STREAM has not been closed."
(declare (type stream stream))
(not (eq (stream-in stream) #'closed-flame)))
(defun close (stream &key abort)
"Closes the given Stream. No more I/O may be performed, but inquiries
may still be made. If :Abort is non-nil, an attempt is made to clean
up the side effects of having created the stream."
(declare (type stream stream))
(when (open-stream-p stream)
(funcall (stream-misc stream) stream :close abort))
t)
(defun set-closed-flame (stream)
(setf (stream-in stream) #'closed-flame)
(setf (stream-bin stream) #'closed-flame)
(setf (stream-n-bin stream) #'closed-flame)
(setf (stream-in stream) #'closed-flame)
(setf (stream-out stream) #'closed-flame)
(setf (stream-bout stream) #'closed-flame)
(setf (stream-sout stream) #'closed-flame)
(setf (stream-misc stream) #'closed-flame))
;;;; File position and file length.
;;; File-Position -- Public
;;;
;;; Call the misc method with the :file-position operation.
;;;
(defun file-position (stream &optional position)
"With one argument returns the current position within the file
File-Stream is open to. If the second argument is supplied, then
this becomes the new file position. The second argument may also
be :start or :end for the start and end of the file, respectively."
(declare (stream stream)
(type (or index (member nil :start :end)) position))
(cond
(position
(setf (stream-in-index stream) in-buffer-length)
(funcall (stream-misc stream) stream :file-position position))
(t
(let ((res (funcall (stream-misc stream) stream :file-position nil)))
(when res (- res (- in-buffer-length (stream-in-index stream))))))))
;;; File-Length -- Public
;;;
;;; Like File-Position, only use :file-length.
;;;
(defun file-length (stream)
"This function returns the length of the file that File-Stream is open to."
(declare (stream stream))
(funcall (stream-misc stream) stream :file-length))
;;; Input functions:
(defun read-line (&optional (stream *standard-input*) (eof-errorp t) eof-value
recursive-p)
"Returns a line of text read from the Stream as a string, discarding the
newline character."
(declare (ignore recursive-p))
(prepare-for-fast-read-char stream
(let ((res (make-string 80))
(len 80)
(index 0))
(loop
(let ((ch (fast-read-char nil nil)))
(cond (ch
(when (char= ch #\newline)
(done-with-fast-read-char)
(return (values (shrink-vector res index) nil)))
(when (= index len)
(setq len (* len 2))
(let ((new (make-string len)))
(replace new res)
(setq res new)))
(setf (schar res index) ch)
(incf index))
((zerop index)
(done-with-fast-read-char)
(return (values (eof-or-lose (in-synonym-of stream)
eof-errorp eof-value)
t)))
;; since fast-read-char hit already the eof char, we
;; shouldn't do another read-char
(t
(done-with-fast-read-char)
(return (values (shrink-vector res index) t)))))))))
;;; We proclaim them inline here, then proclaim them notinline at EOF,
;;; so, except in this file, they are not inline by default, but they can be.
;;;
(proclaim '(inline read-char unread-char read-byte listen))
(defun read-char (&optional (stream *standard-input*) (eof-errorp t) eof-value
recursive-p)
"Inputs a character from Stream and returns it."
(declare (ignore recursive-p))
(prepare-for-fast-read-char stream
(prog1
(fast-read-char eof-errorp eof-value)
(done-with-fast-read-char))))
(defun unread-char (character &optional (stream *standard-input*))
"Puts the Character back on the front of the input Stream."
(let* ((stream (in-synonym-of stream))
(index (1- (stream-in-index stream)))
(buffer (stream-in-buffer stream)))
(declare (fixnum index))
(when (minusp index) (error "Nothing to unread."))
(cond (buffer
(setf (aref buffer index) (char-code character))
(setf (stream-in-index stream) index))
(t
(funcall (stream-misc stream) stream :unread character))))
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
nil)
(defun peek-char (&optional (peek-type nil) (stream *standard-input*)
(eof-errorp t) eof-value recursive-p)
"Peeks at the next character in the input Stream. See manual for details."
(declare (ignore recursive-p))
(let* ((stream (in-synonym-of stream))
(char (read-char stream eof-errorp eof-value)))
(cond ((eq char eof-value) char)
((characterp peek-type)
(do ((char char (read-char stream eof-errorp eof-value)))
((or (eq char eof-value) (char= char peek-type))
(unless (eq char eof-value)
(unread-char char stream))
char)))
((eq peek-type t)
(do ((char char (read-char stream eof-errorp eof-value)))
((or (eq char eof-value) (not (whitespace-char-p char)))
(unless (eq char eof-value)
(unread-char char stream))
char)))
(t
(unread-char char stream)
char))))
(defun listen (&optional (stream *standard-input*))
"Returns T if a character is availible on the given Stream."
(let ((stream (in-synonym-of stream)))
(or (/= (the fixnum (stream-in-index stream)) in-buffer-length)
;; Test for t explicitly since misc methods return :eof sometimes.
(eq (funcall (stream-misc stream) stream :listen) t))))
(defun read-char-no-hang (&optional (stream *standard-input*)
(eof-errorp t) eof-value recursive-p)
"Returns the next character from the Stream if one is availible, or nil."
(declare (ignore recursive-p))
(let ((stream (in-synonym-of stream)))
(if (funcall (stream-misc stream) stream :listen)
;; On t or :eof get READ-CHAR to do the work.
(read-char stream eof-errorp eof-value)
nil)))
(defun clear-input (&optional (stream *standard-input*))
"Clears any buffered input associated with the Stream."
(let ((stream (in-synonym-of stream)))
(setf (stream-in-index stream) in-buffer-length)
(funcall (stream-misc stream) stream :clear-input)
nil))
(defun read-byte (stream &optional (eof-errorp t) eof-value)
"Returns the next byte of the Stream."
(prepare-for-fast-read-byte stream
(prog1
(fast-read-byte eof-errorp eof-value t)
(done-with-fast-read-byte))))
(defun read-n-bytes (stream buffer start numbytes &optional (eof-errorp t))
"Reads Numbytes bytes into the Buffer starting at Start, returning the number
of bytes read.
-- If EOF-ERROR-P is true, an END-OF-FILE condition is signalled if
end-of-file is encountered before Count bytes have been read.
-- If EOF-ERROR-P is false, READ-N-BYTES reads as much data is currently
available (up to count bytes.) On pipes or similar devices, this
function returns as soon as any adata is available, even if the amount
read is less than Count and eof has not been hit."
(declare (type index numbytes start)
(type (or (simple-array * (*)) system-area-pointer) buffer))
(let* ((stream (in-synonym-of stream))
(in-buffer (stream-in-buffer stream))
(index (stream-in-index stream))
(num-buffered (- in-buffer-length index)))
(declare (fixnum index num-buffered))
(cond
((not in-buffer)
(funcall (stream-n-bin stream) stream buffer start numbytes eof-errorp))
((<= numbytes num-buffered)
(%primitive byte-blt in-buffer index buffer start (+ start numbytes))
(setf (stream-in-index stream) (+ index numbytes))
numbytes)
(t
(let ((end (+ start num-buffered)))
(%primitive byte-blt in-buffer index buffer start end)
(setf (stream-in-index stream) in-buffer-length)
(+ (funcall (stream-n-bin stream) stream buffer end
(- numbytes num-buffered)
eof-errorp)
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
;;; Amount of space we leave at the start of the in-buffer for unreading. 4
;;; instead of 1 to allow word-aligned copies.
;;;
(defconstant in-buffer-extra 4)
;;; FAST-READ-CHAR-REFILL -- Interface
;;;
;;; This function is called by the fast-read-char expansion to refill the
;;; in-buffer for text streams. There is definitely an in-buffer, and hence
;;; myst be an n-bin method.
;;;
(defun fast-read-char-refill (stream eof-errorp eof-value)
(let* ((ibuf (stream-in-buffer stream))
(count (funcall (stream-n-bin stream) stream
ibuf in-buffer-extra
(- in-buffer-length in-buffer-extra)
nil))
(start (- in-buffer-length count)))
(declare (type index start count))
(cond ((zerop count)
(setf (stream-in-index stream) in-buffer-length)
(funcall (stream-in stream) stream eof-errorp eof-value))
(t
(when (/= start in-buffer-extra)
(bit-bash-copy ibuf (+ (* in-buffer-extra vm:byte-bits)
(* vm:vector-data-offset vm:word-bits))
ibuf (+ (the index (* start vm:byte-bits))
(* vm:vector-data-offset vm:word-bits))
(* count vm:byte-bits)))
(setf (stream-in-index stream) (1+ start))
(code-char (aref ibuf start))))))
;;; FAST-READ-BYTE-REFILL -- Interface
;;;
;;; Similar to FAST-READ-CHAR-REFILL, but we don't have to leave room for
;;; unreading.
;;;
(defun fast-read-byte-refill (stream eof-errorp eof-value)
(let* ((ibuf (stream-in-buffer stream))
(count (funcall (stream-n-bin stream) stream
ibuf 0 in-buffer-length
nil))
(start (- in-buffer-length count)))
(declare (type index start count))
(cond ((zerop count)
(setf (stream-in-index stream) in-buffer-length)
(funcall (stream-bin stream) stream eof-errorp eof-value))
(t
(unless (zerop start)
(bit-bash-copy ibuf (* vm:vector-data-offset vm:word-bits)
ibuf (+ (the index (* start vm:byte-bits))
(* vm:vector-data-offset vm:word-bits))
(* count vm:byte-bits)))
(setf (stream-in-index stream) (1+ start))
(aref ibuf start)))))
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
;;; Output functions:
(defun write-char (character &optional (stream *standard-output*))
"Outputs the Character to the Stream."
(with-out-stream stream stream-out character)
character)
(defun terpri (&optional (stream *standard-output*))
"Outputs a new line to the Stream."
(with-out-stream stream stream-out #\newline)
nil)
(defun fresh-line (&optional (stream *standard-output*))
"Outputs a new line to the Stream if it is not positioned at the begining of
a line. Returns T if it output a new line, nil otherwise."
(let ((stream (out-synonym-of stream)))
(when (/= (or (charpos stream) 1) 0)
(funcall (stream-out stream) stream #\newline)
t)))
(defun write-string (string &optional (stream *standard-output*)
&key (start 0) (end (length (the vector string))))
"Outputs the String to the given Stream."
(write-string* string stream start end))
(defun write-string* (string &optional (stream *standard-output*)
(start 0) (end (length (the vector string))))
(declare (fixnum start end))
(if (array-header-p string)
(with-array-data ((data string) (offset-start start) (offset-end end))
(with-out-stream stream stream-sout data offset-start offset-end))
(with-out-stream stream stream-sout string start end))
string)
(defun write-line (string &optional (stream *standard-output*)
&key (start 0) (end (length string)))
"Outputs the String to the given Stream, followed by a newline character."
(write-line* string stream start end))
(defun write-line* (string &optional (stream *standard-output*)
(start 0) (end (length string)))
(declare (fixnum start end))
(let ((stream (out-synonym-of stream)))
(if (array-header-p string)
(with-array-data ((data string) (offset-start start) (offset-end end))
(with-out-stream stream stream-sout data offset-start offset-end))
(with-out-stream stream stream-sout string start end))
(funcall (stream-out stream) stream #\newline))
string)
(defun charpos (&optional (stream *standard-output*))
"Returns the number of characters on the current line of output of the given
Stream, or Nil if that information is not availible."
(with-out-stream stream stream-misc :charpos))
(defun line-length (&optional (stream *standard-output*))
"Returns the number of characters that will fit on a line of output on the
given Stream, or Nil if that information is not available."
(with-out-stream stream stream-misc :line-length))
(defun finish-output (&optional (stream *standard-output*))
"Attempts to ensure that all output sent to the Stream has reached its
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
destination, and only then returns."
(with-out-stream stream stream-misc :finish-output)
nil)
(defun force-output (&optional (stream *standard-output*))
"Attempts to force any buffered output to be sent."
(with-out-stream stream stream-misc :force-output)
nil)
(defun clear-output (&optional (stream *standard-output*))
"Clears the given output Stream."
(with-out-stream stream stream-misc :clear-output)
nil)
(defun write-byte (integer stream)
"Outputs the Integer to the binary Stream."
(with-out-stream stream stream-bout integer)
integer)
;;;; Broadcast streams:
(defstruct (broadcast-stream (:include stream
(out #'broadcast-out)
(bout #'broadcast-bout)
(sout #'broadcast-sout)
(misc #'broadcast-misc))
(:print-function %print-broadcast-stream)
(:constructor make-broadcast-stream (&rest streams)))
;; This is a list of all the streams we broadcast to.
(streams () :type list :read-only t))
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
(setf (documentation 'make-broadcast-stream 'function)
"Returns an ouput stream which sends its output to all of the given streams.")
(defun %print-broadcast-stream (s stream d)
(declare (ignore s d))
(write-string "#<Broadcast Stream>" stream))
(macrolet ((out-fun (fun method &rest args)
`(defun ,fun (stream ,@args)
(dolist (stream (broadcast-stream-streams stream))
(funcall (,method stream) stream ,@args)))))
(out-fun broadcast-out stream-out char)
(out-fun broadcast-bout stream-bout byte)
(out-fun broadcast-sout stream-sout string start end))
(defun broadcast-misc (stream operation &optional arg1 arg2)
(let ((streams (broadcast-stream-streams stream)))
(case operation
(:charpos
(dolist (stream streams)
(let ((charpos (funcall (stream-misc stream) stream :charpos)))
(if charpos (return charpos)))))
(:line-length
(let ((min nil))
(dolist (stream streams min)
(let ((res (funcall (stream-misc stream) stream :line-length)))
(when res (setq min (if min (min res min) res)))))))
(:element-type
(let (res)
(dolist (stream streams (if (> (length res) 1) `(and ,@res) res))
(pushnew (funcall (stream-misc stream) stream :element-type) res
:test #'equal))))
(t
(let ((res nil))
(dolist (stream streams res)
(setq res (funcall (stream-misc stream) stream operation
arg1 arg2))))))))
;;;; Synonym Streams:
(defstruct (synonym-stream (:include stream
(in #'synonym-in)
(bin #'synonym-bin)
(n-bin #'synonym-n-bin)
(out #'synonym-out)
(bout #'synonym-bout)
(sout #'synonym-sout)
(misc #'synonym-misc))
(:print-function %print-synonym-stream)
(:constructor make-synonym-stream (symbol)))
;; This is the symbol, the value of which is the stream we are synonym to.
(symbol nil :type symbol :read-only t))
(defun %print-synonym-stream (s stream d)
(declare (ignore d))
(format stream "#<Synonym Stream to ~S>" (synonym-stream-symbol s)))
(setf (documentation 'make-synonym-stream 'function)
"Returns a stream which performs its operations on the stream which is the
value of the dynamic variable named by Symbol.")
;;; The output simple output methods just call the corresponding method
;;; in the synonymed stream.
;;;
(macrolet ((out-fun (name slot &rest args)
`(defun ,name (stream ,@args)
(declare (optimize (safety 1)))
(let ((syn (symbol-value (synonym-stream-symbol stream))))
(funcall (,slot syn) syn ,@args)))))
(out-fun synonym-out stream-out ch)
(out-fun synonym-bout stream-bout n)
(out-fun synonym-sout stream-sout string start end))
;;; Bind synonym stream to this so that SPIO can turn on the right frob in
;;; the icon when we are in a terminal input wait.
;;;
(defvar *previous-stream* nil)
;;; For the input methods, we just call the corresponding function on the
;;; synonymed stream. These functions deal with getting input out of
;;; the In-Buffer if there is any.
;;;
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(declare (optimize (safety 1)))
(let ((*previous-stream* stream))
(,fun (symbol-value (synonym-stream-symbol stream)) ,@args)))))
(in-fun synonym-in read-char eof-errorp eof-value)
(in-fun synonym-bin read-byte eof-errorp eof-value)
(in-fun synonym-n-bin read-n-bytes buffer start numbytes eof-errorp))
;;; Synonym-Misc -- Internal
;;;
;;; We have to special-case the operations which could look at stuff in
;;; the in-buffer.
;;;
(defun synonym-misc (stream operation &optional arg1 arg2)
(declare (optimize (safety 1)))
(let ((syn (symbol-value (synonym-stream-symbol stream)))
(*previous-stream* stream))
(case operation
(:listen (or (/= (the fixnum (stream-in-index syn)) in-buffer-length)
(funcall (stream-misc syn) syn :listen)))
(t
(funcall (stream-misc syn) syn operation arg1 arg2)))))
;;;; Two-Way streams:
(defstruct (two-way-stream
(:include stream
(in #'two-way-in)
(bin #'two-way-bin)
(n-bin #'two-way-n-bin)
(out #'two-way-out)
(bout #'two-way-bout)
(sout #'two-way-sout)
(misc #'two-way-misc))
(:print-function %print-two-way-stream)
(:constructor make-two-way-stream (input-stream output-stream)))
;; We read from this stream...
(input-stream (required-argument) :type stream :read-only t)
(output-stream (required-argument) :type stream :read-only t))
(defun %print-two-way-stream (s stream d)
(declare (ignore d))
(format stream "#<Two-Way Stream, Input = ~S, Output = ~S>"
(two-way-stream-input-stream s)
(two-way-stream-output-stream s)))
(setf (documentation 'make-two-way-stream 'function)
"Returns a bidirectional stream which gets its input from Input-Stream and
sends its output to Output-Stream.")
(macrolet ((out-fun (name slot &rest args)
`(defun ,name (stream ,@args)
(let ((syn (two-way-stream-output-stream stream)))
(funcall (,slot syn) syn ,@args)))))
(out-fun two-way-out stream-out ch)
(out-fun two-way-bout stream-bout n)
(out-fun two-way-sout stream-sout string start end))
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(force-output (two-way-stream-output-stream stream))
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
(,fun (two-way-stream-input-stream stream) ,@args))))
(in-fun two-way-in read-char eof-errorp eof-value)
(in-fun two-way-bin read-byte eof-errorp eof-value)
(in-fun two-way-n-bin read-n-bytes buffer start numbytes eof-errorp))
(defun two-way-misc (stream operation &optional arg1 arg2)
(let* ((in (two-way-stream-input-stream stream))
(in-method (stream-misc in))
(out (two-way-stream-output-stream stream))
(out-method (stream-misc out)))
(case operation
(:listen (or (/= (the fixnum (stream-in-index in)) in-buffer-length)
(funcall in-method in :listen)))
((:finish-output :force-output :clear-output)
(funcall out-method out operation arg1 arg2))
((:clear-input :unread)
(funcall in-method in operation arg1 arg2))
(:element-type
(let ((in-type (funcall in-method in :element-type))
(out-type (funcall out-method out :element-type)))
(if (equal in-type out-type)
in-type `(and ,in-type ,out-type))))
(:close
(set-closed-flame stream))
(t
(or (funcall in-method in operation arg1 arg2)
(funcall out-method out operation arg1 arg2))))))
;;;; Concatenated Streams:
(defstruct (concatenated-stream
(:include stream
(in #'concatenated-in)
(bin #'concatenated-bin)
(misc #'concatenated-misc))
(:print-function %print-concatenated-stream)
(:constructor
make-concatenated-stream (&rest streams &aux (current streams))))
;; The car of this is the stream we are reading from now.
current
;; This is a list of all the streams. We need to remember them so that
;; we can close them.
(streams nil :type list :read-only t))
(defun %print-concatenated-stream (s stream d)
(declare (ignore d))
(format stream "#<Concatenated Stream, Streams = ~S>"
(concatenated-stream-streams s)))
(setf (documentation 'make-concatenated-stream 'function)
"Returns a stream which takes its input from each of the Streams in turn,
going on to the next at EOF.")
(macrolet ((in-fun (name fun)
`(defun ,name (stream eof-errorp eof-value)
(do ((current (concatenated-stream-current stream) (cdr current)))
((null current)
(eof-or-lose stream eof-errorp eof-value))
(let* ((stream (car current))
(result (,fun stream nil nil)))
(when result (return result)))
(setf (concatenated-stream-current stream) current)))))
(in-fun concatenated-in read-char)
(in-fun concatenated-bin read-byte))
(defun concatenated-misc (stream operation &optional arg1 arg2)
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
(let ((left (concatenated-stream-current stream)))
(when left
(let* ((current (car left))
(misc (stream-misc current)))
(case operation
(:listen
(loop
(let ((stuff (funcall misc current :listen)))
(cond ((eq stuff :eof)
;; Advance current, and try again.
(pop (concatenated-stream-current stream))
(setf current
(car (concatenated-stream-current stream)))
(unless current
;; No further streams. EOF.
(return :eof))
(setf misc (stream-misc current)))
(stuff
;; Stuff's available.
(return t))
(t
;; Nothing available yet.
(return nil))))))
(:close
(set-closed-flame stream))
(t
(funcall misc current operation arg1 arg2)))))))
;;;; Echo Streams:
(defstruct (echo-stream
(:include two-way-stream
(in #'echo-in)
(bin #'echo-bin)
(misc #'echo-misc)
(n-bin #'ill-bin))
(:print-function %print-echo-stream)
(:constructor make-echo-stream (input-stream output-stream)))
unread-stuff)
(macrolet ((in-fun (name fun out-slot &rest args)
`(defun ,name (stream ,@args)
(or (pop (echo-stream-unread-stuff stream))
(let* ((in (echo-stream-input-stream stream))
(out (echo-stream-output-stream stream))
(result (,fun in ,@args)))
(funcall (,out-slot out) out result)
result)))))
(in-fun echo-in read-char stream-out eof-errorp eof-value)
(in-fun echo-bin read-byte stream-bout eof-errorp eof-value))
(defun echo-misc (stream operation &optional arg1 arg2)
(let* ((in (two-way-stream-input-stream stream))
(in-method (stream-misc in))
(out (two-way-stream-output-stream stream))
(out-method (stream-misc out)))
(case operation
(:listen (or (not (null (echo-stream-unread-stuff stream)))
(/= (the fixnum (stream-in-index in)) in-buffer-length)
(:unread (push arg1 (echo-stream-unread-stuff stream)))
(:element-type
(let ((in-type (funcall in-method in :element-type))
(out-type (funcall out-method out :element-type)))
(if (equal in-type out-type)
in-type `(and ,in-type ,out-type))))
(:close
(set-closed-flame stream))
(t
(or (funcall in-method in operation arg1 arg2)
(funcall out-method out operation arg1 arg2))))))
(defun %print-echo-stream (s stream d)
(declare (ignore d))
(format stream "#<Echo Stream, Input = ~S, Output = ~S>"
(two-way-stream-input-stream s)
(two-way-stream-output-stream s)))
(setf (documentation 'make-echo-stream 'function)
"Returns a bidirectional stream which gets its input from Input-Stream and
sends its output to Output-Stream. In addition, all input is echoed to
the output stream")
;;;; String Input Streams:
(defstruct (string-input-stream
(:include stream
(in #'string-inch)
(bin #'string-binch)
(n-bin #'string-stream-read-n-bytes)
(misc #'string-in-misc))
(:print-function %print-string-input-stream)
;(:constructor nil)
(:constructor internal-make-string-input-stream
(string current end)))
(string nil :type simple-string)
(current nil :type fixnum)
(end nil :type fixnum))
(defun %print-string-input-stream (s stream d)
(declare (ignore s d))
(write-string "#<String-Input Stream>" stream))
(defun string-inch (stream eof-errorp eof-value)
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(declare (simple-string string) (fixnum index))
(cond ((= index (the fixnum (string-input-stream-end stream)))
(eof-or-lose stream eof-errorp eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(aref string index)))))
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
(defun string-binch (stream eof-errorp eof-value)
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(declare (simple-string string) (fixnum index))
(cond ((= index (the fixnum (string-input-stream-end stream)))
(eof-or-lose stream eof-errorp eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(char-code (aref string index))))))
(defun string-stream-read-n-bytes (stream buffer start requested eof-errorp)
(declare (type string-input-stream stream)
(type index start requested))
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream))
(end (string-input-stream-end stream)))
(declare (simple-string string) (fixnum index end))
(cond ((>= (+ index requested) end)
(eof-or-lose stream eof-errorp nil))
(t
(setf (string-input-stream-current stream) (+ index requested))
(system:without-gcing
(system-area-copy (vector-sap string)
(* index vm:byte-bits)
(if (typep buffer 'system-area-pointer)
buffer
(vector-sap buffer))
(* start vm:byte-bits)
(* requested vm:byte-bits)))
requested))))
(:file-position
(if arg1
(setf (string-input-stream-current stream) arg1)
(string-input-stream-current stream)))
(:file-length (length (string-input-stream-string stream)))
(:listen (or (/= (the fixnum (string-input-stream-current stream))
(the fixnum (string-input-stream-end stream)))
:eof))
(:element-type 'base-char)))
(defun make-string-input-stream (string &optional
(start 0) (end (length string)))
"Returns an input stream which will supply the characters of String between
Start and End in order."
(declare (type string string)
(type index start)
(internal-make-string-input-stream (coerce string 'simple-string)
start end))
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
;;;; String Output Streams:
(defstruct (string-output-stream
(:include stream
(out #'string-ouch)
(sout #'string-sout)
(misc #'string-out-misc))
(:print-function %print-string-output-stream)
(:constructor make-string-output-stream ()))
;; The string we throw stuff in.
(string (make-string 40) :type simple-string)
;; Index of the next location to use.
(index 0 :type fixnum))
(defun %print-string-output-stream (s stream d)
(declare (ignore s d))
(write-string "#<String-Output Stream>" stream))
(setf (documentation 'make-string-output-stream 'function)
"Returns an Output stream which will accumulate all output given it for
the benefit of the function Get-Output-Stream-String.")
(defun string-ouch (stream character)
(let ((current (string-output-stream-index stream))
(workspace (string-output-stream-string stream)))
(declare (simple-string workspace) (fixnum current))
(if (= current (the fixnum (length workspace)))
(let ((new-workspace (make-string (* current 2))))
(replace new-workspace workspace)
(setf (aref new-workspace current) character)
(setf (string-output-stream-string stream) new-workspace))
(setf (aref workspace current) character))
(setf (string-output-stream-index stream) (1+ current))))
(defun string-sout (stream string start end)
(declare (simple-string string) (fixnum start end))
(let* ((current (string-output-stream-index stream))
(length (- end start))
(dst-end (+ length current))
(workspace (string-output-stream-string stream)))
(declare (simple-string workspace)
(fixnum current length dst-end))
(if (> dst-end (the fixnum (length workspace)))
(let ((new-workspace (make-string (+ (* current 2) length))))
(replace new-workspace workspace :end2 current)
(replace new-workspace string
:start1 current :end1 dst-end
:start2 start :end2 end)
(replace workspace string
:start1 current :end1 dst-end
:start2 start :end2 end))
(setf (string-output-stream-index stream) dst-end)))
(defun string-out-misc (stream operation &optional arg1 arg2)
(:file-position
(if (null arg1)