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