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