(in-package "SB-PCL")
(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)))
(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 (fdocumentation x 'function)
- ;; 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)))
(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
- (setf (focumentation (%fun-name x) 'function) 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 (fdocumentation x 'function) 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 (fdocumentation x 'function) 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 (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)))
(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)))
(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)))
(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)
- (warn "unsupported DOCUMENTATION: type ~S for object ~S"
+ (warn "unsupported DOCUMENTATION: type ~S for object of type ~S"
doc-type
(type-of object))
nil)
;;; 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.")
projects / sbcl.git / blobdiff