]> code.delx.au - gnu-emacs/blob - lisp/progmodes/compile.el
(compilation-save-buffers-predicate): Remove the "autoload" cookie.
[gnu-emacs] / lisp / progmodes / compile.el
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
2
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
6
7 ;; Authors: Roland McGrath <roland@gnu.org>,
8 ;; Daniel Pfeiffer <occitan@esperanto.org>
9 ;; Maintainer: FSF
10 ;; Keywords: tools, processes
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26
27 ;;; Commentary:
28
29 ;; This package provides the compile facilities documented in the Emacs user's
30 ;; manual.
31
32 ;; This mode uses some complex data-structures:
33
34 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
35
36 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
37 ;; LINE will be nil for a message that doesn't contain them. Then the
38 ;; location refers to a indented beginning of line or beginning of file.
39 ;; Once any location in some file has been jumped to, the list is extended to
40 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
41 ;; for all LOCs pertaining to that file.
42 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
43 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
44 ;; before that point. VISITED is t if we have jumped there, else nil.
45 ;; TIMESTAMP is necessary because of "incremental compilation": `omake -P'
46 ;; polls filesystem for changes and recompiles when a file is modified
47 ;; using the same *compilation* buffer. this necessitates re-parsing markers.
48
49 ;; FILE-STRUCTURE is a list of
50 ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
51
52 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
53 ;; obtained by following directory change messages. DIRECTORY will be nil for
54 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
55 ;; a file of that name can't be found.
56 ;; The rest of the list is an alist of elements with LINE as key. The keys
57 ;; are either nil or line numbers. If present, nil comes first, followed by
58 ;; the numbers in decreasing order. The LOCs for each line are again an alist
59 ;; ordered the same way. Note that the whole file structure is referenced in
60 ;; every LOC.
61
62 ;; MESSAGE is a list of (LOC TYPE END-LOC)
63
64 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
65 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
66 ;; other end, if the parsed message contained a range. If the end of the
67 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
68 ;; These are the value of the `message' text-properties in the compilation
69 ;; buffer.
70
71 ;;; Code:
72
73 (eval-when-compile (require 'cl))
74 (require 'tool-bar)
75 (require 'comint)
76
77 (defvar font-lock-extra-managed-props)
78 (defvar font-lock-keywords)
79 (defvar font-lock-maximum-size)
80 (defvar font-lock-support-mode)
81
82
83 (defgroup compilation nil
84 "Run compiler as inferior of Emacs, parse error messages."
85 :group 'tools
86 :group 'processes)
87
88
89 ;;;###autoload
90 (defcustom compilation-mode-hook nil
91 "List of hook functions run by `compilation-mode' (see `run-mode-hooks')."
92 :type 'hook
93 :group 'compilation)
94
95 ;;;###autoload
96 (defcustom compilation-start-hook nil
97 "List of hook functions run by `compilation-start' on the compilation process.
98 \(See `run-hook-with-args').
99 If you use \"omake -P\" and do not want \\[save-buffers-kill-terminal] to ask whether you want
100 the compilation to be killed, you can use this hook:
101 (add-hook 'compilation-start-hook
102 (lambda (process) (set-process-query-on-exit-flag process nil)) nil t)"
103 :type 'hook
104 :group 'compilation)
105
106 ;;;###autoload
107 (defcustom compilation-window-height nil
108 "Number of lines in a compilation window. If nil, use Emacs default."
109 :type '(choice (const :tag "Default" nil)
110 integer)
111 :group 'compilation)
112
113 (defvar compilation-first-column 1
114 "*This is how compilers number the first column, usually 1 or 0.")
115
116 (defvar compilation-parse-errors-filename-function nil
117 "Function to call to post-process filenames while parsing error messages.
118 It takes one arg FILENAME which is the name of a file as found
119 in the compilation output, and should return a transformed file name.")
120
121 ;;;###autoload
122 (defvar compilation-process-setup-function nil
123 "*Function to call to customize the compilation process.
124 This function is called immediately before the compilation process is
125 started. It can be used to set any variables or functions that are used
126 while processing the output of the compilation process. The function
127 is called with variables `compilation-buffer' and `compilation-window'
128 bound to the compilation buffer and window, respectively.")
129
130 ;;;###autoload
131 (defvar compilation-buffer-name-function nil
132 "Function to compute the name of a compilation buffer.
133 The function receives one argument, the name of the major mode of the
134 compilation buffer. It should return a string.
135 If nil, compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
136
137 ;;;###autoload
138 (defvar compilation-finish-function nil
139 "Function to call when a compilation process finishes.
140 It is called with two arguments: the compilation buffer, and a string
141 describing how the process finished.")
142
143 (make-obsolete-variable 'compilation-finish-function
144 "use `compilation-finish-functions', but it works a little differently."
145 "22.1")
146
147 ;;;###autoload
148 (defvar compilation-finish-functions nil
149 "Functions to call when a compilation process finishes.
150 Each function is called with two arguments: the compilation buffer,
151 and a string describing how the process finished.")
152
153 (defvar compilation-in-progress nil
154 "List of compilation processes now running.")
155 (or (assq 'compilation-in-progress minor-mode-alist)
156 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
157 minor-mode-alist)))
158
159 (defvar compilation-error "error"
160 "Stem of message to print when no matches are found.")
161
162 (defvar compilation-arguments nil
163 "Arguments that were given to `compilation-start'.")
164
165 (defvar compilation-num-errors-found)
166
167 (defconst compilation-error-regexp-alist-alist
168 '((absoft
169 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
170 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
171
172 (ada
173 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
174
175 (aix
176 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
177
178 (ant
179 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
180 \\( warning\\)?" 1 2 3 (4))
181
182 (bash
183 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
184
185 (borland
186 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
187 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
188 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
189
190 (caml
191 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
192 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
193 2 (3 . 4) (5 . 6) (7))
194
195 (comma
196 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
197 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
198
199 (edg-1
200 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
201 1 2 nil (3 . 4))
202 (edg-2
203 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
204 2 1 nil 0)
205
206 (epc
207 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
208
209 (ftnchek
210 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
211 4 2 3 (1))
212
213 (iar
214 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
215 1 2 nil (3))
216
217 (ibm
218 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
219 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
220
221 ;; fixme: should be `mips'
222 (irix
223 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
224 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
225
226 (java
227 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
228
229 (jikes-file
230 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
231 (jikes-line
232 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
233 nil 1 nil 2 0
234 (2 (compilation-face '(3))))
235
236 (gnu
237 ;; The first line matches the program name for
238
239 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
240
241 ;; format, which is used for non-interactive programs other than
242 ;; compilers (e.g. the "jade:" entry in compilation.txt).
243
244 ;; This first line makes things ambiguous with output such as
245 ;; "foo:344:50:blabla" since the "foo" part can match this first
246 ;; line (in which case the file name as "344"). To avoid this,
247 ;; the second line disallows filenames exclusively composed of
248 ;; digits.
249
250 ;; Similarly, we get lots of false positives with messages including
251 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
252 ;; the last line tries to rule out message where the info after the
253 ;; line number starts with "SS". --Stef
254
255 ;; The core of the regexp is the one with *?. It says that a file name
256 ;; can be composed of any non-newline char, but it also rules out some
257 ;; valid but unlikely cases, such as a trailing space or a space
258 ;; followed by a -.
259 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
260 \\([0-9]*[^0-9\n]\\(?:[^\n ]\\| [^-/\n]\\)*?\\): ?\
261 \\([0-9]+\\)\\(?:\\([.:]\\)\\([0-9]+\\)\\)?\
262 \\(?:-\\([0-9]+\\)?\\(?:\\.\\([0-9]+\\)\\)?\\)?:\
263 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
264 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\|instantiated from\\|[Nn]ote\\)\\|\
265 \[0-9]?\\(?:[^0-9\n]\\|$\\)\\|[0-9][0-9][0-9]\\)"
266 1 (2 . 5) (4 . 6) (7 . 8))
267
268 ;; The `gnu' style above can incorrectly match gcc's "In file
269 ;; included from" message, so we process that first. -- cyd
270 (gcc-include
271 "^\\(?:In file included\\| \\) from \
272 \\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
273
274 (lcc
275 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
276 2 3 4 (1))
277
278 (makepp
279 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
280 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
281 4 5 nil (1 . 2) 3
282 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil
283 (2 compilation-info-face)
284 (3 compilation-line-face nil t)
285 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
286 append)))
287
288 ;; This regexp is pathologically slow on long lines (Bug#3441).
289 ;; (maven
290 ;; ;; Maven is a popular build tool for Java. Maven is Free Software.
291 ;; "\\(.*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\]" 1 2 3)
292
293 ;; Should be lint-1, lint-2 (SysV lint)
294 (mips-1
295 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
296 (mips-2
297 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
298
299 (msft
300 ;; The message may be a "warning", "error", or "fatal error" with
301 ;; an error code, or "see declaration of" without an error code.
302 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
303 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
304 2 3 nil (4))
305
306 (omake
307 ;; "omake -P" reports "file foo changed"
308 ;; (useful if you do "cvs up" and want to see what has changed)
309 "omake: file \\(.*\\) changed" 1)
310
311 (oracle
312 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
313 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
314 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
315 3 1 2)
316
317 ;; "during global destruction": This comes out under "use
318 ;; warnings" in recent perl when breaking circular references
319 ;; during program or thread exit.
320 (perl
321 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
322 during global destruction\\.$\\)" 1 2)
323
324 (php
325 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
326 2 3 nil nil)
327
328 (rxp
329 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
330 \\([0-9]+\\) of file://\\(.+\\)"
331 4 2 3 (1))
332
333 (sparc-pascal-file
334 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
335 [12][09][0-9][0-9] +\\(.*\\):$"
336 1 nil nil 0)
337 (sparc-pascal-line
338 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
339 nil 3 nil (2) nil (1 (compilation-face '(2))))
340 (sparc-pascal-example
341 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
342 nil 1 nil (3) nil (2 (compilation-face '(3))))
343
344 (sun
345 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
346 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
347 3 4 5 (1 . 2))
348
349 (sun-ada
350 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
351
352 (watcom
353 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
354 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
355 1 2 nil (4))
356
357 (4bsd
358 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
359 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
360
361 (gcov-file
362 "^ *-: *\\(0\\):Source:\\(.+\\)$"
363 2 1 nil 0 nil
364 (1 compilation-line-face prepend) (2 compilation-info-face prepend))
365 (gcov-header
366 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
367 nil 1 nil 0 nil
368 (1 compilation-line-face prepend))
369 ;; Underlines over all lines of gcov output are too uncomfortable to read.
370 ;; However, hyperlinks embedded in the lines are useful.
371 ;; So I put default face on the lines; and then put
372 ;; compilation-*-face by manually to eliminate the underlines.
373 ;; The hyperlinks are still effective.
374 (gcov-nomark
375 "^ *-: *\\([1-9]\\|[0-9]\\{2,\\}\\):.*$"
376 nil 1 nil 0 nil
377 (0 'default t)
378 (1 compilation-line-face prepend))
379 (gcov-called-line
380 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
381 nil 2 nil 0 nil
382 (0 'default t)
383 (1 compilation-info-face prepend) (2 compilation-line-face prepend))
384 (gcov-never-called
385 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
386 nil 2 nil 2 nil
387 (0 'default t)
388 (1 compilation-error-face prepend) (2 compilation-line-face prepend))
389
390 (perl--Pod::Checker
391 ;; podchecker error messages, per Pod::Checker.
392 ;; The style is from the Pod::Checker::poderror() function, eg.
393 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
394 ;;
395 ;; Plus end_pod() can give "at line EOF" instead of a
396 ;; number, so for that match "on line N" which is the
397 ;; originating spot, eg.
398 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
399 ;;
400 ;; Plus command() can give both "on line N" and "at line N";
401 ;; the latter is desired and is matched because the .* is
402 ;; greedy.
403 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
404 ;;
405 "^\\*\\*\\* \\(?:ERROR\\|\\(WARNING\\)\\).* \\(?:at\\|on\\) line \
406 \\([0-9]+\\) \\(?:.* \\)?in file \\([^ \t\n]+\\)"
407 3 2 nil (1))
408 (perl--Test
409 ;; perl Test module error messages.
410 ;; Style per the ok() function "$context", eg.
411 ;; # Failed test 1 in foo.t at line 6
412 ;;
413 "^# Failed test [0-9]+ in \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
414 1 2)
415 (perl--Test2
416 ;; Or when comparing got/want values,
417 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
418 ;;
419 ;; And under Test::Harness they're preceded by progress stuff with
420 ;; \r and "NOK",
421 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
422 ;;
423 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
424 \\([0-9]+\\))"
425 2 3)
426 (perl--Test::Harness
427 ;; perl Test::Harness output, eg.
428 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
429 ;;
430 ;; Test::Harness is slightly designed for tty output, since
431 ;; it prints CRs to overwrite progress messages, but if you
432 ;; run it in with M-x compile this pattern can at least step
433 ;; through the failures.
434 ;;
435 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
436 1 2)
437 (weblint
438 ;; The style comes from HTML::Lint::Error::as_string(), eg.
439 ;; index.html (13:1) Unknown element <fdjsk>
440 ;;
441 ;; The pattern only matches filenames without spaces, since that
442 ;; should be usual and should help reduce the chance of a false
443 ;; match of a message from some unrelated program.
444 ;;
445 ;; This message style is quite close to the "ibm" entry which is
446 ;; for IBM C, though that ibm bit doesn't put a space after the
447 ;; filename.
448 ;;
449 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
450 1 2 3)
451 )
452 "Alist of values for `compilation-error-regexp-alist'.")
453
454 (defcustom compilation-error-regexp-alist
455 (mapcar 'car compilation-error-regexp-alist-alist)
456 "Alist that specifies how to match errors in compiler output.
457 On GNU and Unix, any string is a valid filename, so these
458 matchers must make some common sense assumptions, which catch
459 normal cases. A shorter list will be lighter on resource usage.
460
461 Instead of an alist element, you can use a symbol, which is
462 looked up in `compilation-error-regexp-alist-alist'. You can see
463 the predefined symbols and their effects in the file
464 `etc/compilation.txt' (linked below if you are customizing this).
465
466 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
467 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
468 gives the file name, and the LINE'th subexpression gives the line
469 number. The COLUMN'th subexpression gives the column number on
470 that line.
471
472 If FILE, LINE or COLUMN are nil or that index didn't match, that
473 information is not present on the matched line. In that case the
474 file name is assumed to be the same as the previous one in the
475 buffer, line number defaults to 1 and column defaults to
476 beginning of line's indentation.
477
478 FILE can also have the form (FILE FORMAT...), where the FORMATs
479 \(e.g. \"%s.c\") will be applied in turn to the recognized file
480 name, until a file of that name is found. Or FILE can also be a
481 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
482 In the former case, FILENAME may be relative or absolute.
483
484 LINE can also be of the form (LINE . END-LINE) meaning a range
485 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
486 meaning a range of columns starting on LINE and ending on
487 END-LINE, if that matched.
488
489 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
490 TYPE can also be of the form (WARNING . INFO). In that case this
491 will be equivalent to 1 if the WARNING'th subexpression matched
492 or else equivalent to 0 if the INFO'th subexpression matched.
493 See `compilation-error-face', `compilation-warning-face',
494 `compilation-info-face' and `compilation-skip-threshold'.
495
496 What matched the HYPERLINK'th subexpression has `mouse-face' and
497 `compilation-message-face' applied. If this is nil, the text
498 matched by the whole REGEXP becomes the hyperlink.
499
500 Additional HIGHLIGHTs as described under `font-lock-keywords' can
501 be added."
502 :type `(set :menu-tag "Pick"
503 ,@(mapcar (lambda (elt)
504 (list 'const (car elt)))
505 compilation-error-regexp-alist-alist))
506 :link `(file-link :tag "example file"
507 ,(expand-file-name "compilation.txt" data-directory))
508 :group 'compilation)
509
510 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
511 (defvar compilation-directory nil
512 "Directory to restore to when doing `recompile'.")
513
514 (defvar compilation-directory-matcher
515 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
516 "A list for tracking when directories are entered or left.
517 If nil, do not track directories, e.g. if all file names are absolute. The
518 first element is the REGEXP matching these messages. It can match any number
519 of variants, e.g. different languages. The remaining elements are all of the
520 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
521 matches, that is a directory name. If LEAVE is nil or the corresponding
522 LEAVE'th subexpression doesn't match, this message is about going into another
523 directory. If it does match anything, this message is about going back to the
524 directory we were in before the last entering message. If you change this,
525 you may also want to change `compilation-page-delimiter'.")
526
527 (defvar compilation-page-delimiter
528 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
529 "Value of `page-delimiter' in Compilation mode.")
530
531 (defvar compilation-mode-font-lock-keywords
532 '(;; configure output lines.
533 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
534 (1 font-lock-variable-name-face)
535 (2 (compilation-face '(4 . 3))))
536 ;; Command output lines. Recognize `make[n]:' lines too.
537 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
538 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
539 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
540 ("^Compilation \\(finished\\).*"
541 (0 '(face nil message nil help-echo nil mouse-face nil) t)
542 (1 compilation-info-face))
543 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
544 (0 '(face nil message nil help-echo nil mouse-face nil) t)
545 (1 compilation-error-face)
546 (2 compilation-error-face nil t)))
547 "Additional things to highlight in Compilation mode.
548 This gets tacked on the end of the generated expressions.")
549
550 (defvar compilation-highlight-regexp t
551 "Regexp matching part of visited source lines to highlight temporarily.
552 Highlight entire line if t; don't highlight source lines if nil.")
553
554 (defvar compilation-highlight-overlay nil
555 "Overlay used to temporarily highlight compilation matches.")
556
557 (defcustom compilation-error-screen-columns t
558 "If non-nil, column numbers in error messages are screen columns.
559 Otherwise they are interpreted as character positions, with
560 each character occupying one column.
561 The default is to use screen columns, which requires that the compilation
562 program and Emacs agree about the display width of the characters,
563 especially the TAB character."
564 :type 'boolean
565 :group 'compilation
566 :version "20.4")
567
568 (defcustom compilation-read-command t
569 "Non-nil means \\[compile] reads the compilation command to use.
570 Otherwise, \\[compile] just uses the value of `compile-command'.
571
572 Note that changing this to nil may be a security risk, because a
573 file might define a malicious `compile-command' as a file local
574 variable, and you might not notice. Therefore, `compile-command'
575 is considered unsafe if this variable is nil."
576 :type 'boolean
577 :group 'compilation)
578
579 ;;;###autoload
580 (defcustom compilation-ask-about-save t
581 "Non-nil means \\[compile] asks which buffers to save before compiling.
582 Otherwise, it saves all modified buffers without asking."
583 :type 'boolean
584 :group 'compilation)
585
586 (defcustom compilation-save-buffers-predicate nil
587 "The second argument (PRED) passed to `save-some-buffers' before compiling.
588 E.g., one can set this to
589 (lambda ()
590 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
591 to limit saving to files located under `my-compilation-root'.
592 Note, that, in general, `compilation-directory' cannot be used instead
593 of `my-compilation-root' here."
594 :type '(choice
595 (const :tag "Default (save all file-visiting buffers)" nil)
596 (const :tag "Save all buffers" t)
597 function)
598 :group 'compilation)
599
600 ;;;###autoload
601 (defcustom compilation-search-path '(nil)
602 "List of directories to search for source files named in error messages.
603 Elements should be directory names, not file names of directories.
604 The value nil as an element means to try the default directory."
605 :type '(repeat (choice (const :tag "Default" nil)
606 (string :tag "Directory")))
607 :group 'compilation)
608
609 ;;;###autoload
610 (defcustom compile-command (purecopy "make -k ")
611 "Last shell command used to do a compilation; default for next compilation.
612
613 Sometimes it is useful for files to supply local values for this variable.
614 You might also use mode hooks to specify it in certain modes, like this:
615
616 (add-hook 'c-mode-hook
617 (lambda ()
618 (unless (or (file-exists-p \"makefile\")
619 (file-exists-p \"Makefile\"))
620 (set (make-local-variable 'compile-command)
621 (concat \"make -k \"
622 (file-name-sans-extension buffer-file-name))))))"
623 :type 'string
624 :group 'compilation)
625 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
626
627 ;;;###autoload
628 (defcustom compilation-disable-input nil
629 "If non-nil, send end-of-file as compilation process input.
630 This only affects platforms that support asynchronous processes (see
631 `start-process'); synchronous compilation processes never accept input."
632 :type 'boolean
633 :group 'compilation
634 :version "22.1")
635
636 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
637 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
638 ;; key. This holds the tree seen from root, for storing new nodes.
639 (defvar compilation-locs ())
640
641 (defvar compilation-debug nil
642 "*Set this to t before creating a *compilation* buffer.
643 Then every error line will have a debug text property with the matcher that
644 fit this line and the match data. Use `describe-text-properties'.")
645
646 (defvar compilation-exit-message-function nil "\
647 If non-nil, called when a compilation process dies to return a status message.
648 This should be a function of three arguments: process status, exit status,
649 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
650 write into the compilation buffer, and to put in its mode line.")
651
652 (defvar compilation-environment nil
653 "*List of environment variables for compilation to inherit.
654 Each element should be a string of the form ENVVARNAME=VALUE.
655 This list is temporarily prepended to `process-environment' prior to
656 starting the compilation process.")
657
658 ;; History of compile commands.
659 (defvar compile-history nil)
660
661 (defface compilation-error
662 '((t :inherit font-lock-warning-face))
663 "Face used to highlight compiler errors."
664 :group 'compilation
665 :version "22.1")
666
667 (defface compilation-warning
668 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
669 (((class color)) (:foreground "cyan" :weight bold))
670 (t (:weight bold)))
671 "Face used to highlight compiler warnings."
672 :group 'compilation
673 :version "22.1")
674
675 (defface compilation-info
676 '((((class color) (min-colors 16) (background light))
677 (:foreground "Green3" :weight bold))
678 (((class color) (min-colors 88) (background dark))
679 (:foreground "Green1" :weight bold))
680 (((class color) (min-colors 16) (background dark))
681 (:foreground "Green" :weight bold))
682 (((class color)) (:foreground "green" :weight bold))
683 (t (:weight bold)))
684 "Face used to highlight compiler information."
685 :group 'compilation
686 :version "22.1")
687
688 (defface compilation-line-number
689 '((t :inherit font-lock-variable-name-face))
690 "Face for displaying line numbers in compiler messages."
691 :group 'compilation
692 :version "22.1")
693
694 (defface compilation-column-number
695 '((t :inherit font-lock-type-face))
696 "Face for displaying column numbers in compiler messages."
697 :group 'compilation
698 :version "22.1")
699
700 (defcustom compilation-message-face 'underline
701 "Face name to use for whole messages.
702 Faces `compilation-error-face', `compilation-warning-face',
703 `compilation-info-face', `compilation-line-face' and
704 `compilation-column-face' get prepended to this, when applicable."
705 :type 'face
706 :group 'compilation
707 :version "22.1")
708
709 (defvar compilation-error-face 'compilation-error
710 "Face name to use for file name in error messages.")
711
712 (defvar compilation-warning-face 'compilation-warning
713 "Face name to use for file name in warning messages.")
714
715 (defvar compilation-info-face 'compilation-info
716 "Face name to use for file name in informational messages.")
717
718 (defvar compilation-line-face 'compilation-line-number
719 "Face name to use for line numbers in compiler messages.")
720
721 (defvar compilation-column-face 'compilation-column-number
722 "Face name to use for column numbers in compiler messages.")
723
724 ;; same faces as dired uses
725 (defvar compilation-enter-directory-face 'font-lock-function-name-face
726 "Face name to use for entering directory messages.")
727
728 (defvar compilation-leave-directory-face 'font-lock-type-face
729 "Face name to use for leaving directory messages.")
730
731
732
733 ;; Used for compatibility with the old compile.el.
734 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
735 (defvar compilation-parsing-end (make-marker))
736 (defvar compilation-parse-errors-function nil)
737 (defvar compilation-error-list nil)
738 (defvar compilation-old-error-list nil)
739
740 (defcustom compilation-auto-jump-to-first-error nil
741 "If non-nil, automatically jump to the first error during compilation."
742 :type 'boolean
743 :group 'compilation
744 :version "23.1")
745
746 (defvar compilation-auto-jump-to-next nil
747 "If non-nil, automatically jump to the next error encountered.")
748 (make-variable-buffer-local 'compilation-auto-jump-to-next)
749
750 (defvar buffer-modtime nil
751 "The buffer modification time, for buffers not associated with files.")
752 (make-variable-buffer-local 'buffer-modtime)
753
754 (defvar compilation-skip-to-next-location t
755 "*If non-nil, skip multiple error messages for the same source location.")
756
757 (defcustom compilation-skip-threshold 1
758 "Compilation motion commands skip less important messages.
759 The value can be either 2 -- skip anything less than error, 1 --
760 skip anything less than warning or 0 -- don't skip any messages.
761 Note that all messages not positively identified as warning or
762 info, are considered errors."
763 :type '(choice (const :tag "Warnings and info" 2)
764 (const :tag "Info" 1)
765 (const :tag "None" 0))
766 :group 'compilation
767 :version "22.1")
768
769 (defcustom compilation-skip-visited nil
770 "Compilation motion commands skip visited messages if this is t.
771 Visited messages are ones for which the file, line and column have been jumped
772 to from the current content in the current compilation buffer, even if it was
773 from a different message."
774 :type 'boolean
775 :group 'compilation
776 :version "22.1")
777
778 (defun compilation-face (type)
779 (or (and (car type) (match-end (car type)) compilation-warning-face)
780 (and (cdr type) (match-end (cdr type)) compilation-info-face)
781 compilation-error-face))
782
783 ;; Internal function for calculating the text properties of a directory
784 ;; change message. The directory property is important, because it is
785 ;; the stack of nested enter-messages. Relative filenames on the following
786 ;; lines are relative to the top of the stack.
787 (defun compilation-directory-properties (idx leave)
788 (if leave (setq leave (match-end leave)))
789 ;; find previous stack, and push onto it, or if `leave' pop it
790 (let ((dir (previous-single-property-change (point) 'directory)))
791 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
792 (get-text-property dir 'directory))))
793 `(face ,(if leave
794 compilation-leave-directory-face
795 compilation-enter-directory-face)
796 directory ,(if leave
797 (or (cdr dir)
798 '(nil)) ; nil only isn't a property-change
799 (cons (match-string-no-properties idx) dir))
800 mouse-face highlight
801 keymap compilation-button-map
802 help-echo "mouse-2: visit destination directory")))
803
804 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
805 ;; KEY element from the ALIST, creating it in the right position if not already
806 ;; present. ALIST structure is
807 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
808 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
809 ;; may be nil. The other KEYs are ordered backwards so that growing line
810 ;; numbers can be inserted in front and searching can abort after half the
811 ;; list on average.
812 (eval-when-compile ;Don't keep it at runtime if not needed.
813 (defmacro compilation-assq (key alist)
814 `(let* ((l1 ,alist)
815 (l2 (cdr l1)))
816 (car (if (if (null ,key)
817 (if l2 (null (caar l2)))
818 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
819 (setq l1 l2
820 l2 (cdr l1)))
821 (if l2 (eq ,key (caar l2))))
822 l2
823 (setcdr l1 (cons (list ,key) l2)))))))
824
825 (defun compilation-auto-jump (buffer pos)
826 (with-current-buffer buffer
827 (goto-char pos)
828 (let ((win (get-buffer-window buffer 0)))
829 (if win (set-window-point win pos)))
830 (if compilation-auto-jump-to-first-error
831 (compile-goto-error))))
832
833 ;; This function is the central driver, called when font-locking to gather
834 ;; all information needed to later jump to corresponding source code.
835 ;; Return a property list with all meta information on this error location.
836
837 (defun compilation-error-properties (file line end-line col end-col type fmt)
838 (unless (< (next-single-property-change (match-beginning 0)
839 'directory nil (point))
840 (point))
841 (if file
842 (if (functionp file)
843 (setq file (funcall file))
844 (let (dir)
845 (setq file (match-string-no-properties file))
846 (unless (file-name-absolute-p file)
847 (setq dir (previous-single-property-change (point) 'directory)
848 dir (if dir (or (get-text-property (1- dir) 'directory)
849 (get-text-property dir 'directory)))))
850 (setq file (cons file (car dir)))))
851 ;; This message didn't mention one, get it from previous
852 (let ((prev-pos
853 ;; Find the previous message.
854 (previous-single-property-change (point) 'message)))
855 (if prev-pos
856 ;; Get the file structure that belongs to it.
857 (let* ((prev
858 (or (get-text-property (1- prev-pos) 'message)
859 (get-text-property prev-pos 'message)))
860 (prev-struct
861 (car (nth 2 (car prev)))))
862 ;; Construct FILE . DIR from that.
863 (if prev-struct
864 (setq file (cons (car prev-struct)
865 (cadr prev-struct))))))
866 (unless file
867 (setq file '("*unknown*")))))
868 ;; All of these fields are optional, get them only if we have an index, and
869 ;; it matched some part of the message.
870 (and line
871 (setq line (match-string-no-properties line))
872 (setq line (string-to-number line)))
873 (and end-line
874 (setq end-line (match-string-no-properties end-line))
875 (setq end-line (string-to-number end-line)))
876 (if col
877 (if (functionp col)
878 (setq col (funcall col))
879 (and
880 (setq col (match-string-no-properties col))
881 (setq col (- (string-to-number col) compilation-first-column)))))
882 (if (and end-col (functionp end-col))
883 (setq end-col (funcall end-col))
884 (if (and end-col (setq end-col (match-string-no-properties end-col)))
885 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
886 (if end-line (setq end-col -1))))
887 (if (consp type) ; not a static type, check what it is.
888 (setq type (or (and (car type) (match-end (car type)) 1)
889 (and (cdr type) (match-end (cdr type)) 0)
890 2)))
891
892 (when (and compilation-auto-jump-to-next
893 (>= type compilation-skip-threshold))
894 (kill-local-variable 'compilation-auto-jump-to-next)
895 (run-with-timer 0 nil 'compilation-auto-jump
896 (current-buffer) (match-beginning 0)))
897
898 (compilation-internal-error-properties file line end-line col end-col type fmt)))
899
900 (defun compilation-move-to-column (col screen)
901 "Go to column COL on the current line.
902 If SCREEN is non-nil, columns are screen columns, otherwise, they are
903 just char-counts."
904 (if screen
905 (move-to-column (max col 0))
906 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
907
908 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
909 "Get the meta-info that will be added as text-properties.
910 LINE, END-LINE, COL, END-COL are integers or nil.
911 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
912 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
913 FMTS is a list of format specs for transforming the file name.
914 (See `compilation-error-regexp-alist'.)"
915 (unless file (setq file '("*unknown*")))
916 (let* ((file-struct (compilation-get-file-structure file fmts))
917 ;; Get first already existing marker (if any has one, all have one).
918 ;; Do this first, as the compilation-assq`s may create new nodes.
919 (marker-line (car (cddr file-struct))) ; a line structure
920 (marker (nth 3 (cadr marker-line))) ; its marker
921 (compilation-error-screen-columns compilation-error-screen-columns)
922 end-marker loc end-loc)
923 (if (not (and marker (marker-buffer marker)))
924 (setq marker nil) ; no valid marker for this file
925 (setq loc (or line 1)) ; normalize no linenumber to line 1
926 (catch 'marker ; find nearest loc, at least one exists
927 (dolist (x (nthcdr 3 file-struct)) ; loop over remaining lines
928 (if (> (car x) loc) ; still bigger
929 (setq marker-line x)
930 (if (> (- (or (car marker-line) 1) loc)
931 (- loc (car x))) ; current line is nearer
932 (setq marker-line x))
933 (throw 'marker t))))
934 (setq marker (nth 3 (cadr marker-line))
935 marker-line (or (car marker-line) 1))
936 (with-current-buffer (marker-buffer marker)
937 (save-excursion
938 (save-restriction
939 (widen)
940 (goto-char (marker-position marker))
941 (when (or end-col end-line)
942 (beginning-of-line (- (or end-line line) marker-line -1))
943 (if (or (null end-col) (< end-col 0))
944 (end-of-line)
945 (compilation-move-to-column
946 end-col compilation-error-screen-columns))
947 (setq end-marker (list (point-marker))))
948 (beginning-of-line (if end-line
949 (- line end-line -1)
950 (- loc marker-line -1)))
951 (if col
952 (compilation-move-to-column
953 col compilation-error-screen-columns)
954 (forward-to-indentation 0))
955 (setq marker (list (point-marker)))))))
956
957 (setq loc (compilation-assq line (cdr file-struct)))
958 (if end-line
959 (setq end-loc (compilation-assq end-line (cdr file-struct))
960 end-loc (compilation-assq end-col end-loc))
961 (if end-col ; use same line element
962 (setq end-loc (compilation-assq end-col loc))))
963 (setq loc (compilation-assq col loc))
964 ;; If they are new, make the loc(s) reference the file they point to.
965 (or (cdr loc) (setcdr loc `(,line ,file-struct ,@marker)))
966 (if end-loc
967 (or (cdr end-loc)
968 (setcdr end-loc `(,(or end-line line) ,file-struct ,@end-marker))))
969
970 ;; Must start with face
971 `(face ,compilation-message-face
972 message (,loc ,type ,end-loc)
973 ,@(if compilation-debug
974 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
975 ,@(match-data))))
976 help-echo ,(if col
977 "mouse-2: visit this file, line and column"
978 (if line
979 "mouse-2: visit this file and line"
980 "mouse-2: visit this file"))
981 keymap compilation-button-map
982 mouse-face highlight)))
983
984 (defun compilation-mode-font-lock-keywords ()
985 "Return expressions to highlight in Compilation mode."
986 (if compilation-parse-errors-function
987 ;; An old package! Try the compatibility code.
988 '((compilation-compat-parse-errors))
989 (append
990 ;; make directory tracking
991 (if compilation-directory-matcher
992 `((,(car compilation-directory-matcher)
993 ,@(mapcar (lambda (elt)
994 `(,(car elt)
995 (compilation-directory-properties
996 ,(car elt) ,(cdr elt))
997 t t))
998 (cdr compilation-directory-matcher)))))
999
1000 ;; Compiler warning/error lines.
1001 (mapcar
1002 (lambda (item)
1003 (if (symbolp item)
1004 (setq item (cdr (assq item
1005 compilation-error-regexp-alist-alist))))
1006 (let ((file (nth 1 item))
1007 (line (nth 2 item))
1008 (col (nth 3 item))
1009 (type (nth 4 item))
1010 (pat (car item))
1011 end-line end-col fmt)
1012 ;; omake reports some error indented, so skip the indentation.
1013 ;; another solution is to modify (some?) regexps in
1014 ;; `compilation-error-regexp-alist'.
1015 ;; note that omake usage is not limited to ocaml and C (for stubs).
1016 (when (and (= ?^ (aref pat 0)) ; anchored: starts with "^"
1017 ;; but does not allow an arbitrary number of leading spaces
1018 (not (and (= ? (aref pat 1)) (= ?* (aref pat 2)))))
1019 (setq pat (concat "^ *" (substring pat 1))))
1020 (if (consp file) (setq fmt (cdr file) file (car file)))
1021 (if (consp line) (setq end-line (cdr line) line (car line)))
1022 (if (consp col) (setq end-col (cdr col) col (car col)))
1023
1024 (if (functionp line)
1025 ;; The old compile.el had here an undocumented hook that
1026 ;; allowed `line' to be a function that computed the actual
1027 ;; error location. Let's do our best.
1028 `(,pat
1029 (0 (save-match-data
1030 (compilation-compat-error-properties
1031 (funcall ',line (cons (match-string ,file)
1032 (cons default-directory
1033 ',(nthcdr 4 item)))
1034 ,(if col `(match-string ,col))))))
1035 (,file compilation-error-face t))
1036
1037 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1038 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1039
1040 `(,pat
1041
1042 ,@(when (integerp file)
1043 `((,file ,(if (consp type)
1044 `(compilation-face ',type)
1045 (aref [compilation-info-face
1046 compilation-warning-face
1047 compilation-error-face]
1048 (or type 2))))))
1049
1050 ,@(when line
1051 `((,line compilation-line-face nil t)))
1052 ,@(when end-line
1053 `((,end-line compilation-line-face nil t)))
1054
1055 ,@(when (integerp col)
1056 `((,col compilation-column-face nil t)))
1057 ,@(when (integerp end-col)
1058 `((,end-col compilation-column-face nil t)))
1059
1060 ,@(nthcdr 6 item)
1061 (,(or (nth 5 item) 0)
1062 (compilation-error-properties ',file ,line ,end-line
1063 ,col ,end-col ',(or type 2)
1064 ',fmt)
1065 append))))) ; for compilation-message-face
1066 compilation-error-regexp-alist)
1067
1068 compilation-mode-font-lock-keywords)))
1069
1070 (defun compilation-read-command (command)
1071 (read-shell-command "Compile command: " command
1072 (if (equal (car compile-history) command)
1073 '(compile-history . 1)
1074 'compile-history)))
1075
1076 \f
1077 ;;;###autoload
1078 (defun compile (command &optional comint)
1079 "Compile the program including the current buffer. Default: run `make'.
1080 Runs COMMAND, a shell command, in a separate process asynchronously
1081 with output going to the buffer `*compilation*'.
1082
1083 You can then use the command \\[next-error] to find the next error message
1084 and move to the source code that caused it.
1085
1086 If optional second arg COMINT is t the buffer will be in Comint mode with
1087 `compilation-shell-minor-mode'.
1088
1089 Interactively, prompts for the command if `compilation-read-command' is
1090 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
1091 Additionally, with universal prefix arg, compilation buffer will be in
1092 comint mode, i.e. interactive.
1093
1094 To run more than one compilation at once, start one then rename
1095 the \`*compilation*' buffer to some other name with
1096 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1097 It will create a new \`*compilation*' buffer.
1098
1099 On most systems, termination of the main compilation process
1100 kills its subprocesses.
1101
1102 The name used for the buffer is actually whatever is returned by
1103 the function in `compilation-buffer-name-function', so you can set that
1104 to a function that generates a unique name."
1105 (interactive
1106 (list
1107 (let ((command (eval compile-command)))
1108 (if (or compilation-read-command current-prefix-arg)
1109 (compilation-read-command command)
1110 command))
1111 (consp current-prefix-arg)))
1112 (unless (equal command (eval compile-command))
1113 (setq compile-command command))
1114 (save-some-buffers (not compilation-ask-about-save)
1115 compilation-save-buffers-predicate)
1116 (setq-default compilation-directory default-directory)
1117 (compilation-start command comint))
1118
1119 ;; run compile with the default command line
1120 (defun recompile (&optional edit-command)
1121 "Re-compile the program including the current buffer.
1122 If this is run in a Compilation mode buffer, re-use the arguments from the
1123 original use. Otherwise, recompile using `compile-command'.
1124 If the optional argument `edit-command' is non-nil, the command can be edited."
1125 (interactive "P")
1126 (save-some-buffers (not compilation-ask-about-save)
1127 compilation-save-buffers-predicate)
1128 (let ((default-directory (or compilation-directory default-directory)))
1129 (when edit-command
1130 (setcar compilation-arguments
1131 (compilation-read-command (car compilation-arguments))))
1132 (apply 'compilation-start (or compilation-arguments
1133 `(,(eval compile-command))))))
1134
1135 (defcustom compilation-scroll-output nil
1136 "Non-nil to scroll the *compilation* buffer window as output appears.
1137
1138 Setting it causes the Compilation mode commands to put point at the
1139 end of their output window so that the end of the output is always
1140 visible rather than the beginning.
1141
1142 The value `first-error' stops scrolling at the first error, and leaves
1143 point on its location in the *compilation* buffer."
1144 :type '(choice (const :tag "No scrolling" nil)
1145 (const :tag "Scroll compilation output" t)
1146 (const :tag "Stop scrolling at the first error" first-error))
1147 :version "20.3"
1148 :group 'compilation)
1149
1150
1151 (defun compilation-buffer-name (mode-name mode-command name-function)
1152 "Return the name of a compilation buffer to use.
1153 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
1154 to determine the buffer name.
1155 Likewise if `compilation-buffer-name-function' is non-nil.
1156 If current buffer has the major mode MODE-COMMAND,
1157 return the name of the current buffer, so that it gets reused.
1158 Otherwise, construct a buffer name from MODE-NAME."
1159 (cond (name-function
1160 (funcall name-function mode-name))
1161 (compilation-buffer-name-function
1162 (funcall compilation-buffer-name-function mode-name))
1163 ((eq mode-command major-mode)
1164 (buffer-name))
1165 (t
1166 (concat "*" (downcase mode-name) "*"))))
1167
1168 ;; This is a rough emulation of the old hack, until the transition to new
1169 ;; compile is complete.
1170 (defun compile-internal (command error-message
1171 &optional name-of-mode parser
1172 error-regexp-alist name-function
1173 enter-regexp-alist leave-regexp-alist
1174 file-regexp-alist nomessage-regexp-alist
1175 no-async highlight-regexp local-map)
1176 (if parser
1177 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
1178 (let ((compilation-error-regexp-alist
1179 (append file-regexp-alist (or error-regexp-alist
1180 compilation-error-regexp-alist)))
1181 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
1182 "\\1" error-message)))
1183 (compilation-start command nil name-function highlight-regexp)))
1184 (make-obsolete 'compile-internal 'compilation-start "22.1")
1185
1186 ;;;###autoload
1187 (defun compilation-start (command &optional mode name-function highlight-regexp)
1188 "Run compilation command COMMAND (low level interface).
1189 If COMMAND starts with a cd command, that becomes the `default-directory'.
1190 The rest of the arguments are optional; for them, nil means use the default.
1191
1192 MODE is the major mode to set in the compilation buffer. Mode
1193 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1194
1195 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1196 to determine the buffer name. Otherwise, the default is to
1197 reuses the current buffer if it has the proper major mode,
1198 else use or create a buffer with name based on the major mode.
1199
1200 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1201 the matching section of the visited source line; the default is to use the
1202 global value of `compilation-highlight-regexp'.
1203
1204 Returns the compilation buffer created."
1205 (or mode (setq mode 'compilation-mode))
1206 (let* ((name-of-mode
1207 (if (eq mode t)
1208 "compilation"
1209 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
1210 (thisdir default-directory)
1211 outwin outbuf)
1212 (with-current-buffer
1213 (setq outbuf
1214 (get-buffer-create
1215 (compilation-buffer-name name-of-mode mode name-function)))
1216 (let ((comp-proc (get-buffer-process (current-buffer))))
1217 (if comp-proc
1218 (if (or (not (eq (process-status comp-proc) 'run))
1219 (yes-or-no-p
1220 (format "A %s process is running; kill it? "
1221 name-of-mode)))
1222 (condition-case ()
1223 (progn
1224 (interrupt-process comp-proc)
1225 (sit-for 1)
1226 (delete-process comp-proc))
1227 (error nil))
1228 (error "Cannot have two processes in `%s' at once"
1229 (buffer-name)))))
1230 ;; first transfer directory from where M-x compile was called
1231 (setq default-directory thisdir)
1232 ;; Make compilation buffer read-only. The filter can still write it.
1233 ;; Clear out the compilation buffer.
1234 (let ((inhibit-read-only t)
1235 (default-directory thisdir))
1236 ;; Then evaluate a cd command if any, but don't perform it yet, else
1237 ;; start-command would do it again through the shell: (cd "..") AND
1238 ;; sh -c "cd ..; make"
1239 (cd (if (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]"
1240 command)
1241 (if (match-end 1)
1242 (substitute-env-vars (match-string 1 command))
1243 "~")
1244 default-directory))
1245 (erase-buffer)
1246 ;; Select the desired mode.
1247 (if (not (eq mode t))
1248 (progn
1249 (buffer-disable-undo)
1250 (funcall mode))
1251 (setq buffer-read-only nil)
1252 (with-no-warnings (comint-mode))
1253 (compilation-shell-minor-mode))
1254 ;; Remember the original dir, so we can use it when we recompile.
1255 ;; default-directory' can't be used reliably for that because it may be
1256 ;; affected by the special handling of "cd ...;".
1257 ;; NB: must be fone after (funcall mode) as that resets local variables
1258 (set (make-local-variable 'compilation-directory) thisdir)
1259 (if highlight-regexp
1260 (set (make-local-variable 'compilation-highlight-regexp)
1261 highlight-regexp))
1262 (if (or compilation-auto-jump-to-first-error
1263 (eq compilation-scroll-output 'first-error))
1264 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1265 ;; Output a mode setter, for saving and later reloading this buffer.
1266 (insert "-*- mode: " name-of-mode
1267 "; default-directory: " (prin1-to-string default-directory)
1268 " -*-\n"
1269 (format "%s started at %s\n\n"
1270 mode-name
1271 (substring (current-time-string) 0 19))
1272 command "\n")
1273 (setq thisdir default-directory))
1274 (set-buffer-modified-p nil))
1275 ;; Pop up the compilation buffer.
1276 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1277 (setq outwin (display-buffer outbuf))
1278 (with-current-buffer outbuf
1279 (let ((process-environment
1280 (append
1281 compilation-environment
1282 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
1283 system-uses-terminfo)
1284 (list "TERM=dumb" "TERMCAP="
1285 (format "COLUMNS=%d" (window-width)))
1286 (list "TERM=emacs"
1287 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1288 (window-width))))
1289 ;; Set the EMACS variable, but
1290 ;; don't override users' setting of $EMACS.
1291 (unless (getenv "EMACS")
1292 (list "EMACS=t"))
1293 (list "INSIDE_EMACS=t")
1294 (copy-sequence process-environment))))
1295 (set (make-local-variable 'compilation-arguments)
1296 (list command mode name-function highlight-regexp))
1297 (set (make-local-variable 'revert-buffer-function)
1298 'compilation-revert-buffer)
1299 (set-window-start outwin (point-min))
1300
1301 ;; Position point as the user will see it.
1302 (let ((desired-visible-point
1303 ;; Put it at the end if `compilation-scroll-output' is set.
1304 (if compilation-scroll-output
1305 (point-max)
1306 ;; Normally put it at the top.
1307 (point-min))))
1308 (if (eq outwin (selected-window))
1309 (goto-char desired-visible-point)
1310 (set-window-point outwin desired-visible-point)))
1311
1312 ;; The setup function is called before compilation-set-window-height
1313 ;; so it can set the compilation-window-height buffer locally.
1314 (if compilation-process-setup-function
1315 (funcall compilation-process-setup-function))
1316 (compilation-set-window-height outwin)
1317 ;; Start the compilation.
1318 (if (fboundp 'start-process)
1319 (let ((proc
1320 (if (eq mode t)
1321 ;; comint uses `start-file-process'.
1322 (get-buffer-process
1323 (with-no-warnings
1324 (comint-exec
1325 outbuf (downcase mode-name)
1326 (if (file-remote-p default-directory)
1327 "/bin/sh"
1328 shell-file-name)
1329 nil `("-c" ,command))))
1330 (start-file-process-shell-command (downcase mode-name)
1331 outbuf command))))
1332 ;; Make the buffer's mode line show process state.
1333 (setq mode-line-process
1334 (list (propertize ":%s" 'face 'compilation-warning)))
1335 (set-process-sentinel proc 'compilation-sentinel)
1336 (unless (eq mode t)
1337 ;; Keep the comint filter, since it's needed for proper handling
1338 ;; of the prompts.
1339 (set-process-filter proc 'compilation-filter))
1340 ;; Use (point-max) here so that output comes in
1341 ;; after the initial text,
1342 ;; regardless of where the user sees point.
1343 (set-marker (process-mark proc) (point-max) outbuf)
1344 (when compilation-disable-input
1345 (condition-case nil
1346 (process-send-eof proc)
1347 ;; The process may have exited already.
1348 (error nil)))
1349 (run-hook-with-args 'compilation-start-hook proc)
1350 (setq compilation-in-progress
1351 (cons proc compilation-in-progress)))
1352 ;; No asynchronous processes available.
1353 (message "Executing `%s'..." command)
1354 ;; Fake modeline display as if `start-process' were run.
1355 (setq mode-line-process
1356 (list (propertize ":run" 'face 'compilation-warning)))
1357 (force-mode-line-update)
1358 (sit-for 0) ; Force redisplay
1359 (save-excursion
1360 ;; Insert the output at the end, after the initial text,
1361 ;; regardless of where the user sees point.
1362 (goto-char (point-max))
1363 (let* ((buffer-read-only nil) ; call-process needs to modify outbuf
1364 (status (call-process shell-file-name nil outbuf nil "-c"
1365 command)))
1366 (cond ((numberp status)
1367 (compilation-handle-exit
1368 'exit status
1369 (if (zerop status)
1370 "finished\n"
1371 (format "exited abnormally with code %d\n" status))))
1372 ((stringp status)
1373 (compilation-handle-exit 'signal status
1374 (concat status "\n")))
1375 (t
1376 (compilation-handle-exit 'bizarre status status)))))
1377 ;; Without async subprocesses, the buffer is not yet
1378 ;; fontified, so fontify it now.
1379 (let ((font-lock-verbose nil)) ; shut up font-lock messages
1380 (font-lock-fontify-buffer))
1381 (set-buffer-modified-p nil)
1382 (message "Executing `%s'...done" command)))
1383 ;; Now finally cd to where the shell started make/grep/...
1384 (setq default-directory thisdir)
1385 ;; The following form selected outwin ever since revision 1.183,
1386 ;; so possibly messing up point in some other window (bug#1073).
1387 ;; Moved into the scope of with-current-buffer, though still with
1388 ;; complete disregard for the case when compilation-scroll-output
1389 ;; equals 'first-error (martin 2008-10-04).
1390 (when compilation-scroll-output
1391 (goto-char (point-max))))
1392
1393 ;; Make it so the next C-x ` will use this buffer.
1394 (setq next-error-last-buffer outbuf)))
1395
1396 (defun compilation-set-window-height (window)
1397 "Set the height of WINDOW according to `compilation-window-height'."
1398 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1399 (and height
1400 (window-full-width-p window)
1401 ;; If window is alone in its frame, aside from a minibuffer,
1402 ;; don't change its height.
1403 (not (eq window (frame-root-window (window-frame window))))
1404 ;; Stef said that doing the saves in this order is safer:
1405 (save-excursion
1406 (save-selected-window
1407 (select-window window)
1408 (enlarge-window (- height (window-height))))))))
1409
1410 (defvar compilation-menu-map
1411 (let ((map (make-sparse-keymap "Errors"))
1412 (opt-map (make-sparse-keymap "Skip")))
1413 (define-key map [stop-subjob]
1414 '(menu-item "Stop Compilation" kill-compilation
1415 :help "Kill the process made by the M-x compile or M-x grep commands"))
1416 (define-key map [compilation-mode-separator3]
1417 '("----" . nil))
1418 (define-key map [compilation-next-error-follow-minor-mode]
1419 '(menu-item
1420 "Auto Error Display" next-error-follow-minor-mode
1421 :help "Display the error under cursor when moving the cursor"
1422 :button (:toggle . next-error-follow-minor-mode)))
1423 (define-key map [compilation-skip]
1424 (cons "Skip Less Important Messages" opt-map))
1425 (define-key opt-map [compilation-skip-none]
1426 '(menu-item "Don't Skip Any Messages"
1427 (lambda ()
1428 (interactive)
1429 (customize-set-variable 'compilation-skip-threshold 0))
1430 :help "Do not skip any type of messages"
1431 :button (:radio . (eq compilation-skip-threshold 0))))
1432 (define-key opt-map [compilation-skip-info]
1433 '(menu-item "Skip Info"
1434 (lambda ()
1435 (interactive)
1436 (customize-set-variable 'compilation-skip-threshold 1))
1437 :help "Skip anything less than warning"
1438 :button (:radio . (eq compilation-skip-threshold 1))))
1439 (define-key opt-map [compilation-skip-warning-and-info]
1440 '(menu-item "Skip Warnings and Info"
1441 (lambda ()
1442 (interactive)
1443 (customize-set-variable 'compilation-skip-threshold 2))
1444 :help "Skip over Warnings and Info, stop for errors"
1445 :button (:radio . (eq compilation-skip-threshold 2))))
1446 (define-key map [compilation-mode-separator2]
1447 '("----" . nil))
1448 (define-key map [compilation-first-error]
1449 '(menu-item "First Error" first-error
1450 :help "Restart at the first error, visit corresponding source code"))
1451 (define-key map [compilation-previous-error]
1452 '(menu-item "Previous Error" previous-error
1453 :help "Visit previous `next-error' message and corresponding source code"))
1454 (define-key map [compilation-next-error]
1455 '(menu-item "Next Error" next-error
1456 :help "Visit next `next-error' message and corresponding source code"))
1457 map))
1458
1459 (defvar compilation-minor-mode-map
1460 (let ((map (make-sparse-keymap)))
1461 (define-key map [mouse-2] 'compile-goto-error)
1462 (define-key map [follow-link] 'mouse-face)
1463 (define-key map "\C-c\C-c" 'compile-goto-error)
1464 (define-key map "\C-m" 'compile-goto-error)
1465 (define-key map "\C-c\C-k" 'kill-compilation)
1466 (define-key map "\M-n" 'compilation-next-error)
1467 (define-key map "\M-p" 'compilation-previous-error)
1468 (define-key map "\M-{" 'compilation-previous-file)
1469 (define-key map "\M-}" 'compilation-next-file)
1470 (define-key map "g" 'recompile) ; revert
1471 (define-key map "q" 'quit-window)
1472 ;; Set up the menu-bar
1473 (define-key map [menu-bar compilation]
1474 (cons "Errors" compilation-menu-map))
1475 map)
1476 "Keymap for `compilation-minor-mode'.")
1477
1478 (defvar compilation-shell-minor-mode-map
1479 (let ((map (make-sparse-keymap)))
1480 (define-key map "\M-\C-m" 'compile-goto-error)
1481 (define-key map "\M-\C-n" 'compilation-next-error)
1482 (define-key map "\M-\C-p" 'compilation-previous-error)
1483 (define-key map "\M-{" 'compilation-previous-file)
1484 (define-key map "\M-}" 'compilation-next-file)
1485 ;; Set up the menu-bar
1486 (define-key map [menu-bar compilation]
1487 (cons "Errors" compilation-menu-map))
1488 map)
1489 "Keymap for `compilation-shell-minor-mode'.")
1490
1491 (defvar compilation-button-map
1492 (let ((map (make-sparse-keymap)))
1493 (define-key map [mouse-2] 'compile-goto-error)
1494 (define-key map [follow-link] 'mouse-face)
1495 (define-key map "\C-m" 'compile-goto-error)
1496 map)
1497 "Keymap for compilation-message buttons.")
1498 (fset 'compilation-button-map compilation-button-map)
1499
1500 (defvar compilation-mode-map
1501 (let ((map (make-sparse-keymap)))
1502 ;; Don't inherit from compilation-minor-mode-map,
1503 ;; because that introduces a menu bar item we don't want.
1504 ;; That confuses C-down-mouse-3.
1505 (define-key map [mouse-2] 'compile-goto-error)
1506 (define-key map [follow-link] 'mouse-face)
1507 (define-key map "\C-c\C-c" 'compile-goto-error)
1508 (define-key map "\C-m" 'compile-goto-error)
1509 (define-key map "\C-c\C-k" 'kill-compilation)
1510 (define-key map "\M-n" 'compilation-next-error)
1511 (define-key map "\M-p" 'compilation-previous-error)
1512 (define-key map "\M-{" 'compilation-previous-file)
1513 (define-key map "\M-}" 'compilation-next-file)
1514 (define-key map "\t" 'compilation-next-error)
1515 (define-key map [backtab] 'compilation-previous-error)
1516 (define-key map "g" 'recompile) ; revert
1517 (define-key map "q" 'quit-window)
1518
1519 (define-key map " " 'scroll-up)
1520 (define-key map "\^?" 'scroll-down)
1521 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1522
1523 ;; Set up the menu-bar
1524 (let ((submap (make-sparse-keymap "Compile")))
1525 (define-key map [menu-bar compilation]
1526 (cons "Compile" submap))
1527 (set-keymap-parent submap compilation-menu-map))
1528 (define-key map [menu-bar compilation compilation-separator2]
1529 '("----" . nil))
1530 (define-key map [menu-bar compilation compilation-grep]
1531 '(menu-item "Search Files (grep)..." grep
1532 :help "Run grep, with user-specified args, and collect output in a buffer"))
1533 (define-key map [menu-bar compilation compilation-recompile]
1534 '(menu-item "Recompile" recompile
1535 :help "Re-compile the program including the current buffer"))
1536 (define-key map [menu-bar compilation compilation-compile]
1537 '(menu-item "Compile..." compile
1538 :help "Compile the program including the current buffer. Default: run `make'"))
1539 map)
1540 "Keymap for compilation log buffers.
1541 `compilation-minor-mode-map' is a parent of this.")
1542
1543 (defvar compilation-mode-tool-bar-map
1544 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1545 ;; so don't do anything.
1546 (when (keymapp (butlast tool-bar-map))
1547 (let ((map (butlast (copy-keymap tool-bar-map)))
1548 (help (last tool-bar-map))) ;; Keep Help last in tool bar
1549 (tool-bar-local-item
1550 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1551 :rtl "right-arrow"
1552 :help "Goto previous error")
1553 (tool-bar-local-item
1554 "right-arrow" 'next-error-no-select 'next-error-no-select map
1555 :rtl "left-arrow"
1556 :help "Goto next error")
1557 (tool-bar-local-item
1558 "cancel" 'kill-compilation 'kill-compilation map
1559 :enable '(let ((buffer (compilation-find-buffer)))
1560 (get-buffer-process buffer))
1561 :help "Stop compilation")
1562 (tool-bar-local-item
1563 "refresh" 'recompile 'recompile map
1564 :help "Restart compilation")
1565 (append map help))))
1566
1567 (put 'compilation-mode 'mode-class 'special)
1568
1569 ;;;###autoload
1570 (defun compilation-mode (&optional name-of-mode)
1571 "Major mode for compilation log buffers.
1572 \\<compilation-mode-map>To visit the source for a line-numbered error,
1573 move point to the error message line and type \\[compile-goto-error].
1574 To kill the compilation, type \\[kill-compilation].
1575
1576 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1577
1578 \\{compilation-mode-map}"
1579 (interactive)
1580 (kill-all-local-variables)
1581 (use-local-map compilation-mode-map)
1582 ;; Let windows scroll along with the output.
1583 (set (make-local-variable 'window-point-insertion-type) t)
1584 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
1585 (setq major-mode 'compilation-mode
1586 mode-name (or name-of-mode "Compilation"))
1587 (set (make-local-variable 'page-delimiter)
1588 compilation-page-delimiter)
1589 (set (make-local-variable 'buffer-modtime) nil)
1590 (compilation-setup)
1591 (setq buffer-read-only t)
1592 (run-mode-hooks 'compilation-mode-hook))
1593
1594 (defmacro define-compilation-mode (mode name doc &rest body)
1595 "This is like `define-derived-mode' without the PARENT argument.
1596 The parent is always `compilation-mode' and the customizable `compilation-...'
1597 variables are also set from the name of the mode you have chosen,
1598 by replacing the first word, e.g `compilation-scroll-output' from
1599 `grep-scroll-output' if that variable exists."
1600 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1601 `(define-derived-mode ,mode compilation-mode ,name
1602 ,doc
1603 ,@(mapcar (lambda (v)
1604 (setq v (cons v
1605 (intern-soft (replace-regexp-in-string
1606 "^compilation" mode-name
1607 (symbol-name v)))))
1608 (and (cdr v)
1609 (or (boundp (cdr v))
1610 (if (boundp 'byte-compile-bound-variables)
1611 (memq (cdr v) byte-compile-bound-variables)))
1612 `(set (make-local-variable ',(car v)) ,(cdr v))))
1613 '(compilation-buffer-name-function
1614 compilation-directory-matcher
1615 compilation-error
1616 compilation-error-regexp-alist
1617 compilation-error-regexp-alist-alist
1618 compilation-error-screen-columns
1619 compilation-finish-function
1620 compilation-finish-functions
1621 compilation-first-column
1622 compilation-mode-font-lock-keywords
1623 compilation-page-delimiter
1624 compilation-parse-errors-filename-function
1625 compilation-process-setup-function
1626 compilation-scroll-output
1627 compilation-search-path
1628 compilation-skip-threshold
1629 compilation-window-height))
1630 ,@body)))
1631
1632 (defun compilation-revert-buffer (ignore-auto noconfirm)
1633 (if buffer-file-name
1634 (let (revert-buffer-function)
1635 (revert-buffer ignore-auto noconfirm))
1636 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1637 (apply 'compilation-start compilation-arguments))))
1638
1639 (defvar compilation-current-error nil
1640 "Marker to the location from where the next error will be found.
1641 The global commands next/previous/first-error/goto-error use this.")
1642
1643 (defvar compilation-messages-start nil
1644 "Buffer position of the beginning of the compilation messages.
1645 If nil, use the beginning of buffer.")
1646
1647 ;; A function name can't be a hook, must be something with a value.
1648 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1649
1650 (defun compilation-setup (&optional minor)
1651 "Prepare the buffer for the compilation parsing commands to work.
1652 Optional argument MINOR indicates this is called from
1653 `compilation-minor-mode'."
1654 (make-local-variable 'compilation-current-error)
1655 (make-local-variable 'compilation-messages-start)
1656 (make-local-variable 'compilation-error-screen-columns)
1657 (make-local-variable 'overlay-arrow-position)
1658 (set (make-local-variable 'overlay-arrow-string) "")
1659 (setq next-error-overlay-arrow-position nil)
1660 (add-hook 'kill-buffer-hook
1661 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1662 ;; Note that compilation-next-error-function is for interfacing
1663 ;; with the next-error function in simple.el, and it's only
1664 ;; coincidentally named similarly to compilation-next-error.
1665 (setq next-error-function 'compilation-next-error-function)
1666 (set (make-local-variable 'comint-file-name-prefix)
1667 (or (file-remote-p default-directory) ""))
1668 (set (make-local-variable 'font-lock-extra-managed-props)
1669 '(directory message help-echo mouse-face debug))
1670 (set (make-local-variable 'compilation-locs)
1671 (make-hash-table :test 'equal :weakness 'value))
1672 ;; lazy-lock would never find the message unless it's scrolled to.
1673 ;; jit-lock might fontify some things too late.
1674 (set (make-local-variable 'font-lock-support-mode) nil)
1675 (set (make-local-variable 'font-lock-maximum-size) nil)
1676 (if minor
1677 (let ((fld font-lock-defaults))
1678 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1679 (if font-lock-mode
1680 (if fld
1681 (font-lock-fontify-buffer)
1682 (font-lock-change-mode)
1683 (turn-on-font-lock))
1684 (turn-on-font-lock)))
1685 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))
1686 ;; maybe defer font-lock till after derived mode is set up
1687 (run-mode-hooks 'compilation-turn-on-font-lock)))
1688
1689 ;;;###autoload
1690 (define-minor-mode compilation-shell-minor-mode
1691 "Toggle compilation shell minor mode.
1692 With arg, turn compilation mode on if and only if arg is positive.
1693 In this minor mode, all the error-parsing commands of the
1694 Compilation major mode are available but bound to keys that don't
1695 collide with Shell mode. See `compilation-mode'.
1696 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1697 nil " Shell-Compile"
1698 :group 'compilation
1699 (if compilation-shell-minor-mode
1700 (compilation-setup t)
1701 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1702 (font-lock-fontify-buffer)))
1703
1704 ;;;###autoload
1705 (define-minor-mode compilation-minor-mode
1706 "Toggle compilation minor mode.
1707 With arg, turn compilation mode on if and only if arg is positive.
1708 In this minor mode, all the error-parsing commands of the
1709 Compilation major mode are available. See `compilation-mode'.
1710 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1711 nil " Compilation"
1712 :group 'compilation
1713 (if compilation-minor-mode
1714 (compilation-setup t)
1715 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1716 (font-lock-fontify-buffer)))
1717
1718 (defun compilation-handle-exit (process-status exit-status msg)
1719 "Write MSG in the current buffer and hack its `mode-line-process'."
1720 (let ((inhibit-read-only t)
1721 (status (if compilation-exit-message-function
1722 (funcall compilation-exit-message-function
1723 process-status exit-status msg)
1724 (cons msg exit-status)))
1725 (omax (point-max))
1726 (opoint (point))
1727 (cur-buffer (current-buffer)))
1728 ;; Record where we put the message, so we can ignore it later on.
1729 (goto-char omax)
1730 (insert ?\n mode-name " " (car status))
1731 (if (and (numberp compilation-window-height)
1732 (zerop compilation-window-height))
1733 (message "%s" (cdr status)))
1734 (if (bolp)
1735 (forward-char -1))
1736 (insert " at " (substring (current-time-string) 0 19))
1737 (goto-char (point-max))
1738 ;; Prevent that message from being recognized as a compilation error.
1739 (add-text-properties omax (point)
1740 (append '(compilation-handle-exit t) nil))
1741 (setq mode-line-process
1742 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
1743 (msg (format "%s %s" mode-name
1744 (replace-regexp-in-string "\n?$" "" (car status)))))
1745 (message "%s" msg)
1746 (propertize out-string
1747 'help-echo msg 'face (if (> exit-status 0)
1748 'compilation-error
1749 'compilation-info))))
1750 ;; Force mode line redisplay soon.
1751 (force-mode-line-update)
1752 (if (and opoint (< opoint omax))
1753 (goto-char opoint))
1754 (with-no-warnings
1755 (if compilation-finish-function
1756 (funcall compilation-finish-function cur-buffer msg)))
1757 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
1758
1759 ;; Called when compilation process changes state.
1760 (defun compilation-sentinel (proc msg)
1761 "Sentinel for compilation buffers."
1762 (if (memq (process-status proc) '(exit signal))
1763 (let ((buffer (process-buffer proc)))
1764 (if (null (buffer-name buffer))
1765 ;; buffer killed
1766 (set-process-buffer proc nil)
1767 (with-current-buffer buffer
1768 ;; Write something in the compilation buffer
1769 ;; and hack its mode line.
1770 (compilation-handle-exit (process-status proc)
1771 (process-exit-status proc)
1772 msg)
1773 ;; Since the buffer and mode line will show that the
1774 ;; process is dead, we can delete it now. Otherwise it
1775 ;; will stay around until M-x list-processes.
1776 (delete-process proc)))
1777 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1778
1779 (defun compilation-filter (proc string)
1780 "Process filter for compilation buffers.
1781 Just inserts the text,
1782 handles carriage motion (see `comint-inhibit-carriage-motion'),
1783 and runs `compilation-filter-hook'."
1784 (when (buffer-live-p (process-buffer proc))
1785 (with-current-buffer (process-buffer proc)
1786 (let ((inhibit-read-only t)
1787 ;; `save-excursion' doesn't use the right insertion-type for us.
1788 (pos (copy-marker (point) t))
1789 (min (point-min-marker))
1790 (max (point-max-marker)))
1791 (unwind-protect
1792 (progn
1793 ;; If we are inserting at the end of the accessible part
1794 ;; of the buffer, keep the inserted text visible.
1795 (set-marker-insertion-type max t)
1796 (widen)
1797 (goto-char (process-mark proc))
1798 ;; We used to use `insert-before-markers', so that windows with
1799 ;; point at `process-mark' scroll along with the output, but we
1800 ;; now use window-point-insertion-type instead.
1801 (insert string)
1802 (unless comint-inhibit-carriage-motion
1803 (comint-carriage-motion (process-mark proc) (point)))
1804 (set-marker (process-mark proc) (point))
1805 (set (make-local-variable 'buffer-modtime) (current-time))
1806 (run-hooks 'compilation-filter-hook))
1807 (goto-char pos)
1808 (narrow-to-region min max)
1809 (set-marker min nil)
1810 (set-marker max nil))))))
1811
1812 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1813 (defsubst compilation-buffer-internal-p ()
1814 "Test if inside a compilation buffer."
1815 (local-variable-p 'compilation-locs))
1816
1817 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1818 (defsubst compilation-buffer-p (buffer)
1819 "Test if BUFFER is a compilation buffer."
1820 (with-current-buffer buffer
1821 (compilation-buffer-internal-p)))
1822
1823 (defmacro compilation-loop (< property-change 1+ error limit)
1824 `(let (opt)
1825 (while (,< n 0)
1826 (setq opt pt)
1827 (or (setq pt (,property-change pt 'message))
1828 ;; Handle the case where where the first error message is
1829 ;; at the start of the buffer, and n < 0.
1830 (if (or (eq (get-text-property ,limit 'message)
1831 (get-text-property opt 'message))
1832 (eq pt opt))
1833 (error ,error compilation-error)
1834 (setq pt ,limit)))
1835 ;; prop 'message usually has 2 changes, on and off, so
1836 ;; re-search if off
1837 (or (setq msg (get-text-property pt 'message))
1838 (if (setq pt (,property-change pt 'message nil ,limit))
1839 (setq msg (get-text-property pt 'message)))
1840 (error ,error compilation-error))
1841 (or (< (cadr msg) compilation-skip-threshold)
1842 (if different-file
1843 (eq (prog1 last (setq last (nth 2 (car msg))))
1844 last))
1845 (if compilation-skip-visited
1846 (nthcdr 5 (car msg)))
1847 (if compilation-skip-to-next-location
1848 (eq (car msg) loc))
1849 ;; count this message only if none of the above are true
1850 (setq n (,1+ n))))))
1851
1852 (defun compilation-next-error (n &optional different-file pt)
1853 "Move point to the next error in the compilation buffer.
1854 This function does NOT find the source line like \\[next-error].
1855 Prefix arg N says how many error messages to move forwards (or
1856 backwards, if negative).
1857 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
1858 file that is different from the current one.
1859 Optional arg PT, if non-nil, specifies the value of point to start
1860 looking for the next message."
1861 (interactive "p")
1862 (or (compilation-buffer-p (current-buffer))
1863 (error "Not in a compilation buffer"))
1864 (or pt (setq pt (point)))
1865 (let* ((msg (get-text-property pt 'message))
1866 ;; `loc' is used by the compilation-loop macro.
1867 (loc (car msg))
1868 last)
1869 (if (zerop n)
1870 (unless (or msg ; find message near here
1871 (setq msg (get-text-property (max (1- pt) (point-min))
1872 'message)))
1873 (setq pt (previous-single-property-change pt 'message nil
1874 (line-beginning-position)))
1875 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1876 (setq pt (next-single-property-change pt 'message nil
1877 (line-end-position)))
1878 (or (setq msg (get-text-property pt 'message))
1879 (setq pt (point)))))
1880 (setq last (nth 2 (car msg)))
1881 (if (>= n 0)
1882 (compilation-loop > next-single-property-change 1-
1883 (if (get-buffer-process (current-buffer))
1884 "No more %ss yet"
1885 "Moved past last %s")
1886 (point-max))
1887 ;; Don't move "back" to message at or before point.
1888 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1889 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1890 (compilation-loop < previous-single-property-change 1+
1891 "Moved back before first %s" (point-min))))
1892 (goto-char pt)
1893 (or msg
1894 (error "No %s here" compilation-error))))
1895
1896 (defun compilation-previous-error (n)
1897 "Move point to the previous error in the compilation buffer.
1898 Prefix arg N says how many error messages to move backwards (or
1899 forwards, if negative).
1900 Does NOT find the source line like \\[previous-error]."
1901 (interactive "p")
1902 (compilation-next-error (- n)))
1903
1904 (defun compilation-next-file (n)
1905 "Move point to the next error for a different file than the current one.
1906 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1907 (interactive "p")
1908 (compilation-next-error n t))
1909
1910 (defun compilation-previous-file (n)
1911 "Move point to the previous error for a different file than the current one.
1912 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1913 (interactive "p")
1914 (compilation-next-file (- n)))
1915
1916 (defun kill-compilation ()
1917 "Kill the process made by the \\[compile] or \\[grep] commands."
1918 (interactive)
1919 (let ((buffer (compilation-find-buffer)))
1920 (if (get-buffer-process buffer)
1921 (interrupt-process (get-buffer-process buffer))
1922 (error "The %s process is not running" (downcase mode-name)))))
1923
1924 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1925
1926 (defun compile-goto-error (&optional event)
1927 "Visit the source for the error message at point.
1928 Use this command in a compilation log buffer. Sets the mark at point there."
1929 (interactive (list last-input-event))
1930 (if event (posn-set-point (event-end event)))
1931 (or (compilation-buffer-p (current-buffer))
1932 (error "Not in a compilation buffer"))
1933 (if (get-text-property (point) 'directory)
1934 (dired-other-window (car (get-text-property (point) 'directory)))
1935 (push-mark)
1936 (setq compilation-current-error (point))
1937 (next-error-internal)))
1938
1939 (defun compilation-find-buffer (&optional avoid-current)
1940 "Return a compilation buffer.
1941 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
1942 return it. If AVOID-CURRENT is non-nil, return the current buffer only
1943 as a last resort."
1944 (if (and (compilation-buffer-internal-p) (not avoid-current))
1945 (current-buffer)
1946 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
1947
1948 ;;;###autoload
1949 (defun compilation-next-error-function (n &optional reset)
1950 "Advance to the next error message and visit the file where the error was.
1951 This is the value of `next-error-function' in Compilation buffers."
1952 (interactive "p")
1953 (when reset
1954 (setq compilation-current-error nil))
1955 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1956 (last 1) timestamp
1957 (loc (compilation-next-error (or n 1) nil
1958 (or compilation-current-error
1959 compilation-messages-start
1960 (point-min))))
1961 (end-loc (nth 2 loc))
1962 (marker (point-marker)))
1963 (setq compilation-current-error (point-marker)
1964 overlay-arrow-position
1965 (if (bolp)
1966 compilation-current-error
1967 (copy-marker (line-beginning-position)))
1968 loc (car loc))
1969 ;; If loc contains no marker, no error in that file has been visited.
1970 ;; If the marker is invalid the buffer has been killed.
1971 ;; If the file is newer than the timestamp, it has been modified
1972 ;; (`omake -P' polls filesystem for changes and recompiles when needed
1973 ;; in the same process and buffer).
1974 ;; So, recalculate all markers for that file.
1975 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)) (nthcdr 4 loc)
1976 ;; There may be no timestamp info if the loc is a `fake-loc',
1977 ;; but we just checked that the file has been visited before!
1978 (equal (nth 4 loc)
1979 (setq timestamp buffer-modtime)))
1980 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1981 (cadr (car (nth 2 loc))))
1982 (save-restriction
1983 (widen)
1984 (goto-char (point-min))
1985 ;; Treat file's found lines in forward order, 1 by 1.
1986 (dolist (line (reverse (cddr (nth 2 loc))))
1987 (when (car line) ; else this is a filename w/o a line#
1988 (beginning-of-line (- (car line) last -1))
1989 (setq last (car line)))
1990 ;; Treat line's found columns and store/update a marker for each.
1991 (dolist (col (cdr line))
1992 (if (car col)
1993 (if (eq (car col) -1) ; special case for range end
1994 (end-of-line)
1995 (compilation-move-to-column (car col) columns))
1996 (beginning-of-line)
1997 (skip-chars-forward " \t"))
1998 (if (nth 3 col)
1999 (set-marker (nth 3 col) (point))
2000 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
2001 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
2002 (setcdr (nthcdr 3 loc) (list timestamp))
2003 (setcdr (nthcdr 4 loc) t))) ; Set this one as visited.
2004
2005 (defvar compilation-gcpro nil
2006 "Internal variable used to keep some values from being GC'd.")
2007 (make-variable-buffer-local 'compilation-gcpro)
2008
2009 (defun compilation-fake-loc (marker file &optional line col)
2010 "Preassociate MARKER with FILE.
2011 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2012 This is useful when you compile temporary files, but want
2013 automatic translation of the messages to the real buffer from
2014 which the temporary file came. This only works if done before a
2015 message about FILE appears!
2016
2017 Optional args LINE and COL default to 1 and beginning of
2018 indentation respectively. The marker is expected to reflect
2019 this. In the simplest case the marker points to the first line
2020 of the region that was saved to the temp file.
2021
2022 If you concatenate several regions into the temp file (e.g. a
2023 header with variable assignments and a code region), you must
2024 call this several times, once each for the last line of one
2025 region and the first line of the next region."
2026 (or (consp file) (setq file (list file)))
2027 (setq file (compilation-get-file-structure file))
2028 ;; Between the current call to compilation-fake-loc and the first occurrence
2029 ;; of an error message referring to `file', the data is only kept in the
2030 ;; weak hash-table compilation-locs, so we need to prevent this entry
2031 ;; in compilation-locs from being GC'd away. --Stef
2032 (push file compilation-gcpro)
2033 (let ((loc (compilation-assq (or line 1) (cdr file))))
2034 (setq loc (compilation-assq col loc))
2035 (if (cdr loc)
2036 (setcdr (cddr loc) (list marker))
2037 (setcdr loc (list line file marker)))
2038 loc))
2039
2040 (defcustom compilation-context-lines nil
2041 "Display this many lines of leading context before the current message.
2042 If nil and the left fringe is displayed, don't scroll the
2043 compilation output window; an arrow in the left fringe points to
2044 the current message. If nil and there is no left fringe, the message
2045 displays at the top of the window; there is no arrow."
2046 :type '(choice integer (const :tag "No window scrolling" nil))
2047 :group 'compilation
2048 :version "22.1")
2049
2050 (defsubst compilation-set-window (w mk)
2051 "Align the compilation output window W with marker MK near top."
2052 (if (integerp compilation-context-lines)
2053 (set-window-start w (save-excursion
2054 (goto-char mk)
2055 (beginning-of-line
2056 (- 1 compilation-context-lines))
2057 (point)))
2058 ;; If there is no left fringe.
2059 (if (equal (car (window-fringes)) 0)
2060 (set-window-start w (save-excursion
2061 (goto-char mk)
2062 (beginning-of-line 1)
2063 (point)))))
2064 (set-window-point w mk))
2065
2066 (defvar next-error-highlight-timer)
2067
2068 (defun compilation-goto-locus (msg mk end-mk)
2069 "Jump to an error corresponding to MSG at MK.
2070 All arguments are markers. If END-MK is non-nil, mark is set there
2071 and overlay is highlighted between MK and END-MK."
2072 ;; Show compilation buffer in other window, scrolled to this error.
2073 (let* ((from-compilation-buffer (eq (window-buffer (selected-window))
2074 (marker-buffer msg)))
2075 ;; Use an existing window if it is in a visible frame.
2076 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2077 (w (if (and from-compilation-buffer pre-existing)
2078 ;; Calling display-buffer here may end up (partly) hiding
2079 ;; the error location if the two buffers are in two
2080 ;; different frames. So don't do it if it's not necessary.
2081 pre-existing
2082 (let ((display-buffer-reuse-frames t)
2083 (pop-up-windows t))
2084 ;; Pop up a window.
2085 (display-buffer (marker-buffer msg)))))
2086 (highlight-regexp (with-current-buffer (marker-buffer msg)
2087 ;; also do this while we change buffer
2088 (compilation-set-window w msg)
2089 compilation-highlight-regexp)))
2090 ;; Ideally, the window-size should be passed to `display-buffer' (via
2091 ;; something like special-display-buffer) so it's only used when
2092 ;; creating a new window.
2093 (unless pre-existing (compilation-set-window-height w))
2094
2095 (if from-compilation-buffer
2096 ;; If the compilation buffer window was selected,
2097 ;; keep the compilation buffer in this window;
2098 ;; display the source in another window.
2099 (let ((pop-up-windows t))
2100 (pop-to-buffer (marker-buffer mk) 'other-window))
2101 (if (window-dedicated-p (selected-window))
2102 (pop-to-buffer (marker-buffer mk))
2103 (switch-to-buffer (marker-buffer mk))))
2104 (unless (eq (goto-char mk) (point))
2105 ;; If narrowing gets in the way of going to the right place, widen.
2106 (widen)
2107 (if next-error-move-function
2108 (funcall next-error-move-function msg mk)
2109 (goto-char mk)))
2110 (if end-mk
2111 (push-mark end-mk t)
2112 (if mark-active (setq mark-active)))
2113 ;; If hideshow got in the way of
2114 ;; seeing the right place, open permanently.
2115 (dolist (ov (overlays-at (point)))
2116 (when (eq 'hs (overlay-get ov 'invisible))
2117 (delete-overlay ov)
2118 (goto-char mk)))
2119
2120 (when highlight-regexp
2121 (if (timerp next-error-highlight-timer)
2122 (cancel-timer next-error-highlight-timer))
2123 (unless compilation-highlight-overlay
2124 (setq compilation-highlight-overlay
2125 (make-overlay (point-min) (point-min)))
2126 (overlay-put compilation-highlight-overlay 'face 'next-error))
2127 (with-current-buffer (marker-buffer mk)
2128 (save-excursion
2129 (if end-mk (goto-char end-mk) (end-of-line))
2130 (let ((end (point)))
2131 (if mk (goto-char mk) (beginning-of-line))
2132 (if (and (stringp highlight-regexp)
2133 (re-search-forward highlight-regexp end t))
2134 (progn
2135 (goto-char (match-beginning 0))
2136 (move-overlay compilation-highlight-overlay
2137 (match-beginning 0) (match-end 0)
2138 (current-buffer)))
2139 (move-overlay compilation-highlight-overlay
2140 (point) end (current-buffer)))
2141 (if (or (eq next-error-highlight t)
2142 (numberp next-error-highlight))
2143 ;; We want highlighting: delete overlay on next input.
2144 (add-hook 'pre-command-hook
2145 'compilation-goto-locus-delete-o)
2146 ;; We don't want highlighting: delete overlay now.
2147 (delete-overlay compilation-highlight-overlay))
2148 ;; We want highlighting for a limited time:
2149 ;; set up a timer to delete it.
2150 (when (numberp next-error-highlight)
2151 (setq next-error-highlight-timer
2152 (run-at-time next-error-highlight nil
2153 'compilation-goto-locus-delete-o)))))))
2154 (when (and (eq next-error-highlight 'fringe-arrow))
2155 ;; We want a fringe arrow (instead of highlighting).
2156 (setq next-error-overlay-arrow-position
2157 (copy-marker (line-beginning-position))))))
2158
2159 (defun compilation-goto-locus-delete-o ()
2160 (delete-overlay compilation-highlight-overlay)
2161 ;; Get rid of timer and hook that would try to do this again.
2162 (if (timerp next-error-highlight-timer)
2163 (cancel-timer next-error-highlight-timer))
2164 (remove-hook 'pre-command-hook
2165 'compilation-goto-locus-delete-o))
2166 \f
2167 (defun compilation-find-file (marker filename directory &rest formats)
2168 "Find a buffer for file FILENAME.
2169 If FILENAME is not found at all, ask the user where to find it.
2170 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2171 the user where to find the file.
2172 Search the directories in `compilation-search-path'.
2173 A nil in `compilation-search-path' means to try the
2174 \"current\" directory, which is passed in DIRECTORY.
2175 If DIRECTORY is relative, it is combined with `default-directory'.
2176 If DIRECTORY is nil, that means use `default-directory'.
2177 FORMATS, if given, is a list of formats to reformat FILENAME when
2178 looking for it: for each element FMT in FORMATS, this function
2179 attempts to find a file whose name is produced by (format FMT FILENAME)."
2180 (or formats (setq formats '("%s")))
2181 (let ((dirs compilation-search-path)
2182 (spec-dir (if directory
2183 (expand-file-name directory)
2184 default-directory))
2185 buffer thisdir fmts name)
2186 (if (file-name-absolute-p filename)
2187 ;; The file name is absolute. Use its explicit directory as
2188 ;; the first in the search path, and strip it from FILENAME.
2189 (setq filename (abbreviate-file-name (expand-file-name filename))
2190 dirs (cons (file-name-directory filename) dirs)
2191 filename (file-name-nondirectory filename)))
2192 ;; Now search the path.
2193 (while (and dirs (null buffer))
2194 (setq thisdir (or (car dirs) spec-dir)
2195 fmts formats)
2196 ;; For each directory, try each format string.
2197 (while (and fmts (null buffer))
2198 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2199 buffer (and (file-exists-p name)
2200 (find-file-noselect name))
2201 fmts (cdr fmts)))
2202 (setq dirs (cdr dirs)))
2203 (while (null buffer) ;Repeat until the user selects an existing file.
2204 ;; The file doesn't exist. Ask the user where to find it.
2205 (save-excursion ;This save-excursion is probably not right.
2206 (let ((pop-up-windows t))
2207 (compilation-set-window (display-buffer (marker-buffer marker))
2208 marker)
2209 (let* ((name (read-file-name
2210 (format "Find this %s in (default %s): "
2211 compilation-error filename)
2212 spec-dir filename t nil
2213 ;; The predicate below is fine when called from
2214 ;; minibuffer-complete-and-exit, but it's too
2215 ;; restrictive otherwise, since it also prevents the
2216 ;; user from completing "fo" to "foo/" when she
2217 ;; wants to enter "foo/bar".
2218 ;;
2219 ;; Try to make sure the user can only select
2220 ;; a valid answer. This predicate may be ignored,
2221 ;; tho, so we still have to double-check afterwards.
2222 ;; TODO: We should probably fix read-file-name so
2223 ;; that it never ignores this predicate, even when
2224 ;; using popup dialog boxes.
2225 ;; (lambda (name)
2226 ;; (if (file-directory-p name)
2227 ;; (setq name (expand-file-name filename name)))
2228 ;; (file-exists-p name))
2229 ))
2230 (origname name))
2231 (cond
2232 ((not (file-exists-p name))
2233 (message "Cannot find file `%s'" name)
2234 (ding) (sit-for 2))
2235 ((and (file-directory-p name)
2236 (not (file-exists-p
2237 (setq name (expand-file-name filename name)))))
2238 (message "No `%s' in directory %s" filename origname)
2239 (ding) (sit-for 2))
2240 (t
2241 (setq buffer (find-file-noselect name))))))))
2242 ;; Make intangible overlays tangible.
2243 ;; This is weird: it's not even clear which is the current buffer,
2244 ;; so the code below can't be expected to DTRT here. -- Stef
2245 (dolist (ov (overlays-in (point-min) (point-max)))
2246 (when (overlay-get ov 'intangible)
2247 (overlay-put ov 'intangible nil)))
2248 buffer))
2249
2250 (defun compilation-get-file-structure (file &optional fmt)
2251 "Retrieve FILE's file-structure or create a new one.
2252 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2253 In the former case, FILENAME may be relative or absolute.
2254
2255 The file-structure looks like this:
2256 (list (list FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2257 (or (gethash file compilation-locs)
2258 ;; File was not previously encountered, at least not in the form passed.
2259 ;; Let's normalize it and look again.
2260 (let ((filename (car file))
2261 ;; Get the specified directory from FILE.
2262 (spec-directory (if (cdr file)
2263 (file-truename (cdr file)))))
2264
2265 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2266 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2267 ;; buffer.)
2268 (when (and (boundp 'comint-file-name-prefix)
2269 (not (equal comint-file-name-prefix "")))
2270 (if (file-name-absolute-p filename)
2271 (setq filename
2272 (concat comint-file-name-prefix filename))
2273 (if spec-directory
2274 (setq spec-directory
2275 (file-truename
2276 (concat comint-file-name-prefix spec-directory))))))
2277
2278 ;; If compilation-parse-errors-filename-function is
2279 ;; defined, use it to process the filename.
2280 (when compilation-parse-errors-filename-function
2281 (setq filename
2282 (funcall compilation-parse-errors-filename-function
2283 filename)))
2284
2285 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2286 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2287 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2288 ;; the appropriate file. So we look for doubled slashes in the file
2289 ;; name and fix them.
2290 (setq filename (command-line-normalize-file-name filename))
2291
2292 ;; Store it for the possibly unnormalized name
2293 (puthash file
2294 ;; Retrieve or create file-structure for normalized name
2295 ;; The gethash used to not use spec-directory, but
2296 ;; this leads to errors when files in different
2297 ;; directories have the same name:
2298 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2299 (or (gethash (cons filename spec-directory) compilation-locs)
2300 (puthash (cons filename spec-directory)
2301 (list (list filename spec-directory) fmt)
2302 compilation-locs))
2303 compilation-locs))))
2304
2305 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
2306
2307 ;;; Compatibility with the old compile.el.
2308
2309 (defun compile-buffer-substring (n) (if n (match-string n)))
2310
2311 (defun compilation-compat-error-properties (err)
2312 "Map old-style error ERR to new-style message."
2313 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2314 ;; (MARKER . MARKER).
2315 (let ((dst (cdr err)))
2316 (if (markerp dst)
2317 ;; Must start with a face, for font-lock.
2318 `(face nil
2319 message ,(list (list nil nil nil dst) 2)
2320 help-echo "mouse-2: visit the source location"
2321 keymap compilation-button-map
2322 mouse-face highlight)
2323 ;; Too difficult to do it by hand: dispatch to the normal code.
2324 (let* ((file (pop dst))
2325 (line (pop dst))
2326 (col (pop dst))
2327 (filename (pop file))
2328 (dirname (pop file))
2329 (fmt (pop file)))
2330 (compilation-internal-error-properties
2331 (cons filename dirname) line nil col nil 2 fmt)))))
2332
2333 (defun compilation-compat-parse-errors (limit)
2334 (when compilation-parse-errors-function
2335 ;; FIXME: We should remove the rest of the compilation keywords
2336 ;; but we can't do that from here because font-lock is using
2337 ;; the value right now. --stef
2338 (save-excursion
2339 (setq compilation-error-list nil)
2340 ;; Reset compilation-parsing-end each time because font-lock
2341 ;; might force us the re-parse many times (typically because
2342 ;; some code adds some text-property to the output that we
2343 ;; already parsed). You might say "why reparse", well:
2344 ;; because font-lock has just removed the `message' property so
2345 ;; have to do it all over again.
2346 (if compilation-parsing-end
2347 (set-marker compilation-parsing-end (point))
2348 (setq compilation-parsing-end (point-marker)))
2349 (condition-case nil
2350 ;; Ignore any error: we're calling this function earlier than
2351 ;; in the old compile.el so things might not all be setup yet.
2352 (funcall compilation-parse-errors-function limit nil)
2353 (error nil))
2354 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2355 (let* ((src (car err))
2356 (dst (cdr err))
2357 (loc (cond ((markerp dst) (list nil nil nil dst))
2358 ((consp dst)
2359 (list (nth 2 dst) (nth 1 dst)
2360 (cons (cdar dst) (caar dst)))))))
2361 (when loc
2362 (goto-char src)
2363 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
2364 (put-text-property src (line-end-position)
2365 'message (list loc 2)))))))
2366 (goto-char limit)
2367 nil)
2368
2369 ;; Beware: this is not only compatibility code. New code stil uses it. --Stef
2370 (defun compilation-forget-errors ()
2371 ;; In case we hit the same file/line specs, we want to recompute a new
2372 ;; marker for them, so flush our cache.
2373 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
2374 (setq compilation-gcpro nil)
2375 ;; FIXME: the old code reset the directory-stack, so maybe we should
2376 ;; put a `directory change' marker of some sort, but where? -stef
2377 ;;
2378 ;; FIXME: The old code moved compilation-current-error (which was
2379 ;; virtually represented by a mix of compilation-parsing-end and
2380 ;; compilation-error-list) to point-min, but that was only meaningful for
2381 ;; the internal uses of compilation-forget-errors: all calls from external
2382 ;; packages seem to be followed by a move of compilation-parsing-end to
2383 ;; something equivalent to point-max. So we heuristically move
2384 ;; compilation-current-error to point-max (since the external package
2385 ;; won't know that it should do it). --Stef
2386 (setq compilation-current-error nil)
2387 (let* ((proc (get-buffer-process (current-buffer)))
2388 (mark (if proc (process-mark proc)))
2389 (pos (or mark (point-max))))
2390 (setq compilation-messages-start
2391 ;; In the future, ignore the text already present in the buffer.
2392 ;; Since many process filter functions insert before markers,
2393 ;; we need to put ours just before the insertion point rather
2394 ;; than at the insertion point. If that's not possible, then
2395 ;; don't use a marker. --Stef
2396 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2397 ;; Again, since this command is used in buffers that contain several
2398 ;; compilations, to set the beginning of "this compilation", it's a good
2399 ;; place to reset compilation-auto-jump-to-next.
2400 (set (make-local-variable 'compilation-auto-jump-to-next)
2401 (or compilation-auto-jump-to-first-error
2402 (eq compilation-scroll-output 'first-error))))
2403
2404 ;;;###autoload
2405 (add-to-list 'auto-mode-alist (cons (purecopy "\\.gcov\\'") 'compilation-mode))
2406
2407 (provide 'compile)
2408
2409 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
2410 ;;; compile.el ends here