X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fpprint.lisp;h=5c1a353696e86d5dea380bfbea4052c5991fb786;hb=0e3c4b4db102bd204a30402d7e5a0de44aea57ce;hp=74c368c966d3882d8062c4940ef31bcc54d73a65;hpb=e303f38caaf6055614e7cf5cc542cfb7da22d070;p=sbcl.git diff --git a/src/code/pprint.lisp b/src/code/pprint.lisp index 74c368c..5c1a353 100644 --- a/src/code/pprint.lisp +++ b/src/code/pprint.lisp @@ -75,12 +75,12 @@ ;; Buffer holding the per-line prefix active at the buffer start. ;; Indentation is included in this. The length of this is stored ;; in the logical block stack. - (prefix (make-string initial-buffer-size) :type simple-string) + (prefix (make-string initial-buffer-size) :type (simple-array character (*))) ;; Buffer holding the total remaining suffix active at the buffer start. ;; The characters are right-justified in the buffer to make it easier ;; to output the buffer. The length is stored in the logical block ;; stack. - (suffix (make-string initial-buffer-size) :type simple-string) + (suffix (make-string initial-buffer-size) :type (simple-array character (*))) ;; Queue of pending operations. When empty, HEAD=TAIL=NIL. Otherwise, ;; TAIL holds the first (oldest) cons and HEAD holds the last (newest) ;; cons. Adding things to the queue is basically (setf (cdr head) (list @@ -679,7 +679,7 @@ "Output a conditional newline to STREAM (which defaults to *STANDARD-OUTPUT*) if it is a pretty-printing stream, and do nothing if not. KIND can be one of: - :LINEAR - A line break is inserted if and only if the immediatly + :LINEAR - A line break is inserted if and only if the immediately containing section cannot be printed on one line. :MISER - Same as LINEAR, but only if ``miser-style'' is in effect. (See *PRINT-MISER-WIDTH*.) @@ -691,7 +691,7 @@ line and miser-style is in effect. :MANDATORY - A line break is always inserted. When a line break is inserted by any type of conditional newline, any - blanks that immediately precede the conditional newline are ommitted + blanks that immediately precede the conditional newline are omitted from the output and indentation is introduced at the beginning of the next line. (See PPRINT-INDENT.)" (declare (type (member :linear :miser :fill :mandatory) kind) @@ -813,7 +813,8 @@ line break." ;;;; pprint-dispatch tables -(defvar *initial-pprint-dispatch*) +(defvar *standard-pprint-dispatch-table*) +(defvar *initial-pprint-dispatch-table*) (defvar *building-initial-table* nil) (defstruct (pprint-dispatch-entry (:copier nil)) @@ -868,7 +869,7 @@ line break." ,x)))) (defvar *precompiled-pprint-dispatch-funs* (list (frob array (typep object 'array)) - (frob sharp-function (and (consp object) + (frob function-call (and (consp object) (symbolp (car object)) (fboundp (car object)))) (frob cons (typep object 'cons))))) @@ -920,7 +921,7 @@ line break." (defun copy-pprint-dispatch (&optional (table *print-pprint-dispatch*)) (declare (type (or pprint-dispatch-table null) table)) - (let* ((orig (or table *initial-pprint-dispatch*)) + (let* ((orig (or table *initial-pprint-dispatch-table*)) (new (make-pprint-dispatch-table :entries (copy-list (pprint-dispatch-table-entries orig)))) (new-cons-entries (pprint-dispatch-table-cons-entries new))) @@ -931,7 +932,7 @@ line break." (defun pprint-dispatch (object &optional (table *print-pprint-dispatch*)) (declare (type (or pprint-dispatch-table null) table)) - (let* ((table (or table *initial-pprint-dispatch*)) + (let* ((table (or table *initial-pprint-dispatch-table*)) (cons-entry (and (consp object) (gethash (car object) @@ -949,6 +950,11 @@ line break." (output-ugly-object object stream)) nil)))) +(defun assert-not-standard-pprint-dispatch-table (pprint-dispatch operation) + (when (eq pprint-dispatch *standard-pprint-dispatch-table*) + (cerror "Frob it anyway!" 'standard-pprint-dispatch-table-modified-error + :operation operation))) + (defun set-pprint-dispatch (type function &optional (priority 0) (table *print-pprint-dispatch*)) (declare (type (or null callable) function) @@ -956,6 +962,7 @@ line break." (type pprint-dispatch-table table)) (/show0 "entering SET-PPRINT-DISPATCH, TYPE=...") (/hexstr type) + (assert-not-standard-pprint-dispatch-table table 'set-pprint-dispatch) (if function (if (cons-type-specifier-p type) (setf (gethash (second (second type)) @@ -996,14 +1003,15 @@ line break." ;;;; standard pretty-printing routines (defun pprint-array (stream array) - (cond ((or (and (null *print-array*) (null *print-readably*)) - (stringp array) - (bit-vector-p array)) + (cond ((and (null *print-array*) (null *print-readably*)) (output-ugly-object array stream)) ((and *print-readably* (not (array-readably-printable-p array))) - (let ((*print-readably* nil)) - (error 'print-not-readable :object array))) + (if *read-eval* + (if (vectorp array) + (sb!impl::output-unreadable-vector-readably array stream) + (sb!impl::output-unreadable-array-readably array stream)) + (print-not-readable-error array stream))) ((vectorp array) (pprint-vector stream array)) (t @@ -1132,7 +1140,10 @@ line break." (declare (ignore noise)) (if (and (consp list) (consp (cdr list)) - (cddr list)) + (cddr list) + ;; Filter out (FLET FOO :IN BAR) names. + (and (consp (cddr list)) + (not (eq :in (third list))))) (funcall (formatter "~:<~^~W~^ ~@_~:<~@{~:<~^~W~^~3I ~:_~/SB!PRETTY:PPRINT-LAMBDA-LIST/~1I~:@_~@{~W~^ ~_~}~:>~^ ~_~}~:>~1I~@:_~@{~W~^ ~_~}~:>") stream @@ -1154,18 +1165,26 @@ line break." (defun pprint-progn (stream list &rest noise) (declare (ignore noise)) - (funcall (formatter "~:<~^~W~@{ ~_~W~}~:>") stream list)) + (pprint-linear stream list)) (defun pprint-progv (stream list &rest noise) (declare (ignore noise)) (funcall (formatter "~:<~^~W~^~3I ~_~W~^ ~_~W~^~1I~@{ ~_~W~}~:>") stream list)) +(defun pprint-prog2 (stream list &rest noise) + (declare (ignore noise)) + (funcall (formatter "~:<~^~W~^~3I ~:_~W~^ ~_~W~^~1I~@{ ~_~W~}~:>") + stream list)) + +(defvar *pprint-quote-with-syntactic-sugar* t) + (defun pprint-quote (stream list &rest noise) (declare (ignore noise)) (if (and (consp list) (consp (cdr list)) - (null (cddr list))) + (null (cddr list)) + *pprint-quote-with-syntactic-sugar*) (case (car list) (function (write-string "#'" stream) @@ -1177,6 +1196,21 @@ line break." (pprint-fill stream list))) (pprint-fill stream list))) +(defun pprint-declare (stream list &rest noise) + (declare (ignore noise)) + ;; Make sure to print (DECLARE (FUNCTION F)) not (DECLARE #'A). + (let ((*pprint-quote-with-syntactic-sugar* nil)) + (pprint-spread-fun-call stream list))) + +;;; Try to print every variable-value pair on one line; if that doesn't +;;; work print the value indented by 2 spaces: +;;; +;;; (setq foo bar +;;; quux xoo) +;;; vs. +;;; (setf foo +;;; (long form ...) +;;; quux xoo) (defun pprint-setq (stream list &rest noise) (declare (ignore noise)) (pprint-logical-block (stream list :prefix "(" :suffix ")") @@ -1184,26 +1218,21 @@ line break." (output-object (pprint-pop) stream) (pprint-exit-if-list-exhausted) (write-char #\space stream) + (unless (listp (cdr list)) + (write-string ". " stream)) (pprint-newline :miser stream) - (if (and (consp (cdr list)) (consp (cddr list))) - (loop - (pprint-indent :current 2 stream) - (output-object (pprint-pop) stream) - (pprint-exit-if-list-exhausted) - (write-char #\space stream) - (pprint-newline :linear stream) - (pprint-indent :current -2 stream) - (output-object (pprint-pop) stream) - (pprint-exit-if-list-exhausted) - (write-char #\space stream) - (pprint-newline :linear stream)) - (progn - (pprint-indent :current 0 stream) - (output-object (pprint-pop) stream) - (pprint-exit-if-list-exhausted) - (write-char #\space stream) - (pprint-newline :linear stream) - (output-object (pprint-pop) stream))))) + (pprint-logical-block (stream (cdr list) :prefix "" :suffix "") + (loop + (pprint-indent :block 2 stream) + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (write-char #\space stream) + (pprint-newline :fill stream) + (pprint-indent :block 0 stream) + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (write-char #\space stream) + (pprint-newline :mandatory stream))))) ;;; FIXME: could become SB!XC:DEFMACRO wrapped in EVAL-WHEN (COMPILE EVAL) (defmacro pprint-tagbody-guts (stream) @@ -1238,6 +1267,17 @@ line break." stream list)) +(defun pprint-defmethod (stream list &rest noise) + (declare (ignore noise)) + (if (and (consp (cdr list)) + (consp (cddr list)) + (consp (third list))) + (pprint-defun stream list) + (funcall (formatter + "~:<~^~W~^ ~@_~:I~W~^ ~W~^ ~:_~/SB!PRETTY:PPRINT-LAMBDA-LIST/~1I~@{ ~_~W~}~:>") + stream + list))) + (defun pprint-defpackage (stream list &rest noise) (declare (ignore noise)) (funcall (formatter @@ -1300,15 +1340,126 @@ line break." (pprint-fill stream (pprint-pop)) (pprint-tagbody-guts stream))) +;;; Each clause in this list will get its own line. +(defvar *loop-seperating-clauses* + '(:and + :with :for + :initially :finally + :do :doing + :collect :collecting + :append :appending + :nconc :nconcing + :count :counting + :sum :summing + :maximize :maximizing + :minimize :minimizing + :if :when :unless :end + :for :while :until :repeat :always :never :thereis + )) + +(defun pprint-extended-loop (stream list) + (pprint-logical-block (stream list :prefix "(" :suffix ")") + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (write-char #\space stream) + (pprint-indent :current 0 stream) + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (write-char #\space stream) + (loop for thing = (pprint-pop) + when (and (symbolp thing) + (member thing *loop-seperating-clauses* :test #'string=)) + do (pprint-newline :mandatory stream) + do (output-object thing stream) + do (pprint-exit-if-list-exhausted) + do (write-char #\space stream)))) + +(defun pprint-loop (stream list &rest noise) + (declare (ignore noise)) + (destructuring-bind (loop-symbol . clauses) list + (declare (ignore loop-symbol)) + (if (or (atom clauses) (consp (car clauses))) + (pprint-spread-fun-call stream list) + (pprint-extended-loop stream list)))) + +(defun pprint-if (stream list &rest noise) + (declare (ignore noise)) + ;; Indent after the ``predicate'' form, and the ``then'' form. + (funcall (formatter "~:<~^~W~^ ~:I~W~^ ~:@_~@{~W~^ ~:@_~}~:>") + stream + list)) + (defun pprint-fun-call (stream list &rest noise) (declare (ignore noise)) (funcall (formatter "~:<~^~W~^ ~:_~:I~@{~W~^ ~:_~}~:>") stream list)) +(defun pprint-spread-fun-call (stream list &rest noise) + (declare (ignore noise)) + ;; Similiar to PPRINT-FUN-CALL but emit a mandatory newline after + ;; each parameter. I.e. spread out each parameter on its own line. + (funcall (formatter "~:<~^~W~^ ~:_~:I~@{~W~^ ~:@_~}~:>") + stream + list)) + (defun pprint-data-list (stream list &rest noise) (declare (ignore noise)) - (funcall (formatter "~:<~@{~W~^ ~:_~}~:>") stream list)) + (pprint-fill stream list)) + +;;; Returns an Emacs-style indent spec: an integer N, meaning indent +;;; the first N arguments specially then indent any further arguments +;;; like a body. +(defun macro-indentation (name) + (labels ((proper-list-p (list) + (not (nth-value 1 (ignore-errors (list-length list))))) + (macro-arglist (name) + (%simple-fun-arglist (macro-function name))) + (clean-arglist (arglist) + "Remove &whole, &enviroment, and &aux elements from ARGLIST." + (cond ((null arglist) '()) + ((member (car arglist) '(&whole &environment)) + (clean-arglist (cddr arglist))) + ((eq (car arglist) '&aux) + '()) + (t (cons (car arglist) (clean-arglist (cdr arglist))))))) + (let ((arglist (macro-arglist name))) + (if (proper-list-p arglist) ; guard against dotted arglists + (position '&body (remove '&optional (clean-arglist arglist))) + nil)))) + +;;; Pretty-Print macros by looking where &BODY appears in a macro's +;;; lambda-list. +(defun pprint-macro-call (stream list &rest noise) + (declare (ignore noise)) + (let ((indentation (and (car list) (macro-indentation (car list))))) + (unless indentation + (return-from pprint-macro-call + (pprint-fun-call stream list))) + (pprint-logical-block (stream list :prefix "(" :suffix ")") + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (write-char #\space stream) + (loop for indent from 0 below indentation do + (cond + ;; Place the very first argument next to the macro name + ((zerop indent) + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted)) + ;; Indent any other non-body argument by the same + ;; amount. It's what Emacs seems to do, too. + (t + (pprint-indent :block 3 stream) + (pprint-newline :mandatory stream) + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted)))) + ;; Indent back for the body. + (pprint-indent :block 1 stream) + (pprint-newline :mandatory stream) + (loop + (output-object (pprint-pop) stream) + (pprint-exit-if-list-exhausted) + (pprint-newline :mandatory stream))))) ;;;; the interface seen by regular (ugly) printer and initialization routines @@ -1323,14 +1474,23 @@ line break." ;; printing the object after all. (output-ugly-object object stream)))) +(defun mboundp (name) + (and (fboundp name) (macro-function name) t)) + (defun !pprint-cold-init () (/show0 "entering !PPRINT-COLD-INIT") - (setf *initial-pprint-dispatch* (make-pprint-dispatch-table)) - (let ((*print-pprint-dispatch* *initial-pprint-dispatch*) + ;; Kludge: We set *STANDARD-PP-D-TABLE* to a new table even though + ;; it's going to be set to a copy of *INITIAL-PP-D-T* below because + ;; it's used in WITH-STANDARD-IO-SYNTAX, and condition reportery + ;; possibly performed in the following extent may use W-S-IO-SYNTAX. + (setf *standard-pprint-dispatch-table* (make-pprint-dispatch-table)) + (setf *initial-pprint-dispatch-table* (make-pprint-dispatch-table)) + (let ((*print-pprint-dispatch* *initial-pprint-dispatch-table*) (*building-initial-table* t)) - ;; printers for regular types (/show0 "doing SET-PPRINT-DISPATCH for regular types") - (set-pprint-dispatch 'array #'pprint-array) + (set-pprint-dispatch '(and array (not (or string bit-vector))) #'pprint-array) + (set-pprint-dispatch '(cons (and symbol (satisfies mboundp))) + #'pprint-macro-call -1) (set-pprint-dispatch '(cons (and symbol (satisfies fboundp))) #'pprint-fun-call -1) (set-pprint-dispatch '(cons symbol) @@ -1340,6 +1500,7 @@ line break." (/show0 "doing SET-PPRINT-DISPATCH for CONS with interesting CAR") (dolist (magic-form '((lambda pprint-lambda) + (declare pprint-declare) ;; special forms (block pprint-block) @@ -1347,6 +1508,7 @@ line break." (eval-when pprint-block) (flet pprint-flet) (function pprint-quote) + (if pprint-if) (labels pprint-flet) (let pprint-let) (let* pprint-let) @@ -1368,10 +1530,12 @@ line break." (case pprint-case) (ccase pprint-case) (ctypecase pprint-typecase) + (declaim pprint-declare) (defconstant pprint-block) (define-modify-macro pprint-defun) (define-setf-expander pprint-defun) (defmacro pprint-defun) + (defmethod pprint-defmethod) (defpackage pprint-defpackage) (defparameter pprint-block) (defsetf pprint-defun) @@ -1391,15 +1555,15 @@ line break." (etypecase pprint-typecase) #+nil (handler-bind ...) #+nil (handler-case ...) - #+nil (loop ...) - (multiple-value-bind pprint-progv) + (loop pprint-loop) + (multiple-value-bind pprint-prog2) (multiple-value-setq pprint-block) (pprint-logical-block pprint-block) (print-unreadable-object pprint-block) (prog pprint-prog) (prog* pprint-prog) (prog1 pprint-block) - (prog2 pprint-progv) + (prog2 pprint-prog2) (psetf pprint-setq) (psetq pprint-setq) #+nil (restart-bind ...) @@ -1419,7 +1583,11 @@ line break." (with-output-to-string pprint-block) (with-package-iterator pprint-block) (with-simple-restart pprint-block) - (with-standard-io-syntax pprint-progn))) + (with-standard-io-syntax pprint-progn) + + ;; sbcl specific + (sb!int:dx-flet pprint-flet) + )) (set-pprint-dispatch `(cons (eql ,(first magic-form))) (symbol-function (second magic-form)))) @@ -1429,5 +1597,8 @@ line break." (sb!impl::!backq-pp-cold-init) (/show0 "leaving !PPRINT-COLD-INIT")) - (setf *print-pprint-dispatch* (copy-pprint-dispatch nil)) + (setf *standard-pprint-dispatch-table* + (copy-pprint-dispatch *initial-pprint-dispatch-table*)) + (setf *print-pprint-dispatch* + (copy-pprint-dispatch *initial-pprint-dispatch-table*)) (setf *print-pretty* t))