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