Mercurial > emacs
annotate lisp/emacs-lisp/warnings.el @ 70166:1204092d4458
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Fri, 21 Apr 2006 14:06:42 +0000 |
parents | 067115a6e738 |
children | 5a0747ecd057 c5406394f567 |
rev | line source |
---|---|
51349 | 1 ;;; warnings.el --- log and display warnings |
2 | |
68648
067115a6e738
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64751
diff
changeset
|
3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
51349 | 4 |
5 ;; Maintainer: FSF | |
6 ;; Keywords: internal | |
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 2, 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 | |
64085 | 22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 ;; Boston, MA 02110-1301, USA. | |
51349 | 24 |
25 ;;; Commentary: | |
26 | |
27 ;; This file implements the entry points `warn', `lwarn' | |
54486 | 28 ;; and `display-warning'. |
51349 | 29 |
30 ;;; Code: | |
31 | |
32 (defgroup warnings nil | |
33 "Log and display warnings." | |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
54486
diff
changeset
|
34 :version "22.1" |
51349 | 35 :group 'lisp) |
36 | |
37 (defvar warning-levels | |
38 '((:emergency "Emergency%s: " ding) | |
39 (:error "Error%s: ") | |
40 (:warning "Warning%s: ") | |
41 (:debug "Debug%s: ")) | |
42 "List of severity level definitions for `display-warning'. | |
43 Each element looks like (LEVEL STRING FUNCTION) and | |
44 defines LEVEL as a severity level. STRING specifies the | |
45 description of this level. STRING should use `%s' to | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
46 specify where to put the warning type information, |
51349 | 47 or it can omit the `%s' so as not to include that information. |
48 | |
49 The optional FUNCTION, if non-nil, is a function to call | |
50 with no arguments, to get the user's attention. | |
51 | |
52 The standard levels are :emergency, :error, :warning and :debug. | |
53 See `display-warning' for documentation of their meanings. | |
54 Level :debug is ignored by default (see `warning-minimum-level').") | |
55 (put 'warning-levels 'risky-local-variable t) | |
56 | |
57 ;; These are for compatibility with XEmacs. | |
58 ;; I don't think there is any chance of designing meaningful criteria | |
59 ;; to distinguish so many levels. | |
60 (defvar warning-level-aliases | |
61 '((emergency . :emergency) | |
62 (error . :error) | |
63 (warning . :warning) | |
64 (notice . :warning) | |
65 (info . :warning) | |
66 (critical . :emergency) | |
67 (alarm . :emergency)) | |
68 "Alist of aliases for severity levels for `display-warning'. | |
69 Each element looks like (ALIAS . LEVEL) and defines | |
70 ALIAS as equivalent to LEVEL. LEVEL must be defined in `warning-levels'; | |
71 it may not itself be an alias.") | |
72 | |
73 (defcustom warning-minimum-level :warning | |
74 "Minimum severity level for displaying the warning buffer. | |
75 If a warning's severity level is lower than this, | |
76 the warning is logged in the warnings buffer, but the buffer | |
77 is not immediately displayed. See also `warning-minimum-log-level'." | |
78 :group 'warnings | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
79 :type '(choice (const :emergency) (const :error) |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
80 (const :warning) (const :debug)) |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
54486
diff
changeset
|
81 :version "22.1") |
51349 | 82 (defvaralias 'display-warning-minimum-level 'warning-minimum-level) |
83 | |
84 (defcustom warning-minimum-log-level :warning | |
85 "Minimum severity level for logging a warning. | |
86 If a warning severity level is lower than this, | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
87 the warning is completely ignored. |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
88 Value must be lower or equal than `warning-minimum-level', |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
89 because warnings not logged aren't displayed either." |
51349 | 90 :group 'warnings |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
91 :type '(choice (const :emergency) (const :error) |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
92 (const :warning) (const :debug)) |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
54486
diff
changeset
|
93 :version "22.1") |
51349 | 94 (defvaralias 'log-warning-minimum-level 'warning-minimum-log-level) |
95 | |
96 (defcustom warning-suppress-log-types nil | |
97 "List of warning types that should not be logged. | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
98 If any element of this list matches the TYPE argument to `display-warning', |
51349 | 99 the warning is completely ignored. |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
100 The element must match the first elements of TYPE. |
51349 | 101 Thus, (foo bar) as an element matches (foo bar) |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
102 or (foo bar ANYTHING...) as TYPE. |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
103 If TYPE is a symbol FOO, that is equivalent to the list (FOO), |
51349 | 104 so only the element (FOO) will match it." |
105 :group 'warnings | |
106 :type '(repeat (repeat symbol)) | |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
54486
diff
changeset
|
107 :version "22.1") |
51349 | 108 |
109 (defcustom warning-suppress-types nil | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
110 "List of warning types not to display immediately. |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
111 If any element of this list matches the TYPE argument to `display-warning', |
51349 | 112 the warning is logged nonetheless, but the warnings buffer is |
113 not immediately displayed. | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
114 The element must match an initial segment of the list TYPE. |
51349 | 115 Thus, (foo bar) as an element matches (foo bar) |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
116 or (foo bar ANYTHING...) as TYPE. |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
117 If TYPE is a symbol FOO, that is equivalent to the list (FOO), |
51349 | 118 so only the element (FOO) will match it. |
119 See also `warning-suppress-log-types'." | |
120 :group 'warnings | |
121 :type '(repeat (repeat symbol)) | |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
54486
diff
changeset
|
122 :version "22.1") |
51349 | 123 |
124 ;;; The autoload cookie is so that programs can bind this variable | |
125 ;;; safely, testing the existing value, before they call one of the | |
126 ;;; warnings functions. | |
127 ;;;###autoload | |
128 (defvar warning-prefix-function nil | |
129 "Function to generate warning prefixes. | |
130 This function, if non-nil, is called with two arguments, | |
131 the severity level and its entry in `warning-levels', | |
132 and should return the entry that should actually be used. | |
133 The warnings buffer is current when this function is called | |
134 and the function can insert text in it. This text becomes | |
135 the beginning of the warning.") | |
136 | |
137 ;;; The autoload cookie is so that programs can bind this variable | |
138 ;;; safely, testing the existing value, before they call one of the | |
139 ;;; warnings functions. | |
140 ;;;###autoload | |
141 (defvar warning-series nil | |
142 "Non-nil means treat multiple `display-warning' calls as a series. | |
143 A marker indicates a position in the warnings buffer | |
144 which is the start of the current series; it means that | |
145 additional warnings in the same buffer should not move point. | |
146 t means the next warning begins a series (and stores a marker here). | |
147 A symbol with a function definition is like t, except | |
148 also call that function before the next warning.") | |
149 (put 'warning-series 'risky-local-variable t) | |
150 | |
151 ;;; The autoload cookie is so that programs can bind this variable | |
152 ;;; safely, testing the existing value, before they call one of the | |
153 ;;; warnings functions. | |
154 ;;;###autoload | |
155 (defvar warning-fill-prefix nil | |
156 "Non-nil means fill each warning text using this string as `fill-prefix'.") | |
157 | |
158 ;;; The autoload cookie is so that programs can bind this variable | |
159 ;;; safely, testing the existing value, before they call one of the | |
160 ;;; warnings functions. | |
161 ;;;###autoload | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
162 (defvar warning-type-format " (%s)" |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
163 "Format for displaying the warning type in the warning message. |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
164 The result of formatting the type this way gets included in the |
51349 | 165 message under the control of the string in `warning-levels'.") |
166 | |
167 (defun warning-numeric-level (level) | |
168 "Return a numeric measure of the warning severity level LEVEL." | |
169 (let* ((elt (assq level warning-levels)) | |
170 (link (memq elt warning-levels))) | |
171 (length link))) | |
172 | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
173 (defun warning-suppress-p (type suppress-list) |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
174 "Non-nil if a warning with type TYPE should be suppressed. |
51349 | 175 SUPPRESS-LIST is the list of kinds of warnings to suppress." |
176 (let (some-match) | |
177 (dolist (elt suppress-list) | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
178 (if (symbolp type) |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
179 ;; If TYPE is a symbol, the ELT must be (TYPE). |
51349 | 180 (if (and (consp elt) |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
181 (eq (car elt) type) |
51349 | 182 (null (cdr elt))) |
183 (setq some-match t)) | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
184 ;; If TYPE is a list, ELT must match it or some initial segment of it. |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
185 (let ((tem1 type) |
51349 | 186 (tem2 elt) |
187 (match t)) | |
188 ;; Check elements of ELT until we run out of them. | |
189 (while tem2 | |
190 (if (not (equal (car tem1) (car tem2))) | |
191 (setq match nil)) | |
192 (setq tem1 (cdr tem1) | |
193 tem2 (cdr tem2))) | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
194 ;; If ELT is an initial segment of TYPE, MATCH is t now. |
51349 | 195 ;; So set SOME-MATCH. |
196 (if match | |
197 (setq some-match t))))) | |
198 ;; If some element of SUPPRESS-LIST matched, | |
199 ;; we return t. | |
200 some-match)) | |
201 | |
202 ;;;###autoload | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
203 (defun display-warning (type message &optional level buffer-name) |
51349 | 204 "Display a warning message, MESSAGE. |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
205 TYPE is the warning type: either a custom group name (a symbol), |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
206 or a list of symbols whose first element is a custom group name. |
51349 | 207 \(The rest of the symbols represent subcategories, for warning purposes |
208 only, and you can use whatever symbols you like.) | |
209 | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
210 LEVEL should be either :debug, :warning, :error, or :emergency |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
211 \(but see `warning-minimum-level' and `warning-minimum-log-level'). |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
212 |
51349 | 213 :emergency -- a problem that will seriously impair Emacs operation soon |
214 if you do not attend to it promptly. | |
215 :error -- data or circumstances that are inherently wrong. | |
216 :warning -- data or circumstances that are not inherently wrong, | |
217 but raise suspicion of a possible problem. | |
218 :debug -- info for debugging only. | |
219 | |
220 BUFFER-NAME, if specified, is the name of the buffer for logging the | |
221 warning. By default, it is `*Warnings*'. | |
222 | |
223 See the `warnings' custom group for user customization features. | |
224 | |
225 See also `warning-series', `warning-prefix-function' and | |
226 `warning-fill-prefix' for additional programming features." | |
227 (unless level | |
228 (setq level :warning)) | |
229 (if (assq level warning-level-aliases) | |
230 (setq level (cdr (assq level warning-level-aliases)))) | |
231 (or (< (warning-numeric-level level) | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
232 (warning-numeric-level warning-minimum-log-level)) |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
233 (warning-suppress-p type warning-suppress-log-types) |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
234 (let* ((typename (if (consp type) (car type) type)) |
51349 | 235 (buffer (get-buffer-create (or buffer-name "*Warnings*"))) |
236 (level-info (assq level warning-levels)) | |
237 start end) | |
238 (with-current-buffer buffer | |
239 (goto-char (point-max)) | |
240 (when (and warning-series (symbolp warning-series)) | |
241 (setq warning-series | |
242 (prog1 (point-marker) | |
243 (unless (eq warning-series t) | |
244 (funcall warning-series))))) | |
245 (unless (bolp) | |
246 (newline)) | |
247 (setq start (point)) | |
248 (if warning-prefix-function | |
249 (setq level-info (funcall warning-prefix-function | |
250 level level-info))) | |
251 (insert (format (nth 1 level-info) | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
252 (format warning-type-format typename)) |
51349 | 253 message) |
254 (newline) | |
255 (when (and warning-fill-prefix (not (string-match "\n" message))) | |
256 (let ((fill-prefix warning-fill-prefix) | |
257 (fill-column 78)) | |
258 (fill-region start (point)))) | |
259 (setq end (point)) | |
260 (when (and (markerp warning-series) | |
261 (eq (marker-buffer warning-series) buffer)) | |
262 (goto-char warning-series))) | |
263 (if (nth 2 level-info) | |
264 (funcall (nth 2 level-info))) | |
265 (if noninteractive | |
266 ;; Noninteractively, take the text we inserted | |
267 ;; in the warnings buffer and print it. | |
268 ;; Do this unconditionally, since there is no way | |
269 ;; to view logged messages unless we output them. | |
270 (with-current-buffer buffer | |
271 (save-excursion | |
272 ;; Don't include the final newline in the arg | |
273 ;; to `message', because it adds a newline. | |
274 (goto-char end) | |
275 (if (bolp) | |
276 (forward-char -1)) | |
277 (message "%s" (buffer-substring start (point))))) | |
278 ;; Interactively, decide whether the warning merits | |
279 ;; immediate display. | |
280 (or (< (warning-numeric-level level) | |
281 (warning-numeric-level warning-minimum-level)) | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
282 (warning-suppress-p type warning-suppress-types) |
51349 | 283 (let ((window (display-buffer buffer))) |
284 (when (and (markerp warning-series) | |
285 (eq (marker-buffer warning-series) buffer)) | |
286 (set-window-start window warning-series)) | |
287 (sit-for 0))))))) | |
288 | |
289 ;;;###autoload | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
290 (defun lwarn (type level message &rest args) |
51349 | 291 "Display a warning message made from (format MESSAGE ARGS...). |
292 Aside from generating the message with `format', | |
293 this is equivalent to `display-warning'. | |
294 | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
295 TYPE is the warning type: either a custom group name (a symbol). |
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
296 or a list of symbols whose first element is a custom group name. |
51349 | 297 \(The rest of the symbols represent subcategories and |
298 can be whatever you like.) | |
299 | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
300 LEVEL should be either :debug, :warning, :error, or :emergency |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
301 \(but see `warning-minimum-level' and `warning-minimum-log-level'). |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
302 |
51349 | 303 :emergency -- a problem that will seriously impair Emacs operation soon |
304 if you do not attend to it promptly. | |
305 :error -- invalid data or circumstances. | |
63537
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
306 :warning -- suspicious data or circumstances. |
5bcd8e3411e3
(display-warning, lwarn, warning-minimum-log-level): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
307 :debug -- info for debugging only." |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
308 (display-warning type (apply 'format message args) level)) |
51349 | 309 |
310 ;;;###autoload | |
311 (defun warn (message &rest args) | |
312 "Display a warning message made from (format MESSAGE ARGS...). | |
313 Aside from generating the message with `format', | |
314 this is equivalent to `display-warning', using | |
52134
d26709514a27
Doc fixes, args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
51349
diff
changeset
|
315 `emacs' as the type and `:warning' as the level." |
51349 | 316 (display-warning 'emacs (apply 'format message args))) |
317 | |
318 (provide 'warnings) | |
319 | |
52401 | 320 ;;; arch-tag: faaad1c8-7b2a-4161-af38-5ab4afde0496 |
51349 | 321 ;;; warnings.el ends here |