(grep-use-null-device): New variable.
[bpt/emacs.git] / lisp / progmodes / compile.el
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
2
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 1999, 2001 Free Software Foundation, Inc.
4
5 ;; Author: Roland McGrath <roland@gnu.org>
6 ;; Maintainer: FSF
7 ;; Keywords: tools, processes
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;; This package provides the compile and grep facilities documented in
29 ;; the Emacs user's manual.
30
31 ;;; Code:
32
33 (defgroup compilation nil
34 "Run compiler as inferior of Emacs, parse error messages."
35 :group 'tools
36 :group 'processes)
37
38
39 ;;;###autoload
40 (defcustom compilation-mode-hook nil
41 "*List of hook functions run by `compilation-mode' (see `run-hooks')."
42 :type 'hook
43 :group 'compilation)
44
45 ;;;###autoload
46 (defcustom compilation-window-height nil
47 "*Number of lines in a compilation window. If nil, use Emacs default."
48 :type '(choice (const :tag "Default" nil)
49 integer)
50 :group 'compilation)
51
52 (defcustom compile-auto-highlight nil
53 "*Specify how many compiler errors to highlight (and parse) initially.
54 \(Highlighting applies to an error message when the mouse is over it.)
55 If this is a number N, all compiler error messages in the first N lines
56 are highlighted and parsed as soon as they arrive in Emacs.
57 If t, highlight and parse the whole compilation output as soon as it arrives.
58 If nil, don't highlight or parse any of the buffer until you try to
59 move to the error messages.
60
61 Those messages which are not parsed and highlighted initially
62 will be parsed and highlighted as soon as you try to move to them."
63 :type '(choice (const :tag "All" t)
64 (const :tag "None" nil)
65 (integer :tag "First N lines"))
66 :group 'compilation)
67
68 (defcustom grep-command nil
69 "The default grep command for \\[grep].
70 If the grep program used supports an option to always include file names
71 in its output (such as the `-H' option to GNU grep), it's a good idea to
72 include it when specifying `grep-command'.
73
74 The default value of this variable is set up by `grep-compute-defaults';
75 call that function before using this variable in your program."
76 :type 'string
77 :get '(lambda (symbol)
78 (or grep-command
79 (progn (grep-compute-defaults) grep-command)))
80 :group 'compilation)
81
82 (defcustom grep-use-null-device 'auto-detect
83 "If non-nil, append the value of `null-device' to grep commands.
84 This is done to ensure that the output of grep includes the filename of
85 any match in the case where only a single file is searched, and is not
86 necessary if the grep program used supports the `-H' option.
87
88 The default value of this variable is set up by `grep-compute-defaults';
89 call that function before using this variable in your program."
90 :type 'boolean
91 :get '(lambda (symbol)
92 (if (and grep-use-null-device (not (eq grep-use-null-device t)))
93 (progn (grep-compute-defaults) grep-use-null-device)
94 grep-use-null-device))
95 :group 'compilation)
96
97 (defcustom grep-find-command nil
98 "The default find command for \\[grep-find].
99 The default value of this variable is set up by `grep-compute-defaults';
100 call that function before using this variable in your program."
101 :type 'string
102 :get (lambda (symbol)
103 (or grep-find-command
104 (progn (grep-compute-defaults) grep-find-command)))
105 :group 'compilation)
106
107 (defvar compilation-error-list nil
108 "List of error message descriptors for visiting erring functions.
109 Each error descriptor is a cons (or nil). Its car is a marker pointing to
110 an error message. If its cdr is a marker, it points to the text of the
111 line the message is about. If its cdr is a cons, it is a list
112 \(\(DIRECTORY . FILE\) LINE [COLUMN]\). Or its cdr may be nil if that
113 error is not interesting.
114
115 The value may be t instead of a list; this means that the buffer of
116 error messages should be reparsed the next time the list of errors is wanted.
117
118 Some other commands (like `diff') use this list to control the error
119 message tracking facilities; if you change its structure, you should make
120 sure you also change those packages. Perhaps it is better not to change
121 it at all.")
122
123 (defvar compilation-old-error-list nil
124 "Value of `compilation-error-list' after errors were parsed.")
125
126 (defvar compilation-parse-errors-function 'compilation-parse-errors
127 "Function to call to parse error messages from a compilation.
128 It takes args LIMIT-SEARCH and FIND-AT-LEAST.
129 If LIMIT-SEARCH is non-nil, don't bother parsing past that location.
130 If FIND-AT-LEAST is non-nil, don't bother parsing after finding that
131 many new errors.
132 It should read in the source files which have errors and set
133 `compilation-error-list' to a list with an element for each error message
134 found. See that variable for more info.")
135
136 ;;;###autoload
137 (defvar compilation-process-setup-function nil
138 "*Function to call to customize the compilation process.
139 This functions is called immediately before the compilation process is
140 started. It can be used to set any variables or functions that are used
141 while processing the output of the compilation process.")
142
143 ;;;###autoload
144 (defvar compilation-buffer-name-function nil
145 "Function to compute the name of a compilation buffer.
146 The function receives one argument, the name of the major mode of the
147 compilation buffer. It should return a string.
148 nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
149
150 ;;;###autoload
151 (defvar compilation-finish-function nil
152 "Function to call when a compilation process finishes.
153 It is called with two arguments: the compilation buffer, and a string
154 describing how the process finished.")
155
156 ;;;###autoload
157 (defvar compilation-finish-functions nil
158 "Functions to call when a compilation process finishes.
159 Each function is called with two arguments: the compilation buffer,
160 and a string describing how the process finished.")
161
162 (defvar compilation-last-buffer nil
163 "The most recent compilation buffer.
164 A buffer becomes most recent when its compilation is started
165 or when it is used with \\[next-error] or \\[compile-goto-error].")
166
167 (defvar compilation-in-progress nil
168 "List of compilation processes now running.")
169 (or (assq 'compilation-in-progress minor-mode-alist)
170 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
171 minor-mode-alist)))
172
173 (defvar compilation-parsing-end nil
174 "Marker position of end of buffer when last error messages were parsed.")
175
176 (defvar compilation-error-message "No more errors"
177 "Message to print when no more matches are found.")
178
179 (defvar compilation-arguments nil
180 "Arguments that were given to `compile-internal'.")
181
182 (defvar compilation-num-errors-found)
183
184 (defvar compilation-error-regexp-alist
185 '(
186 ;; NOTE! See also grep-regexp-alist, below.
187
188 ;; 4.3BSD grep, cc, lint pass 1:
189 ;; /usr/src/foo/foo.c(8): warning: w may be used before set
190 ;; or GNU utilities:
191 ;; foo.c:8: error message
192 ;; or HP-UX 7.0 fc:
193 ;; foo.f :16 some horrible error message
194 ;; or GNU utilities with column (GNAT 1.82):
195 ;; foo.adb:2:1: Unit name does not match file name
196 ;; or with column and program name:
197 ;; jade:dbcommon.dsl:133:17:E: missing argument for function call
198 ;;
199 ;; We'll insist that the number be followed by a colon or closing
200 ;; paren, because otherwise this matches just about anything
201 ;; containing a number with spaces around it.
202
203 ;; We insist on a non-digit in the file name
204 ;; so that we don't mistake the file name for a command name
205 ;; and take the line number as the file name.
206 ("\\([a-zA-Z][-a-zA-Z._0-9]+: ?\\)?\
207 \\([a-zA-Z]?:?[^:( \t\n]*[^:( \t\n0-9][^:( \t\n]*\\)[:(][ \t]*\\([0-9]+\\)\
208 \\([) \t]\\|:\\(\\([0-9]+:\\)\\|[0-9]*[^:0-9]\\)\\)" 2 3 6)
209
210 ;; Microsoft C/C++:
211 ;; keyboard.c(537) : warning C4005: 'min' : macro redefinition
212 ;; d:\tmp\test.c(23) : error C2143: syntax error : missing ';' before 'if'
213 ;; This used to be less selective and allow characters other than
214 ;; parens around the line number, but that caused confusion for
215 ;; GNU-style error messages.
216 ;; This used to reject spaces and dashes in file names,
217 ;; but they are valid now; so I made it more strict about the error
218 ;; message that follows.
219 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
220 : \\(error\\|warning\\) C[0-9]+:" 1 3)
221
222 ;; Borland C++, C++Builder:
223 ;; Error ping.c 15: Unable to open include file 'sys/types.h'
224 ;; Warning ping.c 68: Call to function 'func' with no prototype
225 ;; Error E2010 ping.c 15: Unable to open include file 'sys/types.h'
226 ;; Warning W1022 ping.c 68: Call to function 'func' with no prototype
227 ("\\(Error\\|Warning\\) \\(\\([FEW][0-9]+\\) \\)?\
228 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
229 \\([0-9]+\\)\\([) \t]\\|:[^0-9\n]\\)" 4 5)
230
231 ;; 4.3BSD lint pass 2
232 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
233 (".*[ \t:]\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$"
234 1 2)
235
236 ;; 4.3BSD lint pass 3
237 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
238 ;; This used to be
239 ;; ("[ \t(]+\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
240 ;; which is regexp Impressionism - it matches almost anything!
241 (".*([ \t]*\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
242
243 ;; MIPS lint pass<n>; looks good for SunPro lint also
244 ;; TrimMask (255) in solomon.c may be indistinguishable from TrimMasks (93) in solomon.c due to truncation
245 ("[^\n ]+ (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
246 ;; name defined but never used: LinInt in cmap_calc.c(199)
247 (".*in \\([^(\n]+\\)(\\([0-9]+\\))$" 1 2)
248
249 ;; Ultrix 3.0 f77:
250 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
251 ;; Some SGI cc version:
252 ;; cfe: Warning 835: foo.c, line 2: something
253 ("\\(cfe\\|fort\\): [^:\n]*: \\([^ \n]*\\), line \\([0-9]+\\):" 2 3)
254 ;; Error on line 3 of t.f: Execution error unclassifiable statement
255 ;; Unknown who does this:
256 ;; Line 45 of "foo.c": bloofle undefined
257 ;; Absoft FORTRAN 77 Compiler 3.1.3
258 ;; error on line 19 of fplot.f: spelling error?
259 ;; warning on line 17 of fplot.f: data type is undefined for variable d
260 ("\\(.* on \\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
261 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2)
262
263 ;; Apollo cc, 4.3BSD fc:
264 ;; "foo.f", line 3: Error: syntax error near end of statement
265 ;; IBM RS6000:
266 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
267 ;; Microtec mcc68k:
268 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
269 ;; GNAT (as of July 94):
270 ;; "foo.adb", line 2(11): warning: file name does not match ...
271 ;; IBM AIX xlc compiler:
272 ;; "src/swapping.c", line 30.34: 1506-342 (W) "/*" detected in comment.
273 (".*\"\\([^,\" \n\t]+\\)\", lines? \
274 \\([0-9]+\\)\\([\(.]\\([0-9]+\\)\)?\\)?[:., (-]" 1 2 4)
275
276 ;; Caml compiler:
277 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
278 ("^File \"\\([^,\" \n\t]+\\)\", lines? \\([0-9]+\\)[-0-9]*, characters? \\([0-9]+\\)" 1 2 3)
279
280 ;; MIPS RISC CC - the one distributed with Ultrix:
281 ;; ccom: Error: foo.c, line 2: syntax error
282 ;; DEC AXP OSF/1 cc
283 ;; /usr/lib/cmplrs/cc/cfe: Error: foo.c: 1: blah blah
284 ("[a-z0-9/]+: \\([eE]rror\\|[wW]arning\\): \\([^,\" \n\t]+\\)[,:] \\(line \\)?\\([0-9]+\\):" 2 4)
285
286 ;; IBM AIX PS/2 C version 1.1:
287 ;; ****** Error number 140 in line 8 of file errors.c ******
288 (".*in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
289 ;; IBM AIX lint is too painful to do right this way. File name
290 ;; prefixes entire sections rather than being on each line.
291
292 ;; SPARCcompiler Pascal:
293 ;; 20 linjer : array[1..4] of linje;
294 ;; e 18480-----------^--- Inserted ';'
295 ;; and
296 ;; E 18520 line 61 - 0 is undefined
297 ;; These messages don't contain a file name. Instead the compiler gives
298 ;; a message whenever the file being compiled is changed.
299 (" +\\([0-9]+\\) +.*\n[ew] [0-9]+-+" nil 1)
300 ("[Ew] +[0-9]+ line \\([0-9]+\\) - " nil 1)
301
302 ;; Lucid Compiler, lcc 3.x
303 ;; E, file.cc(35,52) Illegal operation on pointers
304 ("[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
305
306 ;; This seems to be superfluous because the first pattern matches it.
307 ;; ;; GNU messages with program name and optional column number.
308 ;; ("[a-zA-Z]?:?[^0-9 \n\t:]+[^ \n\t:]*:[ \t]*\\([^ \n\t:]+\\):\
309 ;;\\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)
310
311 ;; Cray C compiler error messages
312 ("\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \
313 \\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
314
315 ;; IBM C/C++ Tools 2.01:
316 ;; foo.c(2:0) : informational EDC0804: Function foo is not referenced.
317 ;; foo.c(3:8) : warning EDC0833: Implicit return statement encountered.
318 ;; foo.c(5:5) : error EDC0350: Syntax error.
319 ("\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
320
321 ;; IAR Systems C Compiler:
322 ;; "foo.c",3 Error[32]: Error message
323 ;; "foo.c",3 Warning[32]: Error message
324 ("\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(Error\\|Warning\\)\\[[0-9]+\\]:" 1 2)
325
326 ;; Sun ada (VADS, Solaris):
327 ;; /home3/xdhar/rcds_rc/main.a, line 361, char 6:syntax error: "," inserted
328 ("\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
329
330 ;; Perl -w:
331 ;; syntax error at automake line 922, near "':'"
332 ;; Perl debugging traces
333 ;; store::odrecall('File_A', 'x2') called at store.pm line 90
334 (".* at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 1 2)
335
336 ;; Oracle pro*c:
337 ;; Semantic error at line 528, column 5, file erosacqdb.pc:
338 ("Semantic error at line \\([0-9]+\\), column \\([0-9]+\\), file \\(.*\\):"
339 3 1 2)
340
341 ;; EPC F90 compiler:
342 ;; Error 24 at (2:progran.f90) : syntax error
343 ("Error [0-9]+ at (\\([0-9]*\\):\\([^)\n]+\\))" 2 1)
344
345 ;; SGI IRIX MipsPro 7.3 compilers:
346 ;; cc-1070 cc: ERROR File = linkl.c, Line = 38
347 (".*: ERROR File = \\(.+\\), Line = \\([0-9]+\\)" 1 2)
348 (".*: WARNING File = \\(.+\\), Line = \\([0-9]+\\)" 1 2)
349
350 ;; Sun F90 error messages:
351 ;; cf90-113 f90comp: ERROR NSE, File = Hoved.f90, Line = 16, Column = 3
352 (".* ERROR [a-zA-Z0-9 ]+, File = \\(.+\\), Line = \\([0-9]+\\), Column = \\([0-9]+\\)"
353 1 2 3)
354 )
355
356 "Alist that specifies how to match errors in compiler output.
357 Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
358 If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
359 the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
360 given, the COLUMN-IDX'th subexpression gives the column number on that line.
361 If any FILE-FORMAT is given, each is a format string to produce a file name to
362 try; %s in the string is replaced by the text matching the FILE-IDX'th
363 subexpression.")
364
365 (defvar compilation-enter-directory-regexp-alist
366 '(
367 ;; Matches lines printed by the `-w' option of GNU Make.
368 (".*: Entering directory `\\(.*\\)'$" 1)
369 )
370 "Alist specifying how to match lines that indicate a new current directory.
371 Note that the match is done at the beginning of lines.
372 Each elt has the form (REGEXP IDX).
373 If REGEXP matches, the IDX'th subexpression gives the directory name.
374
375 The default value matches lines printed by the `-w' option of GNU Make.")
376
377 (defvar compilation-leave-directory-regexp-alist
378 '(
379 ;; Matches lines printed by the `-w' option of GNU Make.
380 (".*: Leaving directory `\\(.*\\)'$" 1)
381 )
382 "Alist specifying how to match lines that indicate restoring current directory.
383 Note that the match is done at the beginning of lines.
384 Each elt has the form (REGEXP IDX).
385 If REGEXP matches, the IDX'th subexpression gives the name of the directory
386 being moved from. If IDX is nil, the last directory entered \(by a line
387 matching `compilation-enter-directory-regexp-alist'\) is assumed.
388
389 The default value matches lines printed by the `-w' option of GNU Make.")
390
391 (defvar compilation-file-regexp-alist
392 '(
393 ;; This matches entries with date time year file-name: like
394 ;; Thu May 14 10:46:12 1992 mom3.p:
395 ("\\w\\w\\w \\w\\w\\w +[0-9]+ [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9][0-9][0-9][0-9] \\(.*\\):$" 1)
396 )
397 "Alist specifying how to match lines that indicate a new current file.
398 Note that the match is done at the beginning of lines.
399 Each elt has the form (REGEXP IDX).
400 If REGEXP matches, the IDX'th subexpression gives the file name. This is
401 used with compilers that don't indicate file name in every error message.")
402
403 ;; There is no generally useful regexp that will match non messages, but
404 ;; in special cases there might be one. The lines that are not matched by
405 ;; a regexp take much longer time than the ones that are recognized so if
406 ;; you have same regexeps here, parsing is faster.
407 (defvar compilation-nomessage-regexp-alist
408 '(
409 )
410 "Alist specifying how to match lines that have no message.
411 Note that the match is done at the beginning of lines.
412 Each elt has the form (REGEXP). This alist is by default empty, but if
413 you have some good regexps here, the parsing of messages will be faster.")
414
415 (defcustom compilation-error-screen-columns t
416 "*If non-nil, column numbers in error messages are screen columns.
417 Otherwise they are interpreted as character positions, with
418 each character occupying one column.
419 The default is to use screen columns, which requires that the compilation
420 program and Emacs agree about the display width of the characters,
421 especially the TAB character."
422 :type 'boolean
423 :group 'compilation
424 :version "20.4")
425
426 (defcustom compilation-read-command t
427 "*Non-nil means \\[compile] reads the compilation command to use.
428 Otherwise, \\[compile] just uses the value of `compile-command'."
429 :type 'boolean
430 :group 'compilation)
431
432 ;;;###autoload
433 (defcustom compilation-ask-about-save t
434 "*Non-nil means \\[compile] asks which buffers to save before compiling.
435 Otherwise, it saves all modified buffers without asking."
436 :type 'boolean
437 :group 'compilation)
438
439 ;; Note: the character class after the optional drive letter does not
440 ;; include a space to support file names with blanks.
441 (defvar grep-regexp-alist
442 '(("\\([a-zA-Z]?:?[^:(\t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
443 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
444
445 (defvar grep-program
446 ;; Currently zgrep has trouble. It runs egrep instead of grep,
447 ;; and it doesn't pass along long options right.
448 "grep"
449 ;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
450 ;; (call-process "zgrep" nil nil nil
451 ;; "foo" null-device)
452 ;; (error nil))
453 ;; 1)
454 ;; "zgrep"
455 ;; "grep")
456 "The default grep program for `grep-command' and `grep-find-command'.
457 This variable's value takes effect when `grep-compute-defaults' is called.")
458
459 (defvar find-program "find"
460 "The default find program for `grep-find-command'.
461 This variable's value takes effect when `grep-compute-defaults' is called.")
462
463 (defvar grep-find-use-xargs nil
464 "Whether \\[grep-find] uses the `xargs' utility by default.
465
466 If nil, it uses `grep -exec'; if `gnu', it uses `find -print0' and `xargs -0';
467 if not nil and not `gnu', it uses `find -print' and `xargs'.
468
469 This variable's value takes effect when `grep-compute-defaults' is called.")
470
471 ;;;###autoload
472 (defcustom compilation-search-path '(nil)
473 "*List of directories to search for source files named in error messages.
474 Elements should be directory names, not file names of directories.
475 nil as an element means to try the default directory."
476 :type '(repeat (choice (const :tag "Default" nil)
477 (string :tag "Directory")))
478 :group 'compilation)
479
480 (defcustom compile-command "make -k "
481 "*Last shell command used to do a compilation; default for next compilation.
482
483 Sometimes it is useful for files to supply local values for this variable.
484 You might also use mode hooks to specify it in certain modes, like this:
485
486 (add-hook 'c-mode-hook
487 (lambda ()
488 (unless (or (file-exists-p \"makefile\")
489 (file-exists-p \"Makefile\"))
490 (set (make-local-variable 'compile-command)
491 (concat \"make -k \"
492 (file-name-sans-extension buffer-file-name))))))"
493 :type 'string
494 :group 'compilation)
495
496 (defvar compilation-directory-stack nil
497 "Stack of previous directories for `compilation-leave-directory-regexp'.
498 The last element is the directory the compilation was started in.")
499
500 (defvar compilation-exit-message-function nil "\
501 If non-nil, called when a compilation process dies to return a status message.
502 This should be a function of three arguments: process status, exit status,
503 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
504 write into the compilation buffer, and to put in its mode line.")
505
506 ;; History of compile commands.
507 (defvar compile-history nil)
508 ;; History of grep commands.
509 (defvar grep-history nil)
510 (defvar grep-find-history nil)
511
512 (defun compilation-mode-font-lock-keywords ()
513 "Return expressions to highlight in Compilation mode."
514 (nconc
515 ;;
516 ;; Compiler warning/error lines.
517 (mapcar (function
518 (lambda (item)
519 ;; Prepend "^", adjusting FILE-IDX and LINE-IDX accordingly.
520 (let ((file-idx (nth 1 item))
521 (line-idx (nth 2 item))
522 (col-idx (nth 3 item))
523 keyword)
524 (when (numberp col-idx)
525 (setq keyword
526 (cons (list (1+ col-idx) 'font-lock-type-face nil t)
527 keyword)))
528 (when (numberp line-idx)
529 (setq keyword
530 (cons (list (1+ line-idx) 'font-lock-variable-name-face)
531 keyword)))
532 (when (numberp file-idx)
533 (setq keyword
534 (cons (list (1+ file-idx) 'font-lock-warning-face)
535 keyword)))
536 (cons (concat "^\\(" (nth 0 item) "\\)") keyword))))
537 compilation-error-regexp-alist)
538 (list
539 ;;
540 ;; Compiler output lines. Recognize `make[n]:' lines too.
541 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
542 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
543 ))
544 \f
545 ;;;###autoload
546 (defun compile (command)
547 "Compile the program including the current buffer. Default: run `make'.
548 Runs COMMAND, a shell command, in a separate process asynchronously
549 with output going to the buffer `*compilation*'.
550
551 You can then use the command \\[next-error] to find the next error message
552 and move to the source code that caused it.
553
554 Interactively, prompts for the command if `compilation-read-command' is
555 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
556
557 To run more than one compilation at once, start one and rename the
558 \`*compilation*' buffer to some other name with \\[rename-buffer].
559 Then start the next one.
560
561 The name used for the buffer is actually whatever is returned by
562 the function in `compilation-buffer-name-function', so you can set that
563 to a function that generates a unique name."
564 (interactive
565 (if (or compilation-read-command current-prefix-arg)
566 (list (read-from-minibuffer "Compile command: "
567 (eval compile-command) nil nil
568 '(compile-history . 1)))
569 (list (eval compile-command))))
570 (unless (equal command (eval compile-command))
571 (setq compile-command command))
572 (save-some-buffers (not compilation-ask-about-save) nil)
573 (compile-internal command "No more errors"))
574
575 ;; run compile with the default command line
576 (defun recompile ()
577 "Re-compile the program including the current buffer."
578 (interactive)
579 (save-some-buffers (not compilation-ask-about-save) nil)
580 (compile-internal (eval compile-command) "No more errors"))
581
582 (defun grep-process-setup ()
583 "Set up `compilation-exit-message-function' for `grep'."
584 (set (make-local-variable 'compilation-exit-message-function)
585 (lambda (status code msg)
586 (if (eq status 'exit)
587 (cond ((zerop code)
588 '("finished (matches found)\n" . "matched"))
589 ((= code 1)
590 '("finished with no matches found\n" . "no match"))
591 (t
592 (cons msg code)))
593 (cons msg code)))))
594
595 (defun grep-compute-defaults ()
596 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
597 (setq grep-use-null-device
598 (with-temp-buffer
599 (let ((hello-file (expand-file-name "HELLO" data-directory)))
600 (not
601 (and (equal (condition-case nil
602 (if grep-command
603 ;; `grep-command' is already set, so
604 ;; use that for testing.
605 (call-process-shell-command
606 grep-command nil t nil
607 "^English" hello-file)
608 ;; otherwise use `grep-program'
609 (call-process grep-program nil t nil
610 "-nH" "^English" hello-file))
611 (error nil))
612 0)
613 (progn
614 (goto-char (point-min))
615 (looking-at
616 (concat (regexp-quote hello-file)
617 ":[0-9]+:English")))))))))
618 (unless grep-command
619 (setq grep-command
620 (let ((required-options (if grep-use-null-device "-n" "-nH")))
621 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
622 (call-process grep-program nil nil nil
623 "-e" "foo" null-device)
624 (error nil))
625 1)
626 (format "%s %s -e " grep-program required-options)
627 (format "%s %s " grep-program required-options)))))
628 (unless grep-find-use-xargs
629 (setq grep-find-use-xargs
630 (if (and
631 (equal (call-process "find" nil nil nil
632 null-device "-print0")
633 0)
634 (equal (call-process "xargs" nil nil nil
635 "-0" "-e" "echo")
636 0))
637 'gnu)))
638 (unless grep-find-command
639 (setq grep-find-command
640 (cond ((eq grep-find-use-xargs 'gnu)
641 (format "%s . -type f -print0 | xargs -0 -e %s"
642 find-program grep-command))
643 (grep-find-use-xargs
644 (format "%s . -type f -print | xargs %s"
645 find-program grep-command))
646 (t (cons (format "%s . -type f -exec %s {} %s \\;"
647 find-program grep-command null-device)
648 (+ 22 (length grep-command))))))))
649
650 ;;;###autoload
651 (defun grep (command-args)
652 "Run grep, with user-specified args, and collect output in a buffer.
653 While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
654 or \\<compilation-minor-mode-map>\\[compile-goto-error] in the grep \
655 output buffer, to go to the lines
656 where grep found matches.
657
658 This command uses a special history list for its COMMAND-ARGS, so you can
659 easily repeat a grep command.
660
661 A prefix argument says to default the argument based upon the current
662 tag the cursor is over, substituting it into the last grep command
663 in the grep command history (or into `grep-command'
664 if that history list is empty)."
665 (interactive
666 (let (grep-default (arg current-prefix-arg))
667 (unless (and grep-command
668 (or (not grep-use-null-device) (eq grep-use-null-device t)))
669 (grep-compute-defaults))
670 (when arg
671 (let ((tag-default
672 (funcall (or find-tag-default-function
673 (get major-mode 'find-tag-default-function)
674 ;; We use grep-tag-default instead of
675 ;; find-tag-default, to avoid loading etags.
676 'grep-tag-default))))
677 (setq grep-default (or (car grep-history) grep-command))
678 ;; Replace the thing matching for with that around cursor
679 (when (string-match "[^ ]+\\s +\\(-[^ ]+\\s +\\)*\\(\"[^\"]+\"\\|[^ ]+\\)\\(\\s-+\\S-+\\)?" grep-default)
680 (unless (or (match-beginning 3) (not (stringp buffer-file-name)))
681 (setq grep-default (concat grep-default "*."
682 (file-name-extension buffer-file-name))))
683 (setq grep-default (replace-match (or tag-default "")
684 t t grep-default 2)))))
685 (list (read-from-minibuffer "Run grep (like this): "
686 (or grep-default grep-command)
687 nil nil 'grep-history))))
688
689 ;; Setting process-setup-function makes exit-message-function work
690 ;; even when async processes aren't supported.
691 (let* ((compilation-process-setup-function 'grep-process-setup)
692 (buf (compile-internal (if (and grep-use-null-device null-device)
693 (concat command-args " " null-device)
694 command-args)
695 "No more grep hits" "grep"
696 ;; Give it a simpler regexp to match.
697 nil grep-regexp-alist)))))
698
699 ;; This is a copy of find-tag-default from etags.el.
700 (defun grep-tag-default ()
701 (save-excursion
702 (while (looking-at "\\sw\\|\\s_")
703 (forward-char 1))
704 (when (or (re-search-backward "\\sw\\|\\s_"
705 (save-excursion (beginning-of-line) (point))
706 t)
707 (re-search-forward "\\(\\sw\\|\\s_\\)+"
708 (save-excursion (end-of-line) (point))
709 t))
710 (goto-char (match-end 0))
711 (buffer-substring (point)
712 (progn (forward-sexp -1)
713 (while (looking-at "\\s'")
714 (forward-char 1))
715 (point))))))
716
717 ;;;###autoload
718 (defun grep-find (command-args)
719 "Run grep via find, with user-specified args COMMAND-ARGS.
720 Collect output in a buffer.
721 While find runs asynchronously, you can use the \\[next-error] command
722 to find the text that grep hits refer to.
723
724 This command uses a special history list for its arguments, so you can
725 easily repeat a find command."
726 (interactive
727 (progn
728 (unless grep-find-command
729 (grep-compute-defaults))
730 (list (read-from-minibuffer "Run find (like this): "
731 grep-find-command nil nil
732 'grep-find-history))))
733 (let ((null-device nil)) ; see grep
734 (grep command-args)))
735
736 (defcustom compilation-scroll-output nil
737 "*Non-nil to scroll the *compilation* buffer window as output appears.
738
739 Setting it causes the compilation-mode commands to put point at the
740 end of their output window so that the end of the output is always
741 visible rather than the begining."
742 :type 'boolean
743 :version "20.3"
744 :group 'compilation)
745
746 (defun compile-internal (command error-message
747 &optional name-of-mode parser
748 error-regexp-alist name-function
749 enter-regexp-alist leave-regexp-alist
750 file-regexp-alist nomessage-regexp-alist)
751 "Run compilation command COMMAND (low level interface).
752 ERROR-MESSAGE is a string to print if the user asks to see another error
753 and there are no more errors. The rest of the arguments, 3-10 are optional.
754 For them nil means use the default.
755 NAME-OF-MODE is the name to display as the major mode in the compilation
756 buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
757 message regexp alist to use. NAME-FUNCTION is a function called to name the
758 buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
759 LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
760 FILE-REGEXP-ALIST is the change current file message regexp alist to use.
761 NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
762 The defaults for these variables are the global values of
763 \`compilation-parse-errors-function', `compilation-error-regexp-alist',
764 \`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
765 \`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
766 \ and `compilation-nomessage-regexp-alist', respectively.
767 For arg 7-10 a value `t' means an empty alist.
768
769 Returns the compilation buffer created."
770 (let (outbuf)
771 (save-excursion
772 (or name-of-mode
773 (setq name-of-mode "Compilation"))
774 (setq outbuf
775 (get-buffer-create
776 (funcall (or name-function compilation-buffer-name-function
777 (function (lambda (mode)
778 (concat "*" (downcase mode) "*"))))
779 name-of-mode)))
780 (set-buffer outbuf)
781 (let ((comp-proc (get-buffer-process (current-buffer))))
782 (if comp-proc
783 (if (or (not (eq (process-status comp-proc) 'run))
784 (yes-or-no-p
785 (format "A %s process is running; kill it? "
786 name-of-mode)))
787 (condition-case ()
788 (progn
789 (interrupt-process comp-proc)
790 (sit-for 1)
791 (delete-process comp-proc))
792 (error nil))
793 (error "Cannot have two processes in `%s' at once"
794 (buffer-name))
795 )))
796 ;; In case the compilation buffer is current, make sure we get the global
797 ;; values of compilation-error-regexp-alist, etc.
798 (kill-all-local-variables))
799 (or error-regexp-alist
800 (setq error-regexp-alist compilation-error-regexp-alist))
801 (or enter-regexp-alist
802 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
803 (or leave-regexp-alist
804 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
805 (or file-regexp-alist
806 (setq file-regexp-alist compilation-file-regexp-alist))
807 (or nomessage-regexp-alist
808 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
809 (or parser (setq parser compilation-parse-errors-function))
810 (let ((thisdir default-directory)
811 outwin)
812 (save-excursion
813 ;; Clear out the compilation buffer and make it writable.
814 ;; Change its default-directory to the directory where the compilation
815 ;; will happen, and insert a `cd' command to indicate this.
816 (set-buffer outbuf)
817 (setq buffer-read-only nil)
818 (buffer-disable-undo (current-buffer))
819 (erase-buffer)
820 (buffer-enable-undo (current-buffer))
821 (setq default-directory thisdir)
822 (insert "cd " thisdir "\n" command "\n")
823 (set-buffer-modified-p nil))
824 ;; If we're already in the compilation buffer, go to the end
825 ;; of the buffer, so point will track the compilation output.
826 (if (eq outbuf (current-buffer))
827 (goto-char (point-max)))
828 ;; Pop up the compilation buffer.
829 (setq outwin (display-buffer outbuf nil t))
830 (save-excursion
831 (set-buffer outbuf)
832 (compilation-mode name-of-mode)
833 ;; In what way is it non-ergonomic ? -stef
834 ;; (toggle-read-only 1) ;;; Non-ergonomic.
835 (set (make-local-variable 'compilation-parse-errors-function) parser)
836 (set (make-local-variable 'compilation-error-message) error-message)
837 (set (make-local-variable 'compilation-error-regexp-alist)
838 error-regexp-alist)
839 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
840 enter-regexp-alist)
841 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
842 leave-regexp-alist)
843 (set (make-local-variable 'compilation-file-regexp-alist)
844 file-regexp-alist)
845 (set (make-local-variable 'compilation-nomessage-regexp-alist)
846 nomessage-regexp-alist)
847 (set (make-local-variable 'compilation-arguments)
848 (list command error-message
849 name-of-mode parser
850 error-regexp-alist name-function
851 enter-regexp-alist leave-regexp-alist
852 file-regexp-alist nomessage-regexp-alist))
853 ;; This proves a good idea if the buffer's going to scroll
854 ;; with lazy-lock on.
855 (set (make-local-variable 'lazy-lock-defer-on-scrolling) t)
856 (setq default-directory thisdir
857 compilation-directory-stack (list default-directory))
858 (set-window-start outwin (point-min))
859 (or (eq outwin (selected-window))
860 (set-window-point outwin (point-min)))
861 (compilation-set-window-height outwin)
862 (if compilation-process-setup-function
863 (funcall compilation-process-setup-function))
864 ;; Start the compilation.
865 (if (fboundp 'start-process)
866 (let* ((process-environment
867 ;; Don't override users' setting of $EMACS.
868 (if (getenv "EMACS")
869 process-environment
870 (cons "EMACS=t" process-environment)))
871 (proc (start-process-shell-command (downcase mode-name)
872 outbuf
873 command)))
874 (set-process-sentinel proc 'compilation-sentinel)
875 (set-process-filter proc 'compilation-filter)
876 (set-marker (process-mark proc) (point) outbuf)
877 (setq compilation-in-progress
878 (cons proc compilation-in-progress)))
879 ;; No asynchronous processes available.
880 (message "Executing `%s'..." command)
881 ;; Fake modeline display as if `start-process' were run.
882 (setq mode-line-process ":run")
883 (force-mode-line-update)
884 (sit-for 0) ; Force redisplay
885 (let ((status (call-process shell-file-name nil outbuf nil "-c"
886 command)))
887 (cond ((numberp status)
888 (compilation-handle-exit 'exit status
889 (if (zerop status)
890 "finished\n"
891 (format "\
892 exited abnormally with code %d\n"
893 status))))
894 ((stringp status)
895 (compilation-handle-exit 'signal status
896 (concat status "\n")))
897 (t
898 (compilation-handle-exit 'bizarre status status))))
899 (message "Executing `%s'...done" command)))
900 (if compilation-scroll-output
901 (save-selected-window
902 (select-window outwin)
903 (goto-char (point-max)))))
904 ;; Make it so the next C-x ` will use this buffer.
905 (setq compilation-last-buffer outbuf)))
906
907 (defun compilation-set-window-height (window)
908 "Set the height of WINDOW according to `compilation-window-height'."
909 (and compilation-window-height
910 (= (window-width window) (frame-width (window-frame window)))
911 ;; If window is alone in its frame, aside from a minibuffer,
912 ;; don't change its height.
913 (not (eq window (frame-root-window (window-frame window))))
914 ;; This save-excursion prevents us from changing the current buffer,
915 ;; which might not be the same as the selected window's buffer.
916 (save-excursion
917 (let ((w (selected-window)))
918 (unwind-protect
919 (progn
920 (select-window window)
921 (enlarge-window (- compilation-window-height
922 (window-height))))
923 (select-window w))))))
924
925 (defvar compilation-minor-mode-map
926 (let ((map (make-sparse-keymap)))
927 (define-key map [mouse-2] 'compile-mouse-goto-error)
928 (define-key map "\C-c\C-c" 'compile-goto-error)
929 (define-key map "\C-m" 'compile-goto-error)
930 (define-key map "\C-c\C-k" 'kill-compilation)
931 (define-key map "\M-n" 'compilation-next-error)
932 (define-key map "\M-p" 'compilation-previous-error)
933 (define-key map "\M-{" 'compilation-previous-file)
934 (define-key map "\M-}" 'compilation-next-file)
935 map)
936 "Keymap for `compilation-minor-mode'.")
937
938 (defvar compilation-shell-minor-mode-map
939 (let ((map (make-sparse-keymap)))
940 (define-key map [mouse-2] 'compile-mouse-goto-error)
941 (define-key map "\M-\C-m" 'compile-goto-error)
942 (define-key map "\M-\C-n" 'compilation-next-error)
943 (define-key map "\M-\C-p" 'compilation-previous-error)
944 (define-key map "\M-{" 'compilation-previous-file)
945 (define-key map "\M-}" 'compilation-next-file)
946 ;; Set up the menu-bar
947 (define-key map [menu-bar errors-menu]
948 (cons "Errors" (make-sparse-keymap "Errors")))
949 (define-key map [menu-bar errors-menu stop-subjob]
950 '("Stop" . comint-interrupt-subjob))
951 (define-key map [menu-bar errors-menu compilation-mode-separator2]
952 '("----" . nil))
953 (define-key map [menu-bar errors-menu compilation-mode-first-error]
954 '("First Error" . first-error))
955 (define-key map [menu-bar errors-menu compilation-mode-previous-error]
956 '("Previous Error" . previous-error))
957 (define-key map [menu-bar errors-menu compilation-mode-next-error]
958 '("Next Error" . next-error))
959 map)
960 "Keymap for `compilation-shell-minor-mode'.")
961
962 (defvar compilation-mode-map
963 (let ((map (cons 'keymap compilation-minor-mode-map)))
964 (define-key map " " 'scroll-up)
965 (define-key map "\^?" 'scroll-down)
966 ;; Set up the menu-bar
967 (define-key map [menu-bar compilation-menu]
968 (cons "Compile" (make-sparse-keymap "Compile")))
969
970 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
971 '("Stop Compilation" . kill-compilation))
972 (define-key map [menu-bar compilation-menu compilation-mode-separator2]
973 '("----" . nil))
974 (define-key map [menu-bar compilation-menu compilation-mode-first-error]
975 '("First Error" . first-error))
976 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
977 '("Previous Error" . previous-error))
978 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
979 '("Next Error" . next-error))
980 (define-key map [menu-bar compilation-menu compilation-separator2]
981 '("----" . nil))
982 (define-key map [menu-bar compilation-menu compilation-mode-grep]
983 '("Search Files (grep)" . grep))
984 (define-key map [menu-bar compilation-menu compilation-mode-recompile]
985 '("Recompile" . recompile))
986 (define-key map [menu-bar compilation-menu compilation-mode-compile]
987 '("Compile..." . compile))
988 map)
989 "Keymap for compilation log buffers.
990 `compilation-minor-mode-map' is a cdr of this.")
991
992 (put 'compilation-mode 'mode-class 'special)
993
994 ;;;###autoload
995 (defun compilation-mode (&optional name-of-mode)
996 "Major mode for compilation log buffers.
997 \\<compilation-mode-map>To visit the source for a line-numbered error,
998 move point to the error message line and type \\[compile-goto-error].
999 To kill the compilation, type \\[kill-compilation].
1000
1001 Runs `compilation-mode-hook' with `run-hooks' (which see)."
1002 (interactive)
1003 (kill-all-local-variables)
1004 (use-local-map compilation-mode-map)
1005 (setq major-mode 'compilation-mode
1006 mode-name (or name-of-mode "Compilation"))
1007 (compilation-setup)
1008 (set (make-local-variable 'font-lock-defaults)
1009 '(compilation-mode-font-lock-keywords t))
1010 (set (make-local-variable 'revert-buffer-function)
1011 'compilation-revert-buffer)
1012 (run-hooks 'compilation-mode-hook))
1013
1014 (defun compilation-revert-buffer (ignore-auto noconfirm)
1015 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1016 (apply 'compile-internal compilation-arguments)))
1017
1018 (defun compilation-setup ()
1019 "Prepare the buffer for the compilation parsing commands to work."
1020 ;; Make the buffer's mode line show process state.
1021 (setq mode-line-process '(":%s"))
1022 (set (make-local-variable 'compilation-error-list) nil)
1023 (set (make-local-variable 'compilation-old-error-list) nil)
1024 (set (make-local-variable 'compilation-parsing-end) (copy-marker 1))
1025 (set (make-local-variable 'compilation-directory-stack)
1026 (list default-directory))
1027 (make-local-variable 'compilation-error-screen-columns)
1028 (setq compilation-last-buffer (current-buffer)))
1029
1030 (defvar compilation-shell-minor-mode nil
1031 "Non-nil when in `compilation-shell-minor-mode'.
1032 In this minor mode, all the error-parsing commands of the
1033 Compilation major mode are available but bound to keys that don't
1034 collide with Shell mode.")
1035 (make-variable-buffer-local 'compilation-shell-minor-mode)
1036
1037 (or (assq 'compilation-shell-minor-mode minor-mode-alist)
1038 (setq minor-mode-alist
1039 (cons '(compilation-shell-minor-mode " Shell-Compile")
1040 minor-mode-alist)))
1041 (or (assq 'compilation-shell-minor-mode minor-mode-map-alist)
1042 (setq minor-mode-map-alist (cons (cons 'compilation-shell-minor-mode
1043 compilation-shell-minor-mode-map)
1044 minor-mode-map-alist)))
1045
1046 (defvar compilation-minor-mode nil
1047 "Non-nil when in `compilation-minor-mode'.
1048 In this minor mode, all the error-parsing commands of the
1049 Compilation major mode are available.")
1050 (make-variable-buffer-local 'compilation-minor-mode)
1051
1052 (or (assq 'compilation-minor-mode minor-mode-alist)
1053 (setq minor-mode-alist (cons '(compilation-minor-mode " Compilation")
1054 minor-mode-alist)))
1055 (or (assq 'compilation-minor-mode minor-mode-map-alist)
1056 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
1057 compilation-minor-mode-map)
1058 minor-mode-map-alist)))
1059
1060 ;;;###autoload
1061 (defun compilation-shell-minor-mode (&optional arg)
1062 "Toggle compilation shell minor mode.
1063 With arg, turn compilation mode on if and only if arg is positive.
1064 See `compilation-mode'.
1065 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1066 (interactive "P")
1067 (if (setq compilation-shell-minor-mode (if (null arg)
1068 (null compilation-shell-minor-mode)
1069 (> (prefix-numeric-value arg) 0)))
1070 (let ((mode-line-process))
1071 (compilation-setup)
1072 (run-hooks 'compilation-shell-minor-mode-hook))))
1073
1074 ;;;###autoload
1075 (defun compilation-minor-mode (&optional arg)
1076 "Toggle compilation minor mode.
1077 With arg, turn compilation mode on if and only if arg is positive.
1078 See `compilation-mode'.
1079 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1080 (interactive "P")
1081 (if (setq compilation-minor-mode (if (null arg)
1082 (null compilation-minor-mode)
1083 (> (prefix-numeric-value arg) 0)))
1084 (let ((mode-line-process))
1085 (compilation-setup)
1086 (run-hooks 'compilation-minor-mode-hook))))
1087
1088 (defun compilation-handle-exit (process-status exit-status msg)
1089 "Write msg in the current buffer and hack its mode-line-process."
1090 (let ((buffer-read-only nil)
1091 (status (if compilation-exit-message-function
1092 (funcall compilation-exit-message-function
1093 process-status exit-status msg)
1094 (cons msg exit-status)))
1095 (omax (point-max))
1096 (opoint (point)))
1097 ;; Record where we put the message, so we can ignore it
1098 ;; later on.
1099 (goto-char omax)
1100 (insert ?\n mode-name " " (car status))
1101 (if (bolp)
1102 (forward-char -1))
1103 (insert " at " (substring (current-time-string) 0 19))
1104 (goto-char (point-max))
1105 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1106 ;; Force mode line redisplay soon.
1107 (force-mode-line-update)
1108 (if (and opoint (< opoint omax))
1109 (goto-char opoint))
1110 ;; Automatically parse (and mouse-highlight) error messages:
1111 (cond ((eq compile-auto-highlight t)
1112 (compile-reinitialize-errors nil (point-max)))
1113 ((numberp compile-auto-highlight)
1114 (compile-reinitialize-errors nil
1115 (save-excursion
1116 (goto-line compile-auto-highlight)
1117 (point)))))
1118 (if compilation-finish-function
1119 (funcall compilation-finish-function (current-buffer) msg))
1120 (let ((functions compilation-finish-functions))
1121 (while functions
1122 (funcall (car functions) (current-buffer) msg)
1123 (setq functions (cdr functions))))))
1124
1125 ;; Called when compilation process changes state.
1126 (defun compilation-sentinel (proc msg)
1127 "Sentinel for compilation buffers."
1128 (let ((buffer (process-buffer proc)))
1129 (if (memq (process-status proc) '(signal exit))
1130 (progn
1131 (if (null (buffer-name buffer))
1132 ;; buffer killed
1133 (set-process-buffer proc nil)
1134 (let ((obuf (current-buffer)))
1135 ;; save-excursion isn't the right thing if
1136 ;; process-buffer is current-buffer
1137 (unwind-protect
1138 (progn
1139 ;; Write something in the compilation buffer
1140 ;; and hack its mode line.
1141 (set-buffer buffer)
1142 (compilation-handle-exit (process-status proc)
1143 (process-exit-status proc)
1144 msg)
1145 ;; Since the buffer and mode line will show that the
1146 ;; process is dead, we can delete it now. Otherwise it
1147 ;; will stay around until M-x list-processes.
1148 (delete-process proc))
1149 (set-buffer obuf))))
1150 (setq compilation-in-progress (delq proc compilation-in-progress))
1151 ))))
1152
1153 (defun compilation-filter (proc string)
1154 "Process filter for compilation buffers.
1155 Just inserts the text, but uses `insert-before-markers'."
1156 (if (buffer-name (process-buffer proc))
1157 (save-excursion
1158 (set-buffer (process-buffer proc))
1159 (let ((buffer-read-only nil)
1160 (end (marker-position compilation-parsing-end)))
1161 (save-excursion
1162 (goto-char (process-mark proc))
1163 (insert-before-markers string)
1164 (set-marker compilation-parsing-end end) ;don't move it
1165 (run-hooks 'compilation-filter-hook)
1166 ;; this seems redundant since we insert-before-marks -stefan
1167 ;;(set-marker (process-mark proc) (point))
1168 )))))
1169
1170 (defun compile-error-at-point ()
1171 "Return the cdr of `compilation-old-error-list' for error containing point."
1172 (compile-reinitialize-errors nil (point))
1173 (let ((errors compilation-old-error-list))
1174 (while (and errors
1175 (> (point) (car (car errors))))
1176 (setq errors (cdr errors)))
1177 errors))
1178
1179 (defsubst compilation-buffer-p (buffer)
1180 (save-excursion
1181 (set-buffer buffer)
1182 (or compilation-shell-minor-mode compilation-minor-mode
1183 (eq major-mode 'compilation-mode))))
1184
1185 (defun compilation-next-error (n)
1186 "Move point to the next error in the compilation buffer.
1187 Prefix arg N says how many error messages to move forwards (or
1188 backwards, if negative).
1189 Does NOT find the source line like \\[next-error]."
1190 (interactive "p")
1191 (or (compilation-buffer-p (current-buffer))
1192 (error "Not in a compilation buffer"))
1193 (setq compilation-last-buffer (current-buffer))
1194
1195 (let ((errors (compile-error-at-point)))
1196
1197 ;; Move to the error after the one containing point.
1198 (goto-char (car (if (< n 0)
1199 (let ((i 0)
1200 (e compilation-old-error-list))
1201 ;; See how many cdrs away ERRORS is from the start.
1202 (while (not (eq e errors))
1203 (setq i (1+ i)
1204 e (cdr e)))
1205 (if (> (- n) i)
1206 (error "Moved back past first error")
1207 (nth (+ i n) compilation-old-error-list)))
1208 (let ((compilation-error-list (cdr errors)))
1209 (compile-reinitialize-errors nil nil n)
1210 (if compilation-error-list
1211 (nth (1- n) compilation-error-list)
1212 (error "Moved past last error"))))))))
1213
1214 (defun compilation-previous-error (n)
1215 "Move point to the previous error in the compilation buffer.
1216 Prefix arg N says how many error messages to move backwards (or
1217 forwards, if negative).
1218 Does NOT find the source line like \\[next-error]."
1219 (interactive "p")
1220 (compilation-next-error (- n)))
1221
1222
1223 ;; Given an elt of `compilation-error-list', return an object representing
1224 ;; the referenced file which is equal to (but not necessarily eq to) what
1225 ;; this function would return for another error in the same file.
1226 (defsubst compilation-error-filedata (data)
1227 (setq data (cdr data))
1228 (if (markerp data)
1229 (marker-buffer data)
1230 (car data)))
1231
1232 ;; Return a string describing a value from compilation-error-filedata.
1233 ;; This value is not necessarily useful as a file name, but should be
1234 ;; indicative to the user of what file's errors are being referred to.
1235 (defsubst compilation-error-filedata-file-name (filedata)
1236 (if (bufferp filedata)
1237 (buffer-file-name filedata)
1238 (car filedata)))
1239
1240 (defun compilation-next-file (n)
1241 "Move point to the next error for a different file than the current one."
1242 (interactive "p")
1243 (or (compilation-buffer-p (current-buffer))
1244 (error "Not in a compilation buffer"))
1245 (setq compilation-last-buffer (current-buffer))
1246
1247 (let ((reversed (< n 0))
1248 errors filedata)
1249
1250 (if (not reversed)
1251 (setq errors (or (compile-error-at-point)
1252 (error "Moved past last error")))
1253
1254 ;; Get a reversed list of the errors up through the one containing point.
1255 (compile-reinitialize-errors nil (point))
1256 (setq errors (reverse compilation-old-error-list)
1257 n (- n))
1258
1259 ;; Ignore errors after point. (car ERRORS) will be the error
1260 ;; containing point, (cadr ERRORS) the one before it.
1261 (while (and errors
1262 (< (point) (car (car errors))))
1263 (setq errors (cdr errors))))
1264
1265 (while (> n 0)
1266 (setq filedata (compilation-error-filedata (car errors)))
1267
1268 ;; Skip past the following errors for this file.
1269 (while (equal filedata
1270 (compilation-error-filedata
1271 (car (or errors
1272 (if reversed
1273 (error "%s the first erring file"
1274 (compilation-error-filedata-file-name
1275 filedata))
1276 (let ((compilation-error-list nil))
1277 ;; Parse some more.
1278 (compile-reinitialize-errors nil nil 2)
1279 (setq errors compilation-error-list)))
1280 (error "%s is the last erring file"
1281 (compilation-error-filedata-file-name
1282 filedata))))))
1283 (setq errors (cdr errors)))
1284
1285 (setq n (1- n)))
1286
1287 ;; Move to the following error.
1288 (goto-char (car (car (or errors
1289 (if reversed
1290 (error "This is the first erring file")
1291 (let ((compilation-error-list nil))
1292 ;; Parse the last one.
1293 (compile-reinitialize-errors nil nil 1)
1294 compilation-error-list))))))))
1295
1296 (defun compilation-previous-file (n)
1297 "Move point to the previous error for a different file than the current one."
1298 (interactive "p")
1299 (compilation-next-file (- n)))
1300
1301
1302 (defun kill-compilation ()
1303 "Kill the process made by the \\[compile] command."
1304 (interactive)
1305 (let ((buffer (compilation-find-buffer)))
1306 (if (get-buffer-process buffer)
1307 (interrupt-process (get-buffer-process buffer))
1308 (error "The compilation process is not running"))))
1309
1310
1311 ;; Parse any new errors in the compilation buffer,
1312 ;; or reparse from the beginning if the user has asked for that.
1313 (defun compile-reinitialize-errors (reparse
1314 &optional limit-search find-at-least)
1315 (save-excursion
1316 (set-buffer compilation-last-buffer)
1317 ;; If we are out of errors, or if user says "reparse",
1318 ;; discard the info we have, to force reparsing.
1319 (if (or (eq compilation-error-list t)
1320 reparse)
1321 (compilation-forget-errors))
1322 (if (and compilation-error-list
1323 (or (not limit-search)
1324 (> compilation-parsing-end limit-search))
1325 (or (not find-at-least)
1326 (>= (length compilation-error-list) find-at-least)))
1327 ;; Since compilation-error-list is non-nil, it points to a specific
1328 ;; error the user wanted. So don't move it around.
1329 nil
1330 ;; This was here for a long time (before my rewrite); why? --roland
1331 ;;(switch-to-buffer compilation-last-buffer)
1332 (set-buffer-modified-p nil)
1333 (if (< compilation-parsing-end (point-max))
1334 ;; compilation-error-list might be non-nil if we have a non-nil
1335 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
1336 ;; records the current position in the error list, and we must
1337 ;; preserve that after reparsing.
1338 (let ((error-list-pos compilation-error-list))
1339 (funcall compilation-parse-errors-function
1340 limit-search
1341 (and find-at-least
1342 ;; We only need enough new parsed errors to reach
1343 ;; FIND-AT-LEAST errors past the current
1344 ;; position.
1345 (- find-at-least (length compilation-error-list))))
1346 ;; Remember the entire list for compilation-forget-errors. If
1347 ;; this is an incremental parse, append to previous list. If
1348 ;; we are parsing anew, compilation-forget-errors cleared
1349 ;; compilation-old-error-list above.
1350 (setq compilation-old-error-list
1351 (nconc compilation-old-error-list compilation-error-list))
1352 (if error-list-pos
1353 ;; We started in the middle of an existing list of parsed
1354 ;; errors before parsing more; restore that position.
1355 (setq compilation-error-list error-list-pos))
1356 ;; Mouse-Highlight (the first line of) each error message when the
1357 ;; mouse pointer moves over it:
1358 (let ((inhibit-read-only t)
1359 (buffer-undo-list t)
1360 deactivate-mark
1361 (error-list compilation-error-list))
1362 (while error-list
1363 (save-excursion
1364 (add-text-properties (goto-char (car (car error-list)))
1365 (progn (end-of-line) (point))
1366 '(mouse-face highlight help-echo "\
1367 mouse-2: visit this file and line")))
1368 (setq error-list (cdr error-list))))
1369 )))))
1370
1371 (defun compile-mouse-goto-error (event)
1372 "Visit the source for the error message the mouse is pointing at.
1373 This is like `compile-goto-error' called without prefix arg
1374 at the end of the line."
1375 (interactive "e")
1376 (save-excursion
1377 (set-buffer (window-buffer (posn-window (event-end event))))
1378 (goto-char (posn-point (event-end event)))
1379
1380 (or (compilation-buffer-p (current-buffer))
1381 (error "Not in a compilation buffer"))
1382 (setq compilation-last-buffer (current-buffer))
1383 ;; `compile-reinitialize-errors' needs to see the complete filename
1384 ;; on the line where they clicked the mouse. Since it only looks
1385 ;; up to point, moving point to eol makes sure the filename is
1386 ;; visible to `compile-reinitialize-errors'.
1387 (end-of-line)
1388 (compile-reinitialize-errors nil (point))
1389
1390 ;; Move to bol; the marker for the error on this line will point there.
1391 (beginning-of-line)
1392
1393 ;; Move compilation-error-list to the elt of compilation-old-error-list
1394 ;; we want.
1395 (setq compilation-error-list compilation-old-error-list)
1396 (while (and compilation-error-list
1397 ;; The marker can point nowhere if we previously
1398 ;; failed to find the relevant file. See
1399 ;; compilation-next-error-locus.
1400 (or (null (marker-buffer (caar compilation-error-list)))
1401 (> (point) (caar compilation-error-list))))
1402 (setq compilation-error-list (cdr compilation-error-list)))
1403 (or compilation-error-list
1404 (error "No error to go to")))
1405 (select-window (posn-window (event-end event)))
1406
1407 (push-mark)
1408 (next-error 1))
1409
1410 (defun compile-goto-error (&optional argp)
1411 "Visit the source for the error message point is on.
1412 Use this command in a compilation log buffer. Sets the mark at point there.
1413 \\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
1414 other kinds of prefix arguments are ignored."
1415 (interactive "P")
1416 (or (compilation-buffer-p (current-buffer))
1417 (error "Not in a compilation buffer"))
1418 (setq compilation-last-buffer (current-buffer))
1419 (compile-reinitialize-errors (consp argp) (point))
1420
1421 ;; Move to bol; the marker for the error on this line will point there.
1422 (beginning-of-line)
1423
1424 ;; Move compilation-error-list to the elt of compilation-old-error-list
1425 ;; we want.
1426 (setq compilation-error-list compilation-old-error-list)
1427 (while (and compilation-error-list
1428 ;; The marker can point nowhere if we previously
1429 ;; failed to find the relevant file. See
1430 ;; compilation-next-error-locus.
1431 (or (null (marker-buffer (caar compilation-error-list)))
1432 (> (point) (caar compilation-error-list))))
1433 (setq compilation-error-list (cdr compilation-error-list)))
1434
1435 (push-mark)
1436 (next-error 1))
1437
1438 ;; Return a compilation buffer.
1439 ;; If the current buffer is a compilation buffer, return it.
1440 ;; If compilation-last-buffer is set to a live buffer, use that.
1441 ;; Otherwise, look for a compilation buffer and signal an error
1442 ;; if there are none.
1443 (defun compilation-find-buffer (&optional other-buffer)
1444 (if (and (not other-buffer)
1445 (compilation-buffer-p (current-buffer)))
1446 ;; The current buffer is a compilation buffer.
1447 (current-buffer)
1448 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
1449 (compilation-buffer-p compilation-last-buffer)
1450 (or (not other-buffer) (not (eq compilation-last-buffer
1451 (current-buffer)))))
1452 compilation-last-buffer
1453 (let ((buffers (buffer-list)))
1454 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1455 (and other-buffer
1456 (eq (car buffers) (current-buffer)))))
1457 (setq buffers (cdr buffers)))
1458 (if buffers
1459 (car buffers)
1460 (or (and other-buffer
1461 (compilation-buffer-p (current-buffer))
1462 ;; The current buffer is a compilation buffer.
1463 (progn
1464 (if other-buffer
1465 (message "This is the only compilation buffer."))
1466 (current-buffer)))
1467 (error "No compilation started!")))))))
1468
1469 ;;;###autoload
1470 (defun next-error (&optional argp)
1471 "Visit next compilation error message and corresponding source code.
1472
1473 If all the error messages parsed so far have been processed already,
1474 the message buffer is checked for new ones.
1475
1476 A prefix ARGP specifies how many error messages to move;
1477 negative means move back to previous error messages.
1478 Just \\[universal-argument] as a prefix means reparse the error message buffer
1479 and start at the first error.
1480
1481 \\[next-error] normally uses the most recently started compilation or
1482 grep buffer. However, it can operate on any buffer with output from
1483 the \\[compile] and \\[grep] commands, or, more generally, on any
1484 buffer in Compilation mode or with Compilation Minor mode enabled. To
1485 specify use of a particular buffer for error messages, type
1486 \\[next-error] in that buffer.
1487
1488 Once \\[next-error] has chosen the buffer for error messages,
1489 it stays with that buffer until you use it in some other buffer which
1490 uses Compilation mode or Compilation Minor mode.
1491
1492 See variables `compilation-parse-errors-function' and
1493 \`compilation-error-regexp-alist' for customization ideas."
1494 (interactive "P")
1495 (setq compilation-last-buffer (compilation-find-buffer))
1496 (compilation-goto-locus (compilation-next-error-locus
1497 ;; We want to pass a number here only if
1498 ;; we got a numeric prefix arg, not just C-u.
1499 (and (not (consp argp))
1500 (prefix-numeric-value argp))
1501 (consp argp))))
1502 ;;;###autoload (define-key ctl-x-map "`" 'next-error)
1503
1504 (defun previous-error ()
1505 "Visit previous compilation error message and corresponding source code.
1506 This operates on the output from the \\[compile] command."
1507 (interactive)
1508 (next-error -1))
1509
1510 (defun first-error ()
1511 "Reparse the error message buffer and start at the first error.
1512 Visit corresponding source code.
1513 This operates on the output from the \\[compile] command."
1514 (interactive)
1515 (next-error '(4)))
1516
1517 (defvar compilation-skip-to-next-location nil
1518 "*If non-nil, skip multiple error messages for the same source location.")
1519
1520 (defun compilation-next-error-locus (&optional move reparse silent)
1521 "Visit next compilation error and return locus in corresponding source code.
1522 This operates on the output from the \\[compile] command.
1523 If all preparsed error messages have been processed,
1524 the error message buffer is checked for new ones.
1525
1526 Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1527 location of the error message in the compilation buffer, and SOURCE is a
1528 marker at the location in the source code indicated by the error message.
1529
1530 Optional first arg MOVE says how many error messages to move forwards (or
1531 backwards, if negative); default is 1. Optional second arg REPARSE, if
1532 non-nil, says to reparse the error message buffer and reset to the first
1533 error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
1534 nil instead of raising an error if there are no more errors.
1535
1536 The current buffer should be the desired compilation output buffer."
1537 (or move (setq move 1))
1538 (compile-reinitialize-errors reparse nil (and (not reparse) (max 0 move)))
1539 (let (next-errors next-error)
1540 (catch 'no-next-error
1541 (save-excursion
1542 (set-buffer compilation-last-buffer)
1543 ;; compilation-error-list points to the "current" error.
1544 (setq next-errors
1545 (if (> move 0)
1546 (nthcdr (1- move)
1547 compilation-error-list)
1548 ;; Zero or negative arg; we need to move back in the list.
1549 (let ((n (1- move))
1550 (i 0)
1551 (e compilation-old-error-list))
1552 ;; See how many cdrs away the current error is from the start.
1553 (while (not (eq e compilation-error-list))
1554 (setq i (1+ i)
1555 e (cdr e)))
1556 (if (> (- n) i)
1557 (error "Moved back past first error")
1558 (nthcdr (+ i n) compilation-old-error-list))))
1559 next-error (car next-errors))
1560 (while
1561 (if (null next-error)
1562 (progn
1563 (and move (/= move 1)
1564 (error (if (> move 0)
1565 "Moved past last error")
1566 "Moved back past first error"))
1567 ;; Forget existing error messages if compilation has finished.
1568 (if (not (and (get-buffer-process (current-buffer))
1569 (eq (process-status
1570 (get-buffer-process
1571 (current-buffer)))
1572 'run)))
1573 (compilation-forget-errors))
1574 (if silent
1575 (throw 'no-next-error nil)
1576 (error (concat compilation-error-message
1577 (and (get-buffer-process (current-buffer))
1578 (eq (process-status
1579 (get-buffer-process
1580 (current-buffer)))
1581 'run)
1582 " yet")))))
1583 (setq compilation-error-list (cdr next-errors))
1584 (if (null (cdr next-error))
1585 ;; This error is boring. Go to the next.
1586 t
1587 (or (markerp (cdr next-error))
1588 ;; This error has a filename/lineno pair.
1589 ;; Find the file and turn it into a marker.
1590 (let* ((fileinfo (car (cdr next-error)))
1591 (buffer (apply 'compilation-find-file
1592 (car next-error) fileinfo)))
1593 (if (null buffer)
1594 ;; We can't find this error's file.
1595 ;; Remove all errors in the same file.
1596 (progn
1597 (setq next-errors compilation-old-error-list)
1598 (while next-errors
1599 (and (consp (cdr (car next-errors)))
1600 (equal (car (cdr (car next-errors)))
1601 fileinfo)
1602 (progn
1603 (set-marker (car (car next-errors)) nil)
1604 (setcdr (car next-errors) nil)))
1605 (setq next-errors (cdr next-errors)))
1606 ;; Look for the next error.
1607 t)
1608 ;; We found the file. Get a marker for this error.
1609 ;; compilation-old-error-list and
1610 ;; compilation-error-screen-columns are buffer-local
1611 ;; so we must be careful to extract their value
1612 ;; before switching to the source file buffer.
1613 (let ((errors compilation-old-error-list)
1614 (columns compilation-error-screen-columns)
1615 (last-line (nth 1 (cdr next-error)))
1616 (column (nth 2 (cdr next-error))))
1617 (set-buffer buffer)
1618 (save-excursion
1619 (save-restriction
1620 (widen)
1621 (goto-line last-line)
1622 (if (and column (> column 0))
1623 ;; Columns in error msgs are 1-origin.
1624 (if columns
1625 (move-to-column (1- column))
1626 (forward-char (1- column)))
1627 (beginning-of-line))
1628 (setcdr next-error (point-marker))
1629 ;; Make all the other error messages referring
1630 ;; to the same file have markers into the buffer.
1631 (while errors
1632 (and (consp (cdr (car errors)))
1633 (equal (car (cdr (car errors))) fileinfo)
1634 (let* ((this (nth 1 (cdr (car errors))))
1635 (column (nth 2 (cdr (car errors))))
1636 (lines (- this last-line)))
1637 (if (eq selective-display t)
1638 ;; When selective-display is t,
1639 ;; each C-m is a line boundary,
1640 ;; as well as each newline.
1641 (if (< lines 0)
1642 (re-search-backward "[\n\C-m]"
1643 nil 'end
1644 (- lines))
1645 (re-search-forward "[\n\C-m]"
1646 nil 'end
1647 lines))
1648 (forward-line lines))
1649 (if (and column (> column 1))
1650 (if columns
1651 (move-to-column (1- column))
1652 (forward-char (1- column)))
1653 (beginning-of-line))
1654 (setq last-line this)
1655 (setcdr (car errors) (point-marker))))
1656 (setq errors (cdr errors)))))))))
1657 ;; If we didn't get a marker for this error, or this
1658 ;; marker's buffer was killed, go on to the next one.
1659 (or (not (markerp (cdr next-error)))
1660 (not (marker-buffer (cdr next-error))))))
1661 (setq next-errors compilation-error-list
1662 next-error (car next-errors)))))
1663
1664 (if compilation-skip-to-next-location
1665 ;; Skip over multiple error messages for the same source location,
1666 ;; so the next C-x ` won't go to an error in the same place.
1667 (while (and compilation-error-list
1668 (equal (cdr (car compilation-error-list))
1669 (cdr next-error)))
1670 (setq compilation-error-list (cdr compilation-error-list))))
1671
1672 ;; We now have a marker for the position of the error source code.
1673 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1674 next-error))
1675
1676 (defun compilation-goto-locus (next-error)
1677 "Jump to an error locus returned by `compilation-next-error-locus'.
1678 Takes one argument, a cons (ERROR . SOURCE) of two markers.
1679 Selects a window with point at SOURCE, with another window displaying ERROR."
1680 (if (eq (window-buffer (selected-window))
1681 (marker-buffer (car next-error)))
1682 ;; If the compilation buffer window is selected,
1683 ;; keep the compilation buffer in this window;
1684 ;; display the source in another window.
1685 (let ((pop-up-windows t))
1686 (pop-to-buffer (marker-buffer (cdr next-error))))
1687 (if (and (window-dedicated-p (selected-window))
1688 (eq (selected-window) (frame-root-window)))
1689 (switch-to-buffer-other-frame (marker-buffer (cdr next-error)))
1690 (switch-to-buffer (marker-buffer (cdr next-error)))))
1691 (goto-char (cdr next-error))
1692 ;; If narrowing got in the way of
1693 ;; going to the right place, widen.
1694 (or (= (point) (marker-position (cdr next-error)))
1695 (progn
1696 (widen)
1697 (goto-char (cdr next-error))))
1698 ;; If hideshow got in the way of
1699 ;; seeing the right place, open permanently.
1700 (mapcar (function (lambda (ov)
1701 (when (eq 'hs (overlay-get ov 'invisible))
1702 (delete-overlay ov)
1703 (goto-char (cdr next-error)))))
1704 (overlays-at (point)))
1705
1706 ;; Show compilation buffer in other window, scrolled to this error.
1707 (let* ((pop-up-windows t)
1708 ;; Use an existing window if it is in a visible frame.
1709 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
1710 ;; Pop up a window.
1711 (display-buffer (marker-buffer (car next-error))))))
1712 (set-window-point w (car next-error))
1713 (set-window-start w (car next-error))
1714 (compilation-set-window-height w)))
1715 \f
1716 (defun compilation-find-file (marker filename dir &rest formats)
1717 "Find a buffer for file FILENAME.
1718 Search the directories in `compilation-search-path'.
1719 A nil in `compilation-search-path' means to try the
1720 current directory, which is passed in DIR.
1721 If FILENAME is not found at all, ask the user where to find it.
1722 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1723 (or formats (setq formats '("%s")))
1724 (save-excursion
1725 (let ((dirs compilation-search-path)
1726 buffer thisdir fmts name)
1727 (if (file-name-absolute-p filename)
1728 ;; The file name is absolute. Use its explicit directory as
1729 ;; the first in the search path, and strip it from FILENAME.
1730 (setq filename (abbreviate-file-name (expand-file-name filename))
1731 dirs (cons (file-name-directory filename) dirs)
1732 filename (file-name-nondirectory filename)))
1733 ;; Now search the path.
1734 (while (and dirs (null buffer))
1735 (setq thisdir (or (car dirs) dir)
1736 fmts formats)
1737 ;; For each directory, try each format string.
1738 (while (and fmts (null buffer))
1739 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1740 buffer (and (file-exists-p name)
1741 (find-file-noselect name))
1742 fmts (cdr fmts)))
1743 (setq dirs (cdr dirs)))
1744 (or buffer
1745 ;; The file doesn't exist.
1746 ;; Ask the user where to find it.
1747 ;; If he hits C-g, then the next time he does
1748 ;; next-error, he'll skip past it.
1749 (let* ((pop-up-windows t)
1750 (w (display-buffer (marker-buffer marker))))
1751 (set-window-point w marker)
1752 (set-window-start w marker)
1753 (let ((name (expand-file-name
1754 (read-file-name
1755 (format "Find this error in: (default %s) "
1756 filename)
1757 dir filename t))))
1758 (if (file-directory-p name)
1759 (setq name (expand-file-name filename name)))
1760 (setq buffer (and (file-exists-p name)
1761 (find-file name))))))
1762 ;; Make intangible overlays tangible.
1763 (mapcar (function (lambda (ov)
1764 (when (overlay-get ov 'intangible)
1765 (overlay-put ov 'intangible nil))))
1766 (overlays-in (point-min) (point-max)))
1767 buffer)))
1768
1769
1770 ;; Set compilation-error-list to nil, and unchain the markers that point to the
1771 ;; error messages and their text, so that they no longer slow down gap motion.
1772 ;; This would happen anyway at the next garbage collection, but it is better to
1773 ;; do it right away.
1774 (defun compilation-forget-errors ()
1775 (while compilation-old-error-list
1776 (let ((next-error (car compilation-old-error-list)))
1777 (set-marker (car next-error) nil)
1778 (if (markerp (cdr next-error))
1779 (set-marker (cdr next-error) nil)))
1780 (setq compilation-old-error-list (cdr compilation-old-error-list)))
1781 (setq compilation-error-list nil
1782 compilation-directory-stack (list default-directory))
1783 (set-marker compilation-parsing-end 1)
1784 ;; Remove the highlighting added by compile-reinitialize-errors:
1785 (let ((inhibit-read-only t)
1786 (buffer-undo-list t)
1787 deactivate-mark)
1788 (remove-text-properties (point-min) (point-max)
1789 '(mouse-face highlight help-echo nil))))
1790
1791
1792 ;; This function is not needed any more by compilation mode.
1793 ;; Does anyone else need it or can it be deleted?
1794 (defun count-regexp-groupings (regexp)
1795 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
1796 (let ((groupings 0)
1797 (len (length regexp))
1798 (i 0)
1799 c)
1800 (while (< i len)
1801 (setq c (aref regexp i)
1802 i (1+ i))
1803 (cond ((= c ?\[)
1804 ;; Find the end of this [...].
1805 (while (and (< i len)
1806 (not (= (aref regexp i) ?\])))
1807 (setq i (1+ i))))
1808 ((= c ?\\)
1809 (if (< i len)
1810 (progn
1811 (setq c (aref regexp i)
1812 i (1+ i))
1813 (if (= c ?\))
1814 ;; We found the end of a grouping,
1815 ;; so bump our counter.
1816 (setq groupings (1+ groupings))))))))
1817 groupings))
1818
1819 (defvar compilation-current-file nil
1820 "Used by `compilation-parse-errors' to store filename for file being compiled.")
1821
1822 ;; This variable is not used as a global variable. It's defined here just to
1823 ;; shut up the byte compiler. It's bound and used by compilation-parse-errors
1824 ;; and set by compile-collect-regexps.
1825 (defvar compilation-regexps nil)
1826
1827 (defun compilation-parse-errors (limit-search find-at-least)
1828 "Parse the current buffer as grep, cc, lint or other error messages.
1829 See variable `compilation-parse-errors-function' for the interface it uses."
1830 (setq compilation-error-list nil)
1831 (message "Parsing error messages...")
1832 (if (null compilation-error-regexp-alist)
1833 (error "compilation-error-regexp-alist is empty!"))
1834 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
1835 (default-directory (car compilation-directory-stack))
1836 (found-desired nil)
1837 (compilation-num-errors-found 0)
1838 ;; Set up now the expanded, abbreviated directory variables
1839 ;; that compile-abbreviate-directory will need, so we can
1840 ;; compute them just once here.
1841 (orig (abbreviate-file-name default-directory))
1842 (orig-expanded (abbreviate-file-name
1843 (file-truename default-directory)))
1844 (parent-expanded (abbreviate-file-name
1845 (expand-file-name "../" orig-expanded))))
1846
1847 ;; Make a list of all the regexps. Each element has the form
1848 ;; (REGEXP TYPE IDX1 IDX2 ...)
1849 ;; where TYPE is one of leave, enter, file, error or nomessage.
1850 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
1851 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
1852 (compile-collect-regexps 'file compilation-file-regexp-alist)
1853 (compile-collect-regexps 'error compilation-error-regexp-alist)
1854 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
1855
1856 ;; Don't reparse messages already seen at last parse.
1857 (goto-char compilation-parsing-end)
1858 (when (and (bobp)
1859 (compilation-buffer-p (current-buffer)))
1860 (setq compilation-current-file nil) ; No current file at start.
1861 ;; Don't parse the first two lines as error messages.
1862 ;; This matters for grep.
1863 (forward-line 2))
1864
1865 ;; Parse messages.
1866 (while (not (or found-desired (eobp)))
1867 (let ((this compilation-regexps) (prev nil) (alist nil) type)
1868 ;; Go through the regular expressions. If a match is found,
1869 ;; variable alist is set to the corresponding alist and the
1870 ;; matching regexp is moved to the front of compilation-regexps
1871 ;; to make it match faster next time.
1872 (while (and this (null alist))
1873 (if (not (looking-at (car (car this))))
1874 (progn (setq prev this) ; No match, go to next.
1875 (setq this (cdr this)))
1876 (setq alist (cdr (car this))) ; Got a match.
1877 ;;; (if prev ; If not the first regexp,
1878 ;;; (progn ; move it to the front.
1879 ;;; (setcdr prev (cdr this))
1880 ;;; (setcdr this compilation-regexps)
1881 ;;; (setq compilation-regexps this)))
1882 ))
1883 (if (and alist ; Seen a match and not to
1884 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
1885 (let* ((end-of-match (match-end 0))
1886 (filename
1887 (compile-buffer-substring (car (setq alist (cdr alist)))))
1888 stack)
1889 (if (eq type 'error) ; error message
1890 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
1891 (string-to-int
1892 (compile-buffer-substring (car alist)))
1893 ;; (car alist) is not a number, must be a
1894 ;; function that is called below to return
1895 ;; an error position descriptor.
1896 (car alist)))
1897 ;; Convert to integer later if linenum not a function.
1898 (column (compile-buffer-substring
1899 (car (setq alist (cdr alist)))))
1900 this-error)
1901
1902 ;; Check that we have a file name.
1903 (or filename
1904 ;; No file name in message, we must have seen it before
1905 (setq filename compilation-current-file)
1906 (error "\
1907 An error message with no file name and no file name has been seen earlier"))
1908
1909 ;; Check for a comint-file-name-prefix and prepend it if
1910 ;; appropriate. (This is very useful for
1911 ;; compilation-minor-mode in an rlogin-mode buffer.)
1912 (and (boundp 'comint-file-name-prefix)
1913 ;; If file name is relative, default-directory will
1914 ;; already contain the comint-file-name-prefix (done
1915 ;; by compile-abbreviate-directory).
1916 (file-name-absolute-p filename)
1917 (setq filename
1918 (concat comint-file-name-prefix filename)))
1919
1920 ;; Some compilers (e.g. Sun's java compiler, reportedly)
1921 ;; produce bogus file names like "./bar//foo.c" for file
1922 ;; "bar/foo.c"; expand-file-name will collapse these into
1923 ;; "/foo.c" and fail to find the appropriate file. So we
1924 ;; look for doubled slashes in the file name and fix them
1925 ;; up in the buffer.
1926 (setq filename (command-line-normalize-file-name filename))
1927
1928 (setq filename
1929 (cons filename (cons default-directory (cdr alist))))
1930
1931 ;; Locate the erring file and line.
1932 ;; Make this-error a new elt for compilation-error-list,
1933 ;; giving a marker for the current compilation buffer
1934 ;; location, and the file and line number of the error.
1935 ;; Save, as the start of the error, the beginning of the
1936 ;; line containing the match.
1937 (setq this-error
1938 (if (numberp linenum)
1939 (list (point-marker) filename linenum
1940 (and column (string-to-int column)))
1941 ;; If linenum is not a number then it must be
1942 ;; a function returning an error position
1943 ;; descriptor or nil (meaning no position).
1944 (save-excursion
1945 (funcall linenum filename column))))
1946
1947 ;; We have an error position descriptor.
1948 ;; If we have found as many new errors as the user
1949 ;; wants, or if we are past the buffer position he
1950 ;; indicated, then we continue to parse until we have
1951 ;; seen all consecutive errors in the same file. This
1952 ;; means that all the errors of a source file will be
1953 ;; seen in one parsing run, so that the error positions
1954 ;; will be recorded as markers in the source file
1955 ;; buffer that will move when the buffer is changed.
1956 (if (and this-error
1957 compilation-error-list ; At least one previous.
1958 (or (and find-at-least
1959 (>= compilation-num-errors-found
1960 find-at-least))
1961 (and limit-search
1962 (>= end-of-match limit-search)))
1963 ;; `this-error' could contain a pair of
1964 ;; markers already.
1965 (let ((thispos (cdr this-error))
1966 (lastpos (cdar compilation-error-list)))
1967 (not (equal
1968 (if (markerp thispos)
1969 (marker-buffer thispos)
1970 (car thispos))
1971 (if (markerp lastpos)
1972 (marker-buffer lastpos)
1973 (car lastpos))))))
1974 ;; We are past the limits and the last error
1975 ;; parsed, didn't belong to the same source file
1976 ;; as the earlier ones i.e. we have seen all the
1977 ;; errors belonging to the earlier file. We don't
1978 ;; add the error just parsed so that the next
1979 ;; parsing run can get it and the following errors
1980 ;; in the same file all at once.
1981 (setq found-desired t)
1982
1983 (goto-char end-of-match) ; Prepare for next message.
1984 ;; Don't add the same source line more than once.
1985 (and this-error
1986 (not (and
1987 compilation-error-list
1988 (equal (cdr (car compilation-error-list))
1989 (cdr this-error))))
1990 (setq compilation-error-list
1991 (cons this-error compilation-error-list)
1992 compilation-num-errors-found
1993 (1+ compilation-num-errors-found)))))
1994
1995 ;; Not an error message.
1996 (if (eq type `file) ; Change current file.
1997 (and filename (setq compilation-current-file filename))
1998 ;; Enter or leave directory.
1999 (setq stack compilation-directory-stack)
2000 (and filename
2001 (file-directory-p
2002 (setq filename
2003 ;; The directory name in the message
2004 ;; is a truename. Try to convert it to a form
2005 ;; like what the user typed in.
2006 (compile-abbreviate-directory
2007 (file-name-as-directory
2008 (expand-file-name filename))
2009 orig orig-expanded parent-expanded)))
2010 (if (eq type 'leave)
2011 (while (and stack
2012 (not (string-equal (car stack)
2013 filename)))
2014 (setq stack (cdr stack)))
2015 (setq compilation-directory-stack
2016 (cons filename compilation-directory-stack)
2017 default-directory filename)))
2018 (and (eq type 'leave)
2019 stack
2020 (setq compilation-directory-stack (cdr stack))
2021 (setq stack (car compilation-directory-stack))
2022 (setq default-directory stack)))
2023 (goto-char end-of-match) ; Prepare to look at next message.
2024 (and limit-search (>= end-of-match limit-search)
2025 ;; The user wanted a specific error, and we're past it.
2026 ;; We do this check here rather than at the end of the
2027 ;; loop because if the last thing seen is an error
2028 ;; message, we must carefully discard the last error
2029 ;; when it is the first in a new file (see above in
2030 ;; the error-message case)
2031 (setq found-desired t)))
2032
2033 ;; Go to before the last character in the message so that we will
2034 ;; see the next line also when the message ended at end of line.
2035 ;; When we ignore the last error message above, this will
2036 ;; cancel the effect of forward-line below so that point
2037 ;; doesn't move.
2038 (forward-char -1)
2039
2040 ;; Is this message necessary any more? Parsing is now so fast
2041 ;; that you might not need to know how it proceeds.
2042 (message
2043 "Parsing error messages...%d found. %.0f%% of buffer seen."
2044 compilation-num-errors-found
2045 ;; Use floating-point because (* 100 (point)) frequently
2046 ;; exceeds the range of Emacs Lisp integers.
2047 (/ (* 100.0 (point)) (point-max)))
2048 ))
2049
2050 (forward-line 1))) ; End of while loop. Look at next line.
2051
2052 (set-marker compilation-parsing-end (point))
2053 (setq compilation-error-list (nreverse compilation-error-list))
2054 ;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
2055 ;; compilation-num-errors-found
2056 ;; (/ (* 100.0 (point)) (point-max)))
2057 (message "Parsing error messages...done.")))
2058
2059 (defun compile-collect-regexps (type this)
2060 ;; Add elements to variable compilation-regexps that is bound in
2061 ;; compilation-parse-errors.
2062 (and (not (eq this t))
2063 (dolist (el this)
2064 (push (cons (car el) (cons type (cdr el))) compilation-regexps))))
2065
2066 (defun compile-buffer-substring (index)
2067 "Get substring matched by INDEXth subexpression."
2068 (if index
2069 (let ((beg (match-beginning index)))
2070 (if beg (buffer-substring beg (match-end index))))))
2071
2072 ;; If directory DIR is a subdir of ORIG or of ORIG's parent,
2073 ;; return a relative name for it starting from ORIG or its parent.
2074 ;; ORIG-EXPANDED is an expanded version of ORIG.
2075 ;; PARENT-EXPANDED is an expanded version of ORIG's parent.
2076 ;; Those two args could be computed here, but we run faster by
2077 ;; having the caller compute them just once.
2078 (defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
2079 ;; Apply canonical abbreviations to DIR first thing.
2080 ;; Those abbreviations are already done in the other arguments passed.
2081 (setq dir (abbreviate-file-name dir))
2082
2083 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2084 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2085 ;; buffer.)
2086 (if (boundp 'comint-file-name-prefix)
2087 (setq dir (concat comint-file-name-prefix dir)))
2088
2089 (if (and (> (length dir) (length orig-expanded))
2090 (string= orig-expanded
2091 (substring dir 0 (length orig-expanded))))
2092 (setq dir
2093 (concat orig
2094 (substring dir (length orig-expanded)))))
2095 (if (and (> (length dir) (length parent-expanded))
2096 (string= parent-expanded
2097 (substring dir 0 (length parent-expanded))))
2098 (setq dir
2099 (concat (file-name-directory
2100 (directory-file-name orig))
2101 (substring dir (length parent-expanded)))))
2102 dir)
2103
2104 (add-to-list 'debug-ignored-errors "^No more errors\\( yet\\|\\)$")
2105
2106 (provide 'compile)
2107
2108 ;;; compile.el ends here