X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=a382b9d2c0f171fdb01ffb69278d5c85c765a574;hb=d7cbe5c40e93796d326937f3fb962fa4d7b1fa85;hp=e992894e72770e39f9c927a9e83d6c5bde8e3373;hpb=a97406ba6e8d843a5681fadbb90b28d41aee44d5;p=sbcl.git diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp index e992894..a382b9d 100644 --- 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)) @@ -62,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))) ;;; method combinations (defmethod documentation ((x method-combination) (doc-type (eql 't))) @@ -101,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))) @@ -200,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))) ;;; variables (defmethod documentation ((x symbol) (doc-type (eql 'variable))) @@ -209,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))) ;;; default if DOC-TYPE doesn't match one of the specified types (defmethod documentation (object doc-type)