(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.
-
;;; FIXME: Lots of bare calls to INFO here could be handled
;;; more cleanly by calling the FDOCUMENTATION function instead.
-;;; 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.
-
;;; functions, macros, and special forms
(defmethod documentation ((x function) (doc-type (eql 't)))
- (sb-impl::function-doc x))
+ (if (typep x 'generic-function)
+ (slot-value x 'documentation)
+ (%fun-doc x)))
(defmethod documentation ((x function) (doc-type (eql 'function)))
- (sb-impl::function-doc x))
+ (if (typep x 'generic-function)
+ (slot-value x 'documentation)
+ (%fun-doc x)))
(defmethod documentation ((x list) (doc-type (eql 'function)))
- ;; FIXME: could test harder to see whether it's a SETF function name,
- ;; then call WARN
- (when (eq (first x) 'setf) ; Give up if not a setf function name.
- (or (values (sb-int:info :setf :documentation (second x)))
- ;; Try the pcl function documentation.
- (and (fboundp x) (documentation (fdefinition x) 't)))))
+ (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))
(defmethod documentation ((x symbol) (doc-type (eql 'function)))
- (or (values (sb-int:info :function :documentation x))
+ (or (values (info :function :documentation x))
;; Try the pcl function documentation.
- (and (fboundp x) (documentation (fdefinition x) 't))))
+ (and (fboundp x) (documentation (fdefinition x) t))))
+
+(defmethod documentation ((x symbol) (doc-type (eql 'compiler-macro)))
+ (random-documentation x 'compiler-macro))
(defmethod documentation ((x symbol) (doc-type (eql 'setf)))
- (values (sb-int:info :setf :documentation x)))
+ (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))))
+ 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 list) (doc-type (eql 'function)))
- (setf (sb-int:info :setf :documentation (cadr x)) new-value))
+ (setf (info :function :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 symbol)
(doc-type (eql 'function)))
- (setf (sb-int:info :function :documentation x) new-value))
+ (setf (info :function :documentation x) new-value))
-(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf)))
- (setf (sb-int:info :setf :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 'setf)))
+ (setf (info :setf :documentation x) 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)))
+ (setf (random-documentation x '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)))
- (sb-impl::package-doc-string x))
+ (package-doc-string x))
(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
- (setf (sb-impl::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
-
+ (setf (package-doc-string x) new-value))
+\f
;;; types, classes, and structure names
-(defmethod documentation ((x cl:structure-class) (doc-type (eql 't)))
- (values (sb-int:info :type :documentation (cl:class-name x))))
-
(defmethod documentation ((x structure-class) (doc-type (eql 't)))
- (values (sb-int:info :type :documentation (class-name x))))
-
-(defmethod documentation ((x cl:standard-class) (doc-type (eql 't)))
- (or (values (sb-int:info :type :documentation (cl:class-name x)))
- (let ((pcl-class (sb-kernel:class-pcl-class x)))
- (and pcl-class (plist-value pcl-class 'documentation)))))
-
-(defmethod documentation ((x cl:structure-class) (doc-type (eql 'type)))
- (values (sb-int:info :type :documentation (cl:class-name x))))
+ (values (info :type :documentation (class-name x))))
(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
- (values (sb-int:info :type :documentation (class-name x))))
+ (values (info :type :documentation (class-name x))))
+
+(defmethod documentation ((x standard-class) (doc-type (eql 't)))
+ (slot-value x 'documentation))
-(defmethod documentation ((x cl:standard-class) (doc-type (eql 'type)))
- (or (values (sb-int:info :type :documentation (cl:class-name x)))
- (let ((pcl-class (sb-kernel:class-pcl-class x)))
- (and pcl-class (plist-value pcl-class 'documentation)))))
+(defmethod documentation ((x standard-class) (doc-type (eql 'type)))
+ (slot-value x 'documentation))
(defmethod documentation ((x symbol) (doc-type (eql 'type)))
- (or (values (sb-int:info :type :documentation x))
+ (or (values (info :type :documentation x))
(let ((class (find-class x nil)))
(when class
- (plist-value class 'documentation)))))
+ (slot-value class 'documentation)))))
(defmethod documentation ((x symbol) (doc-type (eql 'structure)))
- (when (eq (sb-int:info :type :kind x) :instance)
- (values (sb-int:info :type :documentation x))))
+ (cond ((eq (info :type :kind x) :instance)
+ (values (info :type :documentation x)))
+ ((info :typed-structure :info x)
+ (values (info :typed-structure :documentation x)))
+ (t
+ (error "~S is not the name of a structure type." x))))
(defmethod (setf documentation) (new-value
- (x cl:structure-class)
+ (x structure-class)
(doc-type (eql 't)))
- (setf (sb-int:info :type :documentation (cl:class-name x)) new-value))
+ (setf (info :type :documentation (class-name x)) new-value))
(defmethod (setf documentation) (new-value
(x structure-class)
- (doc-type (eql 't)))
- (setf (sb-int:info :type :documentation (class-name x)) new-value))
+ (doc-type (eql 'type)))
+ (setf (info :type :documentation (class-name x)) new-value))
(defmethod (setf documentation) (new-value
- (x cl:structure-class)
- (doc-type (eql 'type)))
- (setf (sb-int:info :type :documentation (cl: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 structure-class)
+ (x standard-class)
(doc-type (eql 'type)))
- (setf (sb-int:info :type :documentation (class-name x)) new-value))
+ (setf (slot-value x 'documentation) new-value))
(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'type)))
- (if (structure-type-p x) ; Catch structures first.
- (setf (sb-int:info :type :documentation x) new-value)
+ (if (or (structure-type-p x) (condition-type-p x))
+ (setf (info :type :documentation x) new-value)
(let ((class (find-class x nil)))
(if class
- (setf (plist-value class 'documentation) new-value)
- (setf (sb-int:info :type :documentation x) new-value)))))
+ (setf (slot-value class 'documentation) new-value)
+ (setf (info :type :documentation x) new-value)))))
(defmethod (setf documentation) (new-value
(x symbol)
(doc-type (eql 'structure)))
- (unless (eq (sb-int:info :type :kind x) :instance)
- (error "~S is not the name of a structure type." x))
- (setf (sb-int:info :type :documentation x) new-value))
-
+ (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
+ (error "~S is not the name of a structure type." x))))
+
+\f
;;; variables
(defmethod documentation ((x symbol) (doc-type (eql 'variable)))
- (values (sb-int:info :variable :documentation x)))
+ (values (info :variable :documentation x)))
(defmethod (setf documentation) (new-value
(x symbol)
(doc-type (eql 'variable)))
- (setf (sb-int: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 (sb-int:info :random-documentation :stuff x)))))
-
-(defmethod (setf documentation) (new-value (x symbol) (doc-type symbol))
- (let ((pair (assoc doc-type (sb-int:info :random-documentation :stuff x))))
- (if pair
- (setf (cdr pair) new-value)
- (push (cons doc-type new-value)
- (sb-int:info :random-documentation :stuff x))))
+ (setf (info :variable :documentation x) 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"
+ 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
projects / sbcl.git / blobdiff