+;;;; tests for problems in the interface presented to the user/programmer
+
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; more information.
(in-package :cl-user)
+\f
+;;;; properties of symbols, e.g. presence of doc strings for public symbols
;;; Check for fbound external symbols in public packages that have no
-;;; argument list information. (This can happen if we get carried away
-;;; with byte compilation, since at least in sbcl-0.6.12 the byte
-;;; compiler can't record argument list information.)
+;;; argument list information. (This used to be possible when we got
+;;; carried away with byte compilation, since the byte compiler can't
+;;; record argument list information. Now that there's no byte
+;;; compiler, that can't happen, but it still shouldn't hurt to check
+;;; in case the argument information goes astray some other way.)
(defvar *public-package-names*
- '("SB-ALIEN" "SB-C-CALL" "SB-DEBUG" "SB-EXT" "SB-EXT""SB-GRAY" "SB-MP"
+ '("SB-ALIEN" "SB-C-CALL" "SB-DEBUG" "SB-EXT" "SB-GRAY" "SB-MP"
"SB-PROFILE" "SB-PCL" "COMMON-LISP"))
-(defun has-arglist-info-p (function)
- (and (not (typep function 'sb-c::byte-function))
- (sb-kernel:%function-arglist function)))
+(defun has-arglist-info-p (fun)
+ (declare (type function fun))
+ ;; The Lisp-level type FUNCTION can conceal a multitude of sins..
+ (case (sb-kernel:widetag-of fun)
+ ((#.sb-vm:simple-fun-header-widetag #.sb-vm:closure-fun-header-widetag)
+ (sb-kernel:%simple-fun-arglist fun))
+ (#.sb-vm:closure-header-widetag (has-arglist-info-p
+ (sb-kernel:%closure-fun fun)))
+ ;; In code/describe.lisp, ll. 227 (%describe-fun), we use a scheme
+ ;; like above, and it seems to work. -- MNA 2001-06-12
+ ;;
+ ;; (There might be other cases with arglist info also.
+ ;; SIMPLE-FUN-HEADER-WIDETAG and CLOSURE-HEADER-WIDETAG just
+ ;; happen to be the two case that I had my nose rubbed in when
+ ;; debugging a GC problem caused by applying %SIMPLE-FUN-ARGLIST to
+ ;; a closure. -- WHN 2001-06-05)
+ (t nil)))
(defun check-ext-symbols-arglist (package)
(format t "~% looking at package: ~A" package)
(do-external-symbols (ext-sym package)
(when (fboundp ext-sym)
(let ((fun (symbol-function ext-sym)))
- (unless (has-arglist-info-p fun)
- (error "~%Function ~A (~A) has no argument-list information available, ~%~
- and is probably byte-compiled.~%" ext-sym fun))))))
+ (cond ((macro-function ext-sym)
+ ;; FIXME: Macro functions should have their argument list
+ ;; information checked separately. Just feeding them into
+ ;; the ordinary-function logic below doesn't work right,
+ ;; though, and I haven't figured out what does work
+ ;; right. For now we just punt.
+ (values))
+ ((typep fun 'generic-function)
+ (sb-pcl::generic-function-pretty-arglist fun))
+ (t
+ (let ((fun (symbol-function ext-sym)))
+ (unless (has-arglist-info-p fun)
+ (error "Function ~A has no arg-list information available."
+ ext-sym)))))))))
(dolist (public-package *public-package-names*)
(when (find-package public-package)
(check-ext-symbols-arglist public-package)))
+(terpri)
+
+;;; FIXME: It would probably be good to require here that every
+;;; external symbol either has a doc string or has some good excuse
+;;; (like being an accessor for a structure which has a doc string).
+\f
+;;;; tests of interface machinery
+
+;;; APROPOS should accept a package designator, not just a package, and
+;;; furthermore do the right thing when it gets a package designator.
+;;; (bug reported and fixed by Alexey Dejneka sbcl-devel 2001-10-17)
+(assert (< 0
+ (length (apropos-list "PRINT" :cl))
+ (length (apropos-list "PRINT"))))
projects / sbcl.git / blobdiff