Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; compile.el --- run compiler as inferior of Emacs, parse error messages |
fad160d5 | 2 | |
930a3e46 | 3 | ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
034babe1 | 4 | ;; 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
3a801d0c | 5 | |
7837c247 SM |
6 | ;; Authors: Roland McGrath <roland@gnu.org>, |
7 | ;; Daniel Pfeiffer <occitan@esperanto.org> | |
d1c7011d | 8 | ;; Maintainer: FSF |
e9571d2a | 9 | ;; Keywords: tools, processes |
d1c7011d | 10 | |
55dfd2c4 RS |
11 | ;; This file is part of GNU Emacs. |
12 | ||
29add8b9 RM |
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 | ||
55dfd2c4 | 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
29add8b9 RM |
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 | |
b578f267 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
3a35cf56 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
55dfd2c4 | 27 | |
5cc57841 ER |
28 | ;;; Commentary: |
29 | ||
7837c247 SM |
30 | ;; This package provides the compile facilities documented in the Emacs user's |
31 | ;; manual. | |
5cc57841 | 32 | |
c536bb39 | 33 | ;; This mode uses some complex data-structures: |
7837c247 | 34 | |
c536bb39 | 35 | ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE) |
7837c247 SM |
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 | ||
c536bb39 SM |
47 | ;; FILE-STRUCTURE is a list of |
48 | ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...) | |
7837c247 SM |
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 | ||
c536bb39 | 60 | ;; MESSAGE is a list of (LOC TYPE END-LOC) |
7837c247 SM |
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 | ||
24299582 DP |
69 | ;;; Code: |
70 | ||
583a15bb SM |
71 | (eval-when-compile (require 'cl)) |
72 | ||
c5049fa0 RS |
73 | (defgroup compilation nil |
74 | "Run compiler as inferior of Emacs, parse error messages." | |
75 | :group 'tools | |
76 | :group 'processes) | |
77 | ||
78 | ||
7c163413 | 79 | ;;;###autoload |
c5049fa0 | 80 | (defcustom compilation-mode-hook nil |
2894bd96 | 81 | "*List of hook functions run by `compilation-mode' (see `run-mode-hooks')." |
c5049fa0 RS |
82 | :type 'hook |
83 | :group 'compilation) | |
7c163413 RM |
84 | |
85 | ;;;###autoload | |
c5049fa0 RS |
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) | |
d3cb357b | 91 | |
7837c247 SM |
92 | (defvar compilation-first-column 1 |
93 | "*This is how compilers number the first column, usually 1 or 0.") | |
55dfd2c4 | 94 | |
e335e194 GM |
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 | ||
49683a13 EZ |
100 | ;;;###autoload |
101 | (defvar compilation-process-setup-function nil | |
102 | "*Function to call to customize the compilation process. | |
6f5b7627 | 103 | This function is called immediately before the compilation process is |
49683a13 | 104 | started. It can be used to set any variables or functions that are used |
9ac57479 KS |
105 | while processing the output of the compilation process. The function |
106 | is called with variables `compilation-buffer' and `compilation-window' | |
7837c247 | 107 | bound to the compilation buffer and window, respectively.") |
49683a13 | 108 | |
aa228418 | 109 | ;;;###autoload |
d3cb357b | 110 | (defvar compilation-buffer-name-function nil |
6c43f2f9 RS |
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) \"*\")'.") | |
55dfd2c4 | 115 | |
aa228418 | 116 | ;;;###autoload |
d3cb357b | 117 | (defvar compilation-finish-function nil |
c5049fa0 | 118 | "Function to call when a compilation process finishes. |
d3cb357b | 119 | It is called with two arguments: the compilation buffer, and a string |
620d3304 | 120 | describing how the process finished.") |
3c9e7f42 RS |
121 | |
122 | (make-obsolete-variable 'compilation-finish-function | |
123 | "Use `compilation-finish-functions', but it works a little differently." | |
124 | "22.1") | |
55dfd2c4 | 125 | |
4cc36b17 RS |
126 | ;;;###autoload |
127 | (defvar compilation-finish-functions nil | |
c5049fa0 | 128 | "Functions to call when a compilation process finishes. |
4cc36b17 RS |
129 | Each function is called with two arguments: the compilation buffer, |
130 | and a string describing how the process finished.") | |
131 | ||
ebff767c RM |
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 | ||
7837c247 SM |
138 | (defvar compilation-error "error" |
139 | "Stem of message to print when no matches are found.") | |
6c43f2f9 | 140 | |
58856335 | 141 | (defvar compilation-arguments nil |
7837c247 | 142 | "Arguments that were given to `compilation-start'.") |
58856335 | 143 | |
6c43f2f9 | 144 | (defvar compilation-num-errors-found) |
d3cb357b | 145 | |
7837c247 SM |
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)) | |
5dfa3d35 | 150 | |
7837c247 SM |
151 | (ada |
152 | "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1)) | |
c7c5bbc0 | 153 | |
7837c247 SM |
154 | (aix |
155 | " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1) | |
e1f540f2 | 156 | |
7837c247 SM |
157 | (ant |
158 | "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\ | |
159 | \\( warning\\)?" 1 2 3 (4)) | |
e1f540f2 | 160 | |
7837c247 SM |
161 | (bash |
162 | "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2) | |
e1f540f2 | 163 | |
7837c247 SM |
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 | |
f6164cdd DP |
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)) | |
7837c247 SM |
173 | |
174 | (comma | |
175 | "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\ | |
176 | \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4)) | |
177 | ||
c39bf546 DP |
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 | ||
7837c247 | 185 | (epc |
c39bf546 | 186 | "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1) |
7837c247 | 187 | |
12221c84 DP |
188 | (ftnchek |
189 | "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)" | |
190 | 4 2 3 (1)) | |
9fcabe79 | 191 | |
7837c247 SM |
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 | ||
6f5b7627 | 200 | ;; fixme: should be `mips' |
7837c247 | 201 | (irix |
9fcabe79 DP |
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)) | |
7837c247 SM |
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 | |
6f5b7627 | 220 | "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\ |
b3ef54c5 | 221 | \\([/.]*[a-zA-Z]:?[^ \t\n:]*\\|{standard input}\\): ?\ |
7837c247 SM |
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 | |
0cb687c0 | 233 | "^makepp: \\(?:\\(?:warning\\(:\\).*?\\|\\(Scanning\\|[LR]e?l?oading makefile\\) \\|.*?\\)\ |
3b79dd20 | 234 | `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)" |
7837c247 | 235 | 4 5 nil (1 . 2) 3 |
3b79dd20 | 236 | ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil |
7837c247 SM |
237 | (2 compilation-info-face) |
238 | (3 compilation-line-face nil t) | |
51c8ad03 | 239 | (1 (compilation-error-properties 2 3 nil nil nil 0 nil) |
7837c247 SM |
240 | append))) |
241 | ||
6f5b7627 | 242 | ;; Should be lint-1, lint-2 (SysV lint) |
7837c247 SM |
243 | (mips-1 |
244 | " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1) | |
245 | (mips-2 | |
246 | " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2) | |
247 | ||
248 | (msft | |
28547c1f | 249 | "^\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \ |
2a516a73 | 250 | : \\(?:error\\|warnin\\(g\\)\\) C[0-9]+:" 2 3 nil (4)) |
7837c247 SM |
251 | |
252 | (oracle | |
b3ef54c5 DP |
253 | "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\ |
254 | \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\ | |
255 | \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$" | |
7837c247 | 256 | 3 1 2) |
40d63d1f | 257 | |
7837c247 SM |
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 | |
6f5b7627 | 278 | ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\ |
7837c247 SM |
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 | ||
7837c247 SM |
285 | (4bsd |
286 | "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\ | |
0c9a01ff MY |
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 | ) | |
7837c247 SM |
299 | "Alist of values for `compilation-error-regexp-alist'.") |
300 | ||
301 | (defcustom compilation-error-regexp-alist | |
302 | (mapcar 'car compilation-error-regexp-alist-alist) | |
6c43f2f9 | 303 | "Alist that specifies how to match errors in compiler output. |
6f5b7627 | 304 | Note that on Unix everything is a valid filename, so these |
7837c247 SM |
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 | |
6f5b7627 | 311 | `etc/compilation.txt' (linked below if you are customizing this). |
7837c247 SM |
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" | |
eeb3ede4 | 353 | ,(expand-file-name "compilation.txt" data-directory)) |
7837c247 | 354 | :group 'compilation) |
55dfd2c4 | 355 | |
ebb8cb68 EZ |
356 | (defvar compilation-directory nil |
357 | "Directory to restore to when doing `recompile'.") | |
358 | ||
7837c247 SM |
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) | |
38dbf92b | 380 | (2 (compilation-face '(4 . 3)))) |
7837c247 | 381 | ;; Command output lines. Recognize `make[n]:' lines too. |
6f5b7627 | 382 | ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:" |
7837c247 SM |
383 | (1 font-lock-function-name-face) (3 compilation-line-face nil t)) |
384 | (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1) | |
314b410b JL |
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))) | |
7837c247 SM |
390 | "Additional things to highlight in Compilation mode. |
391 | This gets tacked on the end of the generated expressions.") | |
a24770bc | 392 | |
9ac57479 KS |
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 | ||
f8e03ecb AS |
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 | ||
c5049fa0 | 411 | (defcustom compilation-read-command t |
851231e9 DL |
412 | "*Non-nil means \\[compile] reads the compilation command to use. |
413 | Otherwise, \\[compile] just uses the value of `compile-command'." | |
c5049fa0 RS |
414 | :type 'boolean |
415 | :group 'compilation) | |
90016295 | 416 | |
e83be080 | 417 | ;;;###autoload |
c5049fa0 | 418 | (defcustom compilation-ask-about-save t |
851231e9 | 419 | "*Non-nil means \\[compile] asks which buffers to save before compiling. |
c5049fa0 RS |
420 | Otherwise, it saves all modified buffers without asking." |
421 | :type 'boolean | |
422 | :group 'compilation) | |
90016295 | 423 | |
7c163413 | 424 | ;;;###autoload |
c5049fa0 | 425 | (defcustom compilation-search-path '(nil) |
7c163413 | 426 | "*List of directories to search for source files named in error messages. |
d3cb357b | 427 | Elements should be directory names, not file names of directories. |
c5049fa0 RS |
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) | |
55dfd2c4 | 432 | |
c5049fa0 RS |
433 | (defcustom compile-command "make -k " |
434 | "*Last shell command used to do a compilation; default for next compilation. | |
55dfd2c4 RS |
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 | ||
61c4aaf8 | 439 | (add-hook 'c-mode-hook |
61c4aaf8 RS |
440 | (lambda () |
441 | (unless (or (file-exists-p \"makefile\") | |
442 | (file-exists-p \"Makefile\")) | |
5b6858da SM |
443 | (set (make-local-variable 'compile-command) |
444 | (concat \"make -k \" | |
7837c247 | 445 | (file-name-sans-extension buffer-file-name))))))" |
c5049fa0 RS |
446 | :type 'string |
447 | :group 'compilation) | |
55dfd2c4 | 448 | |
93ef35e4 | 449 | (defcustom compilation-disable-input nil |
3fa37cd1 EZ |
450 | "*If non-nil, send end-of-file as compilation process input. |
451 | This only affects platforms that support asynchronous processes (see | |
bac3a1c9 | 452 | `start-process'); synchronous compilation processes never accept input." |
3fa37cd1 EZ |
453 | :type 'boolean |
454 | :group 'compilation | |
455 | :version "22.1") | |
456 | ||
7837c247 SM |
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 | |
6f5b7627 | 463 | "*Set this to t before creating a *compilation* buffer. |
7837c247 SM |
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'.") | |
d3cb357b | 466 | |
01f89d11 RM |
467 | (defvar compilation-exit-message-function nil "\ |
468 | If non-nil, called when a compilation process dies to return a status message. | |
fd5e58d7 RM |
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.") | |
01f89d11 | 472 | |
c20f961b JPW |
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 | ||
770970cb RS |
479 | ;; History of compile commands. |
480 | (defvar compile-history nil) | |
770970cb | 481 | |
fa947ef3 JL |
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 | ||
541a6d0d | 488 | (defface compilation-warning |
bc3621a0 EZ |
489 | '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold)) |
490 | (((class color)) (:foreground "cyan" :weight bold)) | |
7837c247 SM |
491 | (t (:weight bold))) |
492 | "Face used to highlight compiler warnings." | |
f6164cdd | 493 | :group 'font-lock-highlighting-faces |
bf247b6e | 494 | :version "22.1") |
7837c247 | 495 | |
541a6d0d | 496 | (defface compilation-info |
e4aa3c94 | 497 | '((((class color) (min-colors 16) (background light)) |
bc3621a0 | 498 | (:foreground "Green3" :weight bold)) |
ea81d57e DN |
499 | (((class color) (min-colors 88) (background dark)) |
500 | (:foreground "Green1" :weight bold)) | |
e4aa3c94 | 501 | (((class color) (min-colors 16) (background dark)) |
bc3621a0 EZ |
502 | (:foreground "Green" :weight bold)) |
503 | (((class color)) (:foreground "green" :weight bold)) | |
7837c247 | 504 | (t (:weight bold))) |
fa947ef3 | 505 | "Face used to highlight compiler information." |
f6164cdd | 506 | :group 'font-lock-highlighting-faces |
bf247b6e | 507 | :version "22.1") |
7837c247 | 508 | |
a5f1c37e | 509 | (defface compilation-line-number |
38dbf92b | 510 | '((t :inherit font-lock-variable-name-face)) |
fa947ef3 | 511 | "Face for displaying line numbers in compiler messages." |
a5f1c37e RS |
512 | :group 'font-lock-highlighting-faces |
513 | :version "22.1") | |
514 | ||
515 | (defface compilation-column-number | |
38dbf92b | 516 | '((t :inherit font-lock-type-face)) |
fa947ef3 | 517 | "Face for displaying column numbers in compiler messages." |
a5f1c37e RS |
518 | :group 'font-lock-highlighting-faces |
519 | :version "22.1") | |
520 | ||
38dbf92b | 521 | (defvar compilation-message-face 'underline |
7837c247 SM |
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 | ||
38dbf92b | 527 | (defvar compilation-error-face 'compilation-error |
7837c247 SM |
528 | "Face name to use for file name in error messages.") |
529 | ||
38dbf92b | 530 | (defvar compilation-warning-face 'compilation-warning |
7837c247 SM |
531 | "Face name to use for file name in warning messages.") |
532 | ||
38dbf92b | 533 | (defvar compilation-info-face 'compilation-info |
7837c247 SM |
534 | "Face name to use for file name in informational messages.") |
535 | ||
a5f1c37e | 536 | (defvar compilation-line-face 'compilation-line-number |
38dbf92b | 537 | "Face name to use for line numbers in compiler messages.") |
7837c247 | 538 | |
a5f1c37e | 539 | (defvar compilation-column-face 'compilation-column-number |
fa947ef3 | 540 | "Face name to use for column numbers in compiler messages.") |
7837c247 SM |
541 | |
542 | ;; same faces as dired uses | |
543 | (defvar compilation-enter-directory-face 'font-lock-function-name-face | |
fa947ef3 | 544 | "Face name to use for entering directory messages.") |
7837c247 SM |
545 | |
546 | (defvar compilation-leave-directory-face 'font-lock-type-face | |
fa947ef3 | 547 | "Face name to use for leaving directory messages.") |
7837c247 SM |
548 | |
549 | ||
550 | ||
c536bb39 | 551 | ;; Used for compatibility with the old compile.el. |
0ff7f01e | 552 | (defvaralias 'compilation-last-buffer 'next-error-last-buffer) |
6f5b7627 | 553 | (defvar compilation-parsing-end (make-marker)) |
c536bb39 SM |
554 | (defvar compilation-parse-errors-function nil) |
555 | (defvar compilation-error-list nil) | |
556 | (defvar compilation-old-error-list nil) | |
557 | ||
7837c247 SM |
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 | ||
deda0c65 DP |
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. | |
7837c247 SM |
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 | |
6f5b7627 | 581 | keymap compilation-button-map |
7837c247 SM |
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. | |
6f5b7627 | 592 | (eval-when-compile ;Don't keep it at runtime if not needed. |
7837c247 SM |
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 | |
6f5b7627 | 603 | (setcdr l1 (cons (list ,key) l2))))))) |
7837c247 SM |
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))))) | |
efb0e677 | 621 | (setq file (cons file (car dir))))) |
7837c247 SM |
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 | |
efb0e677 SM |
625 | (car (nth 2 (car (or (get-text-property (1- file) 'message) |
626 | (get-text-property file 'message)))))) | |
627 | '("*unknown*")))) | |
7837c247 SM |
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))) | |
9dc3a46a JL |
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)))) | |
eb6fb6e2 | 647 | (if (consp type) ; not a static type, check what it is. |
7837c247 SM |
648 | (setq type (or (and (car type) (match-end (car type)) 1) |
649 | (and (cdr type) (match-end (cdr type)) 0) | |
650 | 2))) | |
efb0e677 SM |
651 | (compilation-internal-error-properties file line end-line col end-col type fmt))) |
652 | ||
9c8e6c85 SM |
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 | ||
efb0e677 SM |
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. | |
dbd97672 | 665 | FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil." |
efb0e677 | 666 | (unless file (setq file '("*unknown*"))) |
dbd97672 | 667 | (setq file (compilation-get-file-structure file fmt)) |
efb0e677 SM |
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 | |
dbd97672 DP |
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 | |
efb0e677 | 680 | (setq marker-line x) |
dbd97672 DP |
681 | (if (> (- (or (car marker-line) 1) loc) |
682 | (- loc (car x))) ; current line is nearer | |
efb0e677 SM |
683 | (setq marker-line x)) |
684 | (throw 'marker t)))) | |
685 | (setq marker (nth 3 (cadr marker-line)) | |
dbd97672 | 686 | marker-line (or (car marker-line) 1)) |
efb0e677 SM |
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)) | |
930a3e46 | 693 | (if (or (null end-col) (< end-col 0)) |
efb0e677 | 694 | (end-of-line) |
9c8e6c85 SM |
695 | (compilation-move-to-column |
696 | end-col compilation-error-screen-columns)) | |
efb0e677 SM |
697 | (setq end-marker (list (point-marker)))) |
698 | (beginning-of-line (if end-line | |
930a3e46 | 699 | (- line end-line -1) |
efb0e677 SM |
700 | (- loc marker-line -1))) |
701 | (if col | |
9c8e6c85 SM |
702 | (compilation-move-to-column |
703 | col compilation-error-screen-columns) | |
efb0e677 SM |
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))) | |
7837c247 | 732 | |
e93b2a55 SM |
733 | (defun compilation-mode-font-lock-keywords () |
734 | "Return expressions to highlight in Compilation mode." | |
91fa27cd SM |
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)) | |
0ea50e43 | 746 | t t)) |
91fa27cd SM |
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) | |
b3a7f48f DP |
760 | (if (consp file) (setq fmt (cdr file) file (car file))) |
761 | (if (consp line) (setq end-line (cdr line) line (car line))) | |
91fa27cd | 762 | (if (consp col) (setq end-col (cdr col) col (car col))) |
b3a7f48f | 763 | |
544dccaa | 764 | (if (functionp line) |
91fa27cd SM |
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) | |
0ea50e43 RS |
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)))))) | |
91fa27cd | 775 | (,file compilation-error-face t)) |
b3a7f48f | 776 | |
f71d34b0 SM |
777 | (unless (or (null (nth 5 item)) (integerp (nth 5 item))) |
778 | (error "HYPERLINK should be an integer: %s" (nth 5 item))) | |
779 | ||
91fa27cd SM |
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 | ||
9dc3a46a | 795 | ,@(when (integerp col) |
91fa27cd | 796 | `((,col compilation-column-face nil t))) |
9dc3a46a | 797 | ,@(when (integerp end-col) |
91fa27cd SM |
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))) | |
7837c247 | 809 | |
01f89d11 | 810 | \f |
d3cb357b | 811 | ;;;###autoload |
7837c247 | 812 | (defun compile (command &optional comint) |
55dfd2c4 RS |
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*'. | |
d3cb357b | 816 | |
6f5b7627 | 817 | If optional second arg COMINT is t the buffer will be in Comint mode with |
7837c247 SM |
818 | `compilation-shell-minor-mode'. |
819 | ||
55dfd2c4 RS |
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 | ||
08b1edf4 RM |
823 | Interactively, prompts for the command if `compilation-read-command' is |
824 | non-nil; otherwise uses `compile-command'. With prefix arg, always prompts. | |
c39bf546 DP |
825 | Additionally, with universal prefix arg, compilation buffer will be in |
826 | comint mode, i.e. interactive. | |
08b1edf4 | 827 | |
c72095b3 RS |
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. | |
d3cb357b RM |
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." | |
90016295 | 837 | (interactive |
c39bf546 | 838 | (list |
20320c65 JL |
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)) | |
c39bf546 | 847 | (consp current-prefix-arg))) |
5b6858da SM |
848 | (unless (equal command (eval compile-command)) |
849 | (setq compile-command command)) | |
90016295 | 850 | (save-some-buffers (not compilation-ask-about-save) nil) |
ebb8cb68 | 851 | (setq compilation-directory default-directory) |
7837c247 | 852 | (compilation-start command comint)) |
55dfd2c4 | 853 | |
5b6858da | 854 | ;; run compile with the default command line |
e60476ca | 855 | (defun recompile () |
6867356a | 856 | "Re-compile the program including the current buffer. |
6f5b7627 SM |
857 | If this is run in a Compilation mode buffer, re-use the arguments from the |
858 | original use. Otherwise, recompile using `compile-command'." | |
e60476ca RS |
859 | (interactive) |
860 | (save-some-buffers (not compilation-ask-about-save) nil) | |
e4aa3c94 JL |
861 | (let ((default-directory |
862 | (or (and (not (eq major-mode (nth 1 compilation-arguments))) | |
863 | compilation-directory) | |
864 | default-directory))) | |
7837c247 SM |
865 | (apply 'compilation-start (or compilation-arguments |
866 | `(,(eval compile-command)))))) | |
09843b4a | 867 | |
b5812513 DL |
868 | (defcustom compilation-scroll-output nil |
869 | "*Non-nil to scroll the *compilation* buffer window as output appears. | |
870 | ||
6f5b7627 | 871 | Setting it causes the Compilation mode commands to put point at the |
b5812513 | 872 | end of their output window so that the end of the output is always |
6f5b7627 | 873 | visible rather than the beginning." |
b5812513 | 874 | :type 'boolean |
a46fddeb | 875 | :version "20.3" |
b5812513 DL |
876 | :group 'compilation) |
877 | ||
7bdb67b2 GM |
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." | |
dc2feacf | 887 | (cond (name-function |
7bdb67b2 | 888 | (funcall name-function mode-name)) |
dc2feacf | 889 | (compilation-buffer-name-function |
7bdb67b2 | 890 | (funcall compilation-buffer-name-function mode-name)) |
e4aa3c94 | 891 | ((eq major-mode (nth 1 compilation-arguments)) |
7bdb67b2 GM |
892 | (buffer-name)) |
893 | (t | |
894 | (concat "*" (downcase mode-name) "*")))) | |
895 | ||
7837c247 SM |
896 | ;; This is a rough emulation of the old hack, until the transition to new |
897 | ;; compile is complete. | |
55dfd2c4 | 898 | (defun compile-internal (command error-message |
a24770bc RS |
899 | &optional name-of-mode parser |
900 | error-regexp-alist name-function | |
901 | enter-regexp-alist leave-regexp-alist | |
23b0c5fc | 902 | file-regexp-alist nomessage-regexp-alist |
9ac57479 | 903 | no-async highlight-regexp local-map) |
7837c247 SM |
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 | ||
a24c45d2 | 914 | ;;;###autoload |
7837c247 | 915 | (defun compilation-start (command &optional mode name-function highlight-regexp) |
55dfd2c4 | 916 | "Run compilation command COMMAND (low level interface). |
489a8034 | 917 | If COMMAND starts with a cd command, that becomes the `default-directory'. |
9ac57479 KS |
918 | The rest of the arguments are optional; for them, nil means use the default. |
919 | ||
7837c247 | 920 | MODE is the major mode to set in the compilation buffer. Mode |
6f5b7627 | 921 | may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'. |
5b317d74 RF |
922 | If NAME-FUNCTION is non-nil, call it with one argument (the mode name) |
923 | to determine the buffer name. | |
23b0c5fc | 924 | |
9ac57479 | 925 | If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight |
6f5b7627 | 926 | the matching section of the visited source line; the default is to use the |
9ac57479 KS |
927 | global value of `compilation-highlight-regexp'. |
928 | ||
646bd331 | 929 | Returns the compilation buffer created." |
7837c247 | 930 | (or mode (setq mode 'compilation-mode)) |
489a8034 DP |
931 | (let* ((name-of-mode |
932 | (if (eq mode t) | |
933 | (prog1 "compilation" (require 'comint)) | |
934 | (replace-regexp-in-string "-mode$" "" (symbol-name mode)))) | |
199143f1 | 935 | (thisdir default-directory) |
489a8034 | 936 | outwin outbuf) |
c536bb39 SM |
937 | (with-current-buffer |
938 | (setq outbuf | |
939 | (get-buffer-create | |
940 | (compilation-buffer-name name-of-mode name-function))) | |
d3cb357b RM |
941 | (let ((comp-proc (get-buffer-process (current-buffer)))) |
942 | (if comp-proc | |
943 | (if (or (not (eq (process-status comp-proc) 'run)) | |
944 | (yes-or-no-p | |
bea1d57a JB |
945 | (format "A %s process is running; kill it? " |
946 | name-of-mode))) | |
d3cb357b RM |
947 | (condition-case () |
948 | (progn | |
949 | (interrupt-process comp-proc) | |
950 | (sit-for 1) | |
951 | (delete-process comp-proc)) | |
952 | (error nil)) | |
953 | (error "Cannot have two processes in `%s' at once" | |
7837c247 | 954 | (buffer-name))))) |
7837c247 | 955 | (buffer-disable-undo (current-buffer)) |
199143f1 DP |
956 | ;; first transfer directory from where M-x compile was called |
957 | (setq default-directory thisdir) | |
d42c87ab RS |
958 | ;; Make compilation buffer read-only. The filter can still write it. |
959 | ;; Clear out the compilation buffer. | |
199143f1 DP |
960 | (let ((inhibit-read-only t) |
961 | (default-directory thisdir)) | |
962 | ;; Then evaluate a cd command if any, but don't perform it yet, else start-command | |
963 | ;; would do it again through the shell: (cd "..") AND sh -c "cd ..; make" | |
964 | (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command) | |
965 | (if (match-end 1) | |
12221c84 | 966 | (substitute-env-vars (match-string 1 command)) |
199143f1 DP |
967 | "~") |
968 | default-directory)) | |
abed5267 | 969 | (erase-buffer) |
6d2957c4 RS |
970 | ;; Select the desired mode. |
971 | (if (not (eq mode t)) | |
972 | (funcall mode) | |
973 | (setq buffer-read-only nil) | |
974 | (with-no-warnings (comint-mode)) | |
975 | (compilation-shell-minor-mode)) | |
976 | (if highlight-regexp | |
977 | (set (make-local-variable 'compilation-highlight-regexp) | |
978 | highlight-regexp)) | |
6d2957c4 | 979 | ;; Output a mode setter, for saving and later reloading this buffer. |
d42c87ab RS |
980 | (insert "-*- mode: " name-of-mode |
981 | "; default-directory: " (prin1-to-string default-directory) | |
a67e5425 | 982 | " -*-\n" |
314b410b JL |
983 | (format "%s started at %s\n\n" |
984 | mode-name | |
985 | (substring (current-time-string) 0 19)) | |
a67e5425 | 986 | command "\n") |
abed5267 | 987 | (setq thisdir default-directory)) |
7837c247 SM |
988 | (set-buffer-modified-p nil)) |
989 | ;; If we're already in the compilation buffer, go to the end | |
990 | ;; of the buffer, so point will track the compilation output. | |
991 | (if (eq outbuf (current-buffer)) | |
992 | (goto-char (point-max))) | |
993 | ;; Pop up the compilation buffer. | |
994 | (setq outwin (display-buffer outbuf nil t)) | |
995 | (with-current-buffer outbuf | |
577bf5d2 JL |
996 | (let ((process-environment |
997 | (append | |
998 | compilation-environment | |
999 | (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning | |
1000 | system-uses-terminfo) | |
1001 | (list "TERM=dumb" "TERMCAP=" | |
1002 | (format "COLUMNS=%d" (window-width))) | |
1003 | (list "TERM=emacs" | |
1004 | (format "TERMCAP=emacs:co#%d:tc=unknown:" | |
1005 | (window-width)))) | |
1006 | ;; Set the EMACS variable, but | |
1007 | ;; don't override users' setting of $EMACS. | |
1008 | (unless (getenv "EMACS") '("EMACS=t")) | |
1009 | (copy-sequence process-environment)))) | |
577bf5d2 JL |
1010 | (set (make-local-variable 'compilation-arguments) |
1011 | (list command mode name-function highlight-regexp)) | |
1012 | (set (make-local-variable 'revert-buffer-function) | |
1013 | 'compilation-revert-buffer) | |
1014 | (set-window-start outwin (point-min)) | |
1015 | (or (eq outwin (selected-window)) | |
1016 | (set-window-point outwin (if compilation-scroll-output | |
1017 | (point) | |
1018 | (point-min)))) | |
1019 | ;; The setup function is called before compilation-set-window-height | |
1020 | ;; so it can set the compilation-window-height buffer locally. | |
1021 | (if compilation-process-setup-function | |
1022 | (funcall compilation-process-setup-function)) | |
1023 | (compilation-set-window-height outwin) | |
1024 | ;; Start the compilation. | |
1025 | (if (fboundp 'start-process) | |
1026 | (let ((proc (if (eq mode t) | |
1027 | (get-buffer-process | |
1028 | (with-no-warnings | |
1029 | (comint-exec outbuf (downcase mode-name) | |
1030 | shell-file-name nil `("-c" ,command)))) | |
1031 | (start-process-shell-command (downcase mode-name) | |
1032 | outbuf command)))) | |
1033 | ;; Make the buffer's mode line show process state. | |
1034 | (setq mode-line-process '(":%s")) | |
3fa37cd1 EZ |
1035 | (when compilation-disable-input |
1036 | (process-send-eof proc)) | |
577bf5d2 JL |
1037 | (set-process-sentinel proc 'compilation-sentinel) |
1038 | (set-process-filter proc 'compilation-filter) | |
1039 | (set-marker (process-mark proc) (point) outbuf) | |
1040 | (setq compilation-in-progress | |
1041 | (cons proc compilation-in-progress))) | |
1042 | ;; No asynchronous processes available. | |
1043 | (message "Executing `%s'..." command) | |
1044 | ;; Fake modeline display as if `start-process' were run. | |
1045 | (setq mode-line-process ":run") | |
1046 | (force-mode-line-update) | |
1047 | (sit-for 0) ; Force redisplay | |
cf63e6fa EZ |
1048 | (let* ((buffer-read-only nil) ; call-process needs to modify outbuf |
1049 | (status (call-process shell-file-name nil outbuf nil "-c" | |
1050 | command))) | |
577bf5d2 JL |
1051 | (cond ((numberp status) |
1052 | (compilation-handle-exit 'exit status | |
1053 | (if (zerop status) | |
1054 | "finished\n" | |
1055 | (format "\ | |
fd5e58d7 | 1056 | exited abnormally with code %d\n" |
577bf5d2 JL |
1057 | status)))) |
1058 | ((stringp status) | |
1059 | (compilation-handle-exit 'signal status | |
1060 | (concat status "\n"))) | |
1061 | (t | |
1062 | (compilation-handle-exit 'bizarre status status)))) | |
1063 | ;; Without async subprocesses, the buffer is not yet | |
1064 | ;; fontified, so fontify it now. | |
1065 | (let ((font-lock-verbose nil)) ; shut up font-lock messages | |
1066 | (font-lock-fontify-buffer)) | |
cf63e6fa | 1067 | (set-buffer-modified-p nil) |
199143f1 DP |
1068 | (message "Executing `%s'...done" command))) |
1069 | ;; Now finally cd to where the shell started make/grep/... | |
1070 | (setq default-directory thisdir)) | |
7837c247 SM |
1071 | (if (buffer-local-value 'compilation-scroll-output outbuf) |
1072 | (save-selected-window | |
1073 | (select-window outwin) | |
043442b4 KS |
1074 | (goto-char (point-max)))) |
1075 | ;; Make it so the next C-x ` will use this buffer. | |
5d9f0de2 | 1076 | (setq next-error-last-buffer outbuf))) |
55dfd2c4 | 1077 | |
c94b02d6 | 1078 | (defun compilation-set-window-height (window) |
851231e9 | 1079 | "Set the height of WINDOW according to `compilation-window-height'." |
9ac57479 KS |
1080 | (let ((height (buffer-local-value 'compilation-window-height (window-buffer window)))) |
1081 | (and height | |
1082 | (= (window-width window) (frame-width (window-frame window))) | |
1083 | ;; If window is alone in its frame, aside from a minibuffer, | |
1084 | ;; don't change its height. | |
1085 | (not (eq window (frame-root-window (window-frame window)))) | |
b3ef54c5 DP |
1086 | ;; Stef said that doing the saves in this order is safer: |
1087 | (save-excursion | |
9ac57479 | 1088 | (save-selected-window |
b3ef54c5 DP |
1089 | (select-window window) |
1090 | (enlarge-window (- height (window-height)))))))) | |
c94b02d6 | 1091 | |
4282eba1 SM |
1092 | (defvar compilation-menu-map |
1093 | (let ((map (make-sparse-keymap "Errors"))) | |
1094 | (define-key map [stop-subjob] | |
37bf89ab | 1095 | '("Stop Compilation" . kill-compilation)) |
4282eba1 SM |
1096 | (define-key map [compilation-mode-separator2] |
1097 | '("----" . nil)) | |
9ac57479 | 1098 | (define-key map [compilation-first-error] |
4282eba1 | 1099 | '("First Error" . first-error)) |
9ac57479 | 1100 | (define-key map [compilation-previous-error] |
4282eba1 | 1101 | '("Previous Error" . previous-error)) |
9ac57479 | 1102 | (define-key map [compilation-next-error] |
4282eba1 SM |
1103 | '("Next Error" . next-error)) |
1104 | map)) | |
1105 | ||
0b18a8f6 | 1106 | (defvar compilation-minor-mode-map |
55dfd2c4 | 1107 | (let ((map (make-sparse-keymap))) |
9da85ee5 | 1108 | (define-key map [mouse-2] 'compile-goto-error) |
0ac804df | 1109 | (define-key map [follow-link] 'mouse-face) |
55dfd2c4 | 1110 | (define-key map "\C-c\C-c" 'compile-goto-error) |
4e7ce12e | 1111 | (define-key map "\C-m" 'compile-goto-error) |
d3cb357b | 1112 | (define-key map "\C-c\C-k" 'kill-compilation) |
646bd331 RM |
1113 | (define-key map "\M-n" 'compilation-next-error) |
1114 | (define-key map "\M-p" 'compilation-previous-error) | |
d1ed4475 RM |
1115 | (define-key map "\M-{" 'compilation-previous-file) |
1116 | (define-key map "\M-}" 'compilation-next-file) | |
4282eba1 SM |
1117 | ;; Set up the menu-bar |
1118 | (define-key map [menu-bar compilation] | |
1119 | (cons "Errors" compilation-menu-map)) | |
55dfd2c4 | 1120 | map) |
4f6e4ad6 | 1121 | "Keymap for `compilation-minor-mode'.") |
0b18a8f6 | 1122 | |
a24770bc RS |
1123 | (defvar compilation-shell-minor-mode-map |
1124 | (let ((map (make-sparse-keymap))) | |
a24770bc RS |
1125 | (define-key map "\M-\C-m" 'compile-goto-error) |
1126 | (define-key map "\M-\C-n" 'compilation-next-error) | |
1127 | (define-key map "\M-\C-p" 'compilation-previous-error) | |
1128 | (define-key map "\M-{" 'compilation-previous-file) | |
1129 | (define-key map "\M-}" 'compilation-next-file) | |
1130 | ;; Set up the menu-bar | |
4282eba1 SM |
1131 | (define-key map [menu-bar compilation] |
1132 | (cons "Errors" compilation-menu-map)) | |
a24770bc RS |
1133 | map) |
1134 | "Keymap for `compilation-shell-minor-mode'.") | |
1135 | ||
60470fd2 SM |
1136 | (defvar compilation-button-map |
1137 | (let ((map (make-sparse-keymap))) | |
1138 | (define-key map [mouse-2] 'compile-goto-error) | |
0ac804df | 1139 | (define-key map [follow-link] 'mouse-face) |
60470fd2 SM |
1140 | (define-key map "\C-m" 'compile-goto-error) |
1141 | map) | |
1142 | "Keymap for compilation-message buttons.") | |
1143 | (fset 'compilation-button-map compilation-button-map) | |
1144 | ||
0b18a8f6 | 1145 | (defvar compilation-mode-map |
4282eba1 | 1146 | (let ((map (make-sparse-keymap))) |
261b01c6 RS |
1147 | ;; Don't inherit from compilation-minor-mode-map, |
1148 | ;; because that introduces a menu bar item we don't want. | |
1149 | ;; That confuses C-down-mouse-3. | |
5988691b | 1150 | (define-key map [mouse-2] 'compile-goto-error) |
0ac804df | 1151 | (define-key map [follow-link] 'mouse-face) |
5988691b RS |
1152 | (define-key map "\C-c\C-c" 'compile-goto-error) |
1153 | (define-key map "\C-m" 'compile-goto-error) | |
1154 | (define-key map "\C-c\C-k" 'kill-compilation) | |
1155 | (define-key map "\M-n" 'compilation-next-error) | |
1156 | (define-key map "\M-p" 'compilation-previous-error) | |
1157 | (define-key map "\M-{" 'compilation-previous-file) | |
1158 | (define-key map "\M-}" 'compilation-next-file) | |
70fec115 JL |
1159 | (define-key map "\t" 'compilation-next-error) |
1160 | (define-key map [backtab] 'compilation-previous-error) | |
5988691b | 1161 | |
0b18a8f6 RM |
1162 | (define-key map " " 'scroll-up) |
1163 | (define-key map "\^?" 'scroll-down) | |
221206e3 | 1164 | (define-key map "\C-c\C-f" 'next-error-follow-minor-mode) |
9ac57479 | 1165 | |
e60476ca | 1166 | ;; Set up the menu-bar |
5988691b RS |
1167 | (let ((submap (make-sparse-keymap "Compile"))) |
1168 | (define-key map [menu-bar compilation] | |
1169 | (cons "Compile" submap)) | |
1170 | (set-keymap-parent submap compilation-menu-map)) | |
4282eba1 | 1171 | (define-key map [menu-bar compilation compilation-separator2] |
e60476ca | 1172 | '("----" . nil)) |
9ac57479 | 1173 | (define-key map [menu-bar compilation compilation-grep] |
314b410b | 1174 | '("Search Files (grep)..." . grep)) |
9ac57479 | 1175 | (define-key map [menu-bar compilation compilation-recompile] |
e60476ca | 1176 | '("Recompile" . recompile)) |
9ac57479 | 1177 | (define-key map [menu-bar compilation compilation-compile] |
32f4ab17 | 1178 | '("Compile..." . compile)) |
0b18a8f6 RM |
1179 | map) |
1180 | "Keymap for compilation log buffers. | |
4282eba1 | 1181 | `compilation-minor-mode-map' is a parent of this.") |
55dfd2c4 | 1182 | |
0a35bd79 RS |
1183 | (put 'compilation-mode 'mode-class 'special) |
1184 | ||
c536bb39 SM |
1185 | (defvar compilation-skip-to-next-location t |
1186 | "*If non-nil, skip multiple error messages for the same source location.") | |
1187 | ||
1188 | (defcustom compilation-skip-threshold 1 | |
1189 | "*Compilation motion commands skip less important messages. | |
1190 | The value can be either 2 -- skip anything less than error, 1 -- | |
1191 | skip anything less than warning or 0 -- don't skip any messages. | |
1192 | Note that all messages not positively identified as warning or | |
1193 | info, are considered errors." | |
1194 | :type '(choice (const :tag "Warnings and info" 2) | |
1195 | (const :tag "Info" 1) | |
1196 | (const :tag "None" 0)) | |
f6164cdd | 1197 | :group 'compilation |
bf247b6e | 1198 | :version "22.1") |
c536bb39 SM |
1199 | |
1200 | (defcustom compilation-skip-visited nil | |
1201 | "*Compilation motion commands skip visited messages if this is t. | |
1202 | Visited messages are ones for which the file, line and column have been jumped | |
1203 | to from the current content in the current compilation buffer, even if it was | |
1204 | from a different message." | |
1205 | :type 'boolean | |
f6164cdd | 1206 | :group 'compilation |
bf247b6e | 1207 | :version "22.1") |
c536bb39 | 1208 | |
501cf428 | 1209 | ;;;###autoload |
d42c87ab | 1210 | (defun compilation-mode (&optional name-of-mode) |
55dfd2c4 RS |
1211 | "Major mode for compilation log buffers. |
1212 | \\<compilation-mode-map>To visit the source for a line-numbered error, | |
d3cb357b | 1213 | move point to the error message line and type \\[compile-goto-error]. |
7c163413 RM |
1214 | To kill the compilation, type \\[kill-compilation]. |
1215 | ||
2894bd96 | 1216 | Runs `compilation-mode-hook' with `run-mode-hooks' (which see). |
8ff2ed52 RS |
1217 | |
1218 | \\{compilation-mode-map}" | |
55dfd2c4 | 1219 | (interactive) |
9af0d309 | 1220 | (kill-all-local-variables) |
55dfd2c4 | 1221 | (use-local-map compilation-mode-map) |
0b18a8f6 | 1222 | (setq major-mode 'compilation-mode |
d42c87ab | 1223 | mode-name (or name-of-mode "Compilation")) |
7837c247 SM |
1224 | (set (make-local-variable 'page-delimiter) |
1225 | compilation-page-delimiter) | |
0b18a8f6 | 1226 | (compilation-setup) |
bd8c6db5 | 1227 | (setq buffer-read-only t) |
7837c247 SM |
1228 | (run-mode-hooks 'compilation-mode-hook)) |
1229 | ||
1230 | (defmacro define-compilation-mode (mode name doc &rest body) | |
1231 | "This is like `define-derived-mode' without the PARENT argument. | |
1232 | The parent is always `compilation-mode' and the customizable `compilation-...' | |
bac3a1c9 JL |
1233 | variables are also set from the name of the mode you have chosen, |
1234 | by replacing the first word, e.g `compilation-scroll-output' from | |
1235 | `grep-scroll-output' if that variable exists." | |
7837c247 SM |
1236 | (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode)))) |
1237 | `(define-derived-mode ,mode compilation-mode ,name | |
1238 | ,doc | |
1239 | ,@(mapcar (lambda (v) | |
1240 | (setq v (cons v | |
1241 | (intern-soft (replace-regexp-in-string | |
1242 | "^compilation" mode-name | |
1243 | (symbol-name v))))) | |
1244 | (and (cdr v) | |
1245 | (or (boundp (cdr v)) | |
1246 | (if (boundp 'byte-compile-bound-variables) | |
1247 | (memq (cdr v) byte-compile-bound-variables))) | |
1248 | `(set (make-local-variable ',(car v)) ,(cdr v)))) | |
1249 | '(compilation-buffer-name-function | |
1250 | compilation-directory-matcher | |
1251 | compilation-error | |
1252 | compilation-error-regexp-alist | |
1253 | compilation-error-regexp-alist-alist | |
1254 | compilation-error-screen-columns | |
1255 | compilation-finish-function | |
1256 | compilation-finish-functions | |
1257 | compilation-first-column | |
1258 | compilation-mode-font-lock-keywords | |
1259 | compilation-page-delimiter | |
1260 | compilation-parse-errors-filename-function | |
1261 | compilation-process-setup-function | |
1262 | compilation-scroll-output | |
1263 | compilation-search-path | |
1264 | compilation-skip-threshold | |
1265 | compilation-window-height)) | |
1266 | ,@body))) | |
0b18a8f6 | 1267 | |
58856335 | 1268 | (defun compilation-revert-buffer (ignore-auto noconfirm) |
9ed2ab9f RS |
1269 | (if buffer-file-name |
1270 | (let (revert-buffer-function) | |
9ac57479 | 1271 | (revert-buffer ignore-auto noconfirm)) |
9ed2ab9f | 1272 | (if (or noconfirm (yes-or-no-p (format "Restart compilation? "))) |
7837c247 SM |
1273 | (apply 'compilation-start compilation-arguments)))) |
1274 | ||
c536bb39 SM |
1275 | (defvar compilation-current-error nil |
1276 | "Marker to the location from where the next error will be found. | |
1277 | The global commands next/previous/first-error/goto-error use this.") | |
51c8ad03 | 1278 | |
9b7b51a2 SM |
1279 | (defvar compilation-messages-start nil |
1280 | "Buffer position of the beginning of the compilation messages. | |
1281 | If nil, use the beginning of buffer.") | |
1282 | ||
7837c247 SM |
1283 | ;; A function name can't be a hook, must be something with a value. |
1284 | (defconst compilation-turn-on-font-lock 'turn-on-font-lock) | |
58856335 | 1285 | |
7837c247 | 1286 | (defun compilation-setup (&optional minor) |
6f5b7627 SM |
1287 | "Prepare the buffer for the compilation parsing commands to work. |
1288 | Optional argument MINOR indicates this is called from | |
1289 | `compilation-minor-mode'." | |
51c8ad03 | 1290 | (make-local-variable 'compilation-current-error) |
9b7b51a2 | 1291 | (make-local-variable 'compilation-messages-start) |
18aac618 | 1292 | (make-local-variable 'compilation-error-screen-columns) |
b3a7f48f | 1293 | (make-local-variable 'overlay-arrow-position) |
8b71e4d1 | 1294 | (set (make-local-variable 'overlay-arrow-string) "") |
6a1cdc5b JL |
1295 | (setq next-error-overlay-arrow-position nil) |
1296 | (add-hook 'kill-buffer-hook | |
1297 | (lambda () (setq next-error-overlay-arrow-position nil)) nil t) | |
9b7b51a2 SM |
1298 | ;; Note that compilation-next-error-function is for interfacing |
1299 | ;; with the next-error function in simple.el, and it's only | |
1300 | ;; coincidentally named similarly to compilation-next-error. | |
1301 | (setq next-error-function 'compilation-next-error-function) | |
7837c247 SM |
1302 | (set (make-local-variable 'font-lock-extra-managed-props) |
1303 | '(directory message help-echo mouse-face debug)) | |
1304 | (set (make-local-variable 'compilation-locs) | |
1305 | (make-hash-table :test 'equal :weakness 'value)) | |
6f5b7627 | 1306 | ;; lazy-lock would never find the message unless it's scrolled to. |
c536bb39 SM |
1307 | ;; jit-lock might fontify some things too late. |
1308 | (set (make-local-variable 'font-lock-support-mode) nil) | |
7837c247 | 1309 | (set (make-local-variable 'font-lock-maximum-size) nil) |
f6164cdd DP |
1310 | (let ((fld font-lock-defaults)) |
1311 | (if (and minor fld) | |
1312 | (font-lock-add-keywords nil (compilation-mode-font-lock-keywords)) | |
1313 | (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))) | |
1314 | (if minor | |
1315 | (if font-lock-mode | |
1316 | (if fld | |
1317 | (font-lock-fontify-buffer) | |
1318 | (font-lock-change-mode) | |
1319 | (turn-on-font-lock)) | |
1320 | (turn-on-font-lock)) | |
1321 | ;; maybe defer font-lock till after derived mode is set up | |
1322 | (run-mode-hooks 'compilation-turn-on-font-lock)))) | |
0b18a8f6 | 1323 | |
7052680b | 1324 | ;;;###autoload |
4282eba1 | 1325 | (define-minor-mode compilation-shell-minor-mode |
7052680b RS |
1326 | "Toggle compilation shell minor mode. |
1327 | With arg, turn compilation mode on if and only if arg is positive. | |
4282eba1 SM |
1328 | In this minor mode, all the error-parsing commands of the |
1329 | Compilation major mode are available but bound to keys that don't | |
1330 | collide with Shell mode. See `compilation-mode'. | |
7052680b | 1331 | Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." |
7837c247 | 1332 | nil " Shell-Compile" |
d408fed8 | 1333 | :group 'compilation |
7837c247 SM |
1334 | (if compilation-shell-minor-mode |
1335 | (compilation-setup t) | |
1336 | (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords)) | |
1337 | (font-lock-fontify-buffer))) | |
7052680b | 1338 | |
d6bd8dca | 1339 | ;;;###autoload |
4282eba1 | 1340 | (define-minor-mode compilation-minor-mode |
0b18a8f6 RM |
1341 | "Toggle compilation minor mode. |
1342 | With arg, turn compilation mode on if and only if arg is positive. | |
4282eba1 SM |
1343 | In this minor mode, all the error-parsing commands of the |
1344 | Compilation major mode are available. See `compilation-mode'. | |
fee3f63a | 1345 | Turning the mode on runs the normal hook `compilation-minor-mode-hook'." |
7837c247 | 1346 | nil " Compilation" |
d408fed8 | 1347 | :group 'compilation |
7837c247 SM |
1348 | (if compilation-minor-mode |
1349 | (compilation-setup t) | |
1350 | (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords)) | |
1351 | (font-lock-fontify-buffer))) | |
55dfd2c4 | 1352 | |
fd5e58d7 | 1353 | (defun compilation-handle-exit (process-status exit-status msg) |
6f5b7627 | 1354 | "Write MSG in the current buffer and hack its mode-line-process." |
d42c87ab | 1355 | (let ((inhibit-read-only t) |
fd5e58d7 RM |
1356 | (status (if compilation-exit-message-function |
1357 | (funcall compilation-exit-message-function | |
1358 | process-status exit-status msg) | |
1359 | (cons msg exit-status))) | |
1360 | (omax (point-max)) | |
1361 | (opoint (point))) | |
b3a7f48f | 1362 | ;; Record where we put the message, so we can ignore it later on. |
fd5e58d7 RM |
1363 | (goto-char omax) |
1364 | (insert ?\n mode-name " " (car status)) | |
0eac1faa | 1365 | (if (and (numberp compilation-window-height) |
7837c247 SM |
1366 | (zerop compilation-window-height)) |
1367 | (message "%s" (cdr status))) | |
01c50447 RS |
1368 | (if (bolp) |
1369 | (forward-char -1)) | |
fd5e58d7 | 1370 | (insert " at " (substring (current-time-string) 0 19)) |
01c50447 | 1371 | (goto-char (point-max)) |
47092737 RS |
1372 | ;; Prevent that message from being recognized as a compilation error. |
1373 | (add-text-properties omax (point) | |
1374 | (append '(compilation-handle-exit t) nil)) | |
52f84622 | 1375 | (setq mode-line-process (format ":%s [%s]" process-status (cdr status))) |
fd5e58d7 RM |
1376 | ;; Force mode line redisplay soon. |
1377 | (force-mode-line-update) | |
1378 | (if (and opoint (< opoint omax)) | |
1379 | (goto-char opoint)) | |
a5f1c37e RS |
1380 | (with-no-warnings |
1381 | (if compilation-finish-function | |
1382 | (funcall compilation-finish-function (current-buffer) msg))) | |
4cc36b17 RS |
1383 | (let ((functions compilation-finish-functions)) |
1384 | (while functions | |
1385 | (funcall (car functions) (current-buffer) msg) | |
1386 | (setq functions (cdr functions)))))) | |
fd5e58d7 | 1387 | |
55dfd2c4 | 1388 | ;; Called when compilation process changes state. |
55dfd2c4 | 1389 | (defun compilation-sentinel (proc msg) |
d3cb357b | 1390 | "Sentinel for compilation buffers." |
b3a7f48f DP |
1391 | (if (memq (process-status proc) '(exit signal)) |
1392 | (let ((buffer (process-buffer proc))) | |
1393 | (if (null (buffer-name buffer)) | |
1394 | ;; buffer killed | |
1395 | (set-process-buffer proc nil) | |
1396 | (with-current-buffer buffer | |
1397 | ;; Write something in the compilation buffer | |
1398 | ;; and hack its mode line. | |
1399 | (compilation-handle-exit (process-status proc) | |
1400 | (process-exit-status proc) | |
1401 | msg) | |
1402 | ;; Since the buffer and mode line will show that the | |
1403 | ;; process is dead, we can delete it now. Otherwise it | |
1404 | ;; will stay around until M-x list-processes. | |
1405 | (delete-process proc))) | |
1406 | (setq compilation-in-progress (delq proc compilation-in-progress))))) | |
55dfd2c4 | 1407 | |
ad62b7f1 RM |
1408 | (defun compilation-filter (proc string) |
1409 | "Process filter for compilation buffers. | |
4f6e4ad6 | 1410 | Just inserts the text, but uses `insert-before-markers'." |
991c70f8 | 1411 | (if (buffer-name (process-buffer proc)) |
c536bb39 SM |
1412 | (with-current-buffer (process-buffer proc) |
1413 | (let ((inhibit-read-only t)) | |
991c70f8 RS |
1414 | (save-excursion |
1415 | (goto-char (process-mark proc)) | |
1416 | (insert-before-markers string) | |
7837c247 | 1417 | (run-hooks 'compilation-filter-hook)))))) |
b5bb472e | 1418 | |
5d9f0de2 KS |
1419 | ;;; test if a buffer is a compilation buffer, assuming we're in the buffer |
1420 | (defsubst compilation-buffer-internal-p () | |
1421 | "Test if inside a compilation buffer." | |
1422 | (local-variable-p 'compilation-locs)) | |
1423 | ||
1424 | ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p | |
51ba27e7 | 1425 | (defsubst compilation-buffer-p (buffer) |
5d9f0de2 KS |
1426 | "Test if BUFFER is a compilation buffer." |
1427 | (with-current-buffer buffer | |
1428 | (compilation-buffer-internal-p))) | |
7837c247 SM |
1429 | |
1430 | (defmacro compilation-loop (< property-change 1+ error) | |
1431 | `(while (,< n 0) | |
1432 | (or (setq pt (,property-change pt 'message)) | |
1433 | (error ,error compilation-error)) | |
1434 | ;; prop 'message usually has 2 changes, on and off, so re-search if off | |
1435 | (or (setq msg (get-text-property pt 'message)) | |
1436 | (if (setq pt (,property-change pt 'message)) | |
1437 | (setq msg (get-text-property pt 'message))) | |
1438 | (error ,error compilation-error)) | |
1439 | (or (< (cadr msg) compilation-skip-threshold) | |
1440 | (if different-file | |
1441 | (eq (prog1 last (setq last (nth 2 (car msg)))) | |
1442 | last)) | |
1443 | (if compilation-skip-visited | |
1444 | (nthcdr 4 (car msg))) | |
1445 | (if compilation-skip-to-next-location | |
1446 | (eq (car msg) loc)) | |
1447 | ;; count this message only if none of the above are true | |
1448 | (setq n (,1+ n))))) | |
1449 | ||
51c8ad03 | 1450 | (defun compilation-next-error (n &optional different-file pt) |
646bd331 | 1451 | "Move point to the next error in the compilation buffer. |
851231e9 DL |
1452 | Prefix arg N says how many error messages to move forwards (or |
1453 | backwards, if negative). | |
646bd331 RM |
1454 | Does NOT find the source line like \\[next-error]." |
1455 | (interactive "p") | |
1456 | (or (compilation-buffer-p (current-buffer)) | |
851231e9 | 1457 | (error "Not in a compilation buffer")) |
51c8ad03 | 1458 | (or pt (setq pt (point))) |
51c8ad03 DP |
1459 | (let* ((msg (get-text-property pt 'message)) |
1460 | (loc (car msg)) | |
1461 | last) | |
7837c247 SM |
1462 | (if (zerop n) |
1463 | (unless (or msg ; find message near here | |
c536bb39 SM |
1464 | (setq msg (get-text-property (max (1- pt) (point-min)) |
1465 | 'message))) | |
7837c247 | 1466 | (setq pt (previous-single-property-change pt 'message nil |
c536bb39 | 1467 | (line-beginning-position))) |
b3a7f48f | 1468 | (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message)) |
7837c247 | 1469 | (setq pt (next-single-property-change pt 'message nil |
c536bb39 | 1470 | (line-end-position))) |
b3a7f48f DP |
1471 | (or (setq msg (get-text-property pt 'message)) |
1472 | (setq pt (point))))) | |
7837c247 | 1473 | (setq last (nth 2 (car msg))) |
51c8ad03 DP |
1474 | (if (>= n 0) |
1475 | (compilation-loop > next-single-property-change 1- | |
1476 | (if (get-buffer-process (current-buffer)) | |
1477 | "No more %ss yet" | |
1478 | "Moved past last %s")) | |
c536bb39 SM |
1479 | ;; Don't move "back" to message at or before point. |
1480 | ;; Pass an explicit (point-min) to make sure pt is non-nil. | |
1481 | (setq pt (previous-single-property-change pt 'message nil (point-min))) | |
51c8ad03 DP |
1482 | (compilation-loop < previous-single-property-change 1+ |
1483 | "Moved back before first %s"))) | |
7837c247 SM |
1484 | (goto-char pt) |
1485 | (or msg | |
1486 | (error "No %s here" compilation-error)))) | |
646bd331 RM |
1487 | |
1488 | (defun compilation-previous-error (n) | |
1489 | "Move point to the previous error in the compilation buffer. | |
851231e9 DL |
1490 | Prefix arg N says how many error messages to move backwards (or |
1491 | forwards, if negative). | |
7837c247 | 1492 | Does NOT find the source line like \\[previous-error]." |
646bd331 RM |
1493 | (interactive "p") |
1494 | (compilation-next-error (- n))) | |
1495 | ||
b5bb472e | 1496 | (defun compilation-next-file (n) |
24299582 DP |
1497 | "Move point to the next error for a different file than the current one. |
1498 | Prefix arg N says how many files to move forwards (or backwards, if negative)." | |
b5bb472e | 1499 | (interactive "p") |
7837c247 | 1500 | (compilation-next-error n t)) |
b5bb472e RM |
1501 | |
1502 | (defun compilation-previous-file (n) | |
24299582 DP |
1503 | "Move point to the previous error for a different file than the current one. |
1504 | Prefix arg N says how many files to move backwards (or forwards, if negative)." | |
b5bb472e RM |
1505 | (interactive "p") |
1506 | (compilation-next-file (- n))) | |
1507 | ||
55dfd2c4 | 1508 | (defun kill-compilation () |
b765ba64 | 1509 | "Kill the process made by the \\[compile] or \\[grep] commands." |
55dfd2c4 | 1510 | (interactive) |
d3cb357b | 1511 | (let ((buffer (compilation-find-buffer))) |
55dfd2c4 | 1512 | (if (get-buffer-process buffer) |
d3cb357b | 1513 | (interrupt-process (get-buffer-process buffer)) |
bac3a1c9 | 1514 | (error "The %s process is not running" (downcase mode-name))))) |
d3cb357b | 1515 | |
9da85ee5 | 1516 | (defalias 'compile-mouse-goto-error 'compile-goto-error) |
c536bb39 | 1517 | |
9da85ee5 SM |
1518 | (defun compile-goto-error (&optional event) |
1519 | "Visit the source for the error message at point. | |
7837c247 | 1520 | Use this command in a compilation log buffer. Sets the mark at point there." |
9da85ee5 | 1521 | (interactive (list last-input-event)) |
a6cd3f65 | 1522 | (if event (posn-set-point (event-end event))) |
d3cb357b | 1523 | (or (compilation-buffer-p (current-buffer)) |
851231e9 | 1524 | (error "Not in a compilation buffer")) |
b3a7f48f DP |
1525 | (if (get-text-property (point) 'directory) |
1526 | (dired-other-window (car (get-text-property (point) 'directory))) | |
1527 | (push-mark) | |
1528 | (setq compilation-current-error (point)) | |
bfd271b5 | 1529 | (next-error 0))) |
55dfd2c4 | 1530 | |
d3cb357b RM |
1531 | ;; Return a compilation buffer. |
1532 | ;; If the current buffer is a compilation buffer, return it. | |
d3cb357b RM |
1533 | ;; Otherwise, look for a compilation buffer and signal an error |
1534 | ;; if there are none. | |
749354f0 RS |
1535 | (defun compilation-find-buffer (&optional avoid-current) |
1536 | (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)) | |
d3cb357b RM |
1537 | |
1538 | ;;;###autoload | |
5d9f0de2 | 1539 | (defun compilation-next-error-function (n &optional reset) |
a5f1c37e RS |
1540 | "Advance to the next error message and visit the file where the error was. |
1541 | This is the value of `next-error-function' in Compilation buffers." | |
7837c247 | 1542 | (interactive "p") |
5d9f0de2 KS |
1543 | (when reset |
1544 | (setq compilation-current-error nil)) | |
7837c247 SM |
1545 | (let* ((columns compilation-error-screen-columns) ; buffer's local value |
1546 | (last 1) | |
51c8ad03 | 1547 | (loc (compilation-next-error (or n 1) nil |
9b7b51a2 SM |
1548 | (or compilation-current-error |
1549 | compilation-messages-start | |
1550 | (point-min)))) | |
7837c247 SM |
1551 | (end-loc (nth 2 loc)) |
1552 | (marker (point-marker))) | |
51c8ad03 | 1553 | (setq compilation-current-error (point-marker) |
b3a7f48f DP |
1554 | overlay-arrow-position |
1555 | (if (bolp) | |
1556 | compilation-current-error | |
9b7b51a2 | 1557 | (copy-marker (line-beginning-position))) |
51c8ad03 | 1558 | loc (car loc)) |
7837c247 SM |
1559 | ;; If loc contains no marker, no error in that file has been visited. If |
1560 | ;; the marker is invalid the buffer has been killed. So, recalculate all | |
1561 | ;; markers for that file. | |
eb6fb6e2 | 1562 | (unless (and (nth 3 loc) (marker-buffer (nth 3 loc))) |
c536bb39 SM |
1563 | (with-current-buffer (compilation-find-file marker (caar (nth 2 loc)) |
1564 | (or (cdar (nth 2 loc)) | |
1565 | default-directory)) | |
7837c247 SM |
1566 | (save-restriction |
1567 | (widen) | |
c536bb39 | 1568 | (goto-char (point-min)) |
7837c247 SM |
1569 | ;; Treat file's found lines in forward order, 1 by 1. |
1570 | (dolist (line (reverse (cddr (nth 2 loc)))) | |
1571 | (when (car line) ; else this is a filename w/o a line# | |
1572 | (beginning-of-line (- (car line) last -1)) | |
1573 | (setq last (car line))) | |
1574 | ;; Treat line's found columns and store/update a marker for each. | |
1575 | (dolist (col (cdr line)) | |
1576 | (if (car col) | |
1577 | (if (eq (car col) -1) ; special case for range end | |
1578 | (end-of-line) | |
9c8e6c85 | 1579 | (compilation-move-to-column (car col) columns)) |
7837c247 SM |
1580 | (beginning-of-line) |
1581 | (skip-chars-forward " \t")) | |
eb6fb6e2 | 1582 | (if (nth 3 col) |
7837c247 SM |
1583 | (set-marker (nth 3 col) (point)) |
1584 | (setcdr (nthcdr 2 col) `(,(point-marker))))))))) | |
1585 | (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc)) | |
1586 | (setcdr (nthcdr 3 loc) t))) ; Set this one as visited. | |
1587 | ||
e3bef839 SM |
1588 | (defvar compilation-gcpro nil |
1589 | "Internal variable used to keep some values from being GC'd.") | |
1590 | (make-variable-buffer-local 'compilation-gcpro) | |
1591 | ||
eb6fb6e2 DP |
1592 | (defun compilation-fake-loc (marker file &optional line col) |
1593 | "Preassociate MARKER with FILE. | |
dbd97672 | 1594 | FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME). |
eb6fb6e2 DP |
1595 | This is useful when you compile temporary files, but want |
1596 | automatic translation of the messages to the real buffer from | |
1597 | which the temporary file came. This only works if done before a | |
1598 | message about FILE appears! | |
1599 | ||
1600 | Optional args LINE and COL default to 1 and beginning of | |
1601 | indentation respectively. The marker is expected to reflect | |
1602 | this. In the simplest case the marker points to the first line | |
1603 | of the region that was saved to the temp file. | |
1604 | ||
1605 | If you concatenate several regions into the temp file (e.g. a | |
1606 | header with variable assignments and a code region), you must | |
1607 | call this several times, once each for the last line of one | |
1608 | region and the first line of the next region." | |
1609 | (or (consp file) (setq file (list file))) | |
dbd97672 | 1610 | (setq file (compilation-get-file-structure file)) |
e3bef839 SM |
1611 | ;; Between the current call to compilation-fake-loc and the first occurrence |
1612 | ;; of an error message referring to `file', the data is only kept is the | |
1613 | ;; weak hash-table compilation-locs, so we need to prevent this entry | |
1614 | ;; in compilation-locs from being GC'd away. --Stef | |
1615 | (push file compilation-gcpro) | |
eb6fb6e2 DP |
1616 | (let ((loc (compilation-assq (or line 1) (cdr file)))) |
1617 | (setq loc (compilation-assq col loc)) | |
1618 | (if (cdr loc) | |
1619 | (setcdr (cddr loc) (list marker)) | |
dbd97672 | 1620 | (setcdr loc (list line file marker))) |
eb6fb6e2 DP |
1621 | loc)) |
1622 | ||
8b71e4d1 NR |
1623 | (defcustom compilation-context-lines nil |
1624 | "Display this many lines of leading context before the current message. | |
1625 | If nil and the left fringe is displayed, don't scroll the | |
1626 | compilation output window; an arrow in the left fringe points to | |
1627 | the current message. If nil and there is no left fringe, the message | |
1628 | displays at the top of the window; there is no arrow." | |
a3a9c080 | 1629 | :type '(choice integer (const :tag "No window scrolling" nil)) |
f6164cdd | 1630 | :group 'compilation |
bf247b6e | 1631 | :version "22.1") |
7837c247 SM |
1632 | |
1633 | (defsubst compilation-set-window (w mk) | |
6f5b7627 | 1634 | "Align the compilation output window W with marker MK near top." |
a3a9c080 JL |
1635 | (if (integerp compilation-context-lines) |
1636 | (set-window-start w (save-excursion | |
8b71e4d1 NR |
1637 | (goto-char mk) |
1638 | (beginning-of-line | |
1639 | (- 1 compilation-context-lines)) | |
1640 | (point))) | |
3c9e7f42 RS |
1641 | ;; If there is no left fringe. |
1642 | (if (equal (car (window-fringes)) 0) | |
8b71e4d1 NR |
1643 | (set-window-start w (save-excursion |
1644 | (goto-char mk) | |
1645 | (beginning-of-line 1) | |
1646 | (point))))) | |
1647 | (set-window-point w mk)) | |
7837c247 | 1648 | |
0ea50e43 RS |
1649 | (defvar next-error-highlight-timer) |
1650 | ||
7837c247 | 1651 | (defun compilation-goto-locus (msg mk end-mk) |
6f5b7627 | 1652 | "Jump to an error corresponding to MSG at MK. |
9dc3a46a JL |
1653 | All arguments are markers. If END-MK is non-nil, mark is set there |
1654 | and overlay is highlighted between MK and END-MK." | |
d28701c7 | 1655 | (if (eq (window-buffer (selected-window)) |
7837c247 | 1656 | (marker-buffer msg)) |
d28701c7 RS |
1657 | ;; If the compilation buffer window is selected, |
1658 | ;; keep the compilation buffer in this window; | |
1659 | ;; display the source in another window. | |
1660 | (let ((pop-up-windows t)) | |
7837c247 | 1661 | (pop-to-buffer (marker-buffer mk))) |
8f36a284 | 1662 | (if (window-dedicated-p (selected-window)) |
7837c247 SM |
1663 | (pop-to-buffer (marker-buffer mk)) |
1664 | (switch-to-buffer (marker-buffer mk)))) | |
1665 | ;; If narrowing gets in the way of going to the right place, widen. | |
1666 | (unless (eq (goto-char mk) (point)) | |
1667 | (widen) | |
1668 | (goto-char mk)) | |
1669 | (if end-mk | |
9dc3a46a | 1670 | (push-mark end-mk t) |
7837c247 | 1671 | (if mark-active (setq mark-active))) |
721cfafe TTN |
1672 | ;; If hideshow got in the way of |
1673 | ;; seeing the right place, open permanently. | |
7837c247 SM |
1674 | (dolist (ov (overlays-at (point))) |
1675 | (when (eq 'hs (overlay-get ov 'invisible)) | |
1676 | (delete-overlay ov) | |
1677 | (goto-char mk))) | |
eaa3cac5 RM |
1678 | |
1679 | ;; Show compilation buffer in other window, scrolled to this error. | |
1680 | (let* ((pop-up-windows t) | |
eae2c972 | 1681 | ;; Use an existing window if it is in a visible frame. |
7837c247 | 1682 | (w (or (get-buffer-window (marker-buffer msg) 'visible) |
eae2c972 | 1683 | ;; Pop up a window. |
7837c247 SM |
1684 | (display-buffer (marker-buffer msg)))) |
1685 | (highlight-regexp (with-current-buffer (marker-buffer msg) | |
1686 | ;; also do this while we change buffer | |
1687 | (compilation-set-window w msg) | |
9ac57479 | 1688 | compilation-highlight-regexp))) |
9ac57479 KS |
1689 | (compilation-set-window-height w) |
1690 | ||
9dc3a46a | 1691 | (when highlight-regexp |
073fcaf6 JL |
1692 | (if (timerp next-error-highlight-timer) |
1693 | (cancel-timer next-error-highlight-timer)) | |
9ac57479 | 1694 | (unless compilation-highlight-overlay |
c536bb39 SM |
1695 | (setq compilation-highlight-overlay |
1696 | (make-overlay (point-min) (point-min))) | |
2beb6aa0 | 1697 | (overlay-put compilation-highlight-overlay 'face 'next-error)) |
7837c247 | 1698 | (with-current-buffer (marker-buffer mk) |
9ac57479 | 1699 | (save-excursion |
9dc3a46a | 1700 | (if end-mk (goto-char end-mk) (end-of-line)) |
c536bb39 | 1701 | (let ((end (point))) |
9dc3a46a | 1702 | (if mk (goto-char mk) (beginning-of-line)) |
9ac57479 | 1703 | (if (and (stringp highlight-regexp) |
7837c247 | 1704 | (re-search-forward highlight-regexp end t)) |
9ac57479 KS |
1705 | (progn |
1706 | (goto-char (match-beginning 0)) | |
2beb6aa0 JL |
1707 | (move-overlay compilation-highlight-overlay |
1708 | (match-beginning 0) (match-end 0) | |
1709 | (current-buffer))) | |
1710 | (move-overlay compilation-highlight-overlay | |
1711 | (point) end (current-buffer))) | |
1712 | (if (numberp next-error-highlight) | |
073fcaf6 JL |
1713 | (setq next-error-highlight-timer |
1714 | (run-at-time next-error-highlight nil 'delete-overlay | |
1715 | compilation-highlight-overlay))) | |
1716 | (if (not (or (eq next-error-highlight t) | |
1717 | (numberp next-error-highlight))) | |
2beb6aa0 JL |
1718 | (delete-overlay compilation-highlight-overlay)))))) |
1719 | (when (and (eq next-error-highlight 'fringe-arrow)) | |
6a1cdc5b JL |
1720 | (setq next-error-overlay-arrow-position |
1721 | (copy-marker (line-beginning-position)))))) | |
1722 | ||
eaa3cac5 | 1723 | \f |
20c1daec | 1724 | (defun compilation-find-file (marker filename dir &rest formats) |
851231e9 | 1725 | "Find a buffer for file FILENAME. |
ffb4b7a1 SM |
1726 | Search the directories in `compilation-search-path'. |
1727 | A nil in `compilation-search-path' means to try the | |
851231e9 DL |
1728 | current directory, which is passed in DIR. |
1729 | If FILENAME is not found at all, ask the user where to find it. | |
1730 | Pop up the buffer containing MARKER and scroll to MARKER if we ask the user." | |
20c1daec | 1731 | (or formats (setq formats '("%s"))) |
721cfafe TTN |
1732 | (save-excursion |
1733 | (let ((dirs compilation-search-path) | |
1734 | buffer thisdir fmts name) | |
1735 | (if (file-name-absolute-p filename) | |
5b6858da SM |
1736 | ;; The file name is absolute. Use its explicit directory as |
1737 | ;; the first in the search path, and strip it from FILENAME. | |
1738 | (setq filename (abbreviate-file-name (expand-file-name filename)) | |
1739 | dirs (cons (file-name-directory filename) dirs) | |
1740 | filename (file-name-nondirectory filename))) | |
721cfafe TTN |
1741 | ;; Now search the path. |
1742 | (while (and dirs (null buffer)) | |
1743 | (setq thisdir (or (car dirs) dir) | |
1744 | fmts formats) | |
1745 | ;; For each directory, try each format string. | |
1746 | (while (and fmts (null buffer)) | |
1747 | (setq name (expand-file-name (format (car fmts) filename) thisdir) | |
1748 | buffer (and (file-exists-p name) | |
ffb4b7a1 | 1749 | (find-file-noselect name)) |
721cfafe TTN |
1750 | fmts (cdr fmts))) |
1751 | (setq dirs (cdr dirs))) | |
1752 | (or buffer | |
7837c247 SM |
1753 | ;; The file doesn't exist. Ask the user where to find it. |
1754 | (let ((pop-up-windows t)) | |
1755 | (compilation-set-window (display-buffer (marker-buffer marker)) | |
1756 | marker) | |
721cfafe TTN |
1757 | (let ((name (expand-file-name |
1758 | (read-file-name | |
bac3a1c9 JL |
1759 | (format "Find this %s in: (default %s) " |
1760 | compilation-error filename) | |
721cfafe TTN |
1761 | dir filename t)))) |
1762 | (if (file-directory-p name) | |
1763 | (setq name (expand-file-name filename name))) | |
1764 | (setq buffer (and (file-exists-p name) | |
1765 | (find-file name)))))) | |
1766 | ;; Make intangible overlays tangible. | |
1767 | (mapcar (function (lambda (ov) | |
1768 | (when (overlay-get ov 'intangible) | |
1769 | (overlay-put ov 'intangible nil)))) | |
1770 | (overlays-in (point-min) (point-max))) | |
1771 | buffer))) | |
1772 | ||
dbd97672 DP |
1773 | (defun compilation-get-file-structure (file &optional fmt) |
1774 | "Retrieve FILE's file-structure or create a new one. | |
1775 | FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)." | |
1776 | ||
1777 | (or (gethash file compilation-locs) | |
1778 | ;; File was not previously encountered, at least not in the form passed. | |
1779 | ;; Let's normalize it and look again. | |
1780 | (let ((filename (car file)) | |
1781 | (default-directory (if (cdr file) | |
1782 | (file-truename (cdr file)) | |
1783 | default-directory))) | |
1784 | ||
1785 | ;; Check for a comint-file-name-prefix and prepend it if appropriate. | |
1786 | ;; (This is very useful for compilation-minor-mode in an rlogin-mode | |
1787 | ;; buffer.) | |
1788 | (if (boundp 'comint-file-name-prefix) | |
1789 | (if (file-name-absolute-p filename) | |
1790 | (setq filename | |
1791 | (concat (with-no-warnings comint-file-name-prefix) filename)) | |
1792 | (setq default-directory | |
1793 | (file-truename | |
1794 | (concat (with-no-warnings comint-file-name-prefix) default-directory))))) | |
1795 | ||
1796 | ;; If compilation-parse-errors-filename-function is | |
1797 | ;; defined, use it to process the filename. | |
1798 | (when compilation-parse-errors-filename-function | |
1799 | (setq filename | |
1800 | (funcall compilation-parse-errors-filename-function | |
1801 | filename))) | |
1802 | ||
1803 | ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus | |
1804 | ;; file names like "./bar//foo.c" for file "bar/foo.c"; | |
1805 | ;; expand-file-name will collapse these into "/foo.c" and fail to find | |
1806 | ;; the appropriate file. So we look for doubled slashes in the file | |
1807 | ;; name and fix them. | |
1808 | (setq filename (command-line-normalize-file-name filename)) | |
1809 | ||
1810 | ;; Now eliminate any "..", because find-file would get them wrong. | |
1811 | ;; Make relative and absolute filenames, with or without links, the | |
1812 | ;; same. | |
1813 | (setq filename | |
1814 | (list (abbreviate-file-name | |
1815 | (file-truename (if (cdr file) | |
1816 | (expand-file-name filename) | |
1817 | filename))))) | |
1818 | ||
1819 | ;; Store it for the possibly unnormalized name | |
1820 | (puthash file | |
1821 | ;; Retrieve or create file-structure for normalized name | |
1822 | (or (gethash filename compilation-locs) | |
1823 | (puthash filename (list filename fmt) compilation-locs)) | |
1824 | compilation-locs)))) | |
51501e54 | 1825 | |
7837c247 | 1826 | (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$") |
f1ed9461 | 1827 | |
c536bb39 SM |
1828 | ;;; Compatibility with the old compile.el. |
1829 | ||
1830 | (defun compile-buffer-substring (n) (if n (match-string n))) | |
1831 | ||
1832 | (defun compilation-compat-error-properties (err) | |
6f5b7627 | 1833 | "Map old-style error ERR to new-style message." |
efb0e677 SM |
1834 | ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or |
1835 | ;; (MARKER . MARKER). | |
1836 | (let ((dst (cdr err))) | |
1837 | (if (markerp dst) | |
1838 | ;; Must start with a face, for font-lock. | |
1839 | `(face nil | |
1840 | message ,(list (list nil nil nil dst) 2) | |
1841 | help-echo "mouse-2: visit the source location" | |
1842 | keymap compilation-button-map | |
1843 | mouse-face highlight) | |
1844 | ;; Too difficult to do it by hand: dispatch to the normal code. | |
1845 | (let* ((file (pop dst)) | |
1846 | (line (pop dst)) | |
1847 | (col (pop dst)) | |
1848 | (filename (pop file)) | |
1849 | (dirname (pop file)) | |
1850 | (fmt (pop file))) | |
1851 | (compilation-internal-error-properties | |
1852 | (cons filename dirname) line nil col nil 2 fmt))))) | |
c536bb39 SM |
1853 | |
1854 | (defun compilation-compat-parse-errors (limit) | |
1855 | (when compilation-parse-errors-function | |
1856 | ;; FIXME: We should remove the rest of the compilation keywords | |
1857 | ;; but we can't do that from here because font-lock is using | |
1858 | ;; the value right now. --stef | |
1859 | (save-excursion | |
1860 | (setq compilation-error-list nil) | |
1861 | ;; Reset compilation-parsing-end each time because font-lock | |
1862 | ;; might force us the re-parse many times (typically because | |
1863 | ;; some code adds some text-property to the output that we | |
1864 | ;; already parsed). You might say "why reparse", well: | |
1865 | ;; because font-lock has just removed the `message' property so | |
1866 | ;; have to do it all over again. | |
1867 | (if compilation-parsing-end | |
1868 | (set-marker compilation-parsing-end (point)) | |
1869 | (setq compilation-parsing-end (point-marker))) | |
1870 | (condition-case nil | |
1871 | ;; Ignore any error: we're calling this function earlier than | |
1872 | ;; in the old compile.el so things might not all be setup yet. | |
1873 | (funcall compilation-parse-errors-function limit nil) | |
1874 | (error nil)) | |
1875 | (dolist (err (if (listp compilation-error-list) compilation-error-list)) | |
1876 | (let* ((src (car err)) | |
1877 | (dst (cdr err)) | |
1878 | (loc (cond ((markerp dst) (list nil nil nil dst)) | |
1879 | ((consp dst) | |
1880 | (list (nth 2 dst) (nth 1 dst) | |
1881 | (cons (cdar dst) (caar dst))))))) | |
1882 | (when loc | |
1883 | (goto-char src) | |
1884 | ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face) | |
1885 | (put-text-property src (line-end-position) | |
1886 | 'message (list loc 2))))))) | |
1887 | (goto-char limit) | |
1888 | nil) | |
1889 | ||
9b7b51a2 | 1890 | ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef |
c536bb39 SM |
1891 | (defun compilation-forget-errors () |
1892 | ;; In case we hit the same file/line specs, we want to recompute a new | |
1893 | ;; marker for them, so flush our cache. | |
b3a7f48f | 1894 | (setq compilation-locs (make-hash-table :test 'equal :weakness 'value)) |
e3bef839 | 1895 | (setq compilation-gcpro nil) |
c536bb39 SM |
1896 | ;; FIXME: the old code reset the directory-stack, so maybe we should |
1897 | ;; put a `directory change' marker of some sort, but where? -stef | |
b3a7f48f | 1898 | ;; |
c536bb39 SM |
1899 | ;; FIXME: The old code moved compilation-current-error (which was |
1900 | ;; virtually represented by a mix of compilation-parsing-end and | |
1901 | ;; compilation-error-list) to point-min, but that was only meaningful for | |
1902 | ;; the internal uses of compilation-forget-errors: all calls from external | |
1903 | ;; packages seem to be followed by a move of compilation-parsing-end to | |
1904 | ;; something equivalent to point-max. So we speculatively move | |
1905 | ;; compilation-current-error to point-max (since the external package | |
1906 | ;; won't know that it should do it). --stef | |
9b7b51a2 SM |
1907 | (setq compilation-current-error nil) |
1908 | (let* ((proc (get-buffer-process (current-buffer))) | |
1909 | (mark (if proc (process-mark proc))) | |
1910 | (pos (or mark (point-max)))) | |
1911 | (setq compilation-messages-start | |
1912 | ;; In the future, ignore the text already present in the buffer. | |
1913 | ;; Since many process filter functions insert before markers, | |
1914 | ;; we need to put ours just before the insertion point rather | |
1915 | ;; than at the insertion point. If that's not possible, then | |
1916 | ;; don't use a marker. --Stef | |
1917 | (if (> pos (point-min)) (copy-marker (1- pos)) pos)))) | |
c536bb39 | 1918 | |
0c9a01ff MY |
1919 | ;;;###autoload |
1920 | (add-to-list 'auto-mode-alist '("\\.gcov\\'" . compilation-mode)) | |
1921 | ||
4746118a | 1922 | (provide 'compile) |
fad160d5 | 1923 | |
822001db | 1924 | ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c |
fad160d5 | 1925 | ;;; compile.el ends here |