(in-package "SB-PCL")
-;;; FIXME: Lots of bare calls to INFO here could be handled
-;;; more cleanly by calling the FDOCUMENTATION function instead.
-
-;;; functions, macros, and special forms
-(defmethod documentation ((x function) (doc-type (eql 't)))
+(defun fun-doc (x)
(if (typep x 'generic-function)
(slot-value x '%documentation)
(%fun-doc x)))
-(defmethod documentation ((x function) (doc-type (eql 'function)))
+(defun (setf fun-doc) (new-value x)
(if (typep x 'generic-function)
- (slot-value x '%documentation)
- (%fun-doc x)))
+ (setf (slot-value x '%documentation) new-value)
+ (setf (%fun-doc x) new-value)))
+
+;;; functions, macros, and special forms
+(defmethod documentation ((x function) (doc-type (eql 't)))
+ (fun-doc x))
+
+(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)))
+ (when (and (legal-fun-name-p x) (fboundp x))
+ (fun-doc (fdefinition x))))
(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 symbol) (doc-type (eql 'function)))
- (or (values (info :function :documentation x))
- ;; Try the pcl function documentation.
- (and (fboundp x) (documentation (fdefinition x) t))))
+ (when (and (legal-fun-name-p x) (fboundp x))
+ (fun-doc (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)))
- (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)))
- (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)
+ (setf (fun-doc x) 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 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))
+ (when (and (legal-fun-name-p x) (fboundp x))
+ (setf (documentation (fdefinition x) t) 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 (info :function :documentation x) new-value))
+(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'function)))
+ (when (and (legal-fun-name-p x) (fboundp x))
+ (setf (documentation (or (macro-function x) (symbol-function x)) t)
+ 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)))
+ (awhen (compiler-macro-function x)
+ (setf (documentation it t) new-value)))
(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf)))
- (setf (info :setf :documentation x) new-value))
+ (setf (fdocumentation x 'setf) new-value))
\f
;;; method combinations
(defmethod documentation ((x method-combination) (doc-type (eql 't)))
\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
(slot-value class '%documentation)))))
(defmethod documentation ((x symbol) (doc-type (eql 'structure)))
- (cond ((eq (info :type :kind x) :instance)
- (values (info :type :documentation x)))
- ((info :typed-structure :info x)
- (values (info :typed-structure :documentation x)))
- (t
- nil)))
+ (fdocumentation x 'structure))
(defmethod (setf documentation) (new-value
(x structure-class)
(doc-type (eql 't)))
- (setf (info :type :documentation (class-name x)) new-value))
+ (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))
+ (setf (fdocumentation (class-name x) 'type) 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 condition-class)
+ (doc-type (eql 't)))
+ (setf (fdocumentation (class-name x) 'type) new-value))
+
+(defmethod (setf documentation) (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 (or (structure-type-p x) (condition-type-p x))
- (setf (info :type :documentation x) new-value)
+ (setf (fdocumentation x 'type) new-value)
(let ((class (find-class x nil)))
(if class
(setf (slot-value class '%documentation) new-value)
- (setf (info :type :documentation x) new-value)))))
+ (setf (fdocumentation x 'type) new-value)))))
(defmethod (setf documentation) (new-value
(x symbol)
(doc-type (eql 'structure)))
- (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
- nil)))
-
+ (setf (fdocumentation x '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))
+ (setf (fdocumentation x '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)
projects / sbcl.git / blobdiff