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