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