gencgc: More precise conservatism for pointers to boxed pages.

[sbcl.git] / src / pcl / documentation.lisp

diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp
index a625221..a382b9d 100644 (file)
--- a/src/pcl/documentation.lisp
+++ b/src/pcl/documentation.lisp
@@ -18,6 +18,50 @@
       (setf (slot-value x '%documentation) new-value)
       (setf (%fun-doc x) new-value)))
 
+;;; FIXME: There's already fun-name in code/describe.lisp, but it's
+;;; loaded after PCL, so it cannot be used, because we set
+;;; some documentation at the end of this file.
+(defun fun-name (x)
+  (if (typep x 'generic-function)
+      (sb-pcl:generic-function-name x)
+      (%fun-name x)))
+
+(defun real-function-name (name)
+  ;; Resolve the actual name of the function named by NAME
+  ;; e.g. (setf (name-function 'x) #'car)
+  ;; (real-function-name 'x) => CAR
+  (cond ((not (fboundp name))
+         nil)
+        ((and (symbolp name)
+              (special-operator-p name))
+         (%fun-name (fdefinition name)))
+        ((and (symbolp name)
+              (macro-function name))
+         (let ((name (%fun-name (macro-function name))))
+           (and (consp name)
+                (eq (car name) 'macro-function)
+                (cadr name))))
+        (t
+         (fun-name (fdefinition name)))))
+
+(defun ignore-nil-doc (type)
+  (style-warn "Ignoring documentation of type ~a for ~a."
+              type nil))
+
+(defun set-function-name-documentation (name documentation)
+  (cond ((not name)
+         (ignore-nil-doc 'function))
+        ((not (legal-fun-name-p name))
+         nil)
+        ((not (equal (real-function-name name) name))
+         (setf (random-documentation name 'function) documentation))
+        (t
+         (setf (fun-doc (or (and (symbolp name)
+                                 (macro-function name))
+                            (fdefinition name)))
+               documentation)))
+  documentation)
+
 ;;; functions, macros, and special forms
 (defmethod documentation ((x function) (doc-type (eql 't)))
   (fun-doc x))
@@ -40,7 +84,10 @@
     (or (random-documentation x 'function)
         ;; Nothing under the name, check the function object.
         (when (fboundp x)
-          (fun-doc (or (macro-function x) (fdefinition x)))))))
+          (fun-doc (if (special-operator-p x)
+                       (fdefinition x)
+                       (or (macro-function x)
+                           (fdefinition x))))))))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'compiler-macro)))
   (awhen (compiler-macro-function x)
@@ -59,23 +106,29 @@
   (setf (fun-doc x) new-value))
 
 (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
-  (when (legal-fun-name-p x)
-    (setf (random-documentation x 'function) new-value)))
+  (set-function-name-documentation x new-value))
 
 (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
   (awhen (compiler-macro-function x)
     (setf (documentation it t) new-value)))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'function)))
-  (when (legal-fun-name-p x)
-    (setf (random-documentation x 'function) new-value)))
+  (set-function-name-documentation x new-value))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'compiler-macro)))
-  (awhen (compiler-macro-function x)
-    (setf (documentation it t) new-value)))
+  (cond (x
+         (awhen (compiler-macro-function x)
+           (setf (documentation it t) new-value)))
+        (t
+         (ignore-nil-doc 'compiler-macro)
+         new-value)))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf)))
-  (setf (fdocumentation x 'setf) new-value))
+  (cond (x
+         (setf (fdocumentation x 'setf) new-value))
+        (t
+         (ignore-nil-doc 'setf)
+         new-value)))
 \f
 ;;; method combinations
 (defmethod documentation ((x method-combination) (doc-type (eql 't)))
@@ -98,7 +151,11 @@
 
 (defmethod (setf documentation)
     (new-value (x symbol) (doc-type (eql 'method-combination)))
-  (setf (random-documentation x 'method-combination) new-value))
+  (cond (x
+         (setf (random-documentation x 'method-combination) new-value))
+        (t
+         (ignore-nil-doc 'method-combination)
+         new-value)))
 \f
 ;;; methods
 (defmethod documentation ((x standard-method) (doc-type (eql 't)))
@@ -197,7 +254,11 @@
 (defmethod (setf documentation) (new-value
                                  (x symbol)
                                  (doc-type (eql 'structure)))
-  (setf (fdocumentation x 'structure) new-value))
+  (cond (x
+         (setf (fdocumentation x 'structure) new-value))
+        (t
+         (ignore-nil-doc 'structure)
+         new-value)))
 \f
 ;;; variables
 (defmethod documentation ((x symbol) (doc-type (eql 'variable)))
@@ -206,7 +267,11 @@
 (defmethod (setf documentation) (new-value
                                  (x symbol)
                                  (doc-type (eql 'variable)))
-  (setf (fdocumentation x 'variable) new-value))
+  (cond (x
+         (setf (fdocumentation x 'variable) new-value))
+        (t
+         (ignore-nil-doc 'variable)
+         new-value)))
 \f
 ;;; default if DOC-TYPE doesn't match one of the specified types
 (defmethod documentation (object doc-type)