X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=a382b9d2c0f171fdb01ffb69278d5c85c765a574;hb=0f3a5f2e8886d18d0b4f6485c38a42be629422ae;hp=cb4c2a73ab733c42ea94f5e192eac9ffa7373012;hpb=aea6385395091b21803a97b63b82f824e55b68d3;p=sbcl.git

diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp
index cb4c2a7..a382b9d 100644
--- a/src/pcl/documentation.lisp
+++ b/src/pcl/documentation.lisp
@@ -8,18 +8,59 @@
 
 (in-package "SB-PCL")
 
-;;; FIXME: Lots of bare calls to INFO here could be handled
-;;; more cleanly by calling the FDOCUMENTATION function instead.
-
 (defun fun-doc (x)
-  (etypecase x
-    (generic-function
-     (slot-value x '%documentation))
-    #+sb-eval
-    (sb-eval:interpreted-function
-     (sb-eval:interpreted-function-documentation x))
-    (function
-     (%fun-doc x))))
+  (if (typep x 'generic-function)
+      (slot-value x '%documentation)
+      (%fun-doc x)))
+
+(defun (setf fun-doc) (new-value x)
+  (if (typep x 'generic-function)
+      (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)))
@@ -28,69 +69,66 @@
 (defmethod documentation ((x function) (doc-type (eql 'function)))
   (fun-doc x))
 
-(defmethod documentation ((x list) (doc-type (eql 'function)))
-  (and (legal-fun-name-p x)
-       (fboundp x)
-       (documentation (fdefinition x) t)))
-
 (defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
-  (random-documentation x 'compiler-macro))
+  (awhen (compiler-macro-function x)
+    (documentation it t)))
+
+(defmethod documentation ((x list) (doc-type (eql 'function)))
+  (when (legal-fun-name-p x)
+    (or (random-documentation x 'function)
+        (when (fboundp x)
+          (fun-doc (fdefinition x))))))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'function)))
-  (or (values (info :function :documentation x))
-      ;; Try the pcl function documentation.
-      (and (fboundp x) (documentation (fdefinition x) t))))
+  (when (legal-fun-name-p x)
+    (or (random-documentation x 'function)
+        ;; Nothing under the name, check the function object.
+        (when (fboundp 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)))
-  (random-documentation x 'compiler-macro))
+  (awhen (compiler-macro-function x)
+    (documentation it t)))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'setf)))
-  (values (info :setf :documentation x)))
+  (fdocumentation x 'setf))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'optimize)))
   (random-documentation x 'optimize))
 
-(defun (setf fun-doc) (new-value x)
-  (etypecase x
-    (generic-function
-     (setf (slot-value x '%documentation) new-value))
-    #+sb-eval
-    (sb-eval:interpreted-function
-     (setf (sb-eval:interpreted-function-documentation x)
-           new-value))
-    (function
-     (let ((name (%fun-name x)))
-       (when (valid-function-name-p name)
-         (setf (info :function :documentation name) new-value)))))
-  new-value)
-
-
 (defmethod (setf documentation) (new-value (x function) (doc-type (eql 't)))
   (setf (fun-doc x) new-value))
 
-(defmethod (setf documentation) (new-value
-                                 (x function)
-                                 (doc-type (eql 'function)))
+(defmethod (setf documentation) (new-value (x function) (doc-type (eql 'function)))
   (setf (fun-doc x) new-value))
 
 (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
-  (setf (info :function :documentation x) new-value))
+  (set-function-name-documentation x new-value))
 
-(defmethod (setf documentation)
-    (new-value (x list) (doc-type (eql 'compiler-macro)))
-  (setf (random-documentation x 'compiler-macro) 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)))
-  (setf (info :function :documentation x) new-value))
+(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'function)))
+  (set-function-name-documentation x new-value))
 
-(defmethod (setf documentation)
-    (new-value (x symbol) (doc-type (eql 'compiler-macro)))
-  (setf (random-documentation x 'compiler-macro) new-value))
+(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'compiler-macro)))
+  (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 (info :setf :documentation x) new-value))
+  (cond (x
+         (setf (fdocumentation x 'setf) new-value))
+        (t
+         (ignore-nil-doc 'setf)
+         new-value)))
 
 ;;; method combinations
 (defmethod documentation ((x method-combination) (doc-type (eql 't)))
@@ -113,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)))
 
 ;;; methods
 (defmethod documentation ((x standard-method) (doc-type (eql 't)))
@@ -141,10 +183,10 @@
 
 ;;; types, classes, and structure names
 (defmethod documentation ((x structure-class) (doc-type (eql 't)))
-  (values (info :type :documentation (class-name x))))
+  (fdocumentation (class-name x) 'type))
 
 (defmethod documentation ((x structure-class) (doc-type (eql 'type)))
-  (values (info :type :documentation (class-name x))))
+  (fdocumentation (class-name x) 'type))
 
 (defmethod documentation ((x standard-class) (doc-type (eql 't)))
   (slot-value x '%documentation))
@@ -157,34 +199,29 @@
 ;;; condition-class is in fact not implemented as a standard-class or
 ;;; structure-class).
 (defmethod documentation ((x condition-class) (doc-type (eql 't)))
-  (values (info :type :documentation (class-name x))))
+  (fdocumentation (class-name x) 'type))
 
 (defmethod documentation ((x condition-class) (doc-type (eql 'type)))
-  (values (info :type :documentation (class-name x))))
+  (fdocumentation (class-name x) 'type))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'type)))
-  (or (values (info :type :documentation x))
+  (or (fdocumentation x 'type)
       (let ((class (find-class x nil)))
         (when class
           (slot-value class '%documentation)))))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'structure)))
-  (cond
-    ((structure-type-p x)
-     (values (info :type :documentation x)))
-    ((info :typed-structure :info x)
-     (values (info :typed-structure :documentation x)))
-    (t nil)))
+  (fdocumentation x 'structure))
 
 (defmethod (setf documentation) (new-value
                                  (x structure-class)
                                  (doc-type (eql 't)))
-  (setf (info :type :documentation (class-name x)) new-value))
+  (setf (fdocumentation (class-name x) 'type) new-value))
 
 (defmethod (setf documentation) (new-value
                                  (x structure-class)
                                  (doc-type (eql 'type)))
-  (setf (info :type :documentation (class-name x)) new-value))
+  (setf (fdocumentation (class-name x) 'type) new-value))
 
 (defmethod (setf documentation) (new-value
                                  (x standard-class)
@@ -199,43 +236,46 @@
 (defmethod (setf documentation) (new-value
                                  (x condition-class)
                                  (doc-type (eql 't)))
-  (setf (info :type :documentation (class-name x)) new-value))
+  (setf (fdocumentation (class-name x) 'type) new-value))
 
 (defmethod (setf documentation) (new-value
                                  (x condition-class)
                                  (doc-type (eql 'type)))
-  (setf (info :type :documentation (class-name x)) new-value))
+  (setf (fdocumentation (class-name x) 'type) new-value))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'type)))
   (if (or (structure-type-p x) (condition-type-p x))
-      (setf (info :type :documentation x) new-value)
+      (setf (fdocumentation x 'type) new-value)
       (let ((class (find-class x nil)))
         (if class
             (setf (slot-value class '%documentation) new-value)
-            (setf (info :type :documentation x) new-value)))))
+            (setf (fdocumentation x 'type) new-value)))))
 
 (defmethod (setf documentation) (new-value
                                  (x symbol)
                                  (doc-type (eql 'structure)))
-  (cond
-    ((structure-type-p x)
-     (setf (info :type :documentation x) new-value))
-    ((info :typed-structure :info x)
-     (setf (info :typed-structure :documentation x) new-value))
-    (t new-value)))
+  (cond (x
+         (setf (fdocumentation x 'structure) new-value))
+        (t
+         (ignore-nil-doc 'structure)
+         new-value)))
 
 ;;; variables
 (defmethod documentation ((x symbol) (doc-type (eql 'variable)))
-  (values (info :variable :documentation x)))
+  (fdocumentation x 'variable))
 
 (defmethod (setf documentation) (new-value
                                  (x symbol)
                                  (doc-type (eql 'variable)))
-  (setf (info :variable :documentation x) new-value))
+  (cond (x
+         (setf (fdocumentation x 'variable) new-value))
+        (t
+         (ignore-nil-doc 'variable)
+         new-value)))
 
 ;;; default if DOC-TYPE doesn't match one of the specified types
 (defmethod documentation (object doc-type)
-  (warn "unsupported DOCUMENTATION: type ~S for object ~S"
+  (warn "unsupported DOCUMENTATION: type ~S for object of type ~S"
         doc-type
         (type-of object))
   nil)
@@ -264,6 +304,22 @@
 ;;; set the documentation for the machinery for setting documentation.
 #+sb-doc
 (setf (documentation 'documentation 'function)
-      "Return the documentation string of Doc-Type for X, or NIL if
-  none exists. System doc-types are VARIABLE, FUNCTION, STRUCTURE, TYPE,
-  SETF, and T.")
+      "Return the documentation string of Doc-Type for X, or NIL if none
+exists. System doc-types are VARIABLE, FUNCTION, STRUCTURE, TYPE, SETF, and T.
+
+Function documentation is stored separately for function names and objects:
+DEFUN, LAMBDA, &co create function objects with the specified documentation
+strings.
+
+ \(SETF (DOCUMENTATION NAME 'FUNCTION) STRING)
+
+sets the documentation string stored under the specified name, and
+
+ \(SETF (DOCUMENTATION FUNC T) STRING)
+
+sets the documentation string stored in the function object.
+
+ \(DOCUMENTATION NAME 'FUNCTION)
+
+returns the documentation stored under the function name if any, and
+falls back on the documentation in the function object if necessary.")