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