Mercurial > emacs
annotate lisp/emacs-lisp/check-declare.el @ 95392:838b2bca5a6f
*** empty log message ***
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Thu, 29 May 2008 20:05:36 +0000 |
parents | 90a2847062be |
children | b4b1fe2990a7 |
rev | line source |
---|---|
86178 | 1 ;;; check-declare.el --- Check declare-function statements |
2 | |
87665 | 3 ;; Copyright (C) 2007, 2008 Free Software Foundation, Inc. |
86178 | 4 |
5 ;; Author: Glenn Morris <rgm@gnu.org> | |
6 ;; Keywords: lisp, tools, maint | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94459
diff
changeset
|
10 ;; GNU Emacs is free software: you can redistribute it and/or modify |
86178 | 11 ;; it under the terms of the GNU General Public License as published by |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94459
diff
changeset
|
12 ;; the Free Software Foundation, either version 3 of the License, or |
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94459
diff
changeset
|
13 ;; (at your option) any later version. |
86178 | 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 | |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94459
diff
changeset
|
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
86178 | 22 |
23 ;;; Commentary: | |
24 | |
25 ;; The byte-compiler often warns about undefined functions that you | |
26 ;; know will actually be defined when it matters. The `declare-function' | |
27 ;; statement allows you to suppress these warnings. This package | |
28 ;; checks that all such statements in a file or directory are accurate. | |
29 ;; The entry points are `check-declare-file' and `check-declare-directory'. | |
30 | |
86388 | 31 ;; For more information, see Info node `elisp(Declaring Functions)'. |
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 |
87260
4cd2a938a117
(check-declare-verify): Handle deffoo.
Glenn Morris <rgm@gnu.org>
parents:
86841
diff
changeset
|
35 ;; 1. Warn about functions marked as obsolete, eg |
4cd2a938a117
(check-declare-verify): Handle deffoo.
Glenn Morris <rgm@gnu.org>
parents:
86841
diff
changeset
|
36 ;; password-read-and-add in smime.el. |
4cd2a938a117
(check-declare-verify): Handle deffoo.
Glenn Morris <rgm@gnu.org>
parents:
86841
diff
changeset
|
37 |
86178 | 38 ;;; Code: |
39 | |
40 (defconst check-declare-warning-buffer "*Check Declarations Warnings*" | |
41 "Name of buffer used to display any `check-declare' warnings.") | |
42 | |
86342
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
43 (defun check-declare-locate (file basefile) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
44 "Return the full path of FILE. |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
45 Expands files with a \".c\" extension relative to the Emacs |
86528
db04d9e790f1
(check-declare-locate): Reflow doc.
Glenn Morris <rgm@gnu.org>
parents:
86457
diff
changeset
|
46 \"src/\" directory. Otherwise, `locate-library' searches for FILE. |
db04d9e790f1
(check-declare-locate): Reflow doc.
Glenn Morris <rgm@gnu.org>
parents:
86457
diff
changeset
|
47 If that fails, expands FILE relative to BASEFILE's directory part. |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
48 The returned file might not exist. If FILE has an \"ext:\" prefix, so does |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
49 the result." |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
50 (let ((ext (string-match "^ext:" file)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
51 tfile) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
52 (if ext |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
53 (setq file (substring file 4))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
54 (setq file |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
55 (if (string-equal "c" (file-name-extension file)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
56 (expand-file-name file (expand-file-name "src" source-directory)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
57 (if (setq tfile (locate-library (file-name-nondirectory file))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
58 (progn |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
59 (setq tfile |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
60 (replace-regexp-in-string "\\.elc\\'" ".el" tfile)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
61 (if (and (not (file-exists-p tfile)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
62 (file-exists-p (concat tfile ".gz"))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
63 (concat tfile ".gz") |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
64 tfile)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
65 (setq tfile (expand-file-name file |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
66 (file-name-directory basefile))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
67 (if (or (file-exists-p tfile) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
68 (string-match "\\.el\\'" tfile)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
69 tfile |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
70 (concat tfile ".el"))))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
71 (if ext (concat "ext:" file) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
72 file))) |
86342
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
73 |
86178 | 74 (defun check-declare-scan (file) |
75 "Scan FILE for `declare-function' calls. | |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
76 Return a list with elements of the form (FNFILE FN ARGLIST FILEONLY), |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
77 where only the first two elements need be present. This claims that FNFILE |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
78 defines FN, with ARGLIST. FILEONLY non-nil means only check that FNFILE |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
79 exists, not that it defines FN. This is for function definitions that we |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
80 don't know how to recognize (e.g. some macros)." |
86178 | 81 (let ((m (format "Scanning %s..." file)) |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
82 alist fnfile fn arglist fileonly) |
86178 | 83 (message "%s" m) |
84 (with-temp-buffer | |
85 (insert-file-contents file) | |
86 (while (re-search-forward | |
87 "^[ \t]*(declare-function[ \t]+\\(\\S-+\\)[ \t]+\ | |
88 \"\\(\\S-+\\)\"" nil t) | |
89 (setq fn (match-string 1) | |
86342
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
90 fnfile (match-string 2) |
79a4d6e44352
(check-declare-locate): New function.
Glenn Morris <rgm@gnu.org>
parents:
86302
diff
changeset
|
91 fnfile (check-declare-locate fnfile (expand-file-name file)) |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
92 arglist (progn |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
93 (skip-chars-forward " \t\n") |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
94 ;; Use `t' to distinguish no arglist |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
95 ;; specified from an empty one. |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
96 (if (looking-at "\\((\\|nil\\|t\\)") |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
97 (read (current-buffer)) |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
98 t)) |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
99 fileonly (progn |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
100 (skip-chars-forward " \t\n") |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
101 (if (looking-at "\\(t\\|'\\sw+\\)") |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
102 (match-string 1))) |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
103 alist (cons (list fnfile fn arglist fileonly) alist)))) |
86178 | 104 (message "%sdone" m) |
105 alist)) | |
106 | |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
107 (defun check-declare-errmsg (errlist &optional full) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
108 "Return a string with the number of errors in ERRLIST, if any. |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
109 Normally just counts the number of elements in ERRLIST. |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
110 With optional argument FULL, sums the number of elements in each element." |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
111 (if errlist |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
112 (let ((l (length errlist))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
113 (when full |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
114 (setq l 0) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
115 (dolist (e errlist) |
94459
e7a38a8c4a05
(check-declare-errmsg): Fix counting in the `full' case.
Glenn Morris <rgm@gnu.org>
parents:
88085
diff
changeset
|
116 (setq l (+ l (1- (length e)))))) |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
117 (format "%d problem%s found" l (if (= l 1) "" "s"))) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
118 "OK")) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
119 |
86178 | 120 (autoload 'byte-compile-arglist-signature "bytecomp") |
121 | |
122 (defun check-declare-verify (fnfile fnlist) | |
123 "Check that FNFILE contains function definitions matching FNLIST. | |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
124 Each element of FNLIST has the form (FILE FN ARGLIST FILEONLY), where |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
125 only the first two elements need be present. This means FILE claimed FN |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
126 was defined in FNFILE with the specified ARGLIST. FILEONLY non-nil means |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
127 to only check that FNFILE exists, not that it actually defines FN. |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
128 |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
129 Returns nil if all claims are found to be true, otherwise a list |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
130 of errors with elements of the form \(FILE FN TYPE), where TYPE |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
131 is a string giving details of the error." |
86178 | 132 (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
|
133 (cflag (string-equal "c" (file-name-extension fnfile))) |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
134 (ext (string-match "^ext:" fnfile)) |
86300
96fee69c65a2
(check-declare-verify): Implement arglist checking for C files.
Glenn Morris <rgm@gnu.org>
parents:
86297
diff
changeset
|
135 re fn sig siglist arglist type errlist minargs maxargs) |
86178 | 136 (message "%s" m) |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
137 (if ext |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
138 (setq fnfile (substring fnfile 4))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
139 (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
|
140 (with-temp-buffer |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
141 (insert-file-contents fnfile) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
142 ;; 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
|
143 (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
|
144 "^[ \t]*\\(DEFUN\\)[ \t]*([ \t]*\"%s\"" |
87260
4cd2a938a117
(check-declare-verify): Handle deffoo.
Glenn Morris <rgm@gnu.org>
parents:
86841
diff
changeset
|
145 "^[ \t]*(\\(fset[ \t]+'\\|\ |
4cd2a938a117
(check-declare-verify): Handle deffoo.
Glenn Morris <rgm@gnu.org>
parents:
86841
diff
changeset
|
146 def\\(?:un\\|subst\\|foo\\|\ |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
147 ine-\\(?:derived\\|generic\\|\\(?:global\\(?:ized\\)?-\\)?minor\\)-mode\ |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
148 \\|\\(?:ine-obsolete-function-\\)?alias[ \t]+'\\)\\)\ |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
149 \[ \t]*%s\\([ \t;]+\\|$\\)") |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
150 (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
|
151 (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
|
152 (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
|
153 (setq fn (match-string 2) |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
154 type (match-string 1) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
155 ;; (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
|
156 ;; arglists with optional elements. |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
157 ;; (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
|
158 ;; 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
|
159 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
|
160 (or |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
161 (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
|
162 (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
|
163 ;; 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
|
164 (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
|
165 \\([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
|
166 (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
|
167 (match-string 1)) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
168 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
|
169 (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
|
170 maxargs) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
171 (string-to-number |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
172 maxargs))))) |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
173 'err)) |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
174 ((string-match |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
175 "\\`define-\\(derived\\|generic\\)-mode\\'" |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
176 type) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
177 '(0 . 0)) |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
178 ((string-match |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
179 "\\`define\\(-global\\(ized\\)?\\)?-minor-mode\\'" |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
180 type) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
181 '(0 . 1)) |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
182 ;; Prompt to update. |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
183 ((string-match |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
184 "\\`define-obsolete-function-alias\\>" |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
185 type) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
186 'obsolete) |
86528
db04d9e790f1
(check-declare-locate): Reflow doc.
Glenn Morris <rgm@gnu.org>
parents:
86457
diff
changeset
|
187 ;; Can't easily check arguments in these cases. |
db04d9e790f1
(check-declare-locate): Reflow doc.
Glenn Morris <rgm@gnu.org>
parents:
86457
diff
changeset
|
188 ((string-match "\\`\\(defalias\\|fset\\)\\>" type) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
189 t) |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
190 ((looking-at "\\((\\|nil\\)") |
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
191 (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
|
192 (read (current-buffer)))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
193 (t |
86302
9525bd421fdb
(check-declare-verify): Fix previous change. Warn if could not find
Glenn Morris <rgm@gnu.org>
parents:
86300
diff
changeset
|
194 'err)) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
195 ;; 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
|
196 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
|
197 (dolist (e fnlist) |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
198 (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
|
199 type |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
200 (if (not re) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
201 "file not found" |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
202 (if (not (setq sig (assoc (cadr e) siglist))) |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
203 (unless (nth 3 e) ; fileonly |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
204 "function not found") |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
205 (setq sig (cdr sig)) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
206 (cond ((eq sig 'obsolete) ; check even when no arglist specified |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
207 "obsolete alias") |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
208 ;; arglist t means no arglist specified, as |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
209 ;; opposed to an empty arglist. |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
210 ((eq arglist t) nil) |
86528
db04d9e790f1
(check-declare-locate): Reflow doc.
Glenn Morris <rgm@gnu.org>
parents:
86457
diff
changeset
|
211 ((eq sig t) nil) ; eg defalias - can't check arguments |
86457
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
212 ((eq sig 'err) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
213 "arglist not found") ; internal error |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
214 ((not (equal (byte-compile-arglist-signature |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
215 arglist) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
216 sig)) |
47fc5bc30170
(check-declare-locate): Handle compressed files.
Glenn Morris <rgm@gnu.org>
parents:
86388
diff
changeset
|
217 "arglist mismatch"))))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
218 (when type |
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
219 (setq errlist (cons (list (car e) (cadr e) type) errlist)))) |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
220 (message "%s%s" m |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
221 (if (or re (not ext)) |
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
222 (check-declare-errmsg errlist) |
86841
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
223 (progn |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
224 (setq errlist nil) |
885c9731dd1d
(check-declare-scan): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
86810
diff
changeset
|
225 "skipping external file"))) |
86297
a80b13d94c3c
(check-declare-scan): Expand .c files relative to src/ directory.
Glenn Morris <rgm@gnu.org>
parents:
86278
diff
changeset
|
226 errlist)) |
86178 | 227 |
228 (defun check-declare-sort (alist) | |
229 "Sort a list with elements FILE (FNFILE ...). | |
230 Returned list has elements FNFILE (FILE ...)." | |
231 (let (file fnfile rest sort a) | |
232 (dolist (e alist) | |
233 (setq file (car e)) | |
234 (dolist (f (cdr e)) | |
235 (setq fnfile (car f) | |
236 rest (cdr f)) | |
237 (if (setq a (assoc fnfile sort)) | |
238 (setcdr a (append (cdr a) (list (cons file rest)))) | |
239 (setq sort (cons (list fnfile (cons file rest)) sort))))) | |
240 sort)) | |
241 | |
242 (defun check-declare-warn (file fn fnfile type) | |
243 "Warn that FILE made a false claim about FN in FNFILE. | |
244 TYPE is a string giving the nature of the error. Warning is displayed in | |
245 `check-declare-warning-buffer'." | |
246 (display-warning 'check-declare | |
247 (format "%s said `%s' was defined in %s: %s" | |
248 (file-name-nondirectory file) fn | |
249 (file-name-nondirectory fnfile) | |
250 type) | |
251 nil check-declare-warning-buffer)) | |
252 | |
253 (defun check-declare-files (&rest files) | |
254 "Check veracity of all `declare-function' statements in FILES. | |
255 Return a list of any errors found." | |
256 (let (alist err errlist) | |
257 (dolist (file files) | |
258 (setq alist (cons (cons file (check-declare-scan file)) alist))) | |
259 ;; Sort so that things are ordered by the files supposed to | |
260 ;; contain the defuns. | |
261 (dolist (e (check-declare-sort alist)) | |
262 (if (setq err (check-declare-verify (car e) (cdr e))) | |
263 (setq errlist (cons (cons (car e) err) errlist)))) | |
264 (if (get-buffer check-declare-warning-buffer) | |
265 (kill-buffer check-declare-warning-buffer)) | |
266 ;; Sort back again so that errors are ordered by the files | |
267 ;; containing the declare-function statements. | |
268 (dolist (e (check-declare-sort errlist)) | |
269 (dolist (f (cdr e)) | |
270 (check-declare-warn (car e) (cadr f) (car f) (nth 2 f)))) | |
271 errlist)) | |
272 | |
273 ;;;###autoload | |
274 (defun check-declare-file (file) | |
275 "Check veracity of all `declare-function' statements in FILE. | |
276 See `check-declare-directory' for more information." | |
277 (interactive "fFile to check: ") | |
278 (or (file-exists-p file) | |
279 (error "File `%s' not found" file)) | |
280 (let ((m (format "Checking %s..." file)) | |
281 errlist) | |
282 (message "%s" m) | |
283 (setq errlist (check-declare-files file)) | |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
284 (message "%s%s" m (check-declare-errmsg errlist)) |
86178 | 285 errlist)) |
286 | |
287 ;;;###autoload | |
288 (defun check-declare-directory (root) | |
289 "Check veracity of all `declare-function' statements under directory ROOT. | |
290 Returns non-nil if any false statements are found. For this to | |
291 work correctly, the statements must adhere to the format | |
292 described in the documentation of `declare-function'." | |
293 (interactive "DDirectory to check: ") | |
294 (or (file-directory-p (setq root (expand-file-name root))) | |
295 (error "Directory `%s' not found" root)) | |
296 (let ((m "Checking `declare-function' statements...") | |
297 (m2 "Finding files with declarations...") | |
298 errlist files) | |
299 (message "%s" m) | |
300 (message "%s" m2) | |
88085
f4834ccd5bce
(check-declare-directory): Use `find-program' and
Juanma Barranquero <lekktu@gmail.com>
parents:
87665
diff
changeset
|
301 (setq files (process-lines find-program root |
f4834ccd5bce
(check-declare-directory): Use `find-program' and
Juanma Barranquero <lekktu@gmail.com>
parents:
87665
diff
changeset
|
302 "-name" "*.el" |
f4834ccd5bce
(check-declare-directory): Use `find-program' and
Juanma Barranquero <lekktu@gmail.com>
parents:
87665
diff
changeset
|
303 "-exec" grep-program |
f4834ccd5bce
(check-declare-directory): Use `find-program' and
Juanma Barranquero <lekktu@gmail.com>
parents:
87665
diff
changeset
|
304 "-l" "^[ \t]*(declare-function" "{}" ";")) |
86178 | 305 (message "%s%d found" m2 (length files)) |
306 (when files | |
307 (setq errlist (apply 'check-declare-files files)) | |
86810
bf4a9f989c37
(check-declare-locate, check-declare-verify): Handle `external' files.
Glenn Morris <rgm@gnu.org>
parents:
86528
diff
changeset
|
308 (message "%s%s" m (check-declare-errmsg errlist t)) |
86178 | 309 errlist))) |
310 | |
311 (provide 'check-declare) | |
312 | |
313 ;; arch-tag: a4d6cdc4-deb7-4502-b327-0e4ef3d82d96 | |
314 ;;; check-declare.el ends here. |