Mercurial > emacs
annotate lisp/emacs-lisp/check-declare.el @ 86283:dcb8172071f2
(sh-mode): Set defun-prompt-regexp.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Wed, 21 Nov 2007 20:23:26 +0000 |
parents | 2f50908378c9 |
children | a80b13d94c3c |
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 |
86278
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
37 ;; 2. Check C files (look in src/)? |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
38 |
86178 | 39 ;;; Code: |
40 | |
41 (defconst check-declare-warning-buffer "*Check Declarations Warnings*" | |
42 "Name of buffer used to display any `check-declare' warnings.") | |
43 | |
44 (defun check-declare-scan (file) | |
45 "Scan FILE for `declare-function' calls. | |
46 Return a list with elements of the form (FNFILE FN ARGLIST), where | |
47 ARGLIST may be absent. This claims that FNFILE defines FN, with ARGLIST." | |
48 (let ((m (format "Scanning %s..." file)) | |
49 alist fnfile fn) | |
50 (message "%s" m) | |
51 (with-temp-buffer | |
52 (insert-file-contents file) | |
53 (while (re-search-forward | |
54 "^[ \t]*(declare-function[ \t]+\\(\\S-+\\)[ \t]+\ | |
55 \"\\(\\S-+\\)\"" nil t) | |
56 (setq fn (match-string 1) | |
57 fnfile (match-string 2)) | |
58 (or (file-name-absolute-p fnfile) | |
59 (setq fnfile (expand-file-name fnfile (file-name-directory file)))) | |
60 (setq alist (cons | |
61 (list fnfile fn | |
62 (progn | |
63 (skip-chars-forward " \t\n") | |
64 ;; Use `t' to distinguish no arglist | |
65 ;; specified from an empty one. | |
66 (if (looking-at "\\((\\|nil\\)") | |
67 (read (current-buffer)) | |
68 t))) | |
69 alist)))) | |
70 (message "%sdone" m) | |
71 alist)) | |
72 | |
73 (autoload 'byte-compile-arglist-signature "bytecomp") | |
74 | |
75 (defun check-declare-verify (fnfile fnlist) | |
76 "Check that FNFILE contains function definitions matching FNLIST. | |
77 Each element of FNLIST has the form (FILE FN ARGLIST), where | |
78 ARGLIST is optional. This means FILE claimed FN was defined in | |
79 FNFILE with the specified ARGLIST. Returns nil if all claims are | |
80 found to be true, otherwise a list of errors with elements of the form | |
81 \(FILE FN TYPE), where TYPE is a string giving details of the error." | |
82 (let ((m (format "Checking %s..." fnfile)) | |
83 re fn sig siglist arglist type errlist) | |
84 (message "%s" m) | |
86278
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
85 (if (string-equal (file-name-extension fnfile) "c") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
86 (progn |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
87 (message "%sskipping C file" m) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
88 nil) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
89 (or (file-exists-p fnfile) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
90 (setq fnfile (concat fnfile ".el"))) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
91 (if (file-exists-p fnfile) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
92 (with-temp-buffer |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
93 (insert-file-contents fnfile) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
94 ;; defsubst's don't _have_ to be known at compile time. |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
95 (setq re (format "^[ \t]*(\\(def\\(?:un\\|subst\\|\ |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
96 ine-derived-mode\\|ine-minor-mode\\|alias[ \t]+'\\)\\)\ |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
97 \[ \t]*%s\\([ \t;]+\\|$\\)" |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
98 (regexp-opt (mapcar 'cadr fnlist) t))) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
99 (while (re-search-forward re nil t) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
100 (skip-chars-forward " \t\n") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
101 (setq fn (match-string 2) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
102 sig (cond ((string-equal (match-string 1) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
103 "define-derived-mode") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
104 '(0 . 0)) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
105 ((string-equal (match-string 1) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
106 "define-minor-mode") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
107 '(0 . 1)) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
108 ;; Can't easily check alias arguments. |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
109 ((string-equal (match-string 1) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
110 "defalias") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
111 t) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
112 (t |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
113 (if (looking-at "\\((\\|nil\\)") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
114 (byte-compile-arglist-signature |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
115 (read (current-buffer)))))) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
116 ;; alist of functions and arglist signatures. |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
117 siglist (cons (cons fn sig) siglist))))) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
118 (dolist (e fnlist) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
119 (setq arglist (nth 2 e) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
120 type |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
121 (if re ; re non-nil means found a file |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
122 (if (setq sig (assoc (cadr e) siglist)) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
123 ;; Recall we use t to mean no arglist specified, |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
124 ;; to distinguish from an empty arglist. |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
125 (unless (or (eq arglist t) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
126 (eq sig t)) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
127 (unless (equal (byte-compile-arglist-signature arglist) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
128 (cdr sig)) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
129 "arglist mismatch")) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
130 "function not found") |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
131 "file not found")) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
132 (when type |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
133 (setq errlist (cons (list (car e) (cadr e) type) errlist)))) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
134 (message "%s%s" m (if errlist "problems found" "OK")) |
2f50908378c9
(check-declare-verify): Skip C files for now. Handle
Glenn Morris <rgm@gnu.org>
parents:
86244
diff
changeset
|
135 errlist))) |
86178 | 136 |
137 (defun check-declare-sort (alist) | |
138 "Sort a list with elements FILE (FNFILE ...). | |
139 Returned list has elements FNFILE (FILE ...)." | |
140 (let (file fnfile rest sort a) | |
141 (dolist (e alist) | |
142 (setq file (car e)) | |
143 (dolist (f (cdr e)) | |
144 (setq fnfile (car f) | |
145 rest (cdr f)) | |
146 (if (setq a (assoc fnfile sort)) | |
147 (setcdr a (append (cdr a) (list (cons file rest)))) | |
148 (setq sort (cons (list fnfile (cons file rest)) sort))))) | |
149 sort)) | |
150 | |
151 (defun check-declare-warn (file fn fnfile type) | |
152 "Warn that FILE made a false claim about FN in FNFILE. | |
153 TYPE is a string giving the nature of the error. Warning is displayed in | |
154 `check-declare-warning-buffer'." | |
155 (display-warning 'check-declare | |
156 (format "%s said `%s' was defined in %s: %s" | |
157 (file-name-nondirectory file) fn | |
158 (file-name-nondirectory fnfile) | |
159 type) | |
160 nil check-declare-warning-buffer)) | |
161 | |
162 (defun check-declare-files (&rest files) | |
163 "Check veracity of all `declare-function' statements in FILES. | |
164 Return a list of any errors found." | |
165 (let (alist err errlist) | |
166 (dolist (file files) | |
167 (setq alist (cons (cons file (check-declare-scan file)) alist))) | |
168 ;; Sort so that things are ordered by the files supposed to | |
169 ;; contain the defuns. | |
170 (dolist (e (check-declare-sort alist)) | |
171 (if (setq err (check-declare-verify (car e) (cdr e))) | |
172 (setq errlist (cons (cons (car e) err) errlist)))) | |
173 (if (get-buffer check-declare-warning-buffer) | |
174 (kill-buffer check-declare-warning-buffer)) | |
175 ;; Sort back again so that errors are ordered by the files | |
176 ;; containing the declare-function statements. | |
177 (dolist (e (check-declare-sort errlist)) | |
178 (dolist (f (cdr e)) | |
179 (check-declare-warn (car e) (cadr f) (car f) (nth 2 f)))) | |
180 errlist)) | |
181 | |
182 ;;;###autoload | |
183 (defun check-declare-file (file) | |
184 "Check veracity of all `declare-function' statements in FILE. | |
185 See `check-declare-directory' for more information." | |
186 (interactive "fFile to check: ") | |
187 (or (file-exists-p file) | |
188 (error "File `%s' not found" file)) | |
189 (let ((m (format "Checking %s..." file)) | |
190 errlist) | |
191 (message "%s" m) | |
192 (setq errlist (check-declare-files file)) | |
193 (message "%s%s" m (if errlist "problems found" "OK")) | |
194 errlist)) | |
195 | |
196 ;;;###autoload | |
197 (defun check-declare-directory (root) | |
198 "Check veracity of all `declare-function' statements under directory ROOT. | |
199 Returns non-nil if any false statements are found. For this to | |
200 work correctly, the statements must adhere to the format | |
201 described in the documentation of `declare-function'." | |
202 (interactive "DDirectory to check: ") | |
203 (or (file-directory-p (setq root (expand-file-name root))) | |
204 (error "Directory `%s' not found" root)) | |
205 (let ((m "Checking `declare-function' statements...") | |
206 (m2 "Finding files with declarations...") | |
207 errlist files) | |
208 (message "%s" m) | |
209 (message "%s" m2) | |
210 (setq files (process-lines "find" root "-name" "*.el" | |
211 "-exec" "grep" "-l" | |
212 "^[ ]*(declare-function" "{}" ";")) | |
213 (message "%s%d found" m2 (length files)) | |
214 (when files | |
215 (setq errlist (apply 'check-declare-files files)) | |
216 (message "%s%s" m (if errlist "problems found" "OK")) | |
217 errlist))) | |
218 | |
219 (provide 'check-declare) | |
220 | |
221 ;; arch-tag: a4d6cdc4-deb7-4502-b327-0e4ef3d82d96 | |
222 ;;; check-declare.el ends here. |