Mercurial > emacs
annotate lisp/emacs-lisp/check-declare.el @ 86342:79a4d6e44352
(check-declare-locate): New function.
(check-declare-scan): Use check-declare-locate.
(check-declare-verify): No longer adjust fnfile, now
check-declare-locate does it.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Thu, 22 Nov 2007 20:25:51 +0000 |
parents | 9525bd421fdb |
children | b8e2c95bbb6e |
rev | line source |
---|---|
86178 | 1 ;;; check-declare.el --- Check declare-function statements |
2 | |
3 ;; Copyright (C) 2007 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Glenn Morris <rgm@gnu.org> | |
6 ;; Keywords: lisp, tools, maint | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 3, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
23 ;; Boston, MA 02110-1301, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
27 ;; The byte-compiler often warns about undefined functions that you | |
28 ;; know will actually be defined when it matters. The `declare-function' | |
29 ;; statement allows you to suppress these warnings. This package | |
30 ;; checks that all such statements in a file or directory are accurate. | |
31 ;; The entry points are `check-declare-file' and `check-declare-directory'. | |
32 | |
86220
1244ab609a99
(check-declare-verify): If fnfile does not exist, try adding `.el'
Glenn Morris <rgm@gnu.org>
parents:
86178
diff
changeset
|
33 ;;; TODO: |
1244ab609a99
(check-declare-verify): If fnfile does not exist, try adding `.el'
Glenn Morris <rgm@gnu.org>
parents:
86178
diff
changeset
|
34 |
1244ab609a99
(check-declare-verify): If fnfile does not exist, try adding `.el'
Glenn Morris <rgm@gnu.org>
parents:
86178
diff
changeset
|
35 ;; 1. Handle defstructs (eg uniquify-item-base in desktop.el). |
1244ab609a99
(check-declare-verify): If fnfile does not exist, try adding `.el'
Glenn Morris <rgm@gnu.org>
parents:
86178
diff
changeset
|
36 |
86178 | 37 ;;; Code: |
38 | |
39 (defconst check-declare-warning-buffer "*Check Declarations Warnings*" | |
40 "Name of buffer used to display any `check-declare' warnings.") | |
41 | |
86342
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
42 (defun check-declare-locate (file basefile) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
43 "Return the full path of FILE. |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
44 Expands files with a \".c\" extension relative to the Emacs |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
45 \"src/\" directory. Otherwise, `locate-library' searches for |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
46 FILE. If that fails, expands FILE relative to BASEFILE's |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
47 directory part. The returned file might not exist." |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
48 (if (string-equal "c" (file-name-extension file)) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
49 (expand-file-name file (expand-file-name "src" source-directory)) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
50 (let ((tfile (locate-library (file-name-nondirectory file)))) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
51 (if tfile |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
52 (replace-regexp-in-string "\\.elc\\'" ".el" tfile) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
53 (setq tfile (expand-file-name file (file-name-directory basefile))) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
54 (if (or (file-exists-p tfile) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
55 (string-match "\\.el\\'" tfile)) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
56 tfile |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
57 (concat tfile ".el")))))) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
58 |
86178 | 59 (defun check-declare-scan (file) |
60 "Scan FILE for `declare-function' calls. | |
61 Return a list with elements of the form (FNFILE FN ARGLIST), where | |
62 ARGLIST may be absent. This claims that FNFILE defines FN, with ARGLIST." | |
63 (let ((m (format "Scanning %s..." file)) | |
64 alist fnfile fn) | |
65 (message "%s" m) | |
66 (with-temp-buffer | |
67 (insert-file-contents file) | |
68 (while (re-search-forward | |
69 "^[ \t]*(declare-function[ \t]+\\(\\S-+\\)[ \t]+\ | |
70 \"\\(\\S-+\\)\"" nil t) | |
71 (setq fn (match-string 1) | |
86342
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
72 fnfile (match-string 2) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
73 fnfile (check-declare-locate fnfile (expand-file-name file)) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
74 alist (cons |
86178 | 75 (list fnfile fn |
76 (progn | |
77 (skip-chars-forward " \t\n") | |
78 ;; Use `t' to distinguish no arglist | |
79 ;; specified from an empty one. | |
80 (if (looking-at "\\((\\|nil\\)") | |
81 (read (current-buffer)) | |
82 t))) | |
83 alist)))) | |
84 (message "%sdone" m) | |
85 alist)) | |
86 | |
87 (autoload 'byte-compile-arglist-signature "bytecomp") | |
88 | |
89 (defun check-declare-verify (fnfile fnlist) | |
90 "Check that FNFILE contains function definitions matching FNLIST. | |
91 Each element of FNLIST has the form (FILE FN ARGLIST), where | |
92 ARGLIST is optional. This means FILE claimed FN was defined in | |
93 FNFILE with the specified ARGLIST. Returns nil if all claims are | |
94 found to be true, otherwise a list of errors with elements of the form | |
95 \(FILE FN TYPE), where TYPE is a string giving details of the error." | |
96 (let ((m (format "Checking %s..." fnfile)) | |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
97 (cflag (string-equal "c" (file-name-extension fnfile))) |
86300
96fee69c65a2
(check-declare-verify): Implement arglist checking for C files.
Glenn Morris <rgm@gnu.org>
parents:
86297
diff
changeset
|
98 re fn sig siglist arglist type errlist minargs maxargs) |
86178 | 99 (message "%s" m) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
100 (if (file-exists-p fnfile) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
101 (with-temp-buffer |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
102 (insert-file-contents fnfile) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
103 ;; defsubst's don't _have_ to be known at compile time. |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
104 (setq re (format (if cflag |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
105 "^[ \t]*\\(DEFUN\\)[ \t]*([ \t]*\"%s\"" |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
106 "^[ \t]*(\\(def\\(?:un\\|subst\\|\ |
86278
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
107 ine-derived-mode\\|ine-minor-mode\\|alias[ \t]+'\\)\\)\ |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
108 \[ \t]*%s\\([ \t;]+\\|$\\)") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
109 (regexp-opt (mapcar 'cadr fnlist) t))) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
110 (while (re-search-forward re nil t) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
111 (skip-chars-forward " \t\n") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
112 (setq fn (match-string 2) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
113 ;; (min . max) for a fixed number of arguments, or |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
114 ;; arglists with optional elements. |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
115 ;; (min) for arglists with &rest. |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
116 ;; sig = 'err means we could not find an arglist. |
86300
96fee69c65a2
(check-declare-verify): Implement arglist checking for C files.
Glenn Morris <rgm@gnu.org>
parents:
86297
diff
changeset
|
117 sig (cond (cflag |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
118 (or |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
119 (when (re-search-forward "," nil t 3) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
120 (skip-chars-forward " \t\n") |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
121 ;; Assuming minargs and maxargs on same line. |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
122 (when (looking-at "\\([0-9]+\\)[ \t]*,[ \t]*\ |
86300
96fee69c65a2
(check-declare-verify): Implement arglist checking for C files.
Glenn Morris <rgm@gnu.org>
parents:
86297
diff
changeset
|
123 \\([0-9]+\\|MANY\\|UNEVALLED\\)") |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
124 (setq minargs (string-to-number |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
125 (match-string 1)) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
126 maxargs (match-string 2)) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
127 (cons minargs (unless (string-match "[^0-9]" |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
128 maxargs) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
129 (string-to-number |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
130 maxargs))))) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
131 'err)) |
86300
96fee69c65a2
(check-declare-verify): Implement arglist checking for C files.
Glenn Morris <rgm@gnu.org>
parents:
86297
diff
changeset
|
132 ((string-equal (match-string 1) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
133 "define-derived-mode") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
134 '(0 . 0)) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
135 ((string-equal (match-string 1) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
136 "define-minor-mode") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
137 '(0 . 1)) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
138 ;; Can't easily check alias arguments. |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
139 ((string-equal (match-string 1) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
140 "defalias") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
141 t) |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
142 ((looking-at "\\((\\|nil\\)") |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
143 (byte-compile-arglist-signature |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
144 (read (current-buffer)))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
145 (t |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
146 'err)) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
147 ;; alist of functions and arglist signatures. |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
148 siglist (cons (cons fn sig) siglist))))) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
149 (dolist (e fnlist) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
150 (setq arglist (nth 2 e) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
151 type |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
152 (if re ; re non-nil means found a file |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
153 (if (setq sig (assoc (cadr e) siglist)) ; found function |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
154 ;; Recall we use t to mean no arglist specified, |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
155 ;; to distinguish from an empty arglist. |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
156 (unless (eq arglist t) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
157 (setq sig (cdr-safe sig)) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
158 (cond ((eq sig t)) ; defalias, can't check |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
159 ((eq sig 'err) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
160 "arglist not found") ; internal error |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
161 ((not (equal (byte-compile-arglist-signature |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
162 arglist) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
163 sig)) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
164 "arglist mismatch"))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
165 "function not found") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
166 "file not found")) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
167 (when type |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
168 (setq errlist (cons (list (car e) (cadr e) type) errlist)))) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
169 (message "%s%s" m (if errlist "problems found" "OK")) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
170 errlist)) |
86178 | 171 |
172 (defun check-declare-sort (alist) | |
173 "Sort a list with elements FILE (FNFILE ...). | |
174 Returned list has elements FNFILE (FILE ...)." | |
175 (let (file fnfile rest sort a) | |
176 (dolist (e alist) | |
177 (setq file (car e)) | |
178 (dolist (f (cdr e)) | |
179 (setq fnfile (car f) | |
180 rest (cdr f)) | |
181 (if (setq a (assoc fnfile sort)) | |
182 (setcdr a (append (cdr a) (list (cons file rest)))) | |
183 (setq sort (cons (list fnfile (cons file rest)) sort))))) | |
184 sort)) | |
185 | |
186 (defun check-declare-warn (file fn fnfile type) | |
187 "Warn that FILE made a false claim about FN in FNFILE. | |
188 TYPE is a string giving the nature of the error. Warning is displayed in | |
189 `check-declare-warning-buffer'." | |
190 (display-warning 'check-declare | |
191 (format "%s said `%s' was defined in %s: %s" | |
192 (file-name-nondirectory file) fn | |
193 (file-name-nondirectory fnfile) | |
194 type) | |
195 nil check-declare-warning-buffer)) | |
196 | |
197 (defun check-declare-files (&rest files) | |
198 "Check veracity of all `declare-function' statements in FILES. | |
199 Return a list of any errors found." | |
200 (let (alist err errlist) | |
201 (dolist (file files) | |
202 (setq alist (cons (cons file (check-declare-scan file)) alist))) | |
203 ;; Sort so that things are ordered by the files supposed to | |
204 ;; contain the defuns. | |
205 (dolist (e (check-declare-sort alist)) | |
206 (if (setq err (check-declare-verify (car e) (cdr e))) | |
207 (setq errlist (cons (cons (car e) err) errlist)))) | |
208 (if (get-buffer check-declare-warning-buffer) | |
209 (kill-buffer check-declare-warning-buffer)) | |
210 ;; Sort back again so that errors are ordered by the files | |
211 ;; containing the declare-function statements. | |
212 (dolist (e (check-declare-sort errlist)) | |
213 (dolist (f (cdr e)) | |
214 (check-declare-warn (car e) (cadr f) (car f) (nth 2 f)))) | |
215 errlist)) | |
216 | |
217 ;;;###autoload | |
218 (defun check-declare-file (file) | |
219 "Check veracity of all `declare-function' statements in FILE. | |
220 See `check-declare-directory' for more information." | |
221 (interactive "fFile to check: ") | |
222 (or (file-exists-p file) | |
223 (error "File `%s' not found" file)) | |
224 (let ((m (format "Checking %s..." file)) | |
225 errlist) | |
226 (message "%s" m) | |
227 (setq errlist (check-declare-files file)) | |
228 (message "%s%s" m (if errlist "problems found" "OK")) | |
229 errlist)) | |
230 | |
231 ;;;###autoload | |
232 (defun check-declare-directory (root) | |
233 "Check veracity of all `declare-function' statements under directory ROOT. | |
234 Returns non-nil if any false statements are found. For this to | |
235 work correctly, the statements must adhere to the format | |
236 described in the documentation of `declare-function'." | |
237 (interactive "DDirectory to check: ") | |
238 (or (file-directory-p (setq root (expand-file-name root))) | |
239 (error "Directory `%s' not found" root)) | |
240 (let ((m "Checking `declare-function' statements...") | |
241 (m2 "Finding files with declarations...") | |
242 errlist files) | |
243 (message "%s" m) | |
244 (message "%s" m2) | |
245 (setq files (process-lines "find" root "-name" "*.el" | |
246 "-exec" "grep" "-l" | |
247 "^[ ]*(declare-function" "{}" ";")) | |
248 (message "%s%d found" m2 (length files)) | |
249 (when files | |
250 (setq errlist (apply 'check-declare-files files)) | |
251 (message "%s%s" m (if errlist "problems found" "OK")) | |
252 errlist))) | |
253 | |
254 (provide 'check-declare) | |
255 | |
256 ;; arch-tag: a4d6cdc4-deb7-4502-b327-0e4ef3d82d96 | |
257 ;;; check-declare.el ends here. |