X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=e992894e72770e39f9c927a9e83d6c5bde8e3373;hb=d6f9676ae94419cb5544c45821a8d31adbc1fbe8;hp=df24ea81ca2244087b23375110daf57797c2cfc7;hpb=a57db6f5ee029a4c9817ae239d7bbefd3fb8374e;p=sbcl.git

diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp
index df24ea8..e992894 100644
--- a/src/pcl/documentation.lisp
+++ b/src/pcl/documentation.lisp
@@ -8,93 +8,96 @@
 
 (in-package "SB-PCL")
 
-;;; FIXME: Lots of bare calls to INFO here could be handled
-;;; more cleanly by calling the FDOCUMENTATION function instead.
-
-;;; functions, macros, and special forms
-(defmethod documentation ((x function) (doc-type (eql 't)))
+(defun fun-doc (x)
   (if (typep x 'generic-function)
-      (slot-value x 'documentation)
+      (slot-value x '%documentation)
       (%fun-doc x)))
 
-(defmethod documentation ((x function) (doc-type (eql 'function)))
+(defun (setf fun-doc) (new-value x)
   (if (typep x 'generic-function)
-      (slot-value x 'documentation)
-      (%fun-doc x)))
+      (setf (slot-value x '%documentation) new-value)
+      (setf (%fun-doc x) new-value)))
 
-(defmethod documentation ((x list) (doc-type (eql 'function)))
-  (and (legal-fun-name-p x)
-       (fboundp x)
-       (documentation (fdefinition x) t)))
+;;; functions, macros, and special forms
+(defmethod documentation ((x function) (doc-type (eql 't)))
+  (fun-doc x))
+
+(defmethod documentation ((x function) (doc-type (eql 'function)))
+  (fun-doc x))
 
 (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))
 
 (defmethod (setf documentation) (new-value (x function) (doc-type (eql 't)))
-  (if (typep x 'generic-function)
-      (setf (slot-value x 'documentation) new-value)
-      (let ((name (%fun-name x)))
-	(when (and name (typep name '(or symbol cons)))
-	  (setf (info :function :documentation name) new-value))))
-  new-value)
+  (setf (fun-doc x) new-value))
 
-(defmethod (setf documentation)
-    (new-value (x function) (doc-type (eql 'function)))
-  (if (typep x 'generic-function)
-      (setf (slot-value x 'documentation) new-value)
-      (let ((name (%fun-name x)))
-	(when (and name (typep name '(or symbol cons)))
-	  (setf (info :function :documentation name) new-value))))
-  new-value)
+(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))
+  (when (legal-fun-name-p x)
+    (setf (random-documentation x 'function) 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)))
+  (when (legal-fun-name-p x)
+    (setf (random-documentation x 'function) 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)))
+  (awhen (compiler-macro-function x)
+    (setf (documentation it t) new-value)))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf)))
-  (setf (info :setf :documentation x) new-value))
+  (setf (fdocumentation x 'setf) new-value))
 
 ;;; method combinations
 (defmethod documentation ((x method-combination) (doc-type (eql 't)))
-  (slot-value x 'documentation))
+  (slot-value x '%documentation))
 
 (defmethod documentation
     ((x method-combination) (doc-type (eql 'method-combination)))
-  (slot-value x 'documentation))
+  (slot-value x '%documentation))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'method-combination)))
   (random-documentation x 'method-combination))
 
 (defmethod (setf documentation)
     (new-value (x method-combination) (doc-type (eql 't)))
-  (setf (slot-value x 'documentation) new-value))
+  (setf (slot-value x '%documentation) new-value))
 
 (defmethod (setf documentation)
     (new-value (x method-combination) (doc-type (eql 'method-combination)))
-  (setf (slot-value x 'documentation) new-value))
+  (setf (slot-value x '%documentation) new-value))
 
 (defmethod (setf documentation)
     (new-value (x symbol) (doc-type (eql 'method-combination)))
@@ -102,11 +105,11 @@
 
 ;;; methods
 (defmethod documentation ((x standard-method) (doc-type (eql 't)))
-  (slot-value x 'documentation))
+  (slot-value x '%documentation))
 
 (defmethod (setf documentation)
     (new-value (x standard-method) (doc-type (eql 't)))
-  (setf (slot-value x 'documentation) new-value))
+  (setf (slot-value x '%documentation) new-value))
 
 ;;; packages
 
@@ -126,76 +129,93 @@
 
 ;;; 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))
+  (slot-value x '%documentation))
 
 (defmethod documentation ((x standard-class) (doc-type (eql 'type)))
-  (slot-value x 'documentation))
+  (slot-value x '%documentation))
+
+;;; although the CLHS doesn't mention this, it is reasonable to assume
+;;; that parallel treatment of condition-class was intended (if
+;;; condition-class is in fact not implemented as a standard-class or
+;;; structure-class).
+(defmethod documentation ((x condition-class) (doc-type (eql 't)))
+  (fdocumentation (class-name x) 'type))
+
+(defmethod documentation ((x condition-class) (doc-type (eql 'type)))
+  (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)))))
+        (when class
+          (slot-value class '%documentation)))))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'structure)))
-  (when (eq (info :type :kind x) :instance)
-    (values (info :type :documentation x))))
+  (fdocumentation x 'structure))
+
+(defmethod (setf documentation) (new-value
+                                 (x structure-class)
+                                 (doc-type (eql 't)))
+  (setf (fdocumentation (class-name x) 'type) new-value))
 
 (defmethod (setf documentation) (new-value
-				 (x structure-class)
-				 (doc-type (eql 't)))
-  (setf (info :type :documentation (class-name x)) new-value))
+                                 (x structure-class)
+                                 (doc-type (eql 'type)))
+  (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))
+                                 (x standard-class)
+                                 (doc-type (eql 't)))
+  (setf (slot-value x '%documentation) new-value))
 
 (defmethod (setf documentation) (new-value
-				 (x standard-class)
-				 (doc-type (eql 't)))
-  (setf (slot-value x 'documentation) new-value))
+                                 (x standard-class)
+                                 (doc-type (eql 'type)))
+  (setf (slot-value x '%documentation) new-value))
 
 (defmethod (setf documentation) (new-value
-				 (x standard-class)
-				 (doc-type (eql 'type)))
-  (setf (slot-value x 'documentation) new-value))
+                                 (x condition-class)
+                                 (doc-type (eql 't)))
+  (setf (fdocumentation (class-name x) 'type) new-value))
+
+(defmethod (setf documentation) (new-value
+                                 (x condition-class)
+                                 (doc-type (eql 'type)))
+  (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)))))
+        (if class
+            (setf (slot-value class '%documentation) new-value)
+            (setf (fdocumentation x 'type) new-value)))))
 
 (defmethod (setf documentation) (new-value
-				 (x symbol)
-				 (doc-type (eql 'structure)))
-  (unless (eq (info :type :kind x) :instance)
-    (error "~S is not the name of a structure type." x))
-  (setf (info :type :documentation x) new-value))
+                                 (x symbol)
+                                 (doc-type (eql 'structure)))
+  (setf (fdocumentation x '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))
+                                 (x symbol)
+                                 (doc-type (eql 'variable)))
+  (setf (fdocumentation x '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"
-	doc-type
-	(type-of object))
+  (warn "unsupported DOCUMENTATION: type ~S for object of type ~S"
+        doc-type
+        (type-of object))
   nil)
 
 ;;; default if DOC-TYPE doesn't match one of the specified types
@@ -204,24 +224,40 @@
   ;; doc types an implementation is permitted to discard docs at any time
   ;; for any reason, this feels to me more like a warning. -- WHN 19991214
   (warn "discarding unsupported DOCUMENTATION of type ~S for object ~S"
-	doc-type
-	(type-of object))
+        doc-type
+        (type-of object))
   new-value)
 
 ;;; extra-standard methods, for getting at slot documentation
 (defmethod documentation ((slotd standard-slot-definition) (doc-type (eql 't)))
   (declare (ignore doc-type))
-  (slot-value slotd 'documentation))
+  (slot-value slotd '%documentation))
 
 (defmethod (setf documentation)
     (new-value (slotd standard-slot-definition) (doc-type (eql 't)))
   (declare (ignore doc-type))
-  (setf (slot-value slotd 'documentation) new-value))
+  (setf (slot-value slotd '%documentation) new-value))
 
 ;;; Now that we have created the machinery for setting documentation, we can
 ;;; 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.")