(in-package "SB-PCL")
-;;; Note some cases are handled by the documentation methods in
-;;; std-class.lisp.
-;;; FIXME: Those should probably be moved into this file too.
+(defun fun-doc (x)
+ (if (typep x 'generic-function)
+ (slot-value x '%documentation)
+ (%fun-doc x)))
-;;; FIXME: Lots of bare calls to INFO here could be handled
-;;; more cleanly by calling the FDOCUMENTATION function instead.
+(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: Neither SBCL nor Debian CMU CL 2.4.17 handles
-;;; (DEFUN FOO ())
-;;; (SETF (DOCUMENTATION #'FOO 'FUNCTION) "testing")
-;;; They fail with
-;;; Can't change the documentation of #<interpreted function FOO {900BF51}>.
-;;; The coverage of the DOCUMENTATION methods ought to be systematically
-;;; compared to the ANSI specification of DOCUMENTATION.
+;;; 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))
+ (fun-doc x))
(defmethod documentation ((x function) (doc-type (eql 'function)))
- (%fun-doc x))
+ (fun-doc x))
+
+(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
+ (awhen (compiler-macro-function x)
+ (documentation it t)))
(defmethod documentation ((x list) (doc-type (eql 'function)))
- (and (legal-fun-name-p x)
- (fboundp x)
- (documentation (fdefinition x) t)))
+ (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)))
+ (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)))
+ (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))
+ (set-function-name-documentation x 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 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)))
+ (set-function-name-documentation x 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)))
+\f
+;;; method combinations
+(defmethod documentation ((x method-combination) (doc-type (eql 't)))
+ (slot-value x '%documentation))
+
+(defmethod documentation
+ ((x method-combination) (doc-type (eql 'method-combination)))
+ (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))
+
+(defmethod (setf documentation)
+ (new-value (x method-combination) (doc-type (eql 'method-combination)))
+ (setf (slot-value x '%documentation) new-value))
+(defmethod (setf documentation)
+ (new-value (x symbol) (doc-type (eql 'method-combination)))
+ (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)))
+ (slot-value x '%documentation))
+
+(defmethod (setf documentation)
+ (new-value (x standard-method) (doc-type (eql 't)))
+ (setf (slot-value x '%documentation) new-value))
+\f
;;; packages
+
+;;; KLUDGE: It's nasty having things like this accessor
+;;; (PACKAGE-DOC-STRING) floating around out in this mostly-unrelated
+;;; source file. Perhaps it would be better to support WARM-INIT-FORMS
+;;; by analogy with the existing !COLD-INIT-FORMS and have them be
+;;; EVAL'ed after basic warm load is done? That way things like this
+;;; could be defined alongside the other code which does low-level
+;;; hacking of packages.. -- WHN 19991203
+
(defmethod documentation ((x package) (doc-type (eql 't)))
(package-doc-string x))
(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
(setf (package-doc-string x) new-value))
-;;; KLUDGE: It's nasty having things like this accessor floating around
-;;; out in this mostly-unrelated source file. Perhaps it would be
-;;; better to support WARM-INIT-FORMS by analogy with the existing
-;;; !COLD-INIT-FORMS and have them be EVAL'ed after basic warm load is
-;;; done? That way things like this could be defined alongside the
-;;; other code which does low-level hacking of packages.. -- WHN 19991203
-
+\f
;;; 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))
+
+(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)))
+ (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
- (plist-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 'type)))
+ (setf (fdocumentation (class-name x) 'type) new-value))
+
+(defmethod (setf documentation) (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 'type)))
+ (setf (slot-value x '%documentation) new-value))
(defmethod (setf documentation) (new-value
- (x structure-class)
- (doc-type (eql 't)))
- (setf (info :type :documentation (class-name x)) new-value))
+ (x condition-class)
+ (doc-type (eql 't)))
+ (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 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 (structure-type-p x) ; Catch structures first.
- (setf (info :type :documentation x) new-value)
+ (if (or (structure-type-p x) (condition-type-p x))
+ (setf (fdocumentation x 'type) new-value)
(let ((class (find-class x nil)))
- (if class
- (setf (plist-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)))
+ (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)))
- (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))
-
-;;; miscellaneous documentation. Compiler-macro documentation is stored
-;;; as random-documentation and handled here.
-(defmethod documentation ((x symbol) (doc-type symbol))
- (cdr (assoc doc-type
- (values (info :random-documentation :stuff x)))))
-
-(defmethod (setf documentation) (new-value (x symbol) (doc-type symbol))
- (let ((pair (assoc doc-type (info :random-documentation :stuff x))))
- (if pair
- (setf (cdr pair) new-value)
- (push (cons doc-type new-value)
- (info :random-documentation :stuff x))))
+ (x symbol)
+ (doc-type (eql 'variable)))
+ (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 of type ~S"
+ doc-type
+ (type-of object))
+ nil)
+
+;;; default if DOC-TYPE doesn't match one of the specified types
+(defmethod (setf documentation) (new-value object doc-type)
+ ;; CMU CL made this an error, but since ANSI says that even for supported
+ ;; 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))
new-value)
-;;; FIXME: The ((X SYMBOL) (DOC-TYPE SYMBOL)) method and its setf method should
-;;; have parallel versions which accept LIST-valued X arguments (for function
-;;; names in the (SETF FOO) style).
+;;; 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))
+(defmethod (setf documentation)
+ (new-value (slotd standard-slot-definition) (doc-type (eql 't)))
+ (declare (ignore doc-type))
+ (setf (slot-value slotd '%documentation) new-value))
+\f
;;; 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.")
projects / sbcl.git / blobdiff