:accessor object-plist))
(:metaclass std-class))
-(defclass documentation-mixin (plist-mixin)
- ()
- (:metaclass std-class))
-
(defclass dependent-update-mixin (plist-mixin)
()
(:metaclass std-class))
;;; The class CLASS is a specified basic class. It is the common
;;; superclass of any kind of class. That is, any class that can be a
;;; metaclass must have the class CLASS in its class precedence list.
-(defclass class (documentation-mixin
- dependent-update-mixin
+(defclass class (dependent-update-mixin
definition-source-mixin
specializer)
((name
(predicate-name
:initform nil
:reader class-predicate-name)
+ (documentation
+ :initform nil
+ :initarg :documentation)
(finalized-p
:initform nil
:reader class-finalized-p)))
:initarg :type
:accessor slot-definition-type)
(documentation
- :initform ""
+ :initform nil
:initarg :documentation)
(class
:initform nil
:initform nil
:initarg :fast-function ;no writer
:reader method-fast-function)
-;;; (documentation
-;;; :initform nil
-;;; :initarg :documentation
-;;; :reader method-documentation)
- ))
+ (documentation
+ :initform nil
+ :initarg :documentation)))
(defclass standard-accessor-method (standard-method)
((slot-name :initform nil
(defclass generic-function (dependent-update-mixin
definition-source-mixin
- documentation-mixin
funcallable-standard-object)
- (;; We need to make a distinction between the methods initially set
+ ((documentation
+ :initform nil
+ :initarg :documentation)
+ ;; We need to make a distinction between the methods initially set
;; up by :METHOD options to DEFGENERIC and the ones set up later by
;; DEFMETHOD, because ANSI's specifies that executing DEFGENERIC on
;; an already-DEFGENERICed function clears the methods set by the
(:default-initargs :method-class *the-class-standard-method*
:method-combination *standard-method-combination*))
-(defclass method-combination (standard-object) ())
+(defclass method-combination (standard-object)
+ ((documentation
+ :reader method-combination-documentation
+ :initform nil
+ :initarg :documentation)))
(defclass standard-method-combination (definition-source-mixin
- method-combination)
+ method-combination)
((type
:reader method-combination-type
:initarg :type)
- (documentation
- :reader method-combination-documentation
- :initarg :documentation)
(options
:reader method-combination-options
:initarg :options)))
(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)))
- (%fun-doc x))
+ (if (typep x 'generic-function)
+ (slot-value x 'documentation)
+ (%fun-doc x)))
(defmethod documentation ((x function) (doc-type (eql 'function)))
- (%fun-doc x))
+ (if (typep x 'generic-function)
+ (slot-value x 'documentation)
+ (%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))
+
(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))))
+(defmethod documentation ((x symbol) (doc-type (eql 'compiler-macro)))
+ (random-documentation x 'compiler-macro))
+
(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))))
+ 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 (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 (info :function :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 ((method standard-method) (doc-type (eql 't)))
+ (slot-value slotd 'documentation))
+
+(defmethod (setf documentation)
+ (new-value (method standard-method) (doc-type (eql 't)))
+ (setf (slot-value method '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))))
(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
(values (info :type :documentation (class-name x))))
+(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))
+
(defmethod documentation ((x symbol) (doc-type (eql 'type)))
(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 (info :type :kind x) :instance)
(doc-type (eql 'type)))
(setf (info :type :documentation (class-name x)) 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 symbol) (doc-type (eql 'type)))
(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 (slot-value class 'documentation) new-value)
(setf (info :type :documentation x) new-value)))))
(defmethod (setf documentation) (new-value
(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))
-
+\f
;;; variables
(defmethod documentation ((x symbol) (doc-type (eql 'variable)))
(values (info :variable :documentation x)))
(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))))
+\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 / commitdiff