ecl/src/lsp/iolib.lsp

350 lines
15 KiB
Common Lisp

;;;; -*- Mode: Lisp; Syntax: Common-Lisp; indent-tabs-mode: nil; Package: SYSTEM -*-
;;;; vim: set filetype=lisp tabstop=8 shiftwidth=2 expandtab:
;;;;
;;;; Copyright (c) 1984, Taiichi Yuasa and Masami Hagiya.
;;;; Copyright (c) 1990, Giuseppe Attardi.
;;;; Copyright (c) 2001, Juan Jose Garcia Ripoll.
;;;;
;;;; See file 'LICENSE' for the copyright details.
;;;; The IO library.
(in-package "SYSTEM")
(defmacro with-open-stream ((var stream) &rest body)
"Syntax: (with-open-stream (var stream-form) {decl}* {form}*)
Evaluates FORMs with VAR bound to the value of STREAM-FORM. The stream is
automatically closed on exit."
(multiple-value-bind (ds b)
(find-declarations body)
`(LET ((,var ,stream))
,@ds
(UNWIND-PROTECT
(PROGN ,@b)
(CLOSE ,var)))))
(defmacro with-input-from-string ((var string &key index (start 0) end) &rest body)
"Syntax: (with-input-from-string (var string-form {keyword value}*)
{decl}* {form}*)
Evaluates FORMs with VAR bound to a string input stream from the string that
is the value of STRING-FORM. The stream is automatically closed on exit.
Possible keywords are :INDEX, :START, and :END."
(multiple-value-bind (ds b)
(find-declarations body)
`(let ((,var (make-string-input-stream ,string ,start ,end)))
,@ds
(unwind-protect
,(if index
`(multiple-value-prog1
(progn ,@b)
(setf ,index (file-position ,var)))
`(progn ,@b))
(close ,var)))))
(defmacro with-output-to-string ((var &optional string &rest r &key element-type) &rest body)
"Syntax: (with-output-to-string (var [string-form]) {decl}* {form}*)
Evaluates FORMs with VAR bound to a string output stream to the string that is
the value of STRING-FORM. If STRING-FORM is not given, a new string is used.
The stream is automatically closed on exit and the string is returned."
(multiple-value-bind (decls body)
(find-declarations body)
(if string
(with-gensyms (elt-type-var)
`(let ((,var (make-string-output-stream-from-string ,string))
;; We must evaluate element-type for side effects.
(,elt-type-var ,element-type))
(declare (ignore ,elt-type-var))
,@decls
(unwind-protect (progn ,@body)
(close ,var))))
`(let ((,var (make-string-output-stream ,@r)))
,@decls
(unwind-protect (progn
,@body
(get-output-stream-string ,var))
(close ,var))))))
(defun read-from-string (string
&optional (eof-error-p t) eof-value
&key (start 0) (end (length string))
preserve-whitespace)
"Args: (string &optional (eof-error-p t) (eof-value nil)
&key (start 0) (end (length string)) (preserve-whitespace nil))
Reads an object from STRING and returns the object. As the second value,
returns the index to the character next to the object's representation.
PRESERVE-WHITESPACE specifies whether to leave the character next to the
object's representation."
(let ((stream (make-string-input-stream string start end)))
(if preserve-whitespace
(values (read-preserving-whitespace stream eof-error-p eof-value)
(file-position stream))
(values (read stream eof-error-p eof-value)
(file-position stream)))))
(defun si::string-to-object (string &optional (err-value nil err-value-p))
(if err-value-p
(si::safe-eval `(read-from-string ,string) nil err-value)
(si::safe-eval `(read-from-string ,string) nil)))
(defun write-to-string (object &rest rest
&aux (stream (make-string-output-stream)))
"Args: (object &key (escape *print-escape*) (radix *print-radix*)
(base *print-base*) (circle *print-circle*)
(pretty *print-pretty*) (level *print-level*)
(length *print-length*) (case *print-case*)
(array *print-array*) (gensym *print-gensym*))
Returns as a string the printed representation of OBJECT in the specified
mode. See the variable docs of *PRINT-...* for the mode."
(apply #'write object :stream stream rest)
(get-output-stream-string stream))
(defun prin1-to-string (object
&aux (stream (make-string-output-stream)))
"Args: (object)
PRIN1s OBJECT to a new string and returns the result. Equivalent to
(WRITE-TO-STRING OBJECT :ESCAPE T)."
(prin1 object stream)
(get-output-stream-string stream))
(defun princ-to-string (object
&aux (stream (make-string-output-stream)))
"Args: (object)
PRINCs OBJECT to a new string and returns the result. Equivalent to
(WRITE-TO-STRING OBJECT :ESCAPE NIL)."
(princ object stream)
(get-output-stream-string stream))
(defmacro with-open-file ((stream . filespec) &rest body)
"Syntax: (with-open-file (var filespec-form {options}*) {decl}* {form}*)
Opens the specified file using OPTIONs, and evaluates FORMs with VAR bound to
a stream to/from the file. The file is automatically closed on exit. See
OPEN for the options."
(multiple-value-bind (ds b)
(find-declarations body)
`(LET ((,stream (OPEN ,@filespec)))
,@ds
(UNWIND-PROTECT
(MULTIPLE-VALUE-PROG1 (PROGN ,@b) (WHEN ,stream (CLOSE ,stream)))
(WHEN ,stream (CLOSE ,stream :ABORT T))))))
(defun y-or-n-p (&optional string &rest args)
"Args: (&optional format-string &rest args)
Asks the user a Y-or-N question. Does FRESH-LINE, prints a message as if
FORMAT-STRING and ARGs were given to FORMAT, and then prints \"(Y or N)\" is
printed. If FORMAT-STRING is NIL, however, no prompt will appear."
(do ((reply))
(nil)
(when string (format *query-io* "~&~? (Y or N) " string args))
(setq reply (read *query-io*))
(cond ((string-equal (symbol-name reply) "Y")
(return-from y-or-n-p t))
((string-equal (symbol-name reply) "N")
(return-from y-or-n-p nil)))))
(defun yes-or-no-p (&optional string &rest args)
"Args: (&optional format-string &rest args)
Asks the user an YES-or-NO question. Does FRESH-LINE, prints a message as if
FORMAT-STRING and ARGs were given to FORMAT, and then prints \"(Y or N)\" is
printed. If FORMAT-STRING is NIL, however, no prompt will appear."
(do ((reply))
(nil)
(when string (format *query-io* "~&~? (Yes or No) " string args))
(setq reply (read *query-io*))
(cond ((string-equal (symbol-name reply) "YES")
(return-from yes-or-no-p t))
((string-equal (symbol-name reply) "NO")
(return-from yes-or-no-p nil)))))
(defun sharp-a-reader (stream subchar arg)
(declare (ignore subchar))
(let ((initial-contents (read stream nil nil t)))
(cond
(*read-suppress* nil)
((null arg)
;; readably-pretty-printed array: #A(type dims initial-contents)
(let ((elt-type (car initial-contents))
(dims (cadr initial-contents))
(initial-contents (caddr initial-contents)))
(make-array dims :element-type elt-type :initial-contents initial-contents)))
(t
(do* ((i 0 (1+ i))
(d nil (cons (length ic) d))
(ic initial-contents (if (zerop (length ic)) ic (elt ic 0))))
((>= i arg)
(make-array (nreverse d) :initial-contents initial-contents))
(declare (fixnum i)))))))
(set-dispatch-macro-character #\# #\a 'sharp-a-reader)
(set-dispatch-macro-character #\# #\A 'sharp-a-reader)
(defun sharp-s-reader (stream subchar arg)
(declare (ignore subchar))
(when (and arg (null *read-suppress*))
(error "~S is an extra argument for the #s readmacro." arg))
(let ((l (read stream t nil t)))
(when *read-suppress*
(return-from sharp-s-reader nil))
(unless (get-sysprop (car l) 'is-a-structure)
(error "~S is not a structure." (car l)))
;; Intern keywords in the keyword package.
(do ((ll (cdr l) (cddr ll)))
((endp ll)
;; Find an appropriate construtor.
(do ((cs (get-sysprop (car l) 'structure-constructors) (cdr cs)))
((endp cs)
(error "The structure ~S has no structure constructor."
(car l)))
(when (symbolp (car cs))
(return (apply (car cs) (cdr l))))))
(rplaca ll (intern (string (car ll)) 'keyword)))))
(set-dispatch-macro-character #\# #\s 'sharp-s-reader)
(set-dispatch-macro-character #\# #\S 'sharp-s-reader)
(defparameter *dribble-closure* nil)
(defun dribble (&optional (pathname "DRIBBLE.LOG" psp))
"Args: (&optional filespec)
If FILESPEC is given, starts recording the interaction to the specified file.
FILESPEC may be a symbol, a string, a pathname, or a file stream. If FILESPEC
is not given, ends the recording."
(cond (*dribble-closure*
(funcall *dribble-closure* psp))
((null psp)
(error "Not in dribble."))
(t
(let* ((namestring (namestring pathname))
(stream (open pathname :direction :output
:if-exists :supersede
:if-does-not-exist :create))
(dribble-stream (make-two-way-stream
(make-echo-stream *terminal-io* stream)
(make-broadcast-stream *terminal-io* stream)))
(standard-input *standard-input*)
(standard-output *standard-output*)
(closure #'(lambda (pathname-p)
(when pathname-p
(error "Already in dribble (to ~A)" namestring))
(unless (and (eq dribble-stream *standard-input*)
(eq dribble-stream *standard-output*))
(warn "Stream variables rebound while DRIBBLE is on.~%Some output may be lost."))
(format stream "~&Finished dribbling to ~A." namestring)
(close stream)
(setq *standard-input* standard-input
*standard-output* standard-output
*dribble-closure* nil))))
(multiple-value-bind (sec min hour day month year)
(get-decoded-time)
(format dribble-stream "~&Starts dribbling to ~A (~d/~d/~d, ~2,'0d:~2,'0d:~2,'0d)."
namestring year month day hour min sec)
(setq *standard-input* dribble-stream
*standard-output* dribble-stream
*dribble-closure* closure)))))
(values))
;(provide 'iolib)
(defmacro with-standard-io-syntax (&body body)
"Syntax: ({forms}*)
The forms of the body are executed in a print environment that corresponds to
the one defined in the ANSI standard. *print-base* is 10, *print-array* is t,
*package* is \"CL-USER\", etc."
(with-clean-symbols (%progv-list)
`(let ((%progv-list +io-syntax-progv-list+))
(progv (si:cons-car %progv-list)
(si:cons-cdr %progv-list)
,@body))))
(defmacro with-ecl-io-syntax (&body body)
"Syntax: ({forms}*)
The forms of the body are executed in a print environment that corresponds to
the one used internally by ECL compiled files."
(with-clean-symbols (%progv-list)
`(let ((%progv-list +ecl-syntax-progv-list+))
(progv (si:cons-car %progv-list)
(si:cons-cdr %progv-list)
,@body))))
#-formatter
(defmacro formatter (control-string)
`#'(lambda (*standard-output* &rest args)
(si::formatter-aux *standard-output* ,control-string args)))
(defmacro print-unreadable-object
((object stream &key type identity) &body body)
(if body
`(flet ((.print-unreadable-object-body. () ,@body))
(print-unreadable-object-function
,object ,stream ,type ,identity #'.print-unreadable-object-body.))
`(print-unreadable-object-function ,object ,stream ,type ,identity nil)))
(let* ((basic-encodings
#+unicode
'(:UTF-8 :UCS-2 :UCS-2BE :UCS-2LE :UCS-4 :UCS-4BE :UCS-4LE
:ISO-8859-1 :LATIN-1 :US-ASCII :DEFAULT)
#-unicode
'(:DEFAULT))
(all-encodings nil))
(defun ext:all-encodings ()
(or all-encodings
(progn
(setf all-encodings basic-encodings)
#+unicode
(dolist (i (directory "sys:encodings;*"))
(push (intern (string-upcase (pathname-name i)) "KEYWORD") all-encodings))
all-encodings))))
(defun ext:load-encoding (name)
#-unicode
(warn "EXT:LOAD-ENCODING not available when ECL is built without support for Unicode")
#+unicode
(let ((ext:*default-external-format* t) ; circularity: processing filenames needs encodings itself
(filename (make-pathname :name (symbol-name name) :defaults "sys:encodings;")))
(cond ((probe-file filename)
(load filename :verbose nil)
name)
((probe-file (setf filename (make-pathname :type "BIN" :defaults filename)))
(with-open-file (in filename :element-type '(unsigned-byte 16)
:external-format :big-endian)
(let* ((l (read-byte in))
(s (make-array l :element-type '(unsigned-byte 16) :initial-element 0)))
(read-sequence s in)
s)))
(t
(error "Unable to find mapping file ~A for encoding ~A" filename name)))))
(defun ext:make-encoding (mapping)
#-unicode
(error "Not a valid external format ~A" mapping)
#+unicode
(cond
((symbolp mapping)
(let ((var (intern (symbol-name mapping) (find-package "EXT"))))
(unless (boundp var)
(setf (symbol-value var) (ext::make-encoding (load-encoding mapping))))
(symbol-value var)))
((consp mapping)
(let ((output (make-hash-table :size 512 :test 'eq)))
(dolist (record mapping output)
(let* ((byte (car record))
(unicode (cdr record))
(unicode-char (code-char unicode)))
(when (> byte #xFF)
(setf (gethash (ash byte -8) output) t))
(setf (gethash byte output) unicode-char)
(setf (gethash unicode-char output) byte)))))
((arrayp mapping)
(do* ((l (array-total-size mapping))
(output (make-hash-table :size (floor (* 1.5 l)) :test 'eq))
(i 0 (+ 2 i)))
((>= i l) output)
(let* ((byte (aref mapping i))
(unicode (aref mapping (1+ i)))
(unicode-char (code-char unicode)))
(when (> byte #xFF)
(setf (gethash (ash byte -8) output) t))
(setf (gethash byte output) unicode-char)
(setf (gethash unicode-char output) byte))))
(t
(error "Not a valid external format ~A" mapping))))