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