byte-stream.lisp

   1 ;;; -*- Syntax: Ansi-Common-Lisp; Base: 10; Mode: lisp; Package: kmrcl -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          byte-stream.lisp
   6 ;;;; Purpose:       Byte array input/output streams
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  June 2003
   9 ;;;;
  10 ;;;; $Id: byte-stream.lisp,v 1.2 2003/08/02 22:19:37 kevin Exp $
  11 ;;;;
  12 ;;;; Works for CMUCL, SBCL, and AllergoCL only
  13 ;;;;
  14 ;;;; This file, part of KMRCL, is Copyright (c) 2003 by Kevin M. Rosenberg
  15 ;;;; and by onShore Development, Inc.
  16 ;;;;
  17 ;;;; KMRCL users are granted the rights to distribute and use this software
  18 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  19 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  20 ;;;; *************************************************************************
  21
  22 (in-package #:kmrcl)
  23
  24 ;; Intial CMUCL version by OnShored. Ported to SBCL by Kevin Rosenberg
  25
  26 #+(or cmu sbcl)
  27 (progn
  28 (defstruct (byte-array-output-stream
  29              (:include #+cmu system:lisp-stream
  30                        #+sbcl sb-impl::file-stream
  31                        (bout #'byte-array-bout)
  32                        (misc #'byte-array-out-misc))
  33              (:print-function %print-byte-array-output-stream)
  34              (:constructor make-byte-array-output-stream ()))
  35   ;; The buffer we throw stuff in.
  36   (buffer (make-array 128 :element-type '(unsigned-byte 8)))
  37   ;; Index of the next location to use.
  38   (index 0 :type fixnum))
  39
  40 (defun %print-byte-array-output-stream (s stream d)
  41   (declare (ignore s d))
  42   (write-string "#<Byte-Array-Output Stream>" stream))
  43
  44 (setf (documentation 'make-binary-output-stream 'function)
  45   "Returns an Output stream which will accumulate all output given it for
  46    the benefit of the function Get-Output-Stream-Data.")
  47
  48 (defun byte-array-bout (stream byte)
  49   (let ((current (byte-array-output-stream-index stream))
  50         (workspace (byte-array-output-stream-buffer stream)))
  51     (if (= current (length workspace))
  52         (let ((new-workspace (make-array (* current 2) :element-type '(unsigned-byte 8))))
  53           (replace new-workspace workspace)
  54           (setf (aref new-workspace current) byte)
  55           (setf (byte-array-output-stream-buffer stream) new-workspace))
  56         (setf (aref workspace current) byte))
  57     (setf (byte-array-output-stream-index stream) (1+ current))))
  58
  59 (defun byte-array-out-misc (stream operation &optional arg1 arg2)
  60   (declare (ignore arg2))
  61   (case operation
  62     (:file-position
  63      (if (null arg1)
  64          (byte-array-output-stream-index stream)))
  65     (:element-type '(unsigned-byte 8))))
  66
  67 (defun get-output-stream-data (stream)
  68   "Returns an array of all data sent to a stream made by
  69 Make-Byte-Array-Output-Stream since the last call to this function and
  70 clears buffer."
  71   (declare (type byte-array-output-stream stream))
  72     (prog1
  73         (dump-output-stream-data stream)
  74       (setf (byte-array-output-stream-index stream) 0)))
  75
  76 (defun dump-output-stream-data (stream)
  77   "Returns an array of all data sent to a stream made by
  78 Make-Byte-Array-Output-Stream since the last call to this function."
  79   (declare (type byte-array-output-stream stream))
  80   (let* ((length (byte-array-output-stream-index stream))
  81          (result (make-array length :element-type '(unsigned-byte 8))))
  82     (replace result (byte-array-output-stream-buffer stream))
  83     result))
  84
  85 ) ; progn
  86
  87
  88 #+(or cmu sbcl)
  89 (progn
  90   (defstruct (byte-array-input-stream
  91              (:include #+cmu system:lisp-stream
  92                        #+sbcl sb-impl::file-stream
  93                        (in #'byte-array-inch)
  94                        (bin #'byte-array-binch)
  95                        (n-bin #'byte-array-stream-read-n-bytes)
  96                        (misc #'byte-array-in-misc))
  97              (:print-function %print-byte-array-input-stream)
  98                                         ;(:constructor nil)
  99              (:constructor internal-make-byte-array-input-stream
 100                            (byte-array current end)))
 101   (byte-array nil :type vector)
 102   (current nil)
 103   (end nil))
 104
 105 (defun %print-byte-array-input-stream (s stream d)
 106   (declare (ignore s d))
 107   (write-string "#<Byte-Array-Input Stream>" stream))
 108
 109 (defun byte-array-inch (stream eof-errorp eof-value)
 110   (let ((byte-array (byte-array-input-stream-byte-array stream))
 111         (index (byte-array-input-stream-current stream)))
 112     (cond ((= index (byte-array-input-stream-end stream))
 113            (eof-or-lose stream eof-errorp eof-value))
 114           (t
 115            (setf (byte-array-input-stream-current stream) (1+ index))
 116            (aref byte-array index)))))
 117
 118 (defun byte-array-binch (stream eof-errorp eof-value)
 119   (let ((byte-array (byte-array-input-stream-byte-array stream))
 120         (index (byte-array-input-stream-current stream)))
 121     (cond ((= index (byte-array-input-stream-end stream))
 122            (eof-or-lose stream eof-errorp eof-value))
 123           (t
 124            (setf (byte-array-input-stream-current stream) (1+ index))
 125            (aref byte-array index)))))
 126
 127 (defun byte-array-stream-read-n-bytes (stream buffer start requested eof-errorp)
 128   (declare (type byte-array-input-stream stream))
 129   (let* ((byte-array (byte-array-input-stream-byte-array stream))
 130          (index (byte-array-input-stream-current stream))
 131          (available (- (byte-array-input-stream-end stream) index))
 132          (copy (min available requested)))
 133     (when (plusp copy)
 134       (setf (byte-array-input-stream-current stream)
 135         (+ index copy))
 136       #+cmu
 137       (system:without-gcing
 138        (system::system-area-copy (system:vector-sap byte-array)
 139                          (* index vm:byte-bits)
 140                          (if (typep buffer 'system::system-area-pointer)
 141                              buffer
 142                              (system:vector-sap buffer))
 143                          (* start vm:byte-bits)
 144                          (* copy vm:byte-bits)))
 145       #+sbcl
 146       (sb-sys:without-gcing
 147        (sb-kernel:system-area-copy (sb-sys:vector-sap byte-array)
 148                          (* index sb-vm:n-byte-bits)
 149                          (if (typep buffer 'sb-sys::system-area-pointer)
 150                              buffer
 151                              (sb-sys:vector-sap buffer))
 152                          (* start sb-vm:n-byte-bits)
 153                          (* copy sb-vm:n-byte-bits))))
 154     (if (and (> requested copy) eof-errorp)
 155         (error 'end-of-file :stream stream)
 156         copy)))
 157
 158 (defun byte-array-in-misc (stream operation &optional arg1 arg2)
 159   (declare (ignore arg2))
 160   (case operation
 161     (:file-position
 162      (if arg1
 163          (setf (byte-array-input-stream-current stream) arg1)
 164          (byte-array-input-stream-current stream)))
 165     (:file-length (length (byte-array-input-stream-byte-array stream)))
 166     (:unread (decf (byte-array-input-stream-current stream)))
 167     (:listen (or (/= (the fixnum (byte-array-input-stream-current stream))
 168                      (the fixnum (byte-array-input-stream-end stream)))
 169                  :eof))
 170     (:element-type 'base-char)))
 171
 172 (defun make-byte-array-input-stream (buffer &optional (start 0) (end (length buffer)))
 173   "Returns an input stream which will supply the bytes of BUFFER between
 174   Start and End in order."
 175   (internal-make-byte-array-input-stream buffer start end))
 176
 177 ) ;; progn
 178
 179
 180 ;;; Simple streams implementation by Kevin Rosenberg
 181
 182 #+allegro
 183 (progn
 184
 185   (defclass extendable-buffer-output-stream (excl:buffer-output-simple-stream)
 186     ()
 187     )
 188
 189   (defun make-byte-array-output-stream ()
 190     "Returns an Output stream which will accumulate all output given it for
 191    the benefit of the function Get-Output-Stream-Data."
 192     (make-instance 'extendable-buffer-output-stream
 193       :buffer (make-array 128 :element-type '(unsigned-byte 8))
 194       :external-form :octets))
 195
 196   (defun get-output-stream-data (stream)
 197     "Returns an array of all data sent to a stream made by
 198 Make-Byte-Array-Output-Stream since the last call to this function
 199 and clears buffer."
 200     (prog1
 201         (dump-output-stream-data stream)
 202       (file-position stream 0)))
 203
 204   (defun dump-output-stream-data (stream)
 205     "Returns an array of all data sent to a stream made by
 206 Make-Byte-Array-Output-Stream since the last call to this function."
 207     (force-output stream)
 208     (let* ((length (file-position stream))
 209            (result (make-array length :element-type '(unsigned-byte 8))))
 210       (replace result (slot-value stream 'excl::buffer))
 211       result))
 212
 213   (defmethod excl:device-extend ((stream extendable-buffer-output-stream)
 214                                  need action)
 215     (let* ((len (file-position stream))
 216            (new-len (max (+ len need) (* 2 len)))
 217            (old-buf (slot-value stream 'excl::buffer))
 218            (new-buf (make-array new-len :element-type '(unsigned-byte 8))))
 219       (declare (fixnum len)
 220                (optimize (speed 3) (safety 0)))
 221       (dotimes (i len)
 222         (setf (aref new-buf i) (aref old-buf i)))
 223       (setf (slot-value stream 'excl::buffer) new-buf)
 224       (setf (slot-value stream 'excl::buffer-ptr) new-len)
 225       )
 226     t)
 227
 228 )
 229
 230 #+allegro
 231 (progn
 232   (defun make-byte-array-input-stream (buffer &optional (start 0)
 233                                                         (end (length buffer)))
 234     (excl:make-buffer-input-stream buffer start end :octets))
 235   ) ;; progn