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