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