(The Buffer List): Clarify the manipulation of the buffer list.
[bpt/emacs.git] / lisp / progmodes / compile.el
CommitLineData
55535639 1;;; compile.el --- run compiler as inferior of Emacs, parse error messages
fad160d5 2
930a3e46 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
034babe1 4;; 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3a801d0c 5
7837c247
SM
6;; Authors: Roland McGrath <roland@gnu.org>,
7;; Daniel Pfeiffer <occitan@esperanto.org>
d1c7011d 8;; Maintainer: FSF
e9571d2a 9;; Keywords: tools, processes
d1c7011d 10
55dfd2c4
RS
11;; This file is part of GNU Emacs.
12
29add8b9
RM
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
15;; the Free Software Foundation; either version 2, or (at your option)
16;; any later version.
17
55dfd2c4 18;; GNU Emacs is distributed in the hope that it will be useful,
29add8b9
RM
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
b578f267 24;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
55dfd2c4 27
5cc57841
ER
28;;; Commentary:
29
7837c247
SM
30;; This package provides the compile facilities documented in the Emacs user's
31;; manual.
5cc57841 32
c536bb39 33;; This mode uses some complex data-structures:
7837c247 34
c536bb39 35;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
7837c247
SM
36
37;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
38;; LINE will be nil for a message that doesn't contain them. Then the
39;; location refers to a indented beginning of line or beginning of file.
40;; Once any location in some file has been jumped to, the list is extended to
41;; (COLUMN LINE FILE-STRUCTURE MARKER . VISITED) for all LOCs pertaining to
42;; that file.
43;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
44;; Being a marker it sticks to some text, when the buffer grows or shrinks
45;; before that point. VISITED is t if we have jumped there, else nil.
46
c536bb39
SM
47;; FILE-STRUCTURE is a list of
48;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
7837c247
SM
49
50;; FILENAME is a string parsed from an error message. DIRECTORY is a string
51;; obtained by following directory change messages. DIRECTORY will be nil for
52;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
53;; a file of that name can't be found.
54;; The rest of the list is an alist of elements with LINE as key. The keys
55;; are either nil or line numbers. If present, nil comes first, followed by
56;; the numbers in decreasing order. The LOCs for each line are again an alist
57;; ordered the same way. Note that the whole file structure is referenced in
58;; every LOC.
59
c536bb39 60;; MESSAGE is a list of (LOC TYPE END-LOC)
7837c247
SM
61
62;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
63;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
64;; other end, if the parsed message contained a range. If the end of the
65;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
66;; These are the value of the `message' text-properties in the compilation
67;; buffer.
68
24299582
DP
69;;; Code:
70
583a15bb
SM
71(eval-when-compile (require 'cl))
72
c5049fa0
RS
73(defgroup compilation nil
74 "Run compiler as inferior of Emacs, parse error messages."
75 :group 'tools
76 :group 'processes)
77
78
7c163413 79;;;###autoload
c5049fa0 80(defcustom compilation-mode-hook nil
2894bd96 81 "*List of hook functions run by `compilation-mode' (see `run-mode-hooks')."
c5049fa0
RS
82 :type 'hook
83 :group 'compilation)
7c163413
RM
84
85;;;###autoload
c5049fa0
RS
86(defcustom compilation-window-height nil
87 "*Number of lines in a compilation window. If nil, use Emacs default."
88 :type '(choice (const :tag "Default" nil)
89 integer)
90 :group 'compilation)
d3cb357b 91
7837c247
SM
92(defvar compilation-first-column 1
93 "*This is how compilers number the first column, usually 1 or 0.")
55dfd2c4 94
e335e194
GM
95(defvar compilation-parse-errors-filename-function nil
96 "Function to call to post-process filenames while parsing error messages.
97It takes one arg FILENAME which is the name of a file as found
98in the compilation output, and should return a transformed file name.")
99
49683a13
EZ
100;;;###autoload
101(defvar compilation-process-setup-function nil
102 "*Function to call to customize the compilation process.
6f5b7627 103This function is called immediately before the compilation process is
49683a13 104started. It can be used to set any variables or functions that are used
9ac57479
KS
105while processing the output of the compilation process. The function
106is called with variables `compilation-buffer' and `compilation-window'
7837c247 107bound to the compilation buffer and window, respectively.")
49683a13 108
aa228418 109;;;###autoload
d3cb357b 110(defvar compilation-buffer-name-function nil
6c43f2f9
RS
111 "Function to compute the name of a compilation buffer.
112The function receives one argument, the name of the major mode of the
113compilation buffer. It should return a string.
114nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
55dfd2c4 115
aa228418 116;;;###autoload
d3cb357b 117(defvar compilation-finish-function nil
c5049fa0 118 "Function to call when a compilation process finishes.
d3cb357b 119It is called with two arguments: the compilation buffer, and a string
620d3304 120describing how the process finished.")
3c9e7f42
RS
121
122(make-obsolete-variable 'compilation-finish-function
123 "Use `compilation-finish-functions', but it works a little differently."
124 "22.1")
55dfd2c4 125
4cc36b17
RS
126;;;###autoload
127(defvar compilation-finish-functions nil
c5049fa0 128 "Functions to call when a compilation process finishes.
4cc36b17
RS
129Each function is called with two arguments: the compilation buffer,
130and a string describing how the process finished.")
131
ebff767c
RM
132(defvar compilation-in-progress nil
133 "List of compilation processes now running.")
134(or (assq 'compilation-in-progress minor-mode-alist)
135 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
136 minor-mode-alist)))
137
7837c247
SM
138(defvar compilation-error "error"
139 "Stem of message to print when no matches are found.")
6c43f2f9 140
58856335 141(defvar compilation-arguments nil
7837c247 142 "Arguments that were given to `compilation-start'.")
58856335 143
6c43f2f9 144(defvar compilation-num-errors-found)
d3cb357b 145
7837c247
SM
146(defconst compilation-error-regexp-alist-alist
147 '((absoft
148 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
149of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
5dfa3d35 150
7837c247
SM
151 (ada
152 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
c7c5bbc0 153
7837c247
SM
154 (aix
155 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
e1f540f2 156
7837c247
SM
157 (ant
158 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
159\\( warning\\)?" 1 2 3 (4))
e1f540f2 160
7837c247
SM
161 (bash
162 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
e1f540f2 163
7837c247
SM
164 (borland
165 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
166\\([a-zA-Z]?:?[^:( \t\n]+\\)\
167 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
168
169 (caml
f6164cdd
DP
170 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
171\\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
172 2 (3 . 4) (5 . 6) (7))
7837c247
SM
173
174 (comma
175 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
176\\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
177
c39bf546
DP
178 (edg-1
179 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
180 1 2 nil (3 . 4))
181 (edg-2
182 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
183 2 1 nil 0)
184
7837c247 185 (epc
c39bf546 186 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
7837c247 187
12221c84
DP
188 (ftnchek
189 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
190 4 2 3 (1))
9fcabe79 191
7837c247
SM
192 (iar
193 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
194 1 2 nil (3))
195
196 (ibm
197 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
198 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
199
6f5b7627 200 ;; fixme: should be `mips'
7837c247 201 (irix
9fcabe79
DP
202 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
203\\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
7837c247
SM
204
205 (java
206 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
207
208 (jikes-file
209 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
210 (jikes-line
211 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
212 nil 1 nil 2 0
213 (2 (compilation-face '(3))))
214
215 (gcc-include
216 "^\\(?:In file included\\| \\) from \
217\\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
218
219 (gnu
6f5b7627 220 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
b3ef54c5 221\\([/.]*[a-zA-Z]:?[^ \t\n:]*\\|{standard input}\\): ?\
7837c247
SM
222\\([0-9]+\\)\\([.:]?\\)\\([0-9]+\\)?\
223\\(?:-\\(?:\\([0-9]+\\)\\3\\)?\\.?\\([0-9]+\\)?\\)?:\
224\\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
225 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\)\\)?"
226 1 (2 . 5) (4 . 6) (7 . 8))
227
228 (lcc
229 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
230 2 3 4 (1))
231
232 (makepp
0cb687c0 233 "^makepp: \\(?:\\(?:warning\\(:\\).*?\\|\\(Scanning\\|[LR]e?l?oading makefile\\) \\|.*?\\)\
3b79dd20 234`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
7837c247 235 4 5 nil (1 . 2) 3
3b79dd20 236 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil
7837c247
SM
237 (2 compilation-info-face)
238 (3 compilation-line-face nil t)
51c8ad03 239 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
7837c247
SM
240 append)))
241
6f5b7627 242 ;; Should be lint-1, lint-2 (SysV lint)
7837c247
SM
243 (mips-1
244 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
245 (mips-2
246 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
247
248 (msft
28547c1f 249 "^\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
2a516a73 250: \\(?:error\\|warnin\\(g\\)\\) C[0-9]+:" 2 3 nil (4))
7837c247
SM
251
252 (oracle
b3ef54c5
DP
253 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
254\\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
255\\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
7837c247 256 3 1 2)
40d63d1f 257
7837c247
SM
258 (perl
259 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\)" 1 2)
260
261 (rxp
262 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
263 \\([0-9]+\\) of file://\\(.+\\)"
264 4 2 3 (1))
265
266 (sparc-pascal-file
267 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
268 [12][09][0-9][0-9] +\\(.*\\):$"
269 1 nil nil 0)
270 (sparc-pascal-line
271 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
272 nil 3 nil (2) nil (1 (compilation-face '(2))))
273 (sparc-pascal-example
274 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
275 nil 1 nil (3) nil (2 (compilation-face '(3))))
276
277 (sun
6f5b7627 278 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
7837c247
SM
279File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
280 3 4 5 (1 . 2))
281
282 (sun-ada
283 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
284
7837c247
SM
285 (4bsd
286 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
0c9a01ff
MY
287\\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
288
289 (gcov-file
290 "^ +-: \\(0\\):Source:\\(.+\\)$" 2 1 nil 0)
291 (gcov-bb-file
292 "^ +-: \\(0\\):Object:\\(?:.+\\)$" nil 1 nil 0)
293 (gcov-never-called-line
294 "^ +\\(#####\\): +\\([0-9]+\\):.+$" nil 2 nil 2 nil
295 (1 compilation-error-face))
296 (gcov-called-line
297 "^ +[-0-9]+: +\\([1-9]\\|[0-9]\\{2,\\}\\):.*$" nil 1 nil 0)
298)
7837c247
SM
299 "Alist of values for `compilation-error-regexp-alist'.")
300
301(defcustom compilation-error-regexp-alist
302 (mapcar 'car compilation-error-regexp-alist-alist)
6c43f2f9 303 "Alist that specifies how to match errors in compiler output.
6f5b7627 304Note that on Unix everything is a valid filename, so these
7837c247
SM
305matchers must make some common sense assumptions, which catch
306normal cases. A shorter list will be lighter on resource usage.
307
308Instead of an alist element, you can use a symbol, which is
309looked up in `compilation-error-regexp-alist-alist'. You can see
310the predefined symbols and their effects in the file
6f5b7627 311`etc/compilation.txt' (linked below if you are customizing this).
7837c247
SM
312
313Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
314HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
315gives the file name, and the LINE'th subexpression gives the line
316number. The COLUMN'th subexpression gives the column number on
317that line.
318
319If FILE, LINE or COLUMN are nil or that index didn't match, that
320information is not present on the matched line. In that case the
321file name is assumed to be the same as the previous one in the
322buffer, line number defaults to 1 and column defaults to
323beginning of line's indentation.
324
325FILE can also have the form (FILE FORMAT...), where the FORMATs
326\(e.g. \"%s.c\") will be applied in turn to the recognized file
327name, until a file of that name is found. Or FILE can also be a
328function to return the filename.
329
330LINE can also be of the form (LINE . END-LINE) meaning a range
331of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
332meaning a range of columns starting on LINE and ending on
333END-LINE, if that matched.
334
335TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
336TYPE can also be of the form (WARNING . INFO). In that case this
337will be equivalent to 1 if the WARNING'th subexpression matched
338or else equivalent to 0 if the INFO'th subexpression matched.
339See `compilation-error-face', `compilation-warning-face',
340`compilation-info-face' and `compilation-skip-threshold'.
341
342What matched the HYPERLINK'th subexpression has `mouse-face' and
343`compilation-message-face' applied. If this is nil, the text
344matched by the whole REGEXP becomes the hyperlink.
345
346Additional HIGHLIGHTs as described under `font-lock-keywords' can
347be added."
348 :type `(set :menu-tag "Pick"
349 ,@(mapcar (lambda (elt)
350 (list 'const (car elt)))
351 compilation-error-regexp-alist-alist))
352 :link `(file-link :tag "example file"
eeb3ede4 353 ,(expand-file-name "compilation.txt" data-directory))
7837c247 354 :group 'compilation)
55dfd2c4 355
ebb8cb68
EZ
356(defvar compilation-directory nil
357 "Directory to restore to when doing `recompile'.")
358
7837c247
SM
359(defvar compilation-directory-matcher
360 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
361 "A list for tracking when directories are entered or left.
362Nil means not to track directories, e.g. if all file names are absolute. The
363first element is the REGEXP matching these messages. It can match any number
364of variants, e.g. different languages. The remaining elements are all of the
365form (DIR . LEAVE). If for any one of these the DIR'th subexpression
366matches, that is a directory name. If LEAVE is nil or the corresponding
367LEAVE'th subexpression doesn't match, this message is about going into another
368directory. If it does match anything, this message is about going back to the
369directory we were in before the last entering message. If you change this,
370you may also want to change `compilation-page-delimiter'.")
371
372(defvar compilation-page-delimiter
373 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
374 "Value of `page-delimiter' in Compilation mode.")
375
376(defvar compilation-mode-font-lock-keywords
377 '(;; configure output lines.
378 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
379 (1 font-lock-variable-name-face)
38dbf92b 380 (2 (compilation-face '(4 . 3))))
7837c247 381 ;; Command output lines. Recognize `make[n]:' lines too.
6f5b7627 382 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
7837c247
SM
383 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
384 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
314b410b
JL
385 ("^Compilation \\(finished\\)"
386 (1 compilation-info-face))
387 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?"
388 (1 compilation-error-face)
389 (2 compilation-error-face nil t)))
7837c247
SM
390 "Additional things to highlight in Compilation mode.
391This gets tacked on the end of the generated expressions.")
a24770bc 392
9ac57479
KS
393(defvar compilation-highlight-regexp t
394 "Regexp matching part of visited source lines to highlight temporarily.
395Highlight entire line if t; don't highlight source lines if nil.")
396
397(defvar compilation-highlight-overlay nil
398 "Overlay used to temporarily highlight compilation matches.")
399
f8e03ecb
AS
400(defcustom compilation-error-screen-columns t
401 "*If non-nil, column numbers in error messages are screen columns.
402Otherwise they are interpreted as character positions, with
403each character occupying one column.
404The default is to use screen columns, which requires that the compilation
405program and Emacs agree about the display width of the characters,
406especially the TAB character."
407 :type 'boolean
408 :group 'compilation
409 :version "20.4")
410
c5049fa0 411(defcustom compilation-read-command t
851231e9
DL
412 "*Non-nil means \\[compile] reads the compilation command to use.
413Otherwise, \\[compile] just uses the value of `compile-command'."
c5049fa0
RS
414 :type 'boolean
415 :group 'compilation)
90016295 416
e83be080 417;;;###autoload
c5049fa0 418(defcustom compilation-ask-about-save t
851231e9 419 "*Non-nil means \\[compile] asks which buffers to save before compiling.
c5049fa0
RS
420Otherwise, it saves all modified buffers without asking."
421 :type 'boolean
422 :group 'compilation)
90016295 423
7c163413 424;;;###autoload
c5049fa0 425(defcustom compilation-search-path '(nil)
7c163413 426 "*List of directories to search for source files named in error messages.
d3cb357b 427Elements should be directory names, not file names of directories.
c5049fa0
RS
428nil as an element means to try the default directory."
429 :type '(repeat (choice (const :tag "Default" nil)
430 (string :tag "Directory")))
431 :group 'compilation)
55dfd2c4 432
c5049fa0
RS
433(defcustom compile-command "make -k "
434 "*Last shell command used to do a compilation; default for next compilation.
55dfd2c4
RS
435
436Sometimes it is useful for files to supply local values for this variable.
437You might also use mode hooks to specify it in certain modes, like this:
438
61c4aaf8 439 (add-hook 'c-mode-hook
61c4aaf8
RS
440 (lambda ()
441 (unless (or (file-exists-p \"makefile\")
442 (file-exists-p \"Makefile\"))
5b6858da
SM
443 (set (make-local-variable 'compile-command)
444 (concat \"make -k \"
7837c247 445 (file-name-sans-extension buffer-file-name))))))"
c5049fa0
RS
446 :type 'string
447 :group 'compilation)
55dfd2c4 448
7837c247
SM
449;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
450;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
451;; key. This holds the tree seen from root, for storing new nodes.
452(defvar compilation-locs ())
453
454(defvar compilation-debug nil
6f5b7627 455 "*Set this to t before creating a *compilation* buffer.
7837c247
SM
456Then every error line will have a debug text property with the matcher that
457fit this line and the match data. Use `describe-text-properties'.")
d3cb357b 458
01f89d11
RM
459(defvar compilation-exit-message-function nil "\
460If non-nil, called when a compilation process dies to return a status message.
fd5e58d7
RM
461This should be a function of three arguments: process status, exit status,
462and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
463write into the compilation buffer, and to put in its mode line.")
01f89d11 464
c20f961b
JPW
465(defvar compilation-environment nil
466 "*List of environment variables for compilation to inherit.
467Each element should be a string of the form ENVVARNAME=VALUE.
468This list is temporarily prepended to `process-environment' prior to
469starting the compilation process.")
470
770970cb
RS
471;; History of compile commands.
472(defvar compile-history nil)
770970cb 473
fa947ef3
JL
474(defface compilation-error
475 '((t :inherit font-lock-warning-face))
476 "Face used to highlight compiler errors."
477 :group 'font-lock-highlighting-faces
478 :version "22.1")
479
541a6d0d 480(defface compilation-warning
bc3621a0
EZ
481 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
482 (((class color)) (:foreground "cyan" :weight bold))
7837c247
SM
483 (t (:weight bold)))
484 "Face used to highlight compiler warnings."
f6164cdd 485 :group 'font-lock-highlighting-faces
bf247b6e 486 :version "22.1")
7837c247 487
541a6d0d 488(defface compilation-info
e4aa3c94 489 '((((class color) (min-colors 16) (background light))
bc3621a0 490 (:foreground "Green3" :weight bold))
ea81d57e
DN
491 (((class color) (min-colors 88) (background dark))
492 (:foreground "Green1" :weight bold))
e4aa3c94 493 (((class color) (min-colors 16) (background dark))
bc3621a0
EZ
494 (:foreground "Green" :weight bold))
495 (((class color)) (:foreground "green" :weight bold))
7837c247 496 (t (:weight bold)))
fa947ef3 497 "Face used to highlight compiler information."
f6164cdd 498 :group 'font-lock-highlighting-faces
bf247b6e 499 :version "22.1")
7837c247 500
a5f1c37e 501(defface compilation-line-number
38dbf92b 502 '((t :inherit font-lock-variable-name-face))
fa947ef3 503 "Face for displaying line numbers in compiler messages."
a5f1c37e
RS
504 :group 'font-lock-highlighting-faces
505 :version "22.1")
506
507(defface compilation-column-number
38dbf92b 508 '((t :inherit font-lock-type-face))
fa947ef3 509 "Face for displaying column numbers in compiler messages."
a5f1c37e
RS
510 :group 'font-lock-highlighting-faces
511 :version "22.1")
512
38dbf92b 513(defvar compilation-message-face 'underline
7837c247
SM
514 "Face name to use for whole messages.
515Faces `compilation-error-face', `compilation-warning-face',
516`compilation-info-face', `compilation-line-face' and
517`compilation-column-face' get prepended to this, when applicable.")
518
38dbf92b 519(defvar compilation-error-face 'compilation-error
7837c247
SM
520 "Face name to use for file name in error messages.")
521
38dbf92b 522(defvar compilation-warning-face 'compilation-warning
7837c247
SM
523 "Face name to use for file name in warning messages.")
524
38dbf92b 525(defvar compilation-info-face 'compilation-info
7837c247
SM
526 "Face name to use for file name in informational messages.")
527
a5f1c37e 528(defvar compilation-line-face 'compilation-line-number
38dbf92b 529 "Face name to use for line numbers in compiler messages.")
7837c247 530
a5f1c37e 531(defvar compilation-column-face 'compilation-column-number
fa947ef3 532 "Face name to use for column numbers in compiler messages.")
7837c247
SM
533
534;; same faces as dired uses
535(defvar compilation-enter-directory-face 'font-lock-function-name-face
fa947ef3 536 "Face name to use for entering directory messages.")
7837c247
SM
537
538(defvar compilation-leave-directory-face 'font-lock-type-face
fa947ef3 539 "Face name to use for leaving directory messages.")
7837c247
SM
540
541
542
c536bb39 543;; Used for compatibility with the old compile.el.
0ff7f01e 544(defvaralias 'compilation-last-buffer 'next-error-last-buffer)
6f5b7627 545(defvar compilation-parsing-end (make-marker))
c536bb39
SM
546(defvar compilation-parse-errors-function nil)
547(defvar compilation-error-list nil)
548(defvar compilation-old-error-list nil)
549
7837c247
SM
550(defun compilation-face (type)
551 (or (and (car type) (match-end (car type)) compilation-warning-face)
552 (and (cdr type) (match-end (cdr type)) compilation-info-face)
553 compilation-error-face))
554
deda0c65
DP
555;; Internal function for calculating the text properties of a directory
556;; change message. The directory property is important, because it is
557;; the stack of nested enter-messages. Relative filenames on the following
558;; lines are relative to the top of the stack.
7837c247
SM
559(defun compilation-directory-properties (idx leave)
560 (if leave (setq leave (match-end leave)))
561 ;; find previous stack, and push onto it, or if `leave' pop it
562 (let ((dir (previous-single-property-change (point) 'directory)))
563 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
564 (get-text-property dir 'directory))))
565 `(face ,(if leave
566 compilation-leave-directory-face
567 compilation-enter-directory-face)
568 directory ,(if leave
569 (or (cdr dir)
570 '(nil)) ; nil only isn't a property-change
571 (cons (match-string-no-properties idx) dir))
572 mouse-face highlight
6f5b7627 573 keymap compilation-button-map
7837c247
SM
574 help-echo "mouse-2: visit current directory")))
575
576;; Data type `reverse-ordered-alist' retriever. This function retrieves the
577;; KEY element from the ALIST, creating it in the right position if not already
578;; present. ALIST structure is
579;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
580;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
581;; may be nil. The other KEYs are ordered backwards so that growing line
582;; numbers can be inserted in front and searching can abort after half the
583;; list on average.
6f5b7627 584(eval-when-compile ;Don't keep it at runtime if not needed.
7837c247
SM
585(defmacro compilation-assq (key alist)
586 `(let* ((l1 ,alist)
587 (l2 (cdr l1)))
588 (car (if (if (null ,key)
589 (if l2 (null (caar l2)))
590 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
591 (setq l1 l2
592 l2 (cdr l1)))
593 (if l2 (eq ,key (caar l2))))
594 l2
6f5b7627 595 (setcdr l1 (cons (list ,key) l2)))))))
7837c247
SM
596
597
598;; This function is the central driver, called when font-locking to gather
599;; all information needed to later jump to corresponding source code.
600;; Return a property list with all meta information on this error location.
601(defun compilation-error-properties (file line end-line col end-col type fmt)
602 (unless (< (next-single-property-change (match-beginning 0) 'directory nil (point))
603 (point))
604 (if file
605 (if (functionp file)
606 (setq file (funcall file))
607 (let (dir)
608 (setq file (match-string-no-properties file))
609 (unless (file-name-absolute-p file)
610 (setq dir (previous-single-property-change (point) 'directory)
611 dir (if dir (or (get-text-property (1- dir) 'directory)
612 (get-text-property dir 'directory)))))
efb0e677 613 (setq file (cons file (car dir)))))
7837c247
SM
614 ;; This message didn't mention one, get it from previous
615 (setq file (previous-single-property-change (point) 'message)
616 file (or (if file
efb0e677
SM
617 (car (nth 2 (car (or (get-text-property (1- file) 'message)
618 (get-text-property file 'message))))))
619 '("*unknown*"))))
7837c247
SM
620 ;; All of these fields are optional, get them only if we have an index, and
621 ;; it matched some part of the message.
622 (and line
623 (setq line (match-string-no-properties line))
624 (setq line (string-to-number line)))
625 (and end-line
626 (setq end-line (match-string-no-properties end-line))
627 (setq end-line (string-to-number end-line)))
9dc3a46a
JL
628 (if col
629 (if (functionp col)
630 (setq col (funcall col))
631 (and
632 (setq col (match-string-no-properties col))
633 (setq col (- (string-to-number col) compilation-first-column)))))
634 (if (and end-col (functionp end-col))
635 (setq end-col (funcall end-col))
636 (if (and end-col (setq end-col (match-string-no-properties end-col)))
637 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
638 (if end-line (setq end-col -1))))
eb6fb6e2 639 (if (consp type) ; not a static type, check what it is.
7837c247
SM
640 (setq type (or (and (car type) (match-end (car type)) 1)
641 (and (cdr type) (match-end (cdr type)) 0)
642 2)))
efb0e677
SM
643 (compilation-internal-error-properties file line end-line col end-col type fmt)))
644
9c8e6c85
SM
645(defun compilation-move-to-column (col screen)
646 "Go to column COL on the current line.
647If SCREEN is non-nil, columns are screen columns, otherwise, they are
648just char-counts."
649 (if screen
650 (move-to-column col)
651 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
652
efb0e677
SM
653(defun compilation-internal-error-properties (file line end-line col end-col type fmt)
654 "Get the meta-info that will be added as text-properties.
655LINE, END-LINE, COL, END-COL are integers or nil.
656TYPE can be 0, 1, or 2.
dbd97672 657FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil."
efb0e677 658 (unless file (setq file '("*unknown*")))
dbd97672 659 (setq file (compilation-get-file-structure file fmt))
efb0e677
SM
660 ;; Get first already existing marker (if any has one, all have one).
661 ;; Do this first, as the compilation-assq`s may create new nodes.
662 (let* ((marker-line (car (cddr file))) ; a line structure
663 (marker (nth 3 (cadr marker-line))) ; its marker
664 (compilation-error-screen-columns compilation-error-screen-columns)
665 end-marker loc end-loc)
666 (if (not (and marker (marker-buffer marker)))
667 (setq marker) ; no valid marker for this file
dbd97672
DP
668 (setq loc (or line 1)) ; normalize no linenumber to line 1
669 (catch 'marker ; find nearest loc, at least one exists
670 (dolist (x (nthcdr 3 file)) ; loop over remaining lines
671 (if (> (car x) loc) ; still bigger
efb0e677 672 (setq marker-line x)
dbd97672
DP
673 (if (> (- (or (car marker-line) 1) loc)
674 (- loc (car x))) ; current line is nearer
efb0e677
SM
675 (setq marker-line x))
676 (throw 'marker t))))
677 (setq marker (nth 3 (cadr marker-line))
dbd97672 678 marker-line (or (car marker-line) 1))
efb0e677
SM
679 (with-current-buffer (marker-buffer marker)
680 (save-restriction
681 (widen)
682 (goto-char (marker-position marker))
683 (when (or end-col end-line)
684 (beginning-of-line (- (or end-line line) marker-line -1))
930a3e46 685 (if (or (null end-col) (< end-col 0))
efb0e677 686 (end-of-line)
9c8e6c85
SM
687 (compilation-move-to-column
688 end-col compilation-error-screen-columns))
efb0e677
SM
689 (setq end-marker (list (point-marker))))
690 (beginning-of-line (if end-line
930a3e46 691 (- line end-line -1)
efb0e677
SM
692 (- loc marker-line -1)))
693 (if col
9c8e6c85
SM
694 (compilation-move-to-column
695 col compilation-error-screen-columns)
efb0e677
SM
696 (forward-to-indentation 0))
697 (setq marker (list (point-marker))))))
698
699 (setq loc (compilation-assq line (cdr file)))
700 (if end-line
701 (setq end-loc (compilation-assq end-line (cdr file))
702 end-loc (compilation-assq end-col end-loc))
703 (if end-col ; use same line element
704 (setq end-loc (compilation-assq end-col loc))))
705 (setq loc (compilation-assq col loc))
706 ;; If they are new, make the loc(s) reference the file they point to.
707 (or (cdr loc) (setcdr loc `(,line ,file ,@marker)))
708 (if end-loc
709 (or (cdr end-loc) (setcdr end-loc `(,(or end-line line) ,file ,@end-marker))))
710
711 ;; Must start with face
712 `(face ,compilation-message-face
713 message (,loc ,type ,end-loc)
714 ,@(if compilation-debug
715 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
716 ,@(match-data))))
717 help-echo ,(if col
718 "mouse-2: visit this file, line and column"
719 (if line
720 "mouse-2: visit this file and line"
721 "mouse-2: visit this file"))
722 keymap compilation-button-map
723 mouse-face highlight)))
7837c247 724
e93b2a55
SM
725(defun compilation-mode-font-lock-keywords ()
726 "Return expressions to highlight in Compilation mode."
91fa27cd
SM
727 (if compilation-parse-errors-function
728 ;; An old package! Try the compatibility code.
729 '((compilation-compat-parse-errors))
730 (append
731 ;; make directory tracking
732 (if compilation-directory-matcher
733 `((,(car compilation-directory-matcher)
734 ,@(mapcar (lambda (elt)
735 `(,(car elt)
736 (compilation-directory-properties
737 ,(car elt) ,(cdr elt))
0ea50e43 738 t t))
91fa27cd
SM
739 (cdr compilation-directory-matcher)))))
740
741 ;; Compiler warning/error lines.
742 (mapcar
743 (lambda (item)
744 (if (symbolp item)
745 (setq item (cdr (assq item
746 compilation-error-regexp-alist-alist))))
747 (let ((file (nth 1 item))
748 (line (nth 2 item))
749 (col (nth 3 item))
750 (type (nth 4 item))
751 end-line end-col fmt)
b3a7f48f
DP
752 (if (consp file) (setq fmt (cdr file) file (car file)))
753 (if (consp line) (setq end-line (cdr line) line (car line)))
91fa27cd 754 (if (consp col) (setq end-col (cdr col) col (car col)))
b3a7f48f 755
544dccaa 756 (if (functionp line)
91fa27cd
SM
757 ;; The old compile.el had here an undocumented hook that
758 ;; allowed `line' to be a function that computed the actual
759 ;; error location. Let's do our best.
760 `(,(car item)
0ea50e43
RS
761 (0 (save-match-data
762 (compilation-compat-error-properties
763 (funcall ',line (cons (match-string ,file)
764 (cons default-directory
765 ',(nthcdr 4 item)))
766 ,(if col `(match-string ,col))))))
91fa27cd 767 (,file compilation-error-face t))
b3a7f48f 768
f71d34b0
SM
769 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
770 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
771
91fa27cd
SM
772 `(,(nth 0 item)
773
774 ,@(when (integerp file)
775 `((,file ,(if (consp type)
776 `(compilation-face ',type)
777 (aref [compilation-info-face
778 compilation-warning-face
779 compilation-error-face]
780 (or type 2))))))
781
782 ,@(when line
783 `((,line compilation-line-face nil t)))
784 ,@(when end-line
785 `((,end-line compilation-line-face nil t)))
786
9dc3a46a 787 ,@(when (integerp col)
91fa27cd 788 `((,col compilation-column-face nil t)))
9dc3a46a 789 ,@(when (integerp end-col)
91fa27cd
SM
790 `((,end-col compilation-column-face nil t)))
791
792 ,@(nthcdr 6 item)
793 (,(or (nth 5 item) 0)
794 (compilation-error-properties ',file ,line ,end-line
795 ,col ,end-col ',(or type 2)
796 ',fmt)
797 append))))) ; for compilation-message-face
798 compilation-error-regexp-alist)
799
800 compilation-mode-font-lock-keywords)))
7837c247 801
01f89d11 802\f
d3cb357b 803;;;###autoload
7837c247 804(defun compile (command &optional comint)
55dfd2c4
RS
805 "Compile the program including the current buffer. Default: run `make'.
806Runs COMMAND, a shell command, in a separate process asynchronously
807with output going to the buffer `*compilation*'.
d3cb357b 808
6f5b7627 809If optional second arg COMINT is t the buffer will be in Comint mode with
7837c247
SM
810`compilation-shell-minor-mode'.
811
55dfd2c4
RS
812You can then use the command \\[next-error] to find the next error message
813and move to the source code that caused it.
814
08b1edf4
RM
815Interactively, prompts for the command if `compilation-read-command' is
816non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
c39bf546
DP
817Additionally, with universal prefix arg, compilation buffer will be in
818comint mode, i.e. interactive.
08b1edf4 819
c72095b3
RS
820To run more than one compilation at once, start one and rename
821the \`*compilation*' buffer to some other name with
822\\[rename-buffer]. Then start the next one. On most systems,
823termination of the main compilation process kills its
824subprocesses.
d3cb357b
RM
825
826The name used for the buffer is actually whatever is returned by
827the function in `compilation-buffer-name-function', so you can set that
828to a function that generates a unique name."
90016295 829 (interactive
c39bf546 830 (list
20320c65
JL
831 (let ((command (eval compile-command)))
832 (if (or compilation-read-command current-prefix-arg)
833 (read-from-minibuffer "Compile command: "
834 command nil nil
835 (if (equal (car compile-history) command)
836 '(compile-history . 1)
837 'compile-history))
838 command))
c39bf546 839 (consp current-prefix-arg)))
5b6858da
SM
840 (unless (equal command (eval compile-command))
841 (setq compile-command command))
90016295 842 (save-some-buffers (not compilation-ask-about-save) nil)
ebb8cb68 843 (setq compilation-directory default-directory)
7837c247 844 (compilation-start command comint))
55dfd2c4 845
5b6858da 846;; run compile with the default command line
e60476ca 847(defun recompile ()
6867356a 848 "Re-compile the program including the current buffer.
6f5b7627
SM
849If this is run in a Compilation mode buffer, re-use the arguments from the
850original use. Otherwise, recompile using `compile-command'."
e60476ca
RS
851 (interactive)
852 (save-some-buffers (not compilation-ask-about-save) nil)
e4aa3c94
JL
853 (let ((default-directory
854 (or (and (not (eq major-mode (nth 1 compilation-arguments)))
855 compilation-directory)
856 default-directory)))
7837c247
SM
857 (apply 'compilation-start (or compilation-arguments
858 `(,(eval compile-command))))))
09843b4a 859
b5812513
DL
860(defcustom compilation-scroll-output nil
861 "*Non-nil to scroll the *compilation* buffer window as output appears.
862
6f5b7627 863Setting it causes the Compilation mode commands to put point at the
b5812513 864end of their output window so that the end of the output is always
6f5b7627 865visible rather than the beginning."
b5812513 866 :type 'boolean
a46fddeb 867 :version "20.3"
b5812513
DL
868 :group 'compilation)
869
7bdb67b2
GM
870
871(defun compilation-buffer-name (mode-name name-function)
872 "Return the name of a compilation buffer to use.
873If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
874to determine the buffer name.
875Likewise if `compilation-buffer-name-function' is non-nil.
876If current buffer is in Compilation mode for the same mode name
877return the name of the current buffer, so that it gets reused.
878Otherwise, construct a buffer name from MODE-NAME."
dc2feacf 879 (cond (name-function
7bdb67b2 880 (funcall name-function mode-name))
dc2feacf 881 (compilation-buffer-name-function
7bdb67b2 882 (funcall compilation-buffer-name-function mode-name))
e4aa3c94 883 ((eq major-mode (nth 1 compilation-arguments))
7bdb67b2
GM
884 (buffer-name))
885 (t
886 (concat "*" (downcase mode-name) "*"))))
887
7837c247
SM
888;; This is a rough emulation of the old hack, until the transition to new
889;; compile is complete.
55dfd2c4 890(defun compile-internal (command error-message
a24770bc
RS
891 &optional name-of-mode parser
892 error-regexp-alist name-function
893 enter-regexp-alist leave-regexp-alist
23b0c5fc 894 file-regexp-alist nomessage-regexp-alist
9ac57479 895 no-async highlight-regexp local-map)
7837c247
SM
896 (if parser
897 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
898 (let ((compilation-error-regexp-alist
899 (append file-regexp-alist (or error-regexp-alist
900 compilation-error-regexp-alist)))
901 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
902 "\\1" error-message)))
903 (compilation-start command nil name-function highlight-regexp)))
904(make-obsolete 'compile-internal 'compilation-start)
905
906(defun compilation-start (command &optional mode name-function highlight-regexp)
55dfd2c4 907 "Run compilation command COMMAND (low level interface).
489a8034 908If COMMAND starts with a cd command, that becomes the `default-directory'.
9ac57479
KS
909The rest of the arguments are optional; for them, nil means use the default.
910
7837c247 911MODE is the major mode to set in the compilation buffer. Mode
6f5b7627 912may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
9ac57479 913NAME-FUNCTION is a function called to name the buffer.
23b0c5fc 914
9ac57479 915If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
6f5b7627 916the matching section of the visited source line; the default is to use the
9ac57479
KS
917global value of `compilation-highlight-regexp'.
918
646bd331 919Returns the compilation buffer created."
7837c247 920 (or mode (setq mode 'compilation-mode))
489a8034
DP
921 (let* ((name-of-mode
922 (if (eq mode t)
923 (prog1 "compilation" (require 'comint))
924 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
199143f1 925 (thisdir default-directory)
489a8034 926 outwin outbuf)
c536bb39
SM
927 (with-current-buffer
928 (setq outbuf
929 (get-buffer-create
930 (compilation-buffer-name name-of-mode name-function)))
d3cb357b
RM
931 (let ((comp-proc (get-buffer-process (current-buffer))))
932 (if comp-proc
933 (if (or (not (eq (process-status comp-proc) 'run))
934 (yes-or-no-p
bea1d57a
JB
935 (format "A %s process is running; kill it? "
936 name-of-mode)))
d3cb357b
RM
937 (condition-case ()
938 (progn
939 (interrupt-process comp-proc)
940 (sit-for 1)
941 (delete-process comp-proc))
942 (error nil))
943 (error "Cannot have two processes in `%s' at once"
7837c247 944 (buffer-name)))))
7837c247 945 (buffer-disable-undo (current-buffer))
199143f1
DP
946 ;; first transfer directory from where M-x compile was called
947 (setq default-directory thisdir)
d42c87ab
RS
948 ;; Make compilation buffer read-only. The filter can still write it.
949 ;; Clear out the compilation buffer.
199143f1
DP
950 (let ((inhibit-read-only t)
951 (default-directory thisdir))
952 ;; Then evaluate a cd command if any, but don't perform it yet, else start-command
953 ;; would do it again through the shell: (cd "..") AND sh -c "cd ..; make"
954 (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command)
955 (if (match-end 1)
12221c84 956 (substitute-env-vars (match-string 1 command))
199143f1
DP
957 "~")
958 default-directory))
abed5267 959 (erase-buffer)
6d2957c4
RS
960 ;; Select the desired mode.
961 (if (not (eq mode t))
962 (funcall mode)
963 (setq buffer-read-only nil)
964 (with-no-warnings (comint-mode))
965 (compilation-shell-minor-mode))
966 (if highlight-regexp
967 (set (make-local-variable 'compilation-highlight-regexp)
968 highlight-regexp))
6d2957c4 969 ;; Output a mode setter, for saving and later reloading this buffer.
d42c87ab
RS
970 (insert "-*- mode: " name-of-mode
971 "; default-directory: " (prin1-to-string default-directory)
a67e5425 972 " -*-\n"
314b410b
JL
973 (format "%s started at %s\n\n"
974 mode-name
975 (substring (current-time-string) 0 19))
a67e5425 976 command "\n")
abed5267 977 (setq thisdir default-directory))
7837c247
SM
978 (set-buffer-modified-p nil))
979 ;; If we're already in the compilation buffer, go to the end
980 ;; of the buffer, so point will track the compilation output.
981 (if (eq outbuf (current-buffer))
982 (goto-char (point-max)))
983 ;; Pop up the compilation buffer.
984 (setq outwin (display-buffer outbuf nil t))
985 (with-current-buffer outbuf
577bf5d2
JL
986 (let ((process-environment
987 (append
988 compilation-environment
989 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
990 system-uses-terminfo)
991 (list "TERM=dumb" "TERMCAP="
992 (format "COLUMNS=%d" (window-width)))
993 (list "TERM=emacs"
994 (format "TERMCAP=emacs:co#%d:tc=unknown:"
995 (window-width))))
996 ;; Set the EMACS variable, but
997 ;; don't override users' setting of $EMACS.
998 (unless (getenv "EMACS") '("EMACS=t"))
999 (copy-sequence process-environment))))
577bf5d2
JL
1000 (set (make-local-variable 'compilation-arguments)
1001 (list command mode name-function highlight-regexp))
1002 (set (make-local-variable 'revert-buffer-function)
1003 'compilation-revert-buffer)
1004 (set-window-start outwin (point-min))
1005 (or (eq outwin (selected-window))
1006 (set-window-point outwin (if compilation-scroll-output
1007 (point)
1008 (point-min))))
1009 ;; The setup function is called before compilation-set-window-height
1010 ;; so it can set the compilation-window-height buffer locally.
1011 (if compilation-process-setup-function
1012 (funcall compilation-process-setup-function))
1013 (compilation-set-window-height outwin)
1014 ;; Start the compilation.
1015 (if (fboundp 'start-process)
1016 (let ((proc (if (eq mode t)
1017 (get-buffer-process
1018 (with-no-warnings
1019 (comint-exec outbuf (downcase mode-name)
1020 shell-file-name nil `("-c" ,command))))
1021 (start-process-shell-command (downcase mode-name)
1022 outbuf command))))
1023 ;; Make the buffer's mode line show process state.
1024 (setq mode-line-process '(":%s"))
1025 (set-process-sentinel proc 'compilation-sentinel)
1026 (set-process-filter proc 'compilation-filter)
1027 (set-marker (process-mark proc) (point) outbuf)
1028 (setq compilation-in-progress
1029 (cons proc compilation-in-progress)))
1030 ;; No asynchronous processes available.
1031 (message "Executing `%s'..." command)
1032 ;; Fake modeline display as if `start-process' were run.
1033 (setq mode-line-process ":run")
1034 (force-mode-line-update)
1035 (sit-for 0) ; Force redisplay
cf63e6fa
EZ
1036 (let* ((buffer-read-only nil) ; call-process needs to modify outbuf
1037 (status (call-process shell-file-name nil outbuf nil "-c"
1038 command)))
577bf5d2
JL
1039 (cond ((numberp status)
1040 (compilation-handle-exit 'exit status
1041 (if (zerop status)
1042 "finished\n"
1043 (format "\
fd5e58d7 1044exited abnormally with code %d\n"
577bf5d2
JL
1045 status))))
1046 ((stringp status)
1047 (compilation-handle-exit 'signal status
1048 (concat status "\n")))
1049 (t
1050 (compilation-handle-exit 'bizarre status status))))
1051 ;; Without async subprocesses, the buffer is not yet
1052 ;; fontified, so fontify it now.
1053 (let ((font-lock-verbose nil)) ; shut up font-lock messages
1054 (font-lock-fontify-buffer))
cf63e6fa 1055 (set-buffer-modified-p nil)
199143f1
DP
1056 (message "Executing `%s'...done" command)))
1057 ;; Now finally cd to where the shell started make/grep/...
1058 (setq default-directory thisdir))
7837c247
SM
1059 (if (buffer-local-value 'compilation-scroll-output outbuf)
1060 (save-selected-window
1061 (select-window outwin)
043442b4
KS
1062 (goto-char (point-max))))
1063 ;; Make it so the next C-x ` will use this buffer.
5d9f0de2 1064 (setq next-error-last-buffer outbuf)))
55dfd2c4 1065
c94b02d6 1066(defun compilation-set-window-height (window)
851231e9 1067 "Set the height of WINDOW according to `compilation-window-height'."
9ac57479
KS
1068 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1069 (and height
1070 (= (window-width window) (frame-width (window-frame window)))
1071 ;; If window is alone in its frame, aside from a minibuffer,
1072 ;; don't change its height.
1073 (not (eq window (frame-root-window (window-frame window))))
b3ef54c5
DP
1074 ;; Stef said that doing the saves in this order is safer:
1075 (save-excursion
9ac57479 1076 (save-selected-window
b3ef54c5
DP
1077 (select-window window)
1078 (enlarge-window (- height (window-height))))))))
c94b02d6 1079
4282eba1
SM
1080(defvar compilation-menu-map
1081 (let ((map (make-sparse-keymap "Errors")))
1082 (define-key map [stop-subjob]
37bf89ab 1083 '("Stop Compilation" . kill-compilation))
4282eba1
SM
1084 (define-key map [compilation-mode-separator2]
1085 '("----" . nil))
9ac57479 1086 (define-key map [compilation-first-error]
4282eba1 1087 '("First Error" . first-error))
9ac57479 1088 (define-key map [compilation-previous-error]
4282eba1 1089 '("Previous Error" . previous-error))
9ac57479 1090 (define-key map [compilation-next-error]
4282eba1
SM
1091 '("Next Error" . next-error))
1092 map))
1093
0b18a8f6 1094(defvar compilation-minor-mode-map
55dfd2c4 1095 (let ((map (make-sparse-keymap)))
9da85ee5 1096 (define-key map [mouse-2] 'compile-goto-error)
0ac804df 1097 (define-key map [follow-link] 'mouse-face)
55dfd2c4 1098 (define-key map "\C-c\C-c" 'compile-goto-error)
4e7ce12e 1099 (define-key map "\C-m" 'compile-goto-error)
d3cb357b 1100 (define-key map "\C-c\C-k" 'kill-compilation)
646bd331
RM
1101 (define-key map "\M-n" 'compilation-next-error)
1102 (define-key map "\M-p" 'compilation-previous-error)
d1ed4475
RM
1103 (define-key map "\M-{" 'compilation-previous-file)
1104 (define-key map "\M-}" 'compilation-next-file)
4282eba1
SM
1105 ;; Set up the menu-bar
1106 (define-key map [menu-bar compilation]
1107 (cons "Errors" compilation-menu-map))
55dfd2c4 1108 map)
4f6e4ad6 1109 "Keymap for `compilation-minor-mode'.")
0b18a8f6 1110
a24770bc
RS
1111(defvar compilation-shell-minor-mode-map
1112 (let ((map (make-sparse-keymap)))
a24770bc
RS
1113 (define-key map "\M-\C-m" 'compile-goto-error)
1114 (define-key map "\M-\C-n" 'compilation-next-error)
1115 (define-key map "\M-\C-p" 'compilation-previous-error)
1116 (define-key map "\M-{" 'compilation-previous-file)
1117 (define-key map "\M-}" 'compilation-next-file)
1118 ;; Set up the menu-bar
4282eba1
SM
1119 (define-key map [menu-bar compilation]
1120 (cons "Errors" compilation-menu-map))
a24770bc
RS
1121 map)
1122 "Keymap for `compilation-shell-minor-mode'.")
1123
60470fd2
SM
1124(defvar compilation-button-map
1125 (let ((map (make-sparse-keymap)))
1126 (define-key map [mouse-2] 'compile-goto-error)
0ac804df 1127 (define-key map [follow-link] 'mouse-face)
60470fd2
SM
1128 (define-key map "\C-m" 'compile-goto-error)
1129 map)
1130 "Keymap for compilation-message buttons.")
1131(fset 'compilation-button-map compilation-button-map)
1132
0b18a8f6 1133(defvar compilation-mode-map
4282eba1 1134 (let ((map (make-sparse-keymap)))
261b01c6
RS
1135 ;; Don't inherit from compilation-minor-mode-map,
1136 ;; because that introduces a menu bar item we don't want.
1137 ;; That confuses C-down-mouse-3.
5988691b 1138 (define-key map [mouse-2] 'compile-goto-error)
0ac804df 1139 (define-key map [follow-link] 'mouse-face)
5988691b
RS
1140 (define-key map "\C-c\C-c" 'compile-goto-error)
1141 (define-key map "\C-m" 'compile-goto-error)
1142 (define-key map "\C-c\C-k" 'kill-compilation)
1143 (define-key map "\M-n" 'compilation-next-error)
1144 (define-key map "\M-p" 'compilation-previous-error)
1145 (define-key map "\M-{" 'compilation-previous-file)
1146 (define-key map "\M-}" 'compilation-next-file)
70fec115
JL
1147 (define-key map "\t" 'compilation-next-error)
1148 (define-key map [backtab] 'compilation-previous-error)
5988691b 1149
0b18a8f6
RM
1150 (define-key map " " 'scroll-up)
1151 (define-key map "\^?" 'scroll-down)
221206e3 1152 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
9ac57479 1153
e60476ca 1154 ;; Set up the menu-bar
5988691b
RS
1155 (let ((submap (make-sparse-keymap "Compile")))
1156 (define-key map [menu-bar compilation]
1157 (cons "Compile" submap))
1158 (set-keymap-parent submap compilation-menu-map))
4282eba1 1159 (define-key map [menu-bar compilation compilation-separator2]
e60476ca 1160 '("----" . nil))
9ac57479 1161 (define-key map [menu-bar compilation compilation-grep]
314b410b 1162 '("Search Files (grep)..." . grep))
9ac57479 1163 (define-key map [menu-bar compilation compilation-recompile]
e60476ca 1164 '("Recompile" . recompile))
9ac57479 1165 (define-key map [menu-bar compilation compilation-compile]
32f4ab17 1166 '("Compile..." . compile))
0b18a8f6
RM
1167 map)
1168 "Keymap for compilation log buffers.
4282eba1 1169`compilation-minor-mode-map' is a parent of this.")
55dfd2c4 1170
0a35bd79
RS
1171(put 'compilation-mode 'mode-class 'special)
1172
c536bb39
SM
1173(defvar compilation-skip-to-next-location t
1174 "*If non-nil, skip multiple error messages for the same source location.")
1175
1176(defcustom compilation-skip-threshold 1
1177 "*Compilation motion commands skip less important messages.
1178The value can be either 2 -- skip anything less than error, 1 --
1179skip anything less than warning or 0 -- don't skip any messages.
1180Note that all messages not positively identified as warning or
1181info, are considered errors."
1182 :type '(choice (const :tag "Warnings and info" 2)
1183 (const :tag "Info" 1)
1184 (const :tag "None" 0))
f6164cdd 1185 :group 'compilation
bf247b6e 1186 :version "22.1")
c536bb39
SM
1187
1188(defcustom compilation-skip-visited nil
1189 "*Compilation motion commands skip visited messages if this is t.
1190Visited messages are ones for which the file, line and column have been jumped
1191to from the current content in the current compilation buffer, even if it was
1192from a different message."
1193 :type 'boolean
f6164cdd 1194 :group 'compilation
bf247b6e 1195 :version "22.1")
c536bb39 1196
501cf428 1197;;;###autoload
d42c87ab 1198(defun compilation-mode (&optional name-of-mode)
55dfd2c4
RS
1199 "Major mode for compilation log buffers.
1200\\<compilation-mode-map>To visit the source for a line-numbered error,
d3cb357b 1201move point to the error message line and type \\[compile-goto-error].
7c163413
RM
1202To kill the compilation, type \\[kill-compilation].
1203
2894bd96 1204Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
8ff2ed52
RS
1205
1206\\{compilation-mode-map}"
55dfd2c4 1207 (interactive)
9af0d309 1208 (kill-all-local-variables)
55dfd2c4 1209 (use-local-map compilation-mode-map)
0b18a8f6 1210 (setq major-mode 'compilation-mode
d42c87ab 1211 mode-name (or name-of-mode "Compilation"))
7837c247
SM
1212 (set (make-local-variable 'page-delimiter)
1213 compilation-page-delimiter)
0b18a8f6 1214 (compilation-setup)
bd8c6db5 1215 (setq buffer-read-only t)
7837c247
SM
1216 (run-mode-hooks 'compilation-mode-hook))
1217
1218(defmacro define-compilation-mode (mode name doc &rest body)
1219 "This is like `define-derived-mode' without the PARENT argument.
1220The parent is always `compilation-mode' and the customizable `compilation-...'
1221variables are also set from the name of the mode you have chosen, by replacing
1222the fist word, e.g `compilation-scroll-output' from `grep-scroll-output' if that
1223variable exists."
1224 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1225 `(define-derived-mode ,mode compilation-mode ,name
1226 ,doc
1227 ,@(mapcar (lambda (v)
1228 (setq v (cons v
1229 (intern-soft (replace-regexp-in-string
1230 "^compilation" mode-name
1231 (symbol-name v)))))
1232 (and (cdr v)
1233 (or (boundp (cdr v))
1234 (if (boundp 'byte-compile-bound-variables)
1235 (memq (cdr v) byte-compile-bound-variables)))
1236 `(set (make-local-variable ',(car v)) ,(cdr v))))
1237 '(compilation-buffer-name-function
1238 compilation-directory-matcher
1239 compilation-error
1240 compilation-error-regexp-alist
1241 compilation-error-regexp-alist-alist
1242 compilation-error-screen-columns
1243 compilation-finish-function
1244 compilation-finish-functions
1245 compilation-first-column
1246 compilation-mode-font-lock-keywords
1247 compilation-page-delimiter
1248 compilation-parse-errors-filename-function
1249 compilation-process-setup-function
1250 compilation-scroll-output
1251 compilation-search-path
1252 compilation-skip-threshold
1253 compilation-window-height))
1254 ,@body)))
0b18a8f6 1255
58856335 1256(defun compilation-revert-buffer (ignore-auto noconfirm)
9ed2ab9f
RS
1257 (if buffer-file-name
1258 (let (revert-buffer-function)
9ac57479 1259 (revert-buffer ignore-auto noconfirm))
9ed2ab9f 1260 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
7837c247
SM
1261 (apply 'compilation-start compilation-arguments))))
1262
c536bb39
SM
1263(defvar compilation-current-error nil
1264 "Marker to the location from where the next error will be found.
1265The global commands next/previous/first-error/goto-error use this.")
51c8ad03 1266
9b7b51a2
SM
1267(defvar compilation-messages-start nil
1268 "Buffer position of the beginning of the compilation messages.
1269If nil, use the beginning of buffer.")
1270
7837c247
SM
1271;; A function name can't be a hook, must be something with a value.
1272(defconst compilation-turn-on-font-lock 'turn-on-font-lock)
58856335 1273
7837c247 1274(defun compilation-setup (&optional minor)
6f5b7627
SM
1275 "Prepare the buffer for the compilation parsing commands to work.
1276Optional argument MINOR indicates this is called from
1277`compilation-minor-mode'."
51c8ad03 1278 (make-local-variable 'compilation-current-error)
9b7b51a2 1279 (make-local-variable 'compilation-messages-start)
18aac618 1280 (make-local-variable 'compilation-error-screen-columns)
b3a7f48f 1281 (make-local-variable 'overlay-arrow-position)
8b71e4d1 1282 (set (make-local-variable 'overlay-arrow-string) "")
6a1cdc5b
JL
1283 (setq next-error-overlay-arrow-position nil)
1284 (add-hook 'kill-buffer-hook
1285 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
9b7b51a2
SM
1286 ;; Note that compilation-next-error-function is for interfacing
1287 ;; with the next-error function in simple.el, and it's only
1288 ;; coincidentally named similarly to compilation-next-error.
1289 (setq next-error-function 'compilation-next-error-function)
7837c247
SM
1290 (set (make-local-variable 'font-lock-extra-managed-props)
1291 '(directory message help-echo mouse-face debug))
1292 (set (make-local-variable 'compilation-locs)
1293 (make-hash-table :test 'equal :weakness 'value))
6f5b7627 1294 ;; lazy-lock would never find the message unless it's scrolled to.
c536bb39
SM
1295 ;; jit-lock might fontify some things too late.
1296 (set (make-local-variable 'font-lock-support-mode) nil)
7837c247 1297 (set (make-local-variable 'font-lock-maximum-size) nil)
f6164cdd
DP
1298 (let ((fld font-lock-defaults))
1299 (if (and minor fld)
1300 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1301 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t)))
1302 (if minor
1303 (if font-lock-mode
1304 (if fld
1305 (font-lock-fontify-buffer)
1306 (font-lock-change-mode)
1307 (turn-on-font-lock))
1308 (turn-on-font-lock))
1309 ;; maybe defer font-lock till after derived mode is set up
1310 (run-mode-hooks 'compilation-turn-on-font-lock))))
0b18a8f6 1311
7052680b 1312;;;###autoload
4282eba1 1313(define-minor-mode compilation-shell-minor-mode
7052680b
RS
1314 "Toggle compilation shell minor mode.
1315With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1316In this minor mode, all the error-parsing commands of the
1317Compilation major mode are available but bound to keys that don't
1318collide with Shell mode. See `compilation-mode'.
7052680b 1319Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
7837c247 1320 nil " Shell-Compile"
d408fed8 1321 :group 'compilation
7837c247
SM
1322 (if compilation-shell-minor-mode
1323 (compilation-setup t)
1324 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1325 (font-lock-fontify-buffer)))
7052680b 1326
d6bd8dca 1327;;;###autoload
4282eba1 1328(define-minor-mode compilation-minor-mode
0b18a8f6
RM
1329 "Toggle compilation minor mode.
1330With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1331In this minor mode, all the error-parsing commands of the
1332Compilation major mode are available. See `compilation-mode'.
fee3f63a 1333Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
7837c247 1334 nil " Compilation"
d408fed8 1335 :group 'compilation
7837c247
SM
1336 (if compilation-minor-mode
1337 (compilation-setup t)
1338 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1339 (font-lock-fontify-buffer)))
55dfd2c4 1340
fd5e58d7 1341(defun compilation-handle-exit (process-status exit-status msg)
6f5b7627 1342 "Write MSG in the current buffer and hack its mode-line-process."
d42c87ab 1343 (let ((inhibit-read-only t)
fd5e58d7
RM
1344 (status (if compilation-exit-message-function
1345 (funcall compilation-exit-message-function
1346 process-status exit-status msg)
1347 (cons msg exit-status)))
1348 (omax (point-max))
1349 (opoint (point)))
b3a7f48f 1350 ;; Record where we put the message, so we can ignore it later on.
fd5e58d7
RM
1351 (goto-char omax)
1352 (insert ?\n mode-name " " (car status))
0eac1faa 1353 (if (and (numberp compilation-window-height)
7837c247
SM
1354 (zerop compilation-window-height))
1355 (message "%s" (cdr status)))
01c50447
RS
1356 (if (bolp)
1357 (forward-char -1))
fd5e58d7 1358 (insert " at " (substring (current-time-string) 0 19))
01c50447 1359 (goto-char (point-max))
47092737
RS
1360 ;; Prevent that message from being recognized as a compilation error.
1361 (add-text-properties omax (point)
1362 (append '(compilation-handle-exit t) nil))
52f84622 1363 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
fd5e58d7
RM
1364 ;; Force mode line redisplay soon.
1365 (force-mode-line-update)
1366 (if (and opoint (< opoint omax))
1367 (goto-char opoint))
a5f1c37e
RS
1368 (with-no-warnings
1369 (if compilation-finish-function
1370 (funcall compilation-finish-function (current-buffer) msg)))
4cc36b17
RS
1371 (let ((functions compilation-finish-functions))
1372 (while functions
1373 (funcall (car functions) (current-buffer) msg)
1374 (setq functions (cdr functions))))))
fd5e58d7 1375
55dfd2c4 1376;; Called when compilation process changes state.
55dfd2c4 1377(defun compilation-sentinel (proc msg)
d3cb357b 1378 "Sentinel for compilation buffers."
b3a7f48f
DP
1379 (if (memq (process-status proc) '(exit signal))
1380 (let ((buffer (process-buffer proc)))
1381 (if (null (buffer-name buffer))
1382 ;; buffer killed
1383 (set-process-buffer proc nil)
1384 (with-current-buffer buffer
1385 ;; Write something in the compilation buffer
1386 ;; and hack its mode line.
1387 (compilation-handle-exit (process-status proc)
1388 (process-exit-status proc)
1389 msg)
1390 ;; Since the buffer and mode line will show that the
1391 ;; process is dead, we can delete it now. Otherwise it
1392 ;; will stay around until M-x list-processes.
1393 (delete-process proc)))
1394 (setq compilation-in-progress (delq proc compilation-in-progress)))))
55dfd2c4 1395
ad62b7f1
RM
1396(defun compilation-filter (proc string)
1397 "Process filter for compilation buffers.
4f6e4ad6 1398Just inserts the text, but uses `insert-before-markers'."
991c70f8 1399 (if (buffer-name (process-buffer proc))
c536bb39
SM
1400 (with-current-buffer (process-buffer proc)
1401 (let ((inhibit-read-only t))
991c70f8
RS
1402 (save-excursion
1403 (goto-char (process-mark proc))
1404 (insert-before-markers string)
7837c247 1405 (run-hooks 'compilation-filter-hook))))))
b5bb472e 1406
5d9f0de2
KS
1407;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1408(defsubst compilation-buffer-internal-p ()
1409 "Test if inside a compilation buffer."
1410 (local-variable-p 'compilation-locs))
1411
1412;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
51ba27e7 1413(defsubst compilation-buffer-p (buffer)
5d9f0de2
KS
1414 "Test if BUFFER is a compilation buffer."
1415 (with-current-buffer buffer
1416 (compilation-buffer-internal-p)))
7837c247
SM
1417
1418(defmacro compilation-loop (< property-change 1+ error)
1419 `(while (,< n 0)
1420 (or (setq pt (,property-change pt 'message))
1421 (error ,error compilation-error))
1422 ;; prop 'message usually has 2 changes, on and off, so re-search if off
1423 (or (setq msg (get-text-property pt 'message))
1424 (if (setq pt (,property-change pt 'message))
1425 (setq msg (get-text-property pt 'message)))
1426 (error ,error compilation-error))
1427 (or (< (cadr msg) compilation-skip-threshold)
1428 (if different-file
1429 (eq (prog1 last (setq last (nth 2 (car msg))))
1430 last))
1431 (if compilation-skip-visited
1432 (nthcdr 4 (car msg)))
1433 (if compilation-skip-to-next-location
1434 (eq (car msg) loc))
1435 ;; count this message only if none of the above are true
1436 (setq n (,1+ n)))))
1437
51c8ad03 1438(defun compilation-next-error (n &optional different-file pt)
646bd331 1439 "Move point to the next error in the compilation buffer.
851231e9
DL
1440Prefix arg N says how many error messages to move forwards (or
1441backwards, if negative).
646bd331
RM
1442Does NOT find the source line like \\[next-error]."
1443 (interactive "p")
1444 (or (compilation-buffer-p (current-buffer))
851231e9 1445 (error "Not in a compilation buffer"))
51c8ad03 1446 (or pt (setq pt (point)))
51c8ad03
DP
1447 (let* ((msg (get-text-property pt 'message))
1448 (loc (car msg))
1449 last)
7837c247
SM
1450 (if (zerop n)
1451 (unless (or msg ; find message near here
c536bb39
SM
1452 (setq msg (get-text-property (max (1- pt) (point-min))
1453 'message)))
7837c247 1454 (setq pt (previous-single-property-change pt 'message nil
c536bb39 1455 (line-beginning-position)))
b3a7f48f 1456 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
7837c247 1457 (setq pt (next-single-property-change pt 'message nil
c536bb39 1458 (line-end-position)))
b3a7f48f
DP
1459 (or (setq msg (get-text-property pt 'message))
1460 (setq pt (point)))))
7837c247 1461 (setq last (nth 2 (car msg)))
51c8ad03
DP
1462 (if (>= n 0)
1463 (compilation-loop > next-single-property-change 1-
1464 (if (get-buffer-process (current-buffer))
1465 "No more %ss yet"
1466 "Moved past last %s"))
c536bb39
SM
1467 ;; Don't move "back" to message at or before point.
1468 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1469 (setq pt (previous-single-property-change pt 'message nil (point-min)))
51c8ad03
DP
1470 (compilation-loop < previous-single-property-change 1+
1471 "Moved back before first %s")))
7837c247
SM
1472 (goto-char pt)
1473 (or msg
1474 (error "No %s here" compilation-error))))
646bd331
RM
1475
1476(defun compilation-previous-error (n)
1477 "Move point to the previous error in the compilation buffer.
851231e9
DL
1478Prefix arg N says how many error messages to move backwards (or
1479forwards, if negative).
7837c247 1480Does NOT find the source line like \\[previous-error]."
646bd331
RM
1481 (interactive "p")
1482 (compilation-next-error (- n)))
1483
b5bb472e 1484(defun compilation-next-file (n)
24299582
DP
1485 "Move point to the next error for a different file than the current one.
1486Prefix arg N says how many files to move forwards (or backwards, if negative)."
b5bb472e 1487 (interactive "p")
7837c247 1488 (compilation-next-error n t))
b5bb472e
RM
1489
1490(defun compilation-previous-file (n)
24299582
DP
1491 "Move point to the previous error for a different file than the current one.
1492Prefix arg N says how many files to move backwards (or forwards, if negative)."
b5bb472e
RM
1493 (interactive "p")
1494 (compilation-next-file (- n)))
1495
55dfd2c4 1496(defun kill-compilation ()
b765ba64 1497 "Kill the process made by the \\[compile] or \\[grep] commands."
55dfd2c4 1498 (interactive)
d3cb357b 1499 (let ((buffer (compilation-find-buffer)))
55dfd2c4 1500 (if (get-buffer-process buffer)
d3cb357b 1501 (interrupt-process (get-buffer-process buffer))
851231e9 1502 (error "The compilation process is not running"))))
d3cb357b 1503
9da85ee5 1504(defalias 'compile-mouse-goto-error 'compile-goto-error)
c536bb39 1505
9da85ee5
SM
1506(defun compile-goto-error (&optional event)
1507 "Visit the source for the error message at point.
7837c247 1508Use this command in a compilation log buffer. Sets the mark at point there."
9da85ee5 1509 (interactive (list last-input-event))
a6cd3f65 1510 (if event (posn-set-point (event-end event)))
d3cb357b 1511 (or (compilation-buffer-p (current-buffer))
851231e9 1512 (error "Not in a compilation buffer"))
b3a7f48f
DP
1513 (if (get-text-property (point) 'directory)
1514 (dired-other-window (car (get-text-property (point) 'directory)))
1515 (push-mark)
1516 (setq compilation-current-error (point))
bfd271b5 1517 (next-error 0)))
55dfd2c4 1518
d3cb357b
RM
1519;; Return a compilation buffer.
1520;; If the current buffer is a compilation buffer, return it.
d3cb357b
RM
1521;; Otherwise, look for a compilation buffer and signal an error
1522;; if there are none.
749354f0
RS
1523(defun compilation-find-buffer (&optional avoid-current)
1524 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p))
d3cb357b
RM
1525
1526;;;###autoload
5d9f0de2 1527(defun compilation-next-error-function (n &optional reset)
a5f1c37e
RS
1528 "Advance to the next error message and visit the file where the error was.
1529This is the value of `next-error-function' in Compilation buffers."
7837c247 1530 (interactive "p")
5d9f0de2
KS
1531 (when reset
1532 (setq compilation-current-error nil))
7837c247
SM
1533 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1534 (last 1)
51c8ad03 1535 (loc (compilation-next-error (or n 1) nil
9b7b51a2
SM
1536 (or compilation-current-error
1537 compilation-messages-start
1538 (point-min))))
7837c247
SM
1539 (end-loc (nth 2 loc))
1540 (marker (point-marker)))
51c8ad03 1541 (setq compilation-current-error (point-marker)
b3a7f48f
DP
1542 overlay-arrow-position
1543 (if (bolp)
1544 compilation-current-error
9b7b51a2 1545 (copy-marker (line-beginning-position)))
51c8ad03 1546 loc (car loc))
7837c247
SM
1547 ;; If loc contains no marker, no error in that file has been visited. If
1548 ;; the marker is invalid the buffer has been killed. So, recalculate all
1549 ;; markers for that file.
eb6fb6e2 1550 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)))
c536bb39
SM
1551 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1552 (or (cdar (nth 2 loc))
1553 default-directory))
7837c247
SM
1554 (save-restriction
1555 (widen)
c536bb39 1556 (goto-char (point-min))
7837c247
SM
1557 ;; Treat file's found lines in forward order, 1 by 1.
1558 (dolist (line (reverse (cddr (nth 2 loc))))
1559 (when (car line) ; else this is a filename w/o a line#
1560 (beginning-of-line (- (car line) last -1))
1561 (setq last (car line)))
1562 ;; Treat line's found columns and store/update a marker for each.
1563 (dolist (col (cdr line))
1564 (if (car col)
1565 (if (eq (car col) -1) ; special case for range end
1566 (end-of-line)
9c8e6c85 1567 (compilation-move-to-column (car col) columns))
7837c247
SM
1568 (beginning-of-line)
1569 (skip-chars-forward " \t"))
eb6fb6e2 1570 (if (nth 3 col)
7837c247
SM
1571 (set-marker (nth 3 col) (point))
1572 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1573 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1574 (setcdr (nthcdr 3 loc) t))) ; Set this one as visited.
1575
e3bef839
SM
1576(defvar compilation-gcpro nil
1577 "Internal variable used to keep some values from being GC'd.")
1578(make-variable-buffer-local 'compilation-gcpro)
1579
eb6fb6e2
DP
1580(defun compilation-fake-loc (marker file &optional line col)
1581 "Preassociate MARKER with FILE.
dbd97672 1582FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
eb6fb6e2
DP
1583This is useful when you compile temporary files, but want
1584automatic translation of the messages to the real buffer from
1585which the temporary file came. This only works if done before a
1586message about FILE appears!
1587
1588Optional args LINE and COL default to 1 and beginning of
1589indentation respectively. The marker is expected to reflect
1590this. In the simplest case the marker points to the first line
1591of the region that was saved to the temp file.
1592
1593If you concatenate several regions into the temp file (e.g. a
1594header with variable assignments and a code region), you must
1595call this several times, once each for the last line of one
1596region and the first line of the next region."
1597 (or (consp file) (setq file (list file)))
dbd97672 1598 (setq file (compilation-get-file-structure file))
e3bef839
SM
1599 ;; Between the current call to compilation-fake-loc and the first occurrence
1600 ;; of an error message referring to `file', the data is only kept is the
1601 ;; weak hash-table compilation-locs, so we need to prevent this entry
1602 ;; in compilation-locs from being GC'd away. --Stef
1603 (push file compilation-gcpro)
eb6fb6e2
DP
1604 (let ((loc (compilation-assq (or line 1) (cdr file))))
1605 (setq loc (compilation-assq col loc))
1606 (if (cdr loc)
1607 (setcdr (cddr loc) (list marker))
dbd97672 1608 (setcdr loc (list line file marker)))
eb6fb6e2
DP
1609 loc))
1610
8b71e4d1
NR
1611(defcustom compilation-context-lines nil
1612 "Display this many lines of leading context before the current message.
1613If nil and the left fringe is displayed, don't scroll the
1614compilation output window; an arrow in the left fringe points to
1615the current message. If nil and there is no left fringe, the message
1616displays at the top of the window; there is no arrow."
a3a9c080 1617 :type '(choice integer (const :tag "No window scrolling" nil))
f6164cdd 1618 :group 'compilation
bf247b6e 1619 :version "22.1")
7837c247
SM
1620
1621(defsubst compilation-set-window (w mk)
6f5b7627 1622 "Align the compilation output window W with marker MK near top."
a3a9c080
JL
1623 (if (integerp compilation-context-lines)
1624 (set-window-start w (save-excursion
8b71e4d1
NR
1625 (goto-char mk)
1626 (beginning-of-line
1627 (- 1 compilation-context-lines))
1628 (point)))
3c9e7f42
RS
1629 ;; If there is no left fringe.
1630 (if (equal (car (window-fringes)) 0)
8b71e4d1
NR
1631 (set-window-start w (save-excursion
1632 (goto-char mk)
1633 (beginning-of-line 1)
1634 (point)))))
1635 (set-window-point w mk))
7837c247 1636
0ea50e43
RS
1637(defvar next-error-highlight-timer)
1638
7837c247 1639(defun compilation-goto-locus (msg mk end-mk)
6f5b7627 1640 "Jump to an error corresponding to MSG at MK.
9dc3a46a
JL
1641All arguments are markers. If END-MK is non-nil, mark is set there
1642and overlay is highlighted between MK and END-MK."
d28701c7 1643 (if (eq (window-buffer (selected-window))
7837c247 1644 (marker-buffer msg))
d28701c7
RS
1645 ;; If the compilation buffer window is selected,
1646 ;; keep the compilation buffer in this window;
1647 ;; display the source in another window.
1648 (let ((pop-up-windows t))
7837c247 1649 (pop-to-buffer (marker-buffer mk)))
8f36a284 1650 (if (window-dedicated-p (selected-window))
7837c247
SM
1651 (pop-to-buffer (marker-buffer mk))
1652 (switch-to-buffer (marker-buffer mk))))
1653 ;; If narrowing gets in the way of going to the right place, widen.
1654 (unless (eq (goto-char mk) (point))
1655 (widen)
1656 (goto-char mk))
1657 (if end-mk
9dc3a46a 1658 (push-mark end-mk t)
7837c247 1659 (if mark-active (setq mark-active)))
721cfafe
TTN
1660 ;; If hideshow got in the way of
1661 ;; seeing the right place, open permanently.
7837c247
SM
1662 (dolist (ov (overlays-at (point)))
1663 (when (eq 'hs (overlay-get ov 'invisible))
1664 (delete-overlay ov)
1665 (goto-char mk)))
eaa3cac5
RM
1666
1667 ;; Show compilation buffer in other window, scrolled to this error.
1668 (let* ((pop-up-windows t)
eae2c972 1669 ;; Use an existing window if it is in a visible frame.
7837c247 1670 (w (or (get-buffer-window (marker-buffer msg) 'visible)
eae2c972 1671 ;; Pop up a window.
7837c247
SM
1672 (display-buffer (marker-buffer msg))))
1673 (highlight-regexp (with-current-buffer (marker-buffer msg)
1674 ;; also do this while we change buffer
1675 (compilation-set-window w msg)
9ac57479 1676 compilation-highlight-regexp)))
9ac57479
KS
1677 (compilation-set-window-height w)
1678
9dc3a46a 1679 (when highlight-regexp
073fcaf6
JL
1680 (if (timerp next-error-highlight-timer)
1681 (cancel-timer next-error-highlight-timer))
9ac57479 1682 (unless compilation-highlight-overlay
c536bb39
SM
1683 (setq compilation-highlight-overlay
1684 (make-overlay (point-min) (point-min)))
2beb6aa0 1685 (overlay-put compilation-highlight-overlay 'face 'next-error))
7837c247 1686 (with-current-buffer (marker-buffer mk)
9ac57479 1687 (save-excursion
9dc3a46a 1688 (if end-mk (goto-char end-mk) (end-of-line))
c536bb39 1689 (let ((end (point)))
9dc3a46a 1690 (if mk (goto-char mk) (beginning-of-line))
9ac57479 1691 (if (and (stringp highlight-regexp)
7837c247 1692 (re-search-forward highlight-regexp end t))
9ac57479
KS
1693 (progn
1694 (goto-char (match-beginning 0))
2beb6aa0
JL
1695 (move-overlay compilation-highlight-overlay
1696 (match-beginning 0) (match-end 0)
1697 (current-buffer)))
1698 (move-overlay compilation-highlight-overlay
1699 (point) end (current-buffer)))
1700 (if (numberp next-error-highlight)
073fcaf6
JL
1701 (setq next-error-highlight-timer
1702 (run-at-time next-error-highlight nil 'delete-overlay
1703 compilation-highlight-overlay)))
1704 (if (not (or (eq next-error-highlight t)
1705 (numberp next-error-highlight)))
2beb6aa0
JL
1706 (delete-overlay compilation-highlight-overlay))))))
1707 (when (and (eq next-error-highlight 'fringe-arrow))
6a1cdc5b
JL
1708 (setq next-error-overlay-arrow-position
1709 (copy-marker (line-beginning-position))))))
1710
eaa3cac5 1711\f
20c1daec 1712(defun compilation-find-file (marker filename dir &rest formats)
851231e9 1713 "Find a buffer for file FILENAME.
ffb4b7a1
SM
1714Search the directories in `compilation-search-path'.
1715A nil in `compilation-search-path' means to try the
851231e9
DL
1716current directory, which is passed in DIR.
1717If FILENAME is not found at all, ask the user where to find it.
1718Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
20c1daec 1719 (or formats (setq formats '("%s")))
721cfafe
TTN
1720 (save-excursion
1721 (let ((dirs compilation-search-path)
1722 buffer thisdir fmts name)
1723 (if (file-name-absolute-p filename)
5b6858da
SM
1724 ;; The file name is absolute. Use its explicit directory as
1725 ;; the first in the search path, and strip it from FILENAME.
1726 (setq filename (abbreviate-file-name (expand-file-name filename))
1727 dirs (cons (file-name-directory filename) dirs)
1728 filename (file-name-nondirectory filename)))
721cfafe
TTN
1729 ;; Now search the path.
1730 (while (and dirs (null buffer))
1731 (setq thisdir (or (car dirs) dir)
1732 fmts formats)
1733 ;; For each directory, try each format string.
1734 (while (and fmts (null buffer))
1735 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1736 buffer (and (file-exists-p name)
ffb4b7a1 1737 (find-file-noselect name))
721cfafe
TTN
1738 fmts (cdr fmts)))
1739 (setq dirs (cdr dirs)))
1740 (or buffer
7837c247
SM
1741 ;; The file doesn't exist. Ask the user where to find it.
1742 (let ((pop-up-windows t))
1743 (compilation-set-window (display-buffer (marker-buffer marker))
1744 marker)
721cfafe
TTN
1745 (let ((name (expand-file-name
1746 (read-file-name
1747 (format "Find this error in: (default %s) "
1748 filename)
1749 dir filename t))))
1750 (if (file-directory-p name)
1751 (setq name (expand-file-name filename name)))
1752 (setq buffer (and (file-exists-p name)
1753 (find-file name))))))
1754 ;; Make intangible overlays tangible.
1755 (mapcar (function (lambda (ov)
1756 (when (overlay-get ov 'intangible)
1757 (overlay-put ov 'intangible nil))))
1758 (overlays-in (point-min) (point-max)))
1759 buffer)))
1760
dbd97672
DP
1761(defun compilation-get-file-structure (file &optional fmt)
1762 "Retrieve FILE's file-structure or create a new one.
1763FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)."
1764
1765 (or (gethash file compilation-locs)
1766 ;; File was not previously encountered, at least not in the form passed.
1767 ;; Let's normalize it and look again.
1768 (let ((filename (car file))
1769 (default-directory (if (cdr file)
1770 (file-truename (cdr file))
1771 default-directory)))
1772
1773 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1774 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1775 ;; buffer.)
1776 (if (boundp 'comint-file-name-prefix)
1777 (if (file-name-absolute-p filename)
1778 (setq filename
1779 (concat (with-no-warnings comint-file-name-prefix) filename))
1780 (setq default-directory
1781 (file-truename
1782 (concat (with-no-warnings comint-file-name-prefix) default-directory)))))
1783
1784 ;; If compilation-parse-errors-filename-function is
1785 ;; defined, use it to process the filename.
1786 (when compilation-parse-errors-filename-function
1787 (setq filename
1788 (funcall compilation-parse-errors-filename-function
1789 filename)))
1790
1791 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
1792 ;; file names like "./bar//foo.c" for file "bar/foo.c";
1793 ;; expand-file-name will collapse these into "/foo.c" and fail to find
1794 ;; the appropriate file. So we look for doubled slashes in the file
1795 ;; name and fix them.
1796 (setq filename (command-line-normalize-file-name filename))
1797
1798 ;; Now eliminate any "..", because find-file would get them wrong.
1799 ;; Make relative and absolute filenames, with or without links, the
1800 ;; same.
1801 (setq filename
1802 (list (abbreviate-file-name
1803 (file-truename (if (cdr file)
1804 (expand-file-name filename)
1805 filename)))))
1806
1807 ;; Store it for the possibly unnormalized name
1808 (puthash file
1809 ;; Retrieve or create file-structure for normalized name
1810 (or (gethash filename compilation-locs)
1811 (puthash filename (list filename fmt) compilation-locs))
1812 compilation-locs))))
51501e54 1813
7837c247 1814(add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
f1ed9461 1815
c536bb39
SM
1816;;; Compatibility with the old compile.el.
1817
1818(defun compile-buffer-substring (n) (if n (match-string n)))
1819
1820(defun compilation-compat-error-properties (err)
6f5b7627 1821 "Map old-style error ERR to new-style message."
efb0e677
SM
1822 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
1823 ;; (MARKER . MARKER).
1824 (let ((dst (cdr err)))
1825 (if (markerp dst)
1826 ;; Must start with a face, for font-lock.
1827 `(face nil
1828 message ,(list (list nil nil nil dst) 2)
1829 help-echo "mouse-2: visit the source location"
1830 keymap compilation-button-map
1831 mouse-face highlight)
1832 ;; Too difficult to do it by hand: dispatch to the normal code.
1833 (let* ((file (pop dst))
1834 (line (pop dst))
1835 (col (pop dst))
1836 (filename (pop file))
1837 (dirname (pop file))
1838 (fmt (pop file)))
1839 (compilation-internal-error-properties
1840 (cons filename dirname) line nil col nil 2 fmt)))))
c536bb39
SM
1841
1842(defun compilation-compat-parse-errors (limit)
1843 (when compilation-parse-errors-function
1844 ;; FIXME: We should remove the rest of the compilation keywords
1845 ;; but we can't do that from here because font-lock is using
1846 ;; the value right now. --stef
1847 (save-excursion
1848 (setq compilation-error-list nil)
1849 ;; Reset compilation-parsing-end each time because font-lock
1850 ;; might force us the re-parse many times (typically because
1851 ;; some code adds some text-property to the output that we
1852 ;; already parsed). You might say "why reparse", well:
1853 ;; because font-lock has just removed the `message' property so
1854 ;; have to do it all over again.
1855 (if compilation-parsing-end
1856 (set-marker compilation-parsing-end (point))
1857 (setq compilation-parsing-end (point-marker)))
1858 (condition-case nil
1859 ;; Ignore any error: we're calling this function earlier than
1860 ;; in the old compile.el so things might not all be setup yet.
1861 (funcall compilation-parse-errors-function limit nil)
1862 (error nil))
1863 (dolist (err (if (listp compilation-error-list) compilation-error-list))
1864 (let* ((src (car err))
1865 (dst (cdr err))
1866 (loc (cond ((markerp dst) (list nil nil nil dst))
1867 ((consp dst)
1868 (list (nth 2 dst) (nth 1 dst)
1869 (cons (cdar dst) (caar dst)))))))
1870 (when loc
1871 (goto-char src)
1872 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
1873 (put-text-property src (line-end-position)
1874 'message (list loc 2)))))))
1875 (goto-char limit)
1876 nil)
1877
9b7b51a2 1878;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
c536bb39
SM
1879(defun compilation-forget-errors ()
1880 ;; In case we hit the same file/line specs, we want to recompute a new
1881 ;; marker for them, so flush our cache.
b3a7f48f 1882 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
e3bef839 1883 (setq compilation-gcpro nil)
c536bb39
SM
1884 ;; FIXME: the old code reset the directory-stack, so maybe we should
1885 ;; put a `directory change' marker of some sort, but where? -stef
b3a7f48f 1886 ;;
c536bb39
SM
1887 ;; FIXME: The old code moved compilation-current-error (which was
1888 ;; virtually represented by a mix of compilation-parsing-end and
1889 ;; compilation-error-list) to point-min, but that was only meaningful for
1890 ;; the internal uses of compilation-forget-errors: all calls from external
1891 ;; packages seem to be followed by a move of compilation-parsing-end to
1892 ;; something equivalent to point-max. So we speculatively move
1893 ;; compilation-current-error to point-max (since the external package
1894 ;; won't know that it should do it). --stef
9b7b51a2
SM
1895 (setq compilation-current-error nil)
1896 (let* ((proc (get-buffer-process (current-buffer)))
1897 (mark (if proc (process-mark proc)))
1898 (pos (or mark (point-max))))
1899 (setq compilation-messages-start
1900 ;; In the future, ignore the text already present in the buffer.
1901 ;; Since many process filter functions insert before markers,
1902 ;; we need to put ours just before the insertion point rather
1903 ;; than at the insertion point. If that's not possible, then
1904 ;; don't use a marker. --Stef
1905 (if (> pos (point-min)) (copy-marker (1- pos)) pos))))
c536bb39 1906
0c9a01ff
MY
1907;;;###autoload
1908(add-to-list 'auto-mode-alist '("\\.gcov\\'" . compilation-mode))
1909
4746118a 1910(provide 'compile)
fad160d5 1911
822001db 1912;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
fad160d5 1913;;; compile.el ends here