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