1.0.48.25: automatic &rest to &more conversion
[sbcl.git] / src / code / describe.lisp
1 ;;;; the DESCRIBE system
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 ;;; SB-IMPL, not SB!IMPL, since we're built in warm load.
13 (in-package "SB-IMPL")
14
15 ;;;; Utils, move elsewhere.
16
17 (defun class-name-or-class (class)
18   (let ((name (class-name class)))
19     (if (eq class (find-class name nil))
20         name
21         class)))
22
23 (defun fun-name (x)
24   (if (typep x 'generic-function)
25       (sb-pcl:generic-function-name x)
26       (%fun-name x)))
27
28 ;;; Prints X on a single line, limiting output length by *PRINT-RIGHT-MARGIN*
29 ;;; -- good for printing object parts, etc.
30 (defun prin1-to-line (x &key (columns 1) (reserve 0))
31   (let* ((line (write-to-string x :escape t :readably nil :lines 2 :circle t))
32          (p (position #\newline line))
33          (limit (truncate (- *print-right-margin* reserve) columns)))
34     (flet ((trunc (&optional end)
35              (let ((line-end (- limit 2)))
36                (with-output-to-string (s)
37                  (write-string line s :end (if end
38                                                (min end line-end)
39                                                line-end))
40                  (write-string ".." s)))))
41       (cond (p
42              (trunc p))
43             ((> (length line) limit)
44              (trunc))
45             (t
46              line)))))
47
48 (defun describe (object &optional (stream-designator *standard-output*))
49   #+sb-doc
50   "Print a description of OBJECT to STREAM-DESIGNATOR."
51   (let ((stream (out-synonym-of stream-designator))
52         (*print-right-margin* (or *print-right-margin* 72)))
53     ;; Until sbcl-0.8.0.x, we did
54     ;;   (FRESH-LINE STREAM)
55     ;;   (PPRINT-LOGICAL-BLOCK (STREAM NIL)
56     ;;     ...
57     ;; here. However, ANSI's specification of DEFUN DESCRIBE,
58     ;;   DESCRIBE exists as an interface primarily to manage argument
59     ;;   defaulting (including conversion of arguments T and NIL into
60     ;;   stream objects) and to inhibit any return values from
61     ;;   DESCRIBE-OBJECT.
62     ;; doesn't mention either FRESH-LINEing or PPRINT-LOGICAL-BLOCKing,
63     ;; and the example of typical DESCRIBE-OBJECT behavior in ANSI's
64     ;; specification of DESCRIBE-OBJECT will work poorly if we do them
65     ;; here. (The example method for DESCRIBE-OBJECT does its own
66     ;; FRESH-LINEing, which is a physical directive which works poorly
67     ;; inside a pretty-printer logical block.)
68     (describe-object object stream)
69     ;; We don't TERPRI here either (any more since sbcl-0.8.0.x), because
70     ;; again ANSI's specification of DESCRIBE doesn't mention it and
71     ;; ANSI's example of DESCRIBE-OBJECT does its own final TERPRI.
72     (values)))
73 \f
74 ;;;; DESCRIBE-OBJECT
75 ;;;;
76 ;;;; Style guide:
77 ;;;;
78 ;;;; * Each interesting class has a primary method of its own.
79 ;;;;
80 ;;;; * Output looks like
81 ;;;;
82 ;;;;    object-self-string
83 ;;;;      [object-type-string]
84 ;;;;
85 ;;;;    Block1:
86 ;;;;      Sublabel1: text
87 ;;;;      Sublabel2: text
88 ;;;;
89 ;;;;    Block2:
90 ;;;;      ...
91 ;;;;
92 ;;;; * The newline policy that gets the whitespace right is for
93 ;;;;   each block to both start and end with a newline.
94
95 (defgeneric object-self-string (x))
96
97 (defmethod object-self-string (x)
98   (prin1-to-line x))
99
100 (defmethod object-self-string ((x symbol))
101   (let ((*package* (find-package :keyword)))
102     (prin1-to-string x)))
103
104 (defgeneric object-type-string (x))
105
106 (defmethod object-type-string (x)
107   (let ((type (class-name-or-class (class-of x))))
108     (if (symbolp type)
109         (string-downcase type)
110         (prin1-to-string type))))
111
112 (defmethod object-type-string ((x cons))
113   (if (listp (cdr x)) "list" "cons"))
114
115 (defmethod object-type-string ((x hash-table))
116   "hash-table")
117
118 (defmethod object-type-string ((x condition))
119   "condition")
120
121 (defmethod object-type-string ((x structure-object))
122   "structure-object")
123
124 (defmethod object-type-string ((x standard-object))
125   "standard-object")
126
127 (defmethod object-type-string ((x function))
128   (typecase x
129     (simple-fun "compiled function")
130     (closure "compiled closure")
131     #+sb-eval
132     (sb-eval:interpreted-function
133      "interpreted function")
134     (generic-function
135      "generic-function")
136     (t
137      "funcallable-instance")))
138
139 (defmethod object-type-string ((x stream))
140   "stream")
141
142 (defmethod object-type-string ((x sb-gray:fundamental-stream))
143   "gray stream")
144
145 (defmethod object-type-string ((x package))
146   "package")
147
148 (defmethod object-type-string ((x array))
149   (cond ((or (stringp x) (bit-vector-p x))
150          (format nil "~@[simple-~*~]~A"
151                  (typep x 'simple-array)
152                  (typecase x
153                    (base-string "base-string")
154                    (string "string")
155                    (t "bit-vector"))))
156         (t
157          (if (simple-vector-p x)
158              "simple-vector"
159              (format nil "~@[simple ~*~]~@[specialized ~*~]~:[array~;vector~]"
160                      (typep x 'simple-array)
161                      (neq t (array-element-type x))
162                      (vectorp x))))))
163
164 (defmethod object-type-string ((x character))
165   (typecase x
166     (standard-char "standard-char")
167     (base-char "base-char")
168     (t "character")))
169
170 (defun print-standard-describe-header (x stream)
171   (format stream "~&~A~%  [~A]~%"
172           (object-self-string x)
173           (object-type-string x)))
174
175 (defgeneric describe-object (x stream))
176
177 ;;; Catch-all.
178
179 (defmethod describe-object ((x t) s)
180   (print-standard-describe-header x s))
181
182 (defmethod describe-object ((x cons) s)
183   (print-standard-describe-header x s)
184   (describe-function x nil s))
185
186 (defmethod describe-object ((x function) s)
187   (print-standard-describe-header x s)
188   (describe-function nil x s))
189
190 (defmethod describe-object ((x class) s)
191   (print-standard-describe-header x s)
192   (describe-class nil x s)
193   (describe-instance x s))
194
195 (defmethod describe-object ((x sb-pcl::slot-object) s)
196   (print-standard-describe-header x s)
197   (describe-instance x s))
198
199 (defmethod describe-object ((x character) s)
200   (print-standard-describe-header x s)
201   (format s "~%:_Char-code: ~S" (char-code x))
202   (format s "~%:_Char-name: ~A~%_" (char-name x)))
203
204 (defmethod describe-object ((x array) s)
205   (print-standard-describe-header x s)
206   (format s "~%Element-type: ~S" (array-element-type x))
207   (if (vectorp x)
208       (if (array-has-fill-pointer-p x)
209           (format s "~%Fill-pointer: ~S~%Size: ~S"
210                   (fill-pointer x)
211                   (array-total-size x))
212           (format s "~%Length: ~S" (length x)))
213       (format s "~%Dimensions: ~S" (array-dimensions x)))
214   (let ((*print-array* nil))
215     (unless (typep x 'simple-array)
216       (format s "~%Adjustable: ~A" (if (adjustable-array-p x) "yes" "no"))
217       (multiple-value-bind (to offset) (array-displacement x)
218         (if (format s "~%Displaced-to: ~A~%Displaced-offset: ~S"
219                     (prin1-to-line to)
220                     offset)
221             (format s "~%Displaced: no"))))
222     (when (and (not (array-displacement x)) (array-header-p x))
223       (format s "~%Storage vector: ~A"
224               (prin1-to-line (array-storage-vector x))))
225     (terpri s)))
226
227 (defmethod describe-object ((x hash-table) s)
228   (print-standard-describe-header x s)
229   ;; Don't print things which are already apparent from the printed
230   ;; representation -- COUNT, TEST, and WEAKNESS
231   (format s "~%Occupancy: ~,1F" (float (/ (hash-table-count x)
232                                           (hash-table-size x))))
233   (format s "~%Rehash-threshold: ~S" (hash-table-rehash-threshold x))
234   (format s "~%Rehash-size: ~S" (hash-table-rehash-size x))
235   (format s "~%Size: ~S" (hash-table-size x))
236   (format s "~%Synchronized: ~A" (if (hash-table-synchronized-p x) "yes" "no"))
237   (terpri s))
238
239 (defmethod describe-object ((symbol symbol) stream)
240   (print-standard-describe-header symbol stream)
241   ;; Describe the value cell.
242   (let* ((kind (info :variable :kind symbol))
243          (wot (ecase kind
244                 (:special "a special variable")
245                 (:macro "a symbol macro")
246                 (:constant "a constant variable")
247                 (:global "a global variable")
248                 (:unknown "an undefined variable")
249                 (:alien "an alien variable"))))
250     (when (or (not (eq :unknown kind)) (boundp symbol))
251       (pprint-logical-block (stream nil)
252         (format stream "~%~A names ~A:" symbol wot)
253         (pprint-indent :block 2 stream)
254         (when (eq (info :variable :where-from symbol) :declared)
255           (format stream "~@:_Declared type: ~S"
256                   (type-specifier (info :variable :type symbol))))
257         (when (info :variable :always-bound symbol)
258           (format stream "~@:_Declared always-bound."))
259         (cond
260           ((eq kind :alien)
261            (let ((info (info :variable :alien-info symbol)))
262              (format stream "~@:_Value: ~S" (eval symbol))
263              (format stream "~@:_Type: ~S"
264                      (sb-alien-internals:unparse-alien-type
265                       (sb-alien::heap-alien-info-type info)))
266              (format stream "~@:_Address: #x~8,'0X"
267                      (sap-int (eval (sb-alien::heap-alien-info-sap-form info))))))
268           ((eq kind :macro)
269            (let ((expansion (info :variable :macro-expansion symbol)))
270              (format stream "~@:_Expansion: ~S" expansion)))
271           ((boundp symbol)
272            (format stream "~:@_Value: ~S" (symbol-value symbol)))
273           ((not (eq kind :unknown))
274            (format stream "~:@_Currently unbound.")))
275         (describe-documentation symbol 'variable stream)
276         (terpri stream))))
277
278   ;; TODO: We could grovel over all packages looking for and
279   ;; reporting other phenomena, e.g. IMPORT and SHADOW, or
280   ;; availability in some package even after (SYMBOL-PACKAGE SYMBOL) has
281   ;; been set to NIL.
282   ;;
283   ;; TODO: It might also be nice to describe (find-package symbol)
284   ;; if one exists. Maybe not all the exports, etc, but the package
285   ;; documentation.
286   (describe-function symbol nil stream)
287   (describe-class symbol nil stream)
288
289   ;; Type specifier
290   (let* ((kind (info :type :kind symbol))
291          (fun (case kind
292                 (:defined
293                  (or (info :type :expander symbol) t))
294                 (:primitive
295                  (or (info :type :translator symbol) t)))))
296     (when fun
297       (pprint-newline :mandatory stream)
298       (pprint-logical-block (stream nil)
299         (pprint-indent :block 2 stream)
300         (format stream "~A names a ~@[primitive~* ~]type-specifier:"
301                 symbol
302                 (eq kind :primitive))
303         (describe-documentation symbol 'type stream (eq t fun))
304         (unless (eq t fun)
305           (describe-lambda-list (if (eq :primitive kind)
306                                     (%fun-lambda-list fun)
307                                     (info :type :lambda-list symbol))
308                                 stream)
309           (when (eq (%fun-fun fun) (%fun-fun (constant-type-expander t)))
310             (format stream "~@:_Expansion: ~S" (funcall fun (list symbol))))))
311       (terpri stream)))
312
313   (when (or (member symbol sb-c::*policy-qualities*)
314             (assoc symbol sb-c::*policy-dependent-qualities*))
315     (pprint-logical-block (stream nil)
316       (pprint-newline :mandatory stream)
317       (pprint-indent :block 2 stream)
318       (format stream "~A names a~:[ dependent~;n~] optimization policy quality:"
319               symbol
320               (member symbol sb-c::*policy-qualities*))
321       (describe-documentation symbol 'optimize stream t))
322     (terpri stream))
323
324   ;; Print out properties.
325   (let ((plist (symbol-plist symbol)))
326     (when plist
327       (pprint-logical-block (stream nil)
328         (format stream "~%Symbol-plist:")
329         (pprint-indent :block 2 stream)
330         (sb-pcl::doplist (key value) plist
331           (format stream "~@:_~A -> ~A"
332                   (prin1-to-line key :columns 2 :reserve 5)
333                   (prin1-to-line value :columns 2 :reserve 5))))
334       (terpri stream))))
335
336 (defmethod describe-object ((package package) stream)
337   (print-standard-describe-header package stream)
338   (pprint-logical-block (stream nil)
339     (describe-documentation package t stream)
340     (flet ((humanize (list)
341              (sort (mapcar (lambda (x)
342                              (if (packagep x)
343                                  (package-name x)
344                                  x))
345                            list)
346                    #'string<))
347            (out (label list)
348              (describe-stuff label list stream :escape nil)))
349       (let ((implemented (humanize (package-implemented-by-list package)))
350             (implements (humanize (package-implements-list package)))
351             (nicks (humanize (package-nicknames package)))
352             (uses (humanize (package-use-list package)))
353             (used (humanize (package-used-by-list package)))
354             (shadows (humanize (package-shadowing-symbols package)))
355             (this (list (package-name package)))
356             (exports nil))
357         (do-external-symbols (ext package)
358           (push ext exports))
359         (setf exports (humanize exports))
360         (when (package-locked-p package)
361           (format stream "~@:_Locked."))
362         (when (set-difference implemented this :test #'string=)
363           (out "Implemented-by-list" implemented))
364         (when (set-difference implements this :test #'string=)
365           (out "Implements-list" implements))
366         (out "Nicknames" nicks)
367         (out "Use-list" uses)
368         (out "Used-by-list" used)
369         (out "Shadows" shadows)
370         (out "Exports" exports)
371         (format stream "~@:_~S internal symbols."
372                 (package-internal-symbol-count package))))
373     (terpri stream)))
374 \f
375 ;;;; Helpers to deal with shared functionality
376
377 (defun describe-class (name class stream)
378   (let* ((by-name (not class))
379          (name (if class (class-name class) name))
380          (class (if class class (find-class name nil))))
381     (when class
382       (let ((metaclass-name (class-name (class-of class))))
383         (pprint-logical-block (stream nil)
384           (when by-name
385             (format stream "~%~A names the ~(~A~) ~S:"
386                     name
387                     metaclass-name
388                     class)
389             (pprint-indent :block 2 stream))
390           (describe-documentation class t stream)
391           (when (sb-mop:class-finalized-p class)
392             (describe-stuff "Class precedence-list"
393                             (mapcar #'class-name-or-class (sb-mop:class-precedence-list class))
394                             stream))
395           (describe-stuff "Direct superclasses"
396                           (mapcar #'class-name-or-class (sb-mop:class-direct-superclasses class))
397                           stream)
398           (let ((subs (mapcar #'class-name-or-class (sb-mop:class-direct-subclasses class))))
399             (if subs
400                 (describe-stuff "Direct subclasses" subs stream)
401                 (format stream "~@:_No subclasses.")))
402           (unless (sb-mop:class-finalized-p class)
403             (format stream "~@:_Not yet finalized."))
404           (if (eq 'structure-class metaclass-name)
405               (let* ((dd (find-defstruct-description name))
406                      (slots (dd-slots dd)))
407                 (if slots
408                     (format stream "~@:_Slots:~:{~@:_  ~S~
409                                     ~@:_    Type: ~A ~@[~A~]~
410                                     ~@:_    Initform: ~S~}"
411                             (mapcar (lambda (dsd)
412                                       (list
413                                        (dsd-name dsd)
414                                        (dsd-type dsd)
415                                        (unless (eq t (dsd-raw-type dsd))
416                                          "(unboxed)")
417                                        (dsd-default dsd)))
418                                     slots))
419                     (format stream "~@:_No slots.")))
420               (let ((slots (sb-mop:class-direct-slots class)))
421                 (if slots
422                     (format stream "~@:_Direct slots:~:{~@:_  ~S~
423                                     ~@[~@:_    Type: ~S~]~
424                                     ~@[~@:_    Allocation: ~S~]~
425                                     ~@[~@:_    Initargs: ~{~S~^, ~}~]~
426                                     ~@[~@:_    Initform: ~S~]~
427                                     ~@[~@:_    Readers: ~{~S~^, ~}~]~
428                                     ~@[~@:_    Writers: ~{~S~^, ~}~]~
429                                     ~@[~@:_    Documentation:~@:_     ~@<~@;~A~:>~]~}"
430                             (mapcar (lambda (slotd)
431                                       (list (sb-mop:slot-definition-name slotd)
432                                             (let ((type (sb-mop:slot-definition-type slotd)))
433                                               (unless (eq t type) type))
434                                             (let ((alloc (sb-mop:slot-definition-allocation slotd)))
435                                               (unless (eq :instance alloc) alloc))
436                                             (sb-mop:slot-definition-initargs slotd)
437                                             (sb-mop:slot-definition-initform slotd)
438                                             (sb-mop:slot-definition-readers slotd)
439                                             (sb-mop:slot-definition-writers slotd)
440                                             ;; FIXME: does this get the prefix right?
441                                             (quiet-doc slotd t)))
442                                     slots))
443                     (format stream "~@:_No direct slots."))))
444           (pprint-newline :mandatory stream))))))
445
446 (defun describe-instance (object stream)
447   (let* ((class (class-of object))
448          (slotds (sb-mop:class-slots class))
449          (max-slot-name-length 0)
450          (plist nil))
451
452     ;; Figure out a good width for the slot-name column.
453     (flet ((adjust-slot-name-length (name)
454              (setf max-slot-name-length
455                    (max max-slot-name-length (length (symbol-name name))))))
456       (dolist (slotd slotds)
457         (adjust-slot-name-length (sb-mop:slot-definition-name slotd))
458         (push slotd (getf plist (sb-mop:slot-definition-allocation slotd))))
459       (setf max-slot-name-length  (min (+ max-slot-name-length 3) 30)))
460
461     ;; Now that we know the width, we can print.
462     (flet ((describe-slot (name value)
463              (format stream "~%  ~A~VT = ~A" name max-slot-name-length
464                      (prin1-to-line value))))
465       (sb-pcl::doplist (allocation slots) plist
466         (format stream "~%Slots with ~S allocation:" allocation)
467         (dolist (slotd (nreverse slots))
468           (describe-slot
469            (sb-mop:slot-definition-name slotd)
470            (sb-pcl::slot-value-or-default object (sb-mop:slot-definition-name slotd))))))
471     (unless slotds
472       (format stream "~@:_No slots."))
473     (terpri stream)))
474
475 (defun quiet-doc (object type)
476   (handler-bind ((warning #'muffle-warning))
477     (documentation object type)))
478
479 (defun describe-documentation (object type stream &optional undoc newline)
480   (let ((doc (quiet-doc object type)))
481     (cond (doc
482            (format stream "~@:_Documentation:~@:_")
483            (pprint-logical-block (stream nil :per-line-prefix "  ")
484              (princ doc stream)))
485           (undoc
486            (format stream "~@:_(undocumented)")))
487     (when newline
488       (pprint-newline :mandatory stream))))
489
490 (defun describe-stuff (label list stream &key (escape t))
491   (when list
492     (if escape
493         (format stream "~@:_~A:~@<~;~{ ~S~^,~:_~}~;~:>" label list)
494         (format stream "~@:_~A:~@<~;~{ ~A~^,~:_~}~;~:>" label list))))
495
496 (defun describe-lambda-list (lambda-list stream)
497   (format stream "~@:_Lambda-list: ~:A" lambda-list))
498
499 (defun describe-function-source (function stream)
500   (if (compiled-function-p function)
501       (let* ((code (fun-code-header (%fun-fun function)))
502              (info (sb-kernel:%code-debug-info code)))
503         (when info
504           (let ((source (sb-c::debug-info-source info)))
505             (when source
506               (let ((namestring (sb-c::debug-source-namestring source)))
507                 ;; This used to also report the times the source was created
508                 ;; and compiled, but that seems more like noise than useful
509                 ;; information -- but FWIW that are to be had as
510                 ;; SB-C::DEBUG-SOUCE-CREATED/COMPILED.
511                 (cond (namestring
512                        (format stream "~@:_Source file: ~A" namestring))
513                       ((sb-di:debug-source-form source)
514                        (format stream "~@:_Source form:~@:_  ~S"
515                                (sb-di:debug-source-form source)))
516                       (t (bug "Don't know how to use a DEBUG-SOURCE without ~
517                                a namestring or a form."))))))))
518       #+sb-eval
519       (let ((source (sb-eval:interpreted-function-source-location function)))
520         (when source
521           (let ((namestring (sb-c:definition-source-location-namestring source)))
522             (when namestring
523               (format stream "~@:_Source file: ~A" namestring)))))))
524
525 (defun describe-function (name function stream)
526   (let ((name (if function (fun-name function) name)))
527     (if (not (or function (and (legal-fun-name-p name) (fboundp name))))
528         ;; Not defined, but possibly the type is declared, or we have
529         ;; compiled calls to it.
530         (when (legal-fun-name-p name)
531           (multiple-value-bind (from sure) (info :function :where-from name)
532             (when (or (eq :declared from) (and sure (eq :assumed from)))
533               (pprint-logical-block (stream nil)
534                 (format stream "~%~A names an undefined function" name)
535                 (pprint-indent :block 2 stream)
536                 (format stream "~@:_~:(~A~) type: ~S"
537                         from
538                         (type-specifier (info :function :type name)))))))
539         ;; Defined.
540         (multiple-value-bind (fun what lambda-list ftype from inline
541                                   methods)
542             (cond ((and (not function) (symbolp name) (special-operator-p name))
543                    (let ((fun (symbol-function name)))
544                      (values fun "a special operator" (%fun-lambda-list fun))))
545                   ((and (not function) (symbolp name) (macro-function name))
546                    (let ((fun (macro-function name)))
547                      (values fun "a macro" (%fun-lambda-list fun))))
548                   (t
549                    (let ((fun (or function (fdefinition name))))
550                      (multiple-value-bind (ftype from)
551                          (if function
552                              (values (%fun-type function) "Derived")
553                              (let ((ctype (info :function :type name)))
554                                (values (when ctype (type-specifier ctype))
555                                        (when ctype
556                                          ;; Ensure lazy pickup of information
557                                          ;; from methods.
558                                          (sb-c::maybe-update-info-for-gf name)
559                                          (ecase (info :function :where-from name)
560                                            (:declared "Declared")
561                                            ;; This is hopefully clearer to users
562                                            ((:defined-method :defined) "Derived"))))))
563                        (if (typep fun 'generic-function)
564                            (values fun
565                                    "a generic function"
566                                    (sb-mop:generic-function-lambda-list fun)
567                                    ftype
568                                    from
569                                    nil
570                                    (or (sb-mop:generic-function-methods fun)
571                                        :none))
572                            (values fun
573                                    (if (compiled-function-p fun)
574                                        "a compiled function"
575                                        "an interpreted function")
576                                    (%fun-lambda-list fun)
577                                    ftype
578                                    from
579                                    (unless function
580                                      (cons
581                                       (info :function :inlinep name)
582                                       (info :function :inline-expansion-designator name)))))))))
583           (pprint-logical-block (stream nil)
584             (unless function
585               (format stream "~%~A names ~A:" name what)
586               (pprint-indent :block 2 stream))
587             (describe-lambda-list lambda-list stream)
588             (when (and ftype from)
589               (format stream "~@:_~A type: ~S" from ftype))
590             (describe-documentation name 'function stream)
591             (when (car inline)
592               (format stream "~@:_Inline proclamation: ~A (~:[no ~;~]inline expansion available)"
593                       (car inline)
594                       (cdr inline)))
595             (when methods
596               (format stream "~@:_Method-combination: ~S"
597                       (sb-pcl::method-combination-type-name
598                        (sb-pcl:generic-function-method-combination fun)))
599               (cond ((eq :none methods)
600                      (format stream "~@:_No methods."))
601                     (t
602                      (pprint-newline :mandatory stream)
603                      (pprint-logical-block (stream nil)
604                        (format stream "Methods:")
605                        (dolist (method methods)
606                          (pprint-indent :block 2 stream)
607                          (format stream "~@:_(~A ~{~S ~}~:S)"
608                                  name
609                                  (method-qualifiers method)
610                                  (sb-pcl::unparse-specializers fun (sb-mop:method-specializers method)))
611                          (pprint-indent :block 4 stream)
612                          (describe-documentation method t stream nil))))))
613             (describe-function-source fun stream)
614             (terpri stream)))))
615   (unless function
616     (awhen (and (legal-fun-name-p name) (compiler-macro-function name))
617       (pprint-logical-block (stream nil)
618         (format stream "~@:_~A has a compiler-macro:" name)
619         (pprint-indent :block 2 stream)
620         (describe-documentation it t stream)
621         (describe-function-source it stream))
622       (terpri stream))
623     (when (and (consp name) (eq 'setf (car name)) (not (cddr name)))
624       (let* ((name2 (second name))
625              (inverse (info :setf :inverse name2))
626              (expander (info :setf :expander name2)))
627         (cond (inverse
628                (pprint-logical-block (stream nil)
629                  (format stream "~&~A has setf-expansion: ~S"
630                          name inverse)
631                  (pprint-indent :block 2 stream)
632                  (describe-documentation name2 'setf stream))
633                (terpri stream))
634               (expander
635                (pprint-logical-block (stream nil)
636                  (format stream "~&~A has a complex setf-expansion:"
637                          name)
638                  (pprint-indent :block 2 stream)
639                  (describe-documentation name2 'setf stream t))
640                (terpri stream)))))
641     (when (symbolp name)
642       (describe-function `(setf ,name) nil stream))))