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