X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=cb4c2a73ab733c42ea94f5e192eac9ffa7373012;hb=d25e3478acccec70402ff32554669a982be8e281;hp=2f1d52b3701012ed1f6f98fbe5db29984ae35b0c;hpb=942e45e3bb73fd55786e4a0ab4590324063c0c89;p=sbcl.git diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp index 2f1d52b..cb4c2a7 100644 --- a/src/pcl/documentation.lisp +++ b/src/pcl/documentation.lisp @@ -11,16 +11,22 @@ ;;; 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)))) + ;;; functions, macros, and special forms (defmethod documentation ((x function) (doc-type (eql 't))) - (if (typep x 'generic-function) - (slot-value x '%documentation) - (%fun-doc x))) + (fun-doc x)) (defmethod documentation ((x function) (doc-type (eql 'function))) - (if (typep x 'generic-function) - (slot-value x '%documentation) - (%fun-doc x))) + (fun-doc x)) (defmethod documentation ((x list) (doc-type (eql 'function))) (and (legal-fun-name-p x) @@ -41,22 +47,31 @@ (defmethod documentation ((x symbol) (doc-type (eql 'setf))) (values (info :setf :documentation x))) -(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)))) +(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 '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 't))) + (setf (fun-doc x) 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)) @@ -137,6 +152,16 @@ (defmethod documentation ((x standard-class) (doc-type (eql 'type))) (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))) + (values (info :type :documentation (class-name x)))) + +(defmethod documentation ((x condition-class) (doc-type (eql 'type))) + (values (info :type :documentation (class-name x)))) + (defmethod documentation ((x symbol) (doc-type (eql 'type))) (or (values (info :type :documentation x)) (let ((class (find-class x nil))) @@ -144,12 +169,12 @@ (slot-value class '%documentation))))) (defmethod documentation ((x symbol) (doc-type (eql 'structure))) - (cond ((eq (info :type :kind x) :instance) - (values (info :type :documentation x))) - ((info :typed-structure :info x) - (values (info :typed-structure :documentation x))) - (t - nil))) + (cond + ((structure-type-p x) + (values (info :type :documentation x))) + ((info :typed-structure :info x) + (values (info :typed-structure :documentation x))) + (t nil))) (defmethod (setf documentation) (new-value (x structure-class) @@ -171,6 +196,16 @@ (doc-type (eql 'type))) (setf (slot-value x '%documentation) new-value)) +(defmethod (setf documentation) (new-value + (x condition-class) + (doc-type (eql 't))) + (setf (info :type :documentation (class-name x)) new-value)) + +(defmethod (setf documentation) (new-value + (x condition-class) + (doc-type (eql 'type))) + (setf (info :type :documentation (class-name x)) 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) @@ -182,13 +217,12 @@ (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'structure))) - (cond ((eq (info :type :kind x) :instance) - (setf (info :type :documentation x) new-value)) - ((info :typed-structure :info x) - (setf (info :typed-structure :documentation x) new-value)) - (t - nil))) - + (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))) ;;; variables (defmethod documentation ((x symbol) (doc-type (eql 'variable)))