Merge from emacs-24; up to 2012-05-05T02:50:20Z!monnier@iro.umontreal.ca
[bpt/emacs.git] / lisp / progmodes / flymake.el
CommitLineData
4bcbcb9d
EZ
1;;; flymake.el -- a universal on-the-fly syntax checker
2
e1ac4066 3;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
4bcbcb9d 4
1d9a4930
EZ
5;; Author: Pavel Kobyakov <pk_at_work@yahoo.com>
6;; Maintainer: Pavel Kobyakov <pk_at_work@yahoo.com>
4bcbcb9d
EZ
7;; Version: 0.3
8;; Keywords: c languages tools
9
10;; This file is part of GNU Emacs.
11
b1fc2b50 12;; GNU Emacs is free software: you can redistribute it and/or modify
4bcbcb9d 13;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
4bcbcb9d
EZ
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b1fc2b50 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
4bcbcb9d
EZ
24
25;;; Commentary:
26;;
27;; Flymake is a minor Emacs mode performing on-the-fly syntax
28;; checks using the external syntax check tool (for C/C++ this
29;; is usually the compiler)
30
9f812d23
SM
31;;; Bugs/todo:
32
33;; - Only uses "Makefile", not "makefile" or "GNUmakefile"
34;; (from http://bugs.debian.org/337339).
35
4bcbcb9d
EZ
36;;; Code:
37
a464a6c7 38(eval-when-compile (require 'cl-lib))
6fee12e6
SM
39(if (featurep 'xemacs) (require 'overlay))
40
43ed65ac
SM
41(defvar flymake-is-running nil
42 "If t, flymake syntax check process is running for the current buffer.")
43(make-variable-buffer-local 'flymake-is-running)
c92d6023 44
43ed65ac
SM
45(defvar flymake-timer nil
46 "Timer for starting syntax check.")
47(make-variable-buffer-local 'flymake-timer)
c92d6023 48
43ed65ac
SM
49(defvar flymake-last-change-time nil
50 "Time of last buffer change.")
51(make-variable-buffer-local 'flymake-last-change-time)
52
53(defvar flymake-check-start-time nil
54 "Time at which syntax check was started.")
55(make-variable-buffer-local 'flymake-check-start-time)
56
57(defvar flymake-check-was-interrupted nil
58 "Non-nil if syntax check was killed by `flymake-compile'.")
59(make-variable-buffer-local 'flymake-check-was-interrupted)
60
61(defvar flymake-err-info nil
62 "Sorted list of line numbers and lists of err info in the form (file, err-text).")
63(make-variable-buffer-local 'flymake-err-info)
64
65(defvar flymake-new-err-info nil
66 "Same as `flymake-err-info', effective when a syntax check is in progress.")
67(make-variable-buffer-local 'flymake-new-err-info)
c92d6023 68
4bcbcb9d 69;;;; [[ cross-emacs compatibility routines
ce721de4
KS
70(defsubst flymake-makehash (&optional test)
71 (if (fboundp 'make-hash-table)
72 (if test (make-hash-table :test test) (make-hash-table))
adf8a02e
RS
73 (with-no-warnings
74 (makehash test))))
5323b4b0 75
cd2325cd
SM
76(defalias 'flymake-float-time
77 (if (fboundp 'float-time)
78 'float-time
7ea8834e
RS
79 (if (featurep 'xemacs)
80 (lambda ()
b3f5a846 81 (multiple-value-bind (s0 s1 s2) (values-list (current-time))
7ea8834e 82 (+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2)))))))
ce721de4 83
43ed65ac
SM
84(defalias 'flymake-replace-regexp-in-string
85 (if (eval-when-compile (fboundp 'replace-regexp-in-string))
86 'replace-regexp-in-string
87 (lambda (regexp rep str)
88 (replace-in-string str regexp rep))))
89
90(defalias 'flymake-split-string
91 (if (condition-case nil (equal (split-string " bc " " " t) '("bc"))
92 (error nil))
93 (lambda (str pattern) (split-string str pattern t))
94 (lambda (str pattern)
95 "Split STR into a list of substrings bounded by PATTERN.
53ec26ed 96Zero-length substrings at the beginning and end of the list are omitted."
43ed65ac 97 (let ((split (split-string str pattern)))
587d108e
SM
98 (while (equal (car split) "") (setq split (cdr split)))
99 (setq split (nreverse split))
100 (while (equal (car split) "") (setq split (cdr split)))
101 (nreverse split)))))
43ed65ac
SM
102
103(defalias 'flymake-get-temp-dir
cd2325cd 104 (if (fboundp 'temp-directory)
43ed65ac
SM
105 'temp-directory
106 (lambda () temporary-file-directory)))
4bcbcb9d 107
1d9a4930
EZ
108(defun flymake-posn-at-point-as-event (&optional position window dx dy)
109 "Return pixel position of top left corner of glyph at POSITION,
110relative to top left corner of WINDOW, as a mouse-1 click
111event (identical to the event that would be triggered by clicking
112mouse button 1 at the top left corner of the glyph).
113
114POSITION and WINDOW default to the position of point in the
115selected window.
116
117DX and DY specify optional offsets from the top left of the glyph."
118 (unless window (setq window (selected-window)))
119 (unless position (setq position (window-point window)))
120 (unless dx (setq dx 0))
121 (unless dy (setq dy 0))
122
123 (let* ((pos (posn-at-point position window))
124 (x-y (posn-x-y pos))
125 (edges (window-inside-pixel-edges window))
126 (win-x-y (window-pixel-edges window)))
127 ;; adjust for window edges
128 (setcar (nthcdr 2 pos)
129 (cons (+ (car x-y) (car edges) (- (car win-x-y)) dx)
130 (+ (cdr x-y) (cadr edges) (- (cadr win-x-y)) dy)))
131 (list 'mouse-1 pos)))
43ed65ac
SM
132
133(defun flymake-popup-menu (menu-data)
134 "Pop up the flymake menu at point, using the data MENU-DATA.
53ec26ed
RS
135POS is a list of the form ((X Y) WINDOW), where X and Y are
136pixels positions from the top left corner of WINDOW's frame.
137MENU-DATA is a list of error and warning messages returned by
138`flymake-make-err-menu-data'."
139 (if (featurep 'xemacs)
43ed65ac
SM
140 (let* ((pos (flymake-get-point-pixel-pos))
141 (x-pos (nth 0 pos))
142 (y-pos (nth 1 pos))
ce721de4
KS
143 (fake-event-props '(button 1 x 1 y 1)))
144 (setq fake-event-props (plist-put fake-event-props 'x x-pos))
145 (setq fake-event-props (plist-put fake-event-props 'y y-pos))
43ed65ac
SM
146 (popup-menu (flymake-make-xemacs-menu menu-data)
147 (make-event 'button-press fake-event-props)))
148 (x-popup-menu (if (eval-when-compile (fboundp 'posn-at-point))
1d9a4930 149 (flymake-posn-at-point-as-event)
43ed65ac
SM
150 (list (flymake-get-point-pixel-pos) (selected-window)))
151 (flymake-make-emacs-menu menu-data))))
4bcbcb9d 152
5323b4b0 153(defun flymake-make-emacs-menu (menu-data)
53ec26ed
RS
154 "Return a menu specifier using MENU-DATA.
155MENU-DATA is a list of error and warning messages returned by
156`flymake-make-err-menu-data'.
157See `x-popup-menu' for the menu specifier format."
5323b4b0
RS
158 (let* ((menu-title (nth 0 menu-data))
159 (menu-items (nth 1 menu-data))
43ed65ac
SM
160 (menu-commands (mapcar (lambda (foo)
161 (cons (nth 0 foo) (nth 1 foo)))
162 menu-items)))
5323b4b0 163 (list menu-title (cons "" menu-commands))))
4bcbcb9d 164
ce721de4
KS
165(if (featurep 'xemacs) (progn
166
cd2325cd
SM
167(defun flymake-nop ())
168
2aa13ec4 169(defun flymake-make-xemacs-menu (menu-data)
53ec26ed 170 "Return a menu specifier using MENU-DATA."
5323b4b0
RS
171 (let* ((menu-title (nth 0 menu-data))
172 (menu-items (nth 1 menu-data))
173 (menu-commands nil))
174 (setq menu-commands (mapcar (lambda (foo)
175 (vector (nth 0 foo) (or (nth 1 foo) '(flymake-nop)) t))
176 menu-items))
177 (cons menu-title menu-commands)))
178
ce721de4
KS
179)) ;; xemacs
180
43ed65ac
SM
181(unless (eval-when-compile (fboundp 'posn-at-point))
182
5323b4b0
RS
183(defun flymake-current-row ()
184 "Return current row number in current frame."
cd2325cd
SM
185 (if (fboundp 'window-edges)
186 (+ (car (cdr (window-edges))) (count-lines (window-start) (point)))
187 (count-lines (window-start) (point))))
5323b4b0
RS
188
189(defun flymake-selected-frame ()
cd2325cd
SM
190 (if (fboundp 'window-edges)
191 (selected-frame)
192 (selected-window)))
4bcbcb9d 193
43ed65ac
SM
194(defun flymake-get-point-pixel-pos ()
195 "Return point position in pixels: (x, y)."
196 (let ((mouse-pos (mouse-position))
197 (pixel-pos nil)
198 (ret nil))
199 (if (car (cdr mouse-pos))
200 (progn
201 (set-mouse-position (flymake-selected-frame) (current-column) (flymake-current-row))
202 (setq pixel-pos (mouse-pixel-position))
203 (set-mouse-position (car mouse-pos) (car (cdr mouse-pos)) (cdr (cdr mouse-pos)))
204 (setq ret (list (car (cdr pixel-pos)) (cdr (cdr pixel-pos)))))
205 (progn
206 (setq ret '(0 0))))
207 (flymake-log 3 "mouse pos is %s" ret)
208 ret))
209
210) ;; End of (unless (fboundp 'posn-at-point)
211
4bcbcb9d
EZ
212;;;; ]]
213
214(defcustom flymake-log-level -1
cd2325cd 215 "Logging level, only messages with level lower or equal will be logged.
4bcbcb9d 216-1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG"
5323b4b0
RS
217 :group 'flymake
218 :type 'integer)
4bcbcb9d 219
2aa13ec4 220(defun flymake-log (level text &rest args)
53ec26ed
RS
221 "Log a message at level LEVEL.
222If LEVEL is higher than `flymake-log-level', the message is
223ignored. Otherwise, it is printed using `message'.
224TEXT is a format control string, and the remaining arguments ARGS
225are the string substitutions (see `format')."
5323b4b0
RS
226 (if (<= level flymake-log-level)
227 (let* ((msg (apply 'format text args)))
29a4e67d 228 (message "%s" msg)
5323b4b0
RS
229 ;;(with-temp-buffer
230 ;; (insert msg)
231 ;; (insert "\n")
6df19241 232 ;; (flymake-save-buffer-in-file "d:/flymake.log" t) ; make log file name customizable
5323b4b0 233 ;;)
2aa13ec4 234 )))
4bcbcb9d 235
2aa13ec4 236(defun flymake-ins-after (list pos val)
5323b4b0
RS
237 "Insert VAL into LIST after position POS."
238 (let ((tmp (copy-sequence list))) ; (???)
239 (setcdr (nthcdr pos tmp) (cons val (nthcdr (1+ pos) tmp)))
240 tmp))
4bcbcb9d 241
2aa13ec4 242(defun flymake-set-at (list pos val)
9a686ad2 243 "Set VAL at position POS in LIST."
5323b4b0
RS
244 (let ((tmp (copy-sequence list))) ; (???)
245 (setcar (nthcdr pos tmp) val)
246 tmp))
4bcbcb9d 247
43ed65ac
SM
248(defvar flymake-processes nil
249 "List of currently active flymake processes.")
4bcbcb9d 250
9a686ad2 251(defvar flymake-output-residual nil)
2aa13ec4 252
4bcbcb9d 253(make-variable-buffer-local 'flymake-output-residual)
2aa13ec4 254
57a97b44 255(defgroup flymake nil
cf20dee0 256 "Universal on-the-fly syntax checker."
57a97b44
MR
257 :version "23.1"
258 :group 'tools)
259
5323b4b0 260(defcustom flymake-allowed-file-name-masks
fd09a83f 261 '(("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'" flymake-simple-make-init)
c07fa030
SM
262 ("\\.xml\\'" flymake-xml-init)
263 ("\\.html?\\'" flymake-xml-init)
264 ("\\.cs\\'" flymake-simple-make-init)
eabd11d4
MH
265 ("\\.p[ml]\\'" flymake-perl-init)
266 ("\\.php[345]?\\'" flymake-php-init)
6df19241
SM
267 ("\\.h\\'" flymake-master-make-header-init flymake-master-cleanup)
268 ("\\.java\\'" flymake-simple-make-java-init flymake-simple-java-cleanup)
269 ("[0-9]+\\.tex\\'" flymake-master-tex-init flymake-master-cleanup)
c07fa030
SM
270 ("\\.tex\\'" flymake-simple-tex-init)
271 ("\\.idl\\'" flymake-simple-make-init)
6df19241
SM
272 ;; ("\\.cpp\\'" 1)
273 ;; ("\\.java\\'" 3)
274 ;; ("\\.h\\'" 2 ("\\.cpp\\'" "\\.c\\'")
9a686ad2 275 ;; ("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2))
6df19241
SM
276 ;; ("\\.idl\\'" 1)
277 ;; ("\\.odl\\'" 1)
278 ;; ("[0-9]+\\.tex\\'" 2 ("\\.tex\\'")
9a686ad2 279 ;; ("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2 ))
6df19241 280 ;; ("\\.tex\\'" 1)
5323b4b0 281 )
fd09a83f 282 "Files syntax checking is allowed for."
5323b4b0
RS
283 :group 'flymake
284 :type '(repeat (string symbol symbol symbol)))
4bcbcb9d 285
2aa13ec4 286(defun flymake-get-file-name-mode-and-masks (file-name)
9a686ad2 287 "Return the corresponding entry from `flymake-allowed-file-name-masks'."
5323b4b0
RS
288 (unless (stringp file-name)
289 (error "Invalid file-name"))
17404091 290 (let ((fnm flymake-allowed-file-name-masks)
5323b4b0 291 (mode-and-masks nil))
17404091
SM
292 (while (and (not mode-and-masks) fnm)
293 (if (string-match (car (car fnm)) file-name)
294 (setq mode-and-masks (cdr (car fnm))))
295 (setq fnm (cdr fnm)))
5323b4b0
RS
296 (flymake-log 3 "file %s, init=%s" file-name (car mode-and-masks))
297 mode-and-masks))
4bcbcb9d 298
2aa13ec4 299(defun flymake-can-syntax-check-file (file-name)
5323b4b0 300 "Determine whether we can syntax check FILE-NAME.
2aa13ec4 301Return nil if we cannot, non-nil if we can."
5323b4b0 302 (if (flymake-get-init-function file-name) t nil))
4bcbcb9d 303
2aa13ec4 304(defun flymake-get-init-function (file-name)
5323b4b0
RS
305 "Return init function to be used for the file."
306 (let* ((init-f (nth 0 (flymake-get-file-name-mode-and-masks file-name))))
9a686ad2
SM
307 ;;(flymake-log 0 "calling %s" init-f)
308 ;;(funcall init-f (current-buffer))
5323b4b0 309 init-f))
4bcbcb9d 310
2aa13ec4 311(defun flymake-get-cleanup-function (file-name)
5323b4b0 312 "Return cleanup function to be used for the file."
c07fa030
SM
313 (or (nth 1 (flymake-get-file-name-mode-and-masks file-name))
314 'flymake-simple-cleanup))
4bcbcb9d 315
2aa13ec4 316(defun flymake-get-real-file-name-function (file-name)
6df19241
SM
317 (or (nth 2 (flymake-get-file-name-mode-and-masks file-name))
318 'flymake-get-real-file-name))
4bcbcb9d 319
4bcbcb9d 320(defvar flymake-find-buildfile-cache (flymake-makehash 'equal))
4bcbcb9d 321
2aa13ec4 322(defun flymake-get-buildfile-from-cache (dir-name)
5323b4b0 323 (gethash dir-name flymake-find-buildfile-cache))
2aa13ec4
RS
324
325(defun flymake-add-buildfile-to-cache (dir-name buildfile)
5323b4b0 326 (puthash dir-name buildfile flymake-find-buildfile-cache))
2aa13ec4
RS
327
328(defun flymake-clear-buildfile-cache ()
5323b4b0 329 (clrhash flymake-find-buildfile-cache))
2aa13ec4 330
5f73367d 331(defun flymake-find-buildfile (buildfile-name source-dir-name)
5323b4b0 332 "Find buildfile starting from current directory.
2aa13ec4 333Buildfile includes Makefile, build.xml etc.
5323b4b0 334Return its file name if found, or nil if not found."
5f73367d 335 (or (flymake-get-buildfile-from-cache source-dir-name)
8cd56959 336 (let* ((file (locate-dominating-file source-dir-name buildfile-name)))
8ebbfc80 337 (if file
5f73367d 338 (progn
8ebbfc80 339 (flymake-log 3 "found buildfile at %s" file)
8ebbfc80
SM
340 (flymake-add-buildfile-to-cache source-dir-name file)
341 file)
5f73367d
SM
342 (progn
343 (flymake-log 3 "buildfile for %s not found" source-dir-name)
344 nil)))))
5323b4b0
RS
345
346(defun flymake-fix-file-name (name)
57d3a1f3 347 "Replace all occurrences of '\' with '/'."
5323b4b0 348 (when name
587d108e
SM
349 (setq name (expand-file-name name))
350 (setq name (abbreviate-file-name name))
351 (setq name (directory-file-name name))
352 name))
4bcbcb9d 353
2aa13ec4 354(defun flymake-same-files (file-name-one file-name-two)
5323b4b0 355 "Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
2aa13ec4 356Return t if so, nil if not."
5323b4b0
RS
357 (equal (flymake-fix-file-name file-name-one)
358 (flymake-fix-file-name file-name-two)))
359
4bcbcb9d 360(defcustom flymake-master-file-dirs '("." "./src" "./UnitTest")
9a686ad2 361 "Dirs where to look for master files."
5323b4b0
RS
362 :group 'flymake
363 :type '(repeat (string)))
4bcbcb9d
EZ
364
365(defcustom flymake-master-file-count-limit 32
5323b4b0
RS
366 "Max number of master files to check."
367 :group 'flymake
368 :type 'integer)
2aa13ec4 369
ce721de4
KS
370;; This is bound dynamically to pass a parameter to a sort predicate below
371(defvar flymake-included-file-name)
4bcbcb9d 372
2aa13ec4 373(defun flymake-find-possible-master-files (file-name master-file-dirs masks)
9a686ad2 374 "Find (by name and location) all possible master files.
fd09a83f 375Master files include .cpp and .c for .h. Files are searched for
2aa13ec4 376starting from the .h directory and max max-level parent dirs.
4bcbcb9d 377File contents are not checked."
17404091 378 (let* ((dirs master-file-dirs)
5323b4b0 379 (files nil)
17404091
SM
380 (done nil))
381
382 (while (and (not done) dirs)
587d108e 383 (let* ((dir (expand-file-name (car dirs) (file-name-directory file-name)))
17404091
SM
384 (masks masks))
385 (while (and (file-exists-p dir) (not done) masks)
386 (let* ((mask (car masks))
387 (dir-files (directory-files dir t mask)))
388
389 (flymake-log 3 "dir %s, %d file(s) for mask %s"
390 dir (length dir-files) mask)
391 (while (and (not done) dir-files)
392 (when (not (file-directory-p (car dir-files)))
393 (setq files (cons (car dir-files) files))
5323b4b0
RS
394 (when (>= (length files) flymake-master-file-count-limit)
395 (flymake-log 3 "master file count limit (%d) reached" flymake-master-file-count-limit)
396 (setq done t)))
17404091
SM
397 (setq dir-files (cdr dir-files))))
398 (setq masks (cdr masks))))
399 (setq dirs (cdr dirs)))
5323b4b0 400 (when files
ce721de4
KS
401 (let ((flymake-included-file-name (file-name-nondirectory file-name)))
402 (setq files (sort files 'flymake-master-file-compare))))
5323b4b0
RS
403 (flymake-log 3 "found %d possible master file(s)" (length files))
404 files))
4bcbcb9d 405
2aa13ec4 406(defun flymake-master-file-compare (file-one file-two)
173569aa 407 "Compare two files specified by FILE-ONE and FILE-TWO.
2aa13ec4 408This function is used in sort to move most possible file names
173569aa 409to the beginning of the list (File.h -> File.cpp moved to top)."
5323b4b0 410 (and (equal (file-name-sans-extension flymake-included-file-name)
d2c32364 411 (file-name-base file-one))
5323b4b0 412 (not (equal file-one file-two))))
4bcbcb9d
EZ
413
414(defcustom flymake-check-file-limit 8192
bd77c2ef
GM
415 "Maximum number of chars to look at when checking possible master file.
416Nil means search the entire file."
5323b4b0 417 :group 'flymake
bd77c2ef
GM
418 :type '(choice (const :tag "No limit" nil)
419 (integer :tag "Characters")))
4bcbcb9d 420
587d108e
SM
421(defun flymake-check-patch-master-file-buffer
422 (master-file-temp-buffer
423 master-file-name patched-master-file-name
424 source-file-name patched-source-file-name
425 include-dirs regexp)
5323b4b0 426 "Check if MASTER-FILE-NAME is a master file for SOURCE-FILE-NAME.
2aa13ec4
RS
427If yes, patch a copy of MASTER-FILE-NAME to include PATCHED-SOURCE-FILE-NAME
428instead of SOURCE-FILE-NAME.
fd09a83f
CY
429
430For example, foo.cpp is a master file if it includes foo.h.
431
2aa13ec4
RS
432Whether a buffer for MATER-FILE-NAME exists, use it as a source
433instead of reading master file from disk."
587d108e 434 (let* ((source-file-nondir (file-name-nondirectory source-file-name))
bd77c2ef
GM
435 (source-file-extension (file-name-extension source-file-nondir))
436 (source-file-nonext (file-name-sans-extension source-file-nondir))
587d108e 437 (found nil)
5323b4b0
RS
438 (inc-name nil)
439 (search-limit flymake-check-file-limit))
587d108e
SM
440 (setq regexp
441 (format regexp ; "[ \t]*#[ \t]*include[ \t]*\"\\(.*%s\\)\""
bd77c2ef
GM
442 ;; Hack for tex files, where \include often excludes .tex.
443 ;; Maybe this is safe generally.
444 (if (and (> (length source-file-extension) 1)
445 (string-equal source-file-extension "tex"))
446 (format "%s\\(?:\\.%s\\)?"
447 (regexp-quote source-file-nonext)
448 (regexp-quote source-file-extension))
449 (regexp-quote source-file-nondir))))
587d108e
SM
450 (unwind-protect
451 (with-current-buffer master-file-temp-buffer
bd77c2ef
GM
452 (if (or (not search-limit)
453 (> search-limit (point-max)))
454 (setq search-limit (point-max)))
587d108e
SM
455 (flymake-log 3 "checking %s against regexp %s"
456 master-file-name regexp)
457 (goto-char (point-min))
458 (while (and (< (point) search-limit)
459 (re-search-forward regexp search-limit t))
460 (let ((match-beg (match-beginning 1))
461 (match-end (match-end 1)))
462
463 (flymake-log 3 "found possible match for %s" source-file-nondir)
464 (setq inc-name (match-string 1))
bd77c2ef
GM
465 (and (> (length source-file-extension) 1)
466 (string-equal source-file-extension "tex")
467 (not (string-match (format "\\.%s\\'" source-file-extension)
468 inc-name))
469 (setq inc-name (concat inc-name "." source-file-extension)))
587d108e
SM
470 (when (eq t (compare-strings
471 source-file-nondir nil nil
472 inc-name (- (length inc-name)
473 (length source-file-nondir)) nil))
474 (flymake-log 3 "inc-name=%s" inc-name)
475 (when (flymake-check-include source-file-name inc-name
476 include-dirs)
477 (setq found t)
478 ;; replace-match is not used here as it fails in
479 ;; XEmacs with 'last match not a buffer' error as
480 ;; check-includes calls replace-in-string
481 (flymake-replace-region
482 match-beg match-end
483 (file-name-nondirectory patched-source-file-name))))
484 (forward-line 1)))
485 (when found
486 (flymake-save-buffer-in-file patched-master-file-name)))
487 ;;+(flymake-log 3 "killing buffer %s"
488 ;; (buffer-name master-file-temp-buffer))
489 (kill-buffer master-file-temp-buffer))
9a686ad2 490 ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
5323b4b0
RS
491 (when found
492 (flymake-log 2 "found master file %s" master-file-name))
493 found))
4bcbcb9d 494
4bd0a5d0 495(defun flymake-replace-region (beg end rep)
5323b4b0
RS
496 "Replace text in BUFFER in region (BEG END) with REP."
497 (save-excursion
4bd0a5d0
SM
498 (goto-char end)
499 ;; Insert before deleting, so as to better preserve markers's positions.
500 (insert rep)
501 (delete-region beg end)))
4bcbcb9d 502
2aa13ec4 503(defun flymake-read-file-to-temp-buffer (file-name)
5323b4b0
RS
504 "Insert contents of FILE-NAME into newly created temp buffer."
505 (let* ((temp-buffer (get-buffer-create (generate-new-buffer-name (concat "flymake:" (file-name-nondirectory file-name))))))
cd2325cd 506 (with-current-buffer temp-buffer
5323b4b0
RS
507 (insert-file-contents file-name))
508 temp-buffer))
4bcbcb9d 509
2aa13ec4 510(defun flymake-copy-buffer-to-temp-buffer (buffer)
5323b4b0 511 "Copy contents of BUFFER into newly created temp buffer."
4dd68f44
SM
512 (with-current-buffer
513 (get-buffer-create (generate-new-buffer-name
514 (concat "flymake:" (buffer-name buffer))))
515 (insert-buffer-substring buffer)
516 (current-buffer)))
4bcbcb9d 517
587d108e 518(defun flymake-check-include (source-file-name inc-name include-dirs)
5323b4b0 519 "Check if SOURCE-FILE-NAME can be found in include path.
587d108e
SM
520Return t if it can be found via include path using INC-NAME."
521 (if (file-name-absolute-p inc-name)
522 (flymake-same-files source-file-name inc-name)
523 (while (and include-dirs
524 (not (flymake-same-files
525 source-file-name
526 (concat (file-name-directory source-file-name)
527 "/" (car include-dirs)
528 "/" inc-name))))
529 (setq include-dirs (cdr include-dirs)))
530 include-dirs))
4bcbcb9d 531
2aa13ec4 532(defun flymake-find-buffer-for-file (file-name)
5323b4b0 533 "Check if there exists a buffer visiting FILE-NAME.
2aa13ec4 534Return t if so, nil if not."
5323b4b0
RS
535 (let ((buffer-name (get-file-buffer file-name)))
536 (if buffer-name
537 (get-buffer buffer-name))))
4bcbcb9d 538
587d108e 539(defun flymake-create-master-file (source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp)
5323b4b0 540 "Save SOURCE-FILE-NAME with a different name.
2aa13ec4 541Find master file, patch and save it."
5323b4b0
RS
542 (let* ((possible-master-files (flymake-find-possible-master-files source-file-name flymake-master-file-dirs masks))
543 (master-file-count (length possible-master-files))
544 (idx 0)
545 (temp-buffer nil)
546 (master-file-name nil)
547 (patched-master-file-name nil)
548 (found nil))
549
550 (while (and (not found) (< idx master-file-count))
551 (setq master-file-name (nth idx possible-master-files))
552 (setq patched-master-file-name (funcall create-temp-f master-file-name "flymake_master"))
553 (if (flymake-find-buffer-for-file master-file-name)
554 (setq temp-buffer (flymake-copy-buffer-to-temp-buffer (flymake-find-buffer-for-file master-file-name)))
555 (setq temp-buffer (flymake-read-file-to-temp-buffer master-file-name)))
556 (setq found
557 (flymake-check-patch-master-file-buffer
558 temp-buffer
559 master-file-name
560 patched-master-file-name
561 source-file-name
562 patched-source-file-name
563 (funcall get-incl-dirs-f (file-name-directory master-file-name))
587d108e 564 include-regexp))
5323b4b0
RS
565 (setq idx (1+ idx)))
566 (if found
567 (list master-file-name patched-master-file-name)
568 (progn
569 (flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count
570 (file-name-nondirectory source-file-name))
571 nil))))
4bcbcb9d 572
6df19241 573(defun flymake-save-buffer-in-file (file-name)
ab1d3835
SM
574 (make-directory (file-name-directory file-name) 1)
575 (write-region nil nil file-name nil 566)
6df19241 576 (flymake-log 3 "saved buffer %s in file %s" (buffer-name) file-name))
4bcbcb9d 577
2aa13ec4 578(defun flymake-save-string-to-file (file-name data)
5323b4b0
RS
579 "Save string DATA to file FILE-NAME."
580 (write-region data nil file-name nil 566))
4bcbcb9d 581
2aa13ec4 582(defun flymake-read-file-to-string (file-name)
5323b4b0
RS
583 "Read contents of file FILE-NAME and return as a string."
584 (with-temp-buffer
585 (insert-file-contents file-name)
586 (buffer-substring (point-min) (point-max))))
4bcbcb9d 587
2aa13ec4 588(defun flymake-process-filter (process output)
5323b4b0 589 "Parse OUTPUT and highlight error lines.
2aa13ec4 590It's flymake process filter."
43ed65ac 591 (let ((source-buffer (process-buffer process)))
4bcbcb9d 592
43ed65ac
SM
593 (flymake-log 3 "received %d byte(s) of output from process %d"
594 (length output) (process-id process))
466a09b5 595 (when (buffer-live-p source-buffer)
4dd68f44
SM
596 (with-current-buffer source-buffer
597 (flymake-parse-output-and-residual output)))))
4bcbcb9d 598
e02f48d7 599(defun flymake-process-sentinel (process _event)
5323b4b0 600 "Sentinel for syntax check buffers."
c07fa030
SM
601 (when (memq (process-status process) '(signal exit))
602 (let* ((exit-status (process-exit-status process))
603 (command (process-command process))
604 (source-buffer (process-buffer process))
605 (cleanup-f (flymake-get-cleanup-function (buffer-file-name source-buffer))))
606
607 (flymake-log 2 "process %d exited with code %d"
608 (process-id process) exit-status)
609 (condition-case err
610 (progn
611 (flymake-log 3 "cleaning up using %s" cleanup-f)
612 (when (buffer-live-p source-buffer)
613 (with-current-buffer source-buffer
614 (funcall cleanup-f)))
615
616 (delete-process process)
617 (setq flymake-processes (delq process flymake-processes))
618
619 (when (buffer-live-p source-buffer)
620 (with-current-buffer source-buffer
621
622 (flymake-parse-residual)
623 (flymake-post-syntax-check exit-status command)
624 (setq flymake-is-running nil))))
625 (error
626 (let ((err-str (format "Error in process sentinel for buffer %s: %s"
627 source-buffer (error-message-string err))))
628 (flymake-log 0 err-str)
629 (with-current-buffer source-buffer
630 (setq flymake-is-running nil))))))))
4bcbcb9d 631
4dd68f44
SM
632(defun flymake-post-syntax-check (exit-status command)
633 (setq flymake-err-info flymake-new-err-info)
634 (setq flymake-new-err-info nil)
635 (setq flymake-err-info
636 (flymake-fix-line-numbers
637 flymake-err-info 1 (flymake-count-lines)))
638 (flymake-delete-own-overlays)
639 (flymake-highlight-err-lines flymake-err-info)
53ec26ed 640 (let (err-count warn-count)
4dd68f44
SM
641 (setq err-count (flymake-get-err-count flymake-err-info "e"))
642 (setq warn-count (flymake-get-err-count flymake-err-info "w"))
643 (flymake-log 2 "%s: %d error(s), %d warning(s) in %.2f second(s)"
644 (buffer-name) err-count warn-count
53ec26ed 645 (- (flymake-float-time) flymake-check-start-time))
4dd68f44 646 (setq flymake-check-start-time nil)
53ec26ed 647
5323b4b0
RS
648 (if (and (equal 0 err-count) (equal 0 warn-count))
649 (if (equal 0 exit-status)
4dd68f44
SM
650 (flymake-report-status "" "") ; PASSED
651 (if (not flymake-check-was-interrupted)
652 (flymake-report-fatal-status "CFGERR"
80cd4bb4 653 (format "Configuration error has occurred while running %s" command))
4dd68f44
SM
654 (flymake-report-status nil ""))) ; "STOPPED"
655 (flymake-report-status (format "%d/%d" err-count warn-count) ""))))
4bcbcb9d 656
4dd68f44 657(defun flymake-parse-output-and-residual (output)
5323b4b0 658 "Split OUTPUT into lines, merge in residual if necessary."
4dd68f44
SM
659 (let* ((buffer-residual flymake-output-residual)
660 (total-output (if buffer-residual (concat buffer-residual output) output))
661 (lines-and-residual (flymake-split-output total-output))
662 (lines (nth 0 lines-and-residual))
663 (new-residual (nth 1 lines-and-residual)))
664 (setq flymake-output-residual new-residual)
665 (setq flymake-new-err-info
666 (flymake-parse-err-lines
667 flymake-new-err-info lines))))
668
669(defun flymake-parse-residual ()
5323b4b0 670 "Parse residual if it's non empty."
4dd68f44
SM
671 (when flymake-output-residual
672 (setq flymake-new-err-info
673 (flymake-parse-err-lines
674 flymake-new-err-info
675 (list flymake-output-residual)))
676 (setq flymake-output-residual nil)))
4bcbcb9d 677
2aa13ec4 678(defun flymake-er-make-er (line-no line-err-info-list)
5323b4b0 679 (list line-no line-err-info-list))
2aa13ec4
RS
680
681(defun flymake-er-get-line (err-info)
5323b4b0 682 (nth 0 err-info))
2aa13ec4
RS
683
684(defun flymake-er-get-line-err-info-list (err-info)
5323b4b0 685 (nth 1 err-info))
4bcbcb9d 686
a464a6c7 687(cl-defstruct (flymake-ler
587d108e
SM
688 (:constructor nil)
689 (:constructor flymake-ler-make-ler (file line type text &optional full-file)))
690 file line type text full-file)
2aa13ec4
RS
691
692(defun flymake-ler-set-file (line-err-info file)
5323b4b0 693 (flymake-ler-make-ler file
587d108e
SM
694 (flymake-ler-line line-err-info)
695 (flymake-ler-type line-err-info)
696 (flymake-ler-text line-err-info)
697 (flymake-ler-full-file line-err-info)))
2aa13ec4
RS
698
699(defun flymake-ler-set-full-file (line-err-info full-file)
587d108e
SM
700 (flymake-ler-make-ler (flymake-ler-file line-err-info)
701 (flymake-ler-line line-err-info)
702 (flymake-ler-type line-err-info)
703 (flymake-ler-text line-err-info)
2aa13ec4
RS
704 full-file))
705
706(defun flymake-ler-set-line (line-err-info line)
587d108e 707 (flymake-ler-make-ler (flymake-ler-file line-err-info)
4bcbcb9d 708 line
587d108e
SM
709 (flymake-ler-type line-err-info)
710 (flymake-ler-text line-err-info)
711 (flymake-ler-full-file line-err-info)))
4bcbcb9d 712
2aa13ec4 713(defun flymake-get-line-err-count (line-err-info-list type)
5323b4b0 714 "Return number of errors of specified TYPE.
173569aa 715Value of TYPE is either \"e\" or \"w\"."
5323b4b0
RS
716 (let* ((idx 0)
717 (count (length line-err-info-list))
718 (err-count 0))
4bcbcb9d 719
5323b4b0 720 (while (< idx count)
587d108e 721 (when (equal type (flymake-ler-type (nth idx line-err-info-list)))
5323b4b0
RS
722 (setq err-count (1+ err-count)))
723 (setq idx (1+ idx)))
724 err-count))
4bcbcb9d 725
2aa13ec4 726(defun flymake-get-err-count (err-info-list type)
5323b4b0
RS
727 "Return number of errors of specified TYPE for ERR-INFO-LIST."
728 (let* ((idx 0)
729 (count (length err-info-list))
730 (err-count 0))
731 (while (< idx count)
732 (setq err-count (+ err-count (flymake-get-line-err-count (nth 1 (nth idx err-info-list)) type)))
733 (setq idx (1+ idx)))
734 err-count))
2aa13ec4
RS
735
736(defun flymake-fix-line-numbers (err-info-list min-line max-line)
5323b4b0 737 "Replace line numbers with fixed value.
2aa13ec4
RS
738If line-numbers is less than MIN-LINE, set line numbers to MIN-LINE.
739If line numbers is greater than MAX-LINE, set line numbers to MAX-LINE.
ce721de4 740The reason for this fix is because some compilers might report
2aa13ec4 741line number outside the file being compiled."
5323b4b0
RS
742 (let* ((count (length err-info-list))
743 (err-info nil)
744 (line 0))
745 (while (> count 0)
746 (setq err-info (nth (1- count) err-info-list))
747 (setq line (flymake-er-get-line err-info))
748 (when (or (< line min-line) (> line max-line))
749 (setq line (if (< line min-line) min-line max-line))
750 (setq err-info-list (flymake-set-at err-info-list (1- count)
751 (flymake-er-make-er line
752 (flymake-er-get-line-err-info-list err-info)))))
753 (setq count (1- count))))
754 err-info-list)
4bcbcb9d 755
4dd68f44 756(defun flymake-highlight-err-lines (err-info-list)
5323b4b0 757 "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
4dd68f44
SM
758 (save-excursion
759 (dolist (err err-info-list)
760 (flymake-highlight-line (car err) (nth 1 err)))))
4bcbcb9d 761
2aa13ec4 762(defun flymake-overlay-p (ov)
5323b4b0
RS
763 "Determine whether overlay OV was created by flymake."
764 (and (overlayp ov) (overlay-get ov 'flymake-overlay)))
4bcbcb9d 765
28ca98ac
LL
766(defcustom flymake-error-bitmap '(exclamation-mark error)
767 "Bitmap used in the fringe for indicating errors.
768The value may also be a list of two elements where the second
769element specifies the face for the bitmap."
770 :group 'flymake
771 :type 'symbol)
772
773(defcustom flymake-warning-bitmap 'question-mark
774 "Bitmap used in the fringe for indicating warnings.
775The value may also be a list of two elements where the second
776element specifies the face for the bitmap."
777 :group 'flymake
778 :type 'symbol)
779
780(defcustom flymake-fringe-indicator-position 'left-fringe
781 "The position to put flymake fringe indicator.
782The value can be nil, left-fringe or right-fringe.
783Fringe indicators are disabled if nil."
784 :group 'flymake
785 :type '(choice (const left-fringe)
786 (const right-fringe)
787 (const :tag "No fringe indicators" nil)))
788
789(defun flymake-make-overlay (beg end tooltip-text face bitmap mouse-face)
5323b4b0
RS
790 "Allocate a flymake overlay in range BEG and END."
791 (when (not (flymake-region-has-flymake-overlays beg end))
28ca98ac
LL
792 (let ((ov (make-overlay beg end nil t t))
793 (fringe (and flymake-fringe-indicator-position
794 (propertize "!" 'display
795 (cons flymake-fringe-indicator-position
796 (if (listp bitmap)
797 bitmap
798 (list bitmap)))))))
5323b4b0
RS
799 (overlay-put ov 'face face)
800 (overlay-put ov 'mouse-face mouse-face)
801 (overlay-put ov 'help-echo tooltip-text)
802 (overlay-put ov 'flymake-overlay t)
803 (overlay-put ov 'priority 100)
28ca98ac
LL
804 (overlay-put ov 'evaporate t)
805 (overlay-put ov 'before-string fringe)
9a686ad2 806 ;;+(flymake-log 3 "created overlay %s" ov)
5323b4b0
RS
807 ov)
808 (flymake-log 3 "created an overlay at (%d-%d)" beg end)))
4bcbcb9d 809
4dd68f44 810(defun flymake-delete-own-overlays ()
5323b4b0 811 "Delete all flymake overlays in BUFFER."
4dd68f44
SM
812 (dolist (ol (overlays-in (point-min) (point-max)))
813 (when (flymake-overlay-p ol)
814 (delete-overlay ol)
815 ;;+(flymake-log 3 "deleted overlay %s" ol)
816 )))
4bcbcb9d 817
2aa13ec4 818(defun flymake-region-has-flymake-overlays (beg end)
5323b4b0 819 "Check if region specified by BEG and END has overlay.
2aa13ec4 820Return t if it has at least one flymake overlay, nil if no overlay."
5323b4b0
RS
821 (let ((ov (overlays-in beg end))
822 (has-flymake-overlays nil))
823 (while (consp ov)
824 (when (flymake-overlay-p (car ov))
825 (setq has-flymake-overlays t))
cd2325cd
SM
826 (setq ov (cdr ov)))
827 has-flymake-overlays))
4bcbcb9d 828
ded09abd 829(defface flymake-errline
4b56d0fe 830 '((t :inherit error))
5323b4b0
RS
831 "Face used for marking error lines."
832 :group 'flymake)
4bcbcb9d 833
ded09abd 834(defface flymake-warnline
4b56d0fe 835 '((t :inherit warning))
5323b4b0
RS
836 "Face used for marking warning lines."
837 :group 'flymake)
4bcbcb9d 838
2aa13ec4 839(defun flymake-highlight-line (line-no line-err-info-list)
5323b4b0 840 "Highlight line LINE-NO in current buffer.
173569aa 841Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting."
5f68c1b7
GM
842 (goto-char (point-min))
843 (forward-line (1- line-no))
3ba6b2ee 844 (let* ((line-beg (point-at-bol))
81aa0dab 845 (line-end (point-at-eol))
5323b4b0
RS
846 (beg line-beg)
847 (end line-end)
587d108e 848 (tooltip-text (flymake-ler-text (nth 0 line-err-info-list)))
28ca98ac
LL
849 (face nil)
850 (bitmap nil))
5323b4b0
RS
851
852 (goto-char line-beg)
853 (while (looking-at "[ \t]")
854 (forward-char))
4bcbcb9d 855
5323b4b0 856 (setq beg (point))
4bcbcb9d 857
5323b4b0
RS
858 (goto-char line-end)
859 (while (and (looking-at "[ \t\r\n]") (> (point) 1))
860 (backward-char))
4bcbcb9d 861
5323b4b0 862 (setq end (1+ (point)))
4bcbcb9d 863
5323b4b0
RS
864 (when (<= end beg)
865 (setq beg line-beg)
866 (setq end line-end))
2aa13ec4 867
5323b4b0
RS
868 (when (= end beg)
869 (goto-char end)
870 (forward-line)
871 (setq end (point)))
2aa13ec4 872
5323b4b0 873 (if (> (flymake-get-line-err-count line-err-info-list "e") 0)
28ca98ac
LL
874 (setq face 'flymake-errline
875 bitmap flymake-error-bitmap)
876 (setq face 'flymake-warnline
877 bitmap flymake-warning-bitmap))
2aa13ec4 878
28ca98ac 879 (flymake-make-overlay beg end tooltip-text face bitmap nil)))
4bcbcb9d 880
4dd68f44 881(defun flymake-parse-err-lines (err-info-list lines)
5323b4b0
RS
882 "Parse err LINES, store info in ERR-INFO-LIST."
883 (let* ((count (length lines))
884 (idx 0)
885 (line-err-info nil)
886 (real-file-name nil)
4dd68f44 887 (source-file-name buffer-file-name)
5323b4b0
RS
888 (get-real-file-name-f (flymake-get-real-file-name-function source-file-name)))
889
890 (while (< idx count)
891 (setq line-err-info (flymake-parse-line (nth idx lines)))
892 (when line-err-info
c07fa030 893 (setq real-file-name (funcall get-real-file-name-f
587d108e 894 (flymake-ler-file line-err-info)))
5323b4b0
RS
895 (setq line-err-info (flymake-ler-set-full-file line-err-info real-file-name))
896
b89b385c
CY
897 (when (flymake-same-files real-file-name source-file-name)
898 (setq line-err-info (flymake-ler-set-file line-err-info nil))
899 (setq err-info-list (flymake-add-err-info err-info-list line-err-info))))
5323b4b0
RS
900 (flymake-log 3 "parsed '%s', %s line-err-info" (nth idx lines) (if line-err-info "got" "no"))
901 (setq idx (1+ idx)))
902 err-info-list))
4bcbcb9d 903
2aa13ec4 904(defun flymake-split-output (output)
5323b4b0 905 "Split OUTPUT into lines.
9a686ad2
SM
906Return last one as residual if it does not end with newline char.
907Returns ((LINES) RESIDUAL)."
5323b4b0
RS
908 (when (and output (> (length output) 0))
909 (let* ((lines (flymake-split-string output "[\n\r]+"))
910 (complete (equal "\n" (char-to-string (aref output (1- (length output))))))
911 (residual nil))
912 (when (not complete)
913 (setq residual (car (last lines)))
914 (setq lines (butlast lines)))
915 (list lines residual))))
4bcbcb9d 916
2aa13ec4 917(defun flymake-reformat-err-line-patterns-from-compile-el (original-list)
5323b4b0 918 "Grab error line patterns from ORIGINAL-LIST in compile.el format.
2aa13ec4 919Convert it to flymake internal format."
5323b4b0 920 (let* ((converted-list '()))
cd2325cd
SM
921 (dolist (item original-list)
922 (setq item (cdr item))
923 (let ((regexp (nth 0 item))
924 (file (nth 1 item))
925 (line (nth 2 item))
926 (col (nth 3 item)))
927 (if (consp file) (setq file (car file)))
928 (if (consp line) (setq line (car line)))
929 (if (consp col) (setq col (car col)))
d799c278 930
cd2325cd
SM
931 (when (not (functionp line))
932 (setq converted-list (cons (list regexp file line col) converted-list)))))
5323b4b0 933 converted-list))
2aa13ec4 934
c3b8339f 935(require 'compile)
5323b4b0
RS
936
937(defvar flymake-err-line-patterns ; regexp file-idx line-idx col-idx (optional) text-idx(optional), match-end to end of string is error text
938 (append
939 '(
9a686ad2 940 ;; MS Visual C++ 6.0
5323b4b0
RS
941 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
942 1 3 nil 4)
9a686ad2 943 ;; jikes
5323b4b0
RS
944 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\|Semantic Error\\):[ \t\n]*\\(.+\\)\\)"
945 1 3 nil 4)
9a686ad2 946 ;; MS midl
5323b4b0
RS
947 ("midl[ ]*:[ ]*\\(command line error .*\\)"
948 nil nil nil 1)
9a686ad2 949 ;; MS C#
5323b4b0
RS
950 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\),[0-9]+)\: \\(\\(error\\|warning\\|fatal error\\) \\(CS[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
951 1 3 nil 4)
9a686ad2 952 ;; perl
5323b4b0 953 ("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 2 3 nil 1)
eabd11d4
MH
954 ;; PHP
955 ("\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)" 2 3 nil 1)
9a686ad2 956 ;; LaTeX warnings (fileless) ("\\(LaTeX \\(Warning\\|Error\\): .*\\) on input line \\([0-9]+\\)" 20 3 nil 1)
819a6054
GM
957 ;; ant/javac. Note this also matches gcc warnings!
958 (" *\\(\\[javac\\] *\\)?\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\\(?:\:[0-9]+\\)?\:[ \t\n]*\\(.+\\)"
5323b4b0
RS
959 2 4 nil 5))
960 ;; compilation-error-regexp-alist)
ce721de4 961 (flymake-reformat-err-line-patterns-from-compile-el compilation-error-regexp-alist-alist))
8c01db22
EZ
962 "Patterns for matching error/warning lines. Each pattern has the form
963\(REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX).
9a686ad2
SM
964Use `flymake-reformat-err-line-patterns-from-compile-el' to add patterns
965from compile.el")
966
967;;(defcustom flymake-err-line-patterns
968;; '(
969;; ; MS Visual C++ 6.0
970;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
971;; 1 3 4)
972;; ; jikes
973;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\):[ \t\n]*\\(.+\\)\\)"
974;; 1 3 4))
975;; "patterns for matching error/warning lines, (regexp file-idx line-idx err-text-idx)"
976;; :group 'flymake
977;; :type '(repeat (string number number number))
978;;)
4bcbcb9d 979
3aca1291
LL
980(defvar flymake-warning-re "^[wW]arning"
981 "Regexp matching against err-text to detect a warning.")
982
2aa13ec4 983(defun flymake-parse-line (line)
173569aa
JB
984 "Parse LINE to see if it is an error or warning.
985Return its components if so, nil otherwise."
5323b4b0
RS
986 (let ((raw-file-name nil)
987 (line-no 0)
988 (err-type "e")
989 (err-text nil)
17404091 990 (patterns flymake-err-line-patterns)
5323b4b0 991 (matched nil))
17404091
SM
992 (while (and patterns (not matched))
993 (when (string-match (car (car patterns)) line)
994 (let* ((file-idx (nth 1 (car patterns)))
995 (line-idx (nth 2 (car patterns))))
5323b4b0
RS
996
997 (setq raw-file-name (if file-idx (match-string file-idx line) nil))
027a4b6b 998 (setq line-no (if line-idx (string-to-number (match-string line-idx line)) 0))
17404091
SM
999 (setq err-text (if (> (length (car patterns)) 4)
1000 (match-string (nth 4 (car patterns)) line)
5323b4b0
RS
1001 (flymake-patch-err-text (substring line (match-end 0)))))
1002 (or err-text (setq err-text "<no error text>"))
3aca1291 1003 (if (and err-text (string-match flymake-warning-re err-text))
5323b4b0
RS
1004 (setq err-type "w")
1005 )
1006 (flymake-log 3 "parse line: file-idx=%s line-idx=%s file=%s line=%s text=%s" file-idx line-idx
1007 raw-file-name line-no err-text)
1008 (setq matched t)))
17404091 1009 (setq patterns (cdr patterns)))
5323b4b0
RS
1010 (if matched
1011 (flymake-ler-make-ler raw-file-name line-no err-type err-text)
1012 ())))
4bcbcb9d 1013
2aa13ec4 1014(defun flymake-find-err-info (err-info-list line-no)
5323b4b0
RS
1015 "Find (line-err-info-list pos) for specified LINE-NO."
1016 (if err-info-list
1017 (let* ((line-err-info-list nil)
1018 (pos 0)
1019 (count (length err-info-list)))
1020
1021 (while (and (< pos count) (< (car (nth pos err-info-list)) line-no))
1022 (setq pos (1+ pos)))
1023 (when (and (< pos count) (equal (car (nth pos err-info-list)) line-no))
1024 (setq line-err-info-list (flymake-er-get-line-err-info-list (nth pos err-info-list))))
1025 (list line-err-info-list pos))
1026 '(nil 0)))
4bcbcb9d 1027
2aa13ec4 1028(defun flymake-line-err-info-is-less-or-equal (line-one line-two)
587d108e
SM
1029 (or (string< (flymake-ler-type line-one) (flymake-ler-type line-two))
1030 (and (string= (flymake-ler-type line-one) (flymake-ler-type line-two))
1031 (not (flymake-ler-file line-one)) (flymake-ler-file line-two))
1032 (and (string= (flymake-ler-type line-one) (flymake-ler-type line-two))
1033 (or (and (flymake-ler-file line-one) (flymake-ler-file line-two))
1034 (and (not (flymake-ler-file line-one)) (not (flymake-ler-file line-two)))))))
4bcbcb9d 1035
2aa13ec4 1036(defun flymake-add-line-err-info (line-err-info-list line-err-info)
53ec26ed
RS
1037 "Update LINE-ERR-INFO-LIST with the error LINE-ERR-INFO.
1038For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'.
1039The new element is inserted in the proper position, according to
1040the predicate `flymake-line-err-info-is-less-or-equal'.
1041The updated value of LINE-ERR-INFO-LIST is returned."
5323b4b0
RS
1042 (if (not line-err-info-list)
1043 (list line-err-info)
1044 (let* ((count (length line-err-info-list))
1045 (idx 0))
1046 (while (and (< idx count) (flymake-line-err-info-is-less-or-equal (nth idx line-err-info-list) line-err-info))
1047 (setq idx (1+ idx)))
1048 (cond ((equal 0 idx) (setq line-err-info-list (cons line-err-info line-err-info-list)))
1049 (t (setq line-err-info-list (flymake-ins-after line-err-info-list (1- idx) line-err-info))))
1050 line-err-info-list)))
4bcbcb9d 1051
2aa13ec4 1052(defun flymake-add-err-info (err-info-list line-err-info)
53ec26ed
RS
1053 "Update ERR-INFO-LIST with the error LINE-ERR-INFO, preserving sort order.
1054Returns the updated value of ERR-INFO-LIST.
1055For the format of ERR-INFO-LIST, see `flymake-err-info'.
1056For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'."
587d108e 1057 (let* ((line-no (if (flymake-ler-file line-err-info) 1 (flymake-ler-line line-err-info)))
5323b4b0
RS
1058 (info-and-pos (flymake-find-err-info err-info-list line-no))
1059 (exists (car info-and-pos))
1060 (pos (nth 1 info-and-pos))
1061 (line-err-info-list nil)
1062 (err-info nil))
1063
1064 (if exists
1065 (setq line-err-info-list (flymake-er-get-line-err-info-list (car (nthcdr pos err-info-list)))))
1066 (setq line-err-info-list (flymake-add-line-err-info line-err-info-list line-err-info))
1067
1068 (setq err-info (flymake-er-make-er line-no line-err-info-list))
1069 (cond (exists (setq err-info-list (flymake-set-at err-info-list pos err-info)))
1070 ((equal 0 pos) (setq err-info-list (cons err-info err-info-list)))
1071 (t (setq err-info-list (flymake-ins-after err-info-list (1- pos) err-info))))
1072 err-info-list))
4bcbcb9d 1073
2aa13ec4 1074(defun flymake-get-project-include-dirs-imp (basedir)
5323b4b0
RS
1075 "Include dirs for the project current file belongs to."
1076 (if (flymake-get-project-include-dirs-from-cache basedir)
1077 (progn
1078 (flymake-get-project-include-dirs-from-cache basedir))
9a686ad2 1079 ;;else
ff4e2883
KS
1080 (let* ((command-line (concat "make -C "
1081 (shell-quote-argument basedir)
1082 " DUMPVARS=INCLUDE_DIRS dumpvars"))
5323b4b0
RS
1083 (output (shell-command-to-string command-line))
1084 (lines (flymake-split-string output "\n"))
1085 (count (length lines))
1086 (idx 0)
1087 (inc-dirs nil))
1088 (while (and (< idx count) (not (string-match "^INCLUDE_DIRS=.*" (nth idx lines))))
1089 (setq idx (1+ idx)))
1090 (when (< idx count)
1091 (let* ((inc-lines (flymake-split-string (nth idx lines) " *-I"))
1092 (inc-count (length inc-lines)))
1093 (while (> inc-count 0)
1094 (when (not (string-match "^INCLUDE_DIRS=.*" (nth (1- inc-count) inc-lines)))
587d108e 1095 (push (flymake-replace-regexp-in-string "\"" "" (nth (1- inc-count) inc-lines)) inc-dirs))
5323b4b0
RS
1096 (setq inc-count (1- inc-count)))))
1097 (flymake-add-project-include-dirs-to-cache basedir inc-dirs)
1098 inc-dirs)))
4bcbcb9d
EZ
1099
1100(defcustom flymake-get-project-include-dirs-function 'flymake-get-project-include-dirs-imp
173569aa 1101 "Function used to get project include dirs, one parameter: basedir name."
5323b4b0
RS
1102 :group 'flymake
1103 :type 'function)
4bcbcb9d 1104
2aa13ec4 1105(defun flymake-get-project-include-dirs (basedir)
5323b4b0 1106 (funcall flymake-get-project-include-dirs-function basedir))
4bcbcb9d 1107
2aa13ec4 1108(defun flymake-get-system-include-dirs ()
5323b4b0
RS
1109 "System include dirs - from the 'INCLUDE' env setting."
1110 (let* ((includes (getenv "INCLUDE")))
1111 (if includes (flymake-split-string includes path-separator) nil)))
4bcbcb9d
EZ
1112
1113(defvar flymake-project-include-dirs-cache (flymake-makehash 'equal))
4bcbcb9d 1114
2aa13ec4 1115(defun flymake-get-project-include-dirs-from-cache (base-dir)
5323b4b0 1116 (gethash base-dir flymake-project-include-dirs-cache))
2aa13ec4
RS
1117
1118(defun flymake-add-project-include-dirs-to-cache (base-dir include-dirs)
5323b4b0 1119 (puthash base-dir include-dirs flymake-project-include-dirs-cache))
2aa13ec4
RS
1120
1121(defun flymake-clear-project-include-dirs-cache ()
5323b4b0 1122 (clrhash flymake-project-include-dirs-cache))
2aa13ec4
RS
1123
1124(defun flymake-get-include-dirs (base-dir)
5323b4b0
RS
1125 "Get dirs to use when resolving local file names."
1126 (let* ((include-dirs (append '(".") (flymake-get-project-include-dirs base-dir) (flymake-get-system-include-dirs))))
1127 include-dirs))
4bcbcb9d 1128
4dd68f44
SM
1129;; (defun flymake-restore-formatting ()
1130;; "Remove any formatting made by flymake."
1131;; )
4bcbcb9d 1132
c07fa030
SM
1133;; (defun flymake-get-program-dir (buffer)
1134;; "Get dir to start program in."
1135;; (unless (bufferp buffer)
1136;; (error "Invalid buffer"))
1137;; (with-current-buffer buffer
1138;; default-directory))
4bcbcb9d 1139
2aa13ec4 1140(defun flymake-safe-delete-file (file-name)
5323b4b0
RS
1141 (when (and file-name (file-exists-p file-name))
1142 (delete-file file-name)
1143 (flymake-log 1 "deleted file %s" file-name)))
4bcbcb9d 1144
2aa13ec4 1145(defun flymake-safe-delete-directory (dir-name)
e02f48d7 1146 (condition-case nil
5323b4b0
RS
1147 (progn
1148 (delete-directory dir-name)
1149 (flymake-log 1 "deleted dir %s" dir-name))
1150 (error
1151 (flymake-log 1 "Failed to delete dir %s, error ignored" dir-name))))
4bcbcb9d 1152
ce721de4 1153(defcustom flymake-compilation-prevents-syntax-check t
2c587104 1154 "If non-nil, don't start syntax check if compilation is running."
5323b4b0
RS
1155 :group 'flymake
1156 :type 'boolean)
4bcbcb9d 1157
4dd68f44
SM
1158(defun flymake-start-syntax-check ()
1159 "Start syntax checking for current buffer."
1160 (interactive)
1161 (flymake-log 3 "flymake is running: %s" flymake-is-running)
1162 (when (and (not flymake-is-running)
1163 (flymake-can-syntax-check-file buffer-file-name))
1164 (when (or (not flymake-compilation-prevents-syntax-check)
1165 (not (flymake-compilation-is-running))) ;+ (flymake-rep-ort-status buffer "COMP")
1166 (flymake-clear-buildfile-cache)
1167 (flymake-clear-project-include-dirs-cache)
1168
1169 (setq flymake-check-was-interrupted nil)
4dd68f44
SM
1170
1171 (let* ((source-file-name buffer-file-name)
1172 (init-f (flymake-get-init-function source-file-name))
1173 (cleanup-f (flymake-get-cleanup-function source-file-name))
6df19241 1174 (cmd-and-args (funcall init-f))
4dd68f44
SM
1175 (cmd (nth 0 cmd-and-args))
1176 (args (nth 1 cmd-and-args))
1177 (dir (nth 2 cmd-and-args)))
1178 (if (not cmd-and-args)
1179 (progn
1180 (flymake-log 0 "init function %s for %s failed, cleaning up" init-f source-file-name)
c07fa030 1181 (funcall cleanup-f))
4dd68f44
SM
1182 (progn
1183 (setq flymake-last-change-time nil)
1184 (flymake-start-syntax-check-process cmd args dir)))))))
1185
1186(defun flymake-start-syntax-check-process (cmd args dir)
5323b4b0 1187 "Start syntax check process."
c79a6f38
SM
1188 (condition-case err
1189 (let* ((process
1190 (let ((default-directory (or dir default-directory)))
1191 (when dir
1192 (flymake-log 3 "starting process on dir %s" dir))
1193 (apply 'start-file-process
1194 "flymake-proc" (current-buffer) cmd args))))
1195 (set-process-sentinel process 'flymake-process-sentinel)
1196 (set-process-filter process 'flymake-process-filter)
1197 (push process flymake-processes)
1198
1199 (setq flymake-is-running t)
1200 (setq flymake-last-change-time nil)
1201 (setq flymake-check-start-time (flymake-float-time))
1202
1203 (flymake-report-status nil "*")
1204 (flymake-log 2 "started process %d, command=%s, dir=%s"
1205 (process-id process) (process-command process)
1206 default-directory)
1207 process)
1208 (error
1209 (let* ((err-str (format "Failed to launch syntax check process '%s' with args %s: %s"
1210 cmd args (error-message-string err)))
1211 (source-file-name buffer-file-name)
1212 (cleanup-f (flymake-get-cleanup-function source-file-name)))
1213 (flymake-log 0 err-str)
1214 (funcall cleanup-f)
1215 (flymake-report-fatal-status "PROCERR" err-str)))))
4bcbcb9d 1216
43ed65ac
SM
1217(defun flymake-kill-process (proc)
1218 "Kill process PROC."
1219 (kill-process proc)
1220 (let* ((buf (process-buffer proc)))
1221 (when (buffer-live-p buf)
1222 (with-current-buffer buf
53ec26ed 1223 (setq flymake-check-was-interrupted t))))
43ed65ac 1224 (flymake-log 1 "killed process %d" (process-id proc)))
4bcbcb9d 1225
2aa13ec4 1226(defun flymake-stop-all-syntax-checks ()
5323b4b0
RS
1227 "Kill all syntax check processes."
1228 (interactive)
43ed65ac
SM
1229 (while flymake-processes
1230 (flymake-kill-process (pop flymake-processes))))
4bcbcb9d 1231
2aa13ec4 1232(defun flymake-compilation-is-running ()
5323b4b0
RS
1233 (and (boundp 'compilation-in-progress)
1234 compilation-in-progress))
4bcbcb9d 1235
2aa13ec4 1236(defun flymake-compile ()
5323b4b0
RS
1237 "Kill all flymake syntax checks, start compilation."
1238 (interactive)
1239 (flymake-stop-all-syntax-checks)
1240 (call-interactively 'compile))
4bcbcb9d 1241
4bcbcb9d 1242(defcustom flymake-no-changes-timeout 0.5
5323b4b0
RS
1243 "Time to wait after last change before starting compilation."
1244 :group 'flymake
1245 :type 'number)
4bcbcb9d 1246
2aa13ec4 1247(defun flymake-on-timer-event (buffer)
5323b4b0 1248 "Start a syntax check for buffer BUFFER if necessary."
587d108e 1249 (when (buffer-live-p buffer)
cd2325cd 1250 (with-current-buffer buffer
53ec26ed
RS
1251 (when (and (not flymake-is-running)
1252 flymake-last-change-time
587d108e
SM
1253 (> (- (flymake-float-time) flymake-last-change-time)
1254 flymake-no-changes-timeout))
53ec26ed
RS
1255
1256 (setq flymake-last-change-time nil)
5323b4b0 1257 (flymake-log 3 "starting syntax check as more than 1 second passed since last change")
4dd68f44 1258 (flymake-start-syntax-check)))))
4bcbcb9d 1259
2aa13ec4 1260(defun flymake-current-line-no ()
5323b4b0 1261 "Return number of current line in current buffer."
587d108e 1262 (count-lines (point-min) (if (eobp) (point) (1+ (point)))))
4bcbcb9d 1263
4dd68f44 1264(defun flymake-count-lines ()
5323b4b0 1265 "Return number of lines in buffer BUFFER."
4dd68f44 1266 (count-lines (point-min) (point-max)))
4bcbcb9d 1267
2aa13ec4 1268(defun flymake-display-err-menu-for-current-line ()
5323b4b0
RS
1269 "Display a menu with errors/warnings for current line if it has errors and/or warnings."
1270 (interactive)
1271 (let* ((line-no (flymake-current-line-no))
53ec26ed 1272 (line-err-info-list (nth 0 (flymake-find-err-info flymake-err-info line-no)))
5323b4b0 1273 (menu-data (flymake-make-err-menu-data line-no line-err-info-list))
43ed65ac 1274 (choice nil))
5323b4b0
RS
1275 (if menu-data
1276 (progn
43ed65ac 1277 (setq choice (flymake-popup-menu menu-data))
5323b4b0
RS
1278 (flymake-log 3 "choice=%s" choice)
1279 (when choice
1280 (eval choice)))
1281 (flymake-log 1 "no errors for line %d" line-no))))
4bcbcb9d 1282
2aa13ec4 1283(defun flymake-make-err-menu-data (line-no line-err-info-list)
173569aa 1284 "Make a (menu-title (item-title item-action)*) list with errors/warnings from LINE-ERR-INFO-LIST."
5323b4b0
RS
1285 (let* ((menu-items nil))
1286 (when line-err-info-list
1287 (let* ((count (length line-err-info-list))
1288 (menu-item-text nil))
1289 (while (> count 0)
587d108e
SM
1290 (setq menu-item-text (flymake-ler-text (nth (1- count) line-err-info-list)))
1291 (let* ((file (flymake-ler-file (nth (1- count) line-err-info-list)))
1292 (full-file (flymake-ler-full-file (nth (1- count) line-err-info-list)))
1293 (line (flymake-ler-line (nth (1- count) line-err-info-list))))
5323b4b0
RS
1294 (if file
1295 (setq menu-item-text (concat menu-item-text " - " file "(" (format "%d" line) ")")))
1296 (setq menu-items (cons (list menu-item-text
1297 (if file (list 'flymake-goto-file-and-line full-file line) nil))
1298 menu-items)))
1299 (setq count (1- count)))
1300 (flymake-log 3 "created menu-items with %d item(s)" (length menu-items))))
1301 (if menu-items
1302 (let* ((menu-title (format "Line %d: %d error(s), %d warning(s)" line-no
1303 (flymake-get-line-err-count line-err-info-list "e")
1304 (flymake-get-line-err-count line-err-info-list "w"))))
1305 (list menu-title menu-items))
1306 nil)))
4bcbcb9d 1307
2aa13ec4 1308(defun flymake-goto-file-and-line (file line)
9a686ad2 1309 "Try to get buffer for FILE and goto line LINE in it."
5323b4b0 1310 (if (not (file-exists-p file))
caf790b6
MR
1311 (flymake-log 1 "File %s does not exist" file)
1312 (find-file file)
5f68c1b7
GM
1313 (goto-char (point-min))
1314 (forward-line (1- line))))
4bcbcb9d 1315
2aa13ec4 1316;; flymake minor mode declarations
4bd0a5d0 1317(defvar flymake-mode-line nil)
2aa13ec4 1318
4bcbcb9d 1319(make-variable-buffer-local 'flymake-mode-line)
2aa13ec4 1320
4bcbcb9d 1321(defvar flymake-mode-line-e-w nil)
2aa13ec4 1322
4bcbcb9d 1323(make-variable-buffer-local 'flymake-mode-line-e-w)
2aa13ec4 1324
4bcbcb9d 1325(defvar flymake-mode-line-status nil)
2aa13ec4 1326
4bcbcb9d 1327(make-variable-buffer-local 'flymake-mode-line-status)
4bcbcb9d 1328
4dd68f44 1329(defun flymake-report-status (e-w &optional status)
5323b4b0 1330 "Show status in mode line."
4dd68f44
SM
1331 (when e-w
1332 (setq flymake-mode-line-e-w e-w))
1333 (when status
1334 (setq flymake-mode-line-status status))
1335 (let* ((mode-line " Flymake"))
1336 (when (> (length flymake-mode-line-e-w) 0)
1337 (setq mode-line (concat mode-line ":" flymake-mode-line-e-w)))
1338 (setq mode-line (concat mode-line flymake-mode-line-status))
1339 (setq flymake-mode-line mode-line)
1340 (force-mode-line-update)))
4bcbcb9d 1341
2aa13ec4 1342(defun flymake-display-warning (warning)
5323b4b0
RS
1343 "Display a warning to user."
1344 (message-box warning))
4bcbcb9d
EZ
1345
1346(defcustom flymake-gui-warnings-enabled t
173569aa 1347 "Enables/disables GUI warnings."
5323b4b0
RS
1348 :group 'flymake
1349 :type 'boolean)
4bcbcb9d 1350
4dd68f44 1351(defun flymake-report-fatal-status (status warning)
5323b4b0
RS
1352 "Display a warning and switch flymake mode off."
1353 (when flymake-gui-warnings-enabled
1354 (flymake-display-warning (format "Flymake: %s. Flymake will be switched OFF" warning))
1355 )
4dd68f44
SM
1356 (flymake-mode 0)
1357 (flymake-log 0 "switched OFF Flymake mode for buffer %s due to fatal status %s, warning %s"
1358 (buffer-name) status warning))
4bcbcb9d 1359
d57f6b5e
SM
1360(defcustom flymake-start-syntax-check-on-find-file t
1361 "Start syntax check on find file."
1362 :group 'flymake
1363 :type 'boolean)
1364
5ffc943b 1365;;;###autoload
4bd0a5d0 1366(define-minor-mode flymake-mode
e1ac4066
GM
1367 "Toggle on-the-fly syntax checking.
1368With a prefix argument ARG, enable the mode if ARG is positive,
1369and disable it otherwise. If called from Lisp, enable the mode
1370if ARG is omitted or nil."
d799c278 1371 :group 'flymake :lighter flymake-mode-line
d57f6b5e
SM
1372 (cond
1373
1374 ;; Turning the mode ON.
1375 (flymake-mode
83319045
LMI
1376 (cond
1377 ((not buffer-file-name)
1378 (message "Flymake unable to run without a buffer file name"))
1379 ((not (flymake-can-syntax-check-file buffer-file-name))
1380 (flymake-log 2 "flymake cannot check syntax in buffer %s" (buffer-name)))
1381 (t
d57f6b5e
SM
1382 (add-hook 'after-change-functions 'flymake-after-change-function nil t)
1383 (add-hook 'after-save-hook 'flymake-after-save-hook nil t)
1384 (add-hook 'kill-buffer-hook 'flymake-kill-buffer-hook nil t)
1385 ;;+(add-hook 'find-file-hook 'flymake-find-file-hook)
1386
4dd68f44 1387 (flymake-report-status "" "")
c92d6023 1388
d57f6b5e
SM
1389 (setq flymake-timer
1390 (run-at-time nil 1 'flymake-on-timer-event (current-buffer)))
1391
0221e323
SM
1392 (when (and flymake-start-syntax-check-on-find-file
1393 ;; Since we write temp files in current dir, there's no point
1394 ;; trying if the directory is read-only (bug#8954).
1395 (file-writable-p (file-name-directory buffer-file-name)))
1396 (with-demoted-errors
1397 (flymake-start-syntax-check))))))
d57f6b5e
SM
1398
1399 ;; Turning the mode OFF.
1400 (t
1401 (remove-hook 'after-change-functions 'flymake-after-change-function t)
1402 (remove-hook 'after-save-hook 'flymake-after-save-hook t)
1403 (remove-hook 'kill-buffer-hook 'flymake-kill-buffer-hook t)
1404 ;;+(remove-hook 'find-file-hook (function flymake-find-file-hook) t)
2aa13ec4 1405
4dd68f44 1406 (flymake-delete-own-overlays)
d57f6b5e
SM
1407
1408 (when flymake-timer
1409 (cancel-timer flymake-timer)
1410 (setq flymake-timer nil))
1411
bd6a83d5 1412 (setq flymake-is-running nil))))
4bcbcb9d 1413
4bcbcb9d 1414;;;###autoload
2aa13ec4 1415(defun flymake-mode-on ()
5323b4b0 1416 "Turn flymake mode on."
d57f6b5e
SM
1417 (flymake-mode 1)
1418 (flymake-log 1 "flymake mode turned ON for buffer %s" (buffer-name)))
4bcbcb9d
EZ
1419
1420;;;###autoload
2aa13ec4 1421(defun flymake-mode-off ()
5323b4b0 1422 "Turn flymake mode off."
d57f6b5e 1423 (flymake-mode 0)
bd6a83d5 1424 (flymake-log 1 "flymake mode turned OFF for buffer %s" (buffer-name)))
4bcbcb9d
EZ
1425
1426(defcustom flymake-start-syntax-check-on-newline t
5323b4b0
RS
1427 "Start syntax check if newline char was added/removed from the buffer."
1428 :group 'flymake
1429 :type 'boolean)
4bcbcb9d 1430
e02f48d7 1431(defun flymake-after-change-function (start stop _len)
9a686ad2
SM
1432 "Start syntax check for current buffer if it isn't already running."
1433 ;;+(flymake-log 0 "setting change time to %s" (flymake-float-time))
5323b4b0
RS
1434 (let((new-text (buffer-substring start stop)))
1435 (when (and flymake-start-syntax-check-on-newline (equal new-text "\n"))
1436 (flymake-log 3 "starting syntax check as new-line has been seen")
4dd68f44 1437 (flymake-start-syntax-check))
53ec26ed 1438 (setq flymake-last-change-time (flymake-float-time))))
4bcbcb9d 1439
2aa13ec4 1440(defun flymake-after-save-hook ()
5323b4b0
RS
1441 (if (local-variable-p 'flymake-mode (current-buffer)) ; (???) other way to determine whether flymake is active in buffer being saved?
1442 (progn
1443 (flymake-log 3 "starting syntax check as buffer was saved")
4dd68f44 1444 (flymake-start-syntax-check)))) ; no more mode 3. cannot start check if mode 3 (to temp copies) is active - (???)
4bcbcb9d 1445
2aa13ec4 1446(defun flymake-kill-buffer-hook ()
53ec26ed
RS
1447 (when flymake-timer
1448 (cancel-timer flymake-timer)
1449 (setq flymake-timer nil)))
4bcbcb9d 1450
5bd35902 1451;;;###autoload
2aa13ec4 1452(defun flymake-find-file-hook ()
9a686ad2
SM
1453 ;;+(when flymake-start-syntax-check-on-find-file
1454 ;;+ (flymake-log 3 "starting syntax check on file open")
4dd68f44 1455 ;;+ (flymake-start-syntax-check)
9a686ad2 1456 ;;+)
5323b4b0 1457 (when (and (not (local-variable-p 'flymake-mode (current-buffer)))
d57f6b5e 1458 (flymake-can-syntax-check-file buffer-file-name))
5323b4b0
RS
1459 (flymake-mode)
1460 (flymake-log 3 "automatically turned ON flymake mode")))
4bcbcb9d 1461
2aa13ec4 1462(defun flymake-get-first-err-line-no (err-info-list)
5323b4b0
RS
1463 "Return first line with error."
1464 (when err-info-list
1465 (flymake-er-get-line (car err-info-list))))
4bcbcb9d 1466
2aa13ec4 1467(defun flymake-get-last-err-line-no (err-info-list)
5323b4b0
RS
1468 "Return last line with error."
1469 (when err-info-list
1470 (flymake-er-get-line (nth (1- (length err-info-list)) err-info-list))))
4bcbcb9d 1471
2aa13ec4 1472(defun flymake-get-next-err-line-no (err-info-list line-no)
5323b4b0
RS
1473 "Return next line with error."
1474 (when err-info-list
1475 (let* ((count (length err-info-list))
1476 (idx 0))
1477 (while (and (< idx count) (>= line-no (flymake-er-get-line (nth idx err-info-list))))
1478 (setq idx (1+ idx)))
1479 (if (< idx count)
1480 (flymake-er-get-line (nth idx err-info-list))))))
4bcbcb9d 1481
2aa13ec4 1482(defun flymake-get-prev-err-line-no (err-info-list line-no)
173569aa 1483 "Return previous line with error."
5323b4b0
RS
1484 (when err-info-list
1485 (let* ((count (length err-info-list)))
1486 (while (and (> count 0) (<= line-no (flymake-er-get-line (nth (1- count) err-info-list))))
1487 (setq count (1- count)))
1488 (if (> count 0)
1489 (flymake-er-get-line (nth (1- count) err-info-list))))))
4bcbcb9d 1490
2aa13ec4 1491(defun flymake-skip-whitespace ()
5323b4b0
RS
1492 "Move forward until non-whitespace is reached."
1493 (while (looking-at "[ \t]")
1494 (forward-char)))
4bcbcb9d 1495
2aa13ec4 1496(defun flymake-goto-line (line-no)
9a686ad2 1497 "Go to line LINE-NO, then skip whitespace."
5f68c1b7
GM
1498 (goto-char (point-min))
1499 (forward-line (1- line-no))
5323b4b0 1500 (flymake-skip-whitespace))
4bcbcb9d 1501
2aa13ec4 1502(defun flymake-goto-next-error ()
9a686ad2 1503 "Go to next error in err ring."
5323b4b0 1504 (interactive)
53ec26ed 1505 (let ((line-no (flymake-get-next-err-line-no flymake-err-info (flymake-current-line-no))))
5323b4b0 1506 (when (not line-no)
53ec26ed 1507 (setq line-no (flymake-get-first-err-line-no flymake-err-info))
5323b4b0
RS
1508 (flymake-log 1 "passed end of file"))
1509 (if line-no
1510 (flymake-goto-line line-no)
1511 (flymake-log 1 "no errors in current buffer"))))
4bcbcb9d 1512
2aa13ec4 1513(defun flymake-goto-prev-error ()
173569aa 1514 "Go to previous error in err ring."
5323b4b0 1515 (interactive)
53ec26ed 1516 (let ((line-no (flymake-get-prev-err-line-no flymake-err-info (flymake-current-line-no))))
5323b4b0 1517 (when (not line-no)
53ec26ed 1518 (setq line-no (flymake-get-last-err-line-no flymake-err-info))
5323b4b0
RS
1519 (flymake-log 1 "passed beginning of file"))
1520 (if line-no
1521 (flymake-goto-line line-no)
1522 (flymake-log 1 "no errors in current buffer"))))
4bcbcb9d 1523
2aa13ec4 1524(defun flymake-patch-err-text (string)
5323b4b0
RS
1525 (if (string-match "^[\n\t :0-9]*\\(.*\\)$" string)
1526 (match-string 1 string)
1527 string))
4bcbcb9d
EZ
1528
1529;;;; general init-cleanup and helper routines
2aa13ec4 1530(defun flymake-create-temp-inplace (file-name prefix)
5323b4b0
RS
1531 (unless (stringp file-name)
1532 (error "Invalid file-name"))
1533 (or prefix
1534 (setq prefix "flymake"))
1535 (let* ((temp-name (concat (file-name-sans-extension file-name)
1536 "_" prefix
1537 (and (file-name-extension file-name)
1538 (concat "." (file-name-extension file-name))))))
1539 (flymake-log 3 "create-temp-inplace: file=%s temp=%s" file-name temp-name)
1540 temp-name))
4bcbcb9d 1541
e02f48d7 1542(defun flymake-create-temp-with-folder-structure (file-name _prefix)
5323b4b0
RS
1543 (unless (stringp file-name)
1544 (error "Invalid file-name"))
4bcbcb9d 1545
5323b4b0 1546 (let* ((dir (file-name-directory file-name))
6df19241
SM
1547 ;; Not sure what this slash-pos is all about, but I guess it's just
1548 ;; trying to remove the leading / of absolute file names.
5323b4b0 1549 (slash-pos (string-match "/" dir))
6df19241
SM
1550 (temp-dir (expand-file-name (substring dir (1+ slash-pos))
1551 (flymake-get-temp-dir))))
4bcbcb9d 1552
6df19241
SM
1553 (file-truename (expand-file-name (file-name-nondirectory file-name)
1554 temp-dir))))
4bcbcb9d 1555
2aa13ec4 1556(defun flymake-delete-temp-directory (dir-name)
9a686ad2 1557 "Attempt to delete temp dir created by `flymake-create-temp-with-folder-structure', do not fail on error."
5323b4b0 1558 (let* ((temp-dir (flymake-get-temp-dir))
587d108e 1559 (suffix (substring dir-name (1+ (length temp-dir)))))
5323b4b0
RS
1560
1561 (while (> (length suffix) 0)
6df19241 1562 (setq suffix (directory-file-name suffix))
9a686ad2 1563 ;;+(flymake-log 0 "suffix=%s" suffix)
6df19241
SM
1564 (flymake-safe-delete-directory
1565 (file-truename (expand-file-name suffix temp-dir)))
1566 (setq suffix (file-name-directory suffix)))))
4bcbcb9d 1567
5bcef417
SM
1568(defvar flymake-temp-source-file-name nil)
1569(make-variable-buffer-local 'flymake-temp-source-file-name)
1570
1571(defvar flymake-master-file-name nil)
1572(make-variable-buffer-local 'flymake-master-file-name)
1573
1574(defvar flymake-temp-master-file-name nil)
1575(make-variable-buffer-local 'flymake-temp-master-file-name)
1576
1577(defvar flymake-base-dir nil)
1578(make-variable-buffer-local 'flymake-base-dir)
1579
6df19241 1580(defun flymake-init-create-temp-buffer-copy (create-temp-f)
5323b4b0 1581 "Make a temporary copy of the current buffer, save its name in buffer data and return the name."
6df19241 1582 (let* ((source-file-name buffer-file-name)
5323b4b0 1583 (temp-source-file-name (funcall create-temp-f source-file-name "flymake")))
4bcbcb9d 1584
6df19241
SM
1585 (flymake-save-buffer-in-file temp-source-file-name)
1586 (setq flymake-temp-source-file-name temp-source-file-name)
5323b4b0 1587 temp-source-file-name))
4bcbcb9d 1588
c07fa030 1589(defun flymake-simple-cleanup ()
69df8d97 1590 "Do cleanup after `flymake-init-create-temp-buffer-copy'.
2aa13ec4 1591Delete temp file."
c07fa030
SM
1592 (flymake-safe-delete-file flymake-temp-source-file-name)
1593 (setq flymake-last-change-time nil))
4bcbcb9d 1594
c07fa030 1595(defun flymake-get-real-file-name (file-name-from-err-msg)
9a686ad2
SM
1596 "Translate file name from error message to \"real\" file name.
1597Return full-name. Names are real, not patched."
c07fa030
SM
1598 (let* ((real-name nil)
1599 (source-file-name buffer-file-name)
1600 (master-file-name flymake-master-file-name)
1601 (temp-source-file-name flymake-temp-source-file-name)
1602 (temp-master-file-name flymake-temp-master-file-name)
5bcef417 1603 (base-dirs
c07fa030 1604 (list flymake-base-dir
5bcef417
SM
1605 (file-name-directory source-file-name)
1606 (if master-file-name (file-name-directory master-file-name))))
c07fa030
SM
1607 (files (list (list source-file-name source-file-name)
1608 (list temp-source-file-name source-file-name)
1609 (list master-file-name master-file-name)
1610 (list temp-master-file-name master-file-name))))
5323b4b0
RS
1611
1612 (when (equal 0 (length file-name-from-err-msg))
1613 (setq file-name-from-err-msg source-file-name))
1614
1615 (setq real-name (flymake-get-full-patched-file-name file-name-from-err-msg base-dirs files))
9a686ad2 1616 ;; if real-name is nil, than file name from err msg is none of the files we've patched
5323b4b0
RS
1617 (if (not real-name)
1618 (setq real-name (flymake-get-full-nonpatched-file-name file-name-from-err-msg base-dirs)))
1619 (if (not real-name)
1620 (setq real-name file-name-from-err-msg))
1621 (setq real-name (flymake-fix-file-name real-name))
1622 (flymake-log 3 "get-real-file-name: file-name=%s real-name=%s" file-name-from-err-msg real-name)
1623 real-name))
4bcbcb9d 1624
2aa13ec4 1625(defun flymake-get-full-patched-file-name (file-name-from-err-msg base-dirs files)
5323b4b0
RS
1626 (let* ((base-dirs-count (length base-dirs))
1627 (file-count (length files))
1628 (real-name nil))
1629
1630 (while (and (not real-name) (> base-dirs-count 0))
1631 (setq file-count (length files))
1632 (while (and (not real-name) (> file-count 0))
1633 (let* ((this-dir (nth (1- base-dirs-count) base-dirs))
1634 (this-file (nth 0 (nth (1- file-count) files)))
1635 (this-real-name (nth 1 (nth (1- file-count) files))))
9a686ad2 1636 ;;+(flymake-log 0 "this-dir=%s this-file=%s this-real=%s msg-file=%s" this-dir this-file this-real-name file-name-from-err-msg)
5323b4b0 1637 (when (and this-dir this-file (flymake-same-files
b8471a02 1638 (expand-file-name file-name-from-err-msg this-dir)
5323b4b0
RS
1639 this-file))
1640 (setq real-name this-real-name)))
1641 (setq file-count (1- file-count)))
1642 (setq base-dirs-count (1- base-dirs-count)))
1643 real-name))
4bcbcb9d 1644
2aa13ec4 1645(defun flymake-get-full-nonpatched-file-name (file-name-from-err-msg base-dirs)
5323b4b0
RS
1646 (let* ((real-name nil))
1647 (if (file-name-absolute-p file-name-from-err-msg)
1648 (setq real-name file-name-from-err-msg)
1649 (let* ((base-dirs-count (length base-dirs)))
1650 (while (and (not real-name) (> base-dirs-count 0))
b8471a02
SM
1651 (let* ((full-name (expand-file-name file-name-from-err-msg
1652 (nth (1- base-dirs-count) base-dirs))))
5323b4b0
RS
1653 (if (file-exists-p full-name)
1654 (setq real-name full-name))
1655 (setq base-dirs-count (1- base-dirs-count))))))
1656 real-name))
4bcbcb9d 1657
6df19241 1658(defun flymake-init-find-buildfile-dir (source-file-name buildfile-name)
5323b4b0 1659 "Find buildfile, store its dir in buffer data and return its dir, if found."
5bcef417
SM
1660 (let* ((buildfile-dir
1661 (flymake-find-buildfile buildfile-name
5f73367d 1662 (file-name-directory source-file-name))))
5bcef417 1663 (if buildfile-dir
6df19241 1664 (setq flymake-base-dir buildfile-dir)
5bcef417 1665 (flymake-log 1 "no buildfile (%s) for %s" buildfile-name source-file-name)
6df19241
SM
1666 (flymake-report-fatal-status
1667 "NOMK" (format "No buildfile (%s) found for %s"
1668 buildfile-name source-file-name)))))
4bcbcb9d 1669
587d108e 1670(defun flymake-init-create-temp-source-and-master-buffer-copy (get-incl-dirs-f create-temp-f master-file-masks include-regexp)
84bb5a0c 1671 "Find master file (or buffer), create its copy along with a copy of the source file."
c07fa030 1672 (let* ((source-file-name buffer-file-name)
6df19241 1673 (temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f))
5323b4b0
RS
1674 (master-and-temp-master (flymake-create-master-file
1675 source-file-name temp-source-file-name
1676 get-incl-dirs-f create-temp-f
587d108e 1677 master-file-masks include-regexp)))
5323b4b0
RS
1678
1679 (if (not master-and-temp-master)
1680 (progn
1681 (flymake-log 1 "cannot find master file for %s" source-file-name)
6df19241 1682 (flymake-report-status "!" "") ; NOMASTER
5bcef417 1683 nil)
6df19241
SM
1684 (setq flymake-master-file-name (nth 0 master-and-temp-master))
1685 (setq flymake-temp-master-file-name (nth 1 master-and-temp-master)))))
4bcbcb9d 1686
c07fa030
SM
1687(defun flymake-master-cleanup ()
1688 (flymake-simple-cleanup)
1689 (flymake-safe-delete-file flymake-temp-master-file-name))
4bcbcb9d
EZ
1690
1691;;;; make-specific init-cleanup routines
2aa13ec4 1692(defun flymake-get-syntax-check-program-args (source-file-name base-dir use-relative-base-dir use-relative-source get-cmd-line-f)
5323b4b0 1693 "Create a command line for syntax check using GET-CMD-LINE-F."
6fee12e6
SM
1694 (funcall get-cmd-line-f
1695 (if use-relative-source
1696 (file-relative-name source-file-name base-dir)
1697 source-file-name)
1698 (if use-relative-base-dir
1699 (file-relative-name base-dir
1700 (file-name-directory source-file-name))
1701 base-dir)))
4bcbcb9d 1702
2aa13ec4 1703(defun flymake-get-make-cmdline (source base-dir)
5323b4b0
RS
1704 (list "make"
1705 (list "-s"
1706 "-C"
1707 base-dir
1708 (concat "CHK_SOURCES=" source)
1709 "SYNTAX_CHECK_MODE=1"
1710 "check-syntax")))
4bcbcb9d 1711
2aa13ec4 1712(defun flymake-get-ant-cmdline (source base-dir)
5323b4b0
RS
1713 (list "ant"
1714 (list "-buildfile"
1715 (concat base-dir "/" "build.xml")
1716 (concat "-DCHK_SOURCES=" source)
1717 "check-syntax")))
4bcbcb9d 1718
6df19241 1719(defun flymake-simple-make-init-impl (create-temp-f use-relative-base-dir use-relative-source build-file-name get-cmdline-f)
5323b4b0 1720 "Create syntax check command line for a directly checked source file.
2aa13ec4 1721Use CREATE-TEMP-F for creating temp copy."
5323b4b0 1722 (let* ((args nil)
6df19241
SM
1723 (source-file-name buffer-file-name)
1724 (buildfile-dir (flymake-init-find-buildfile-dir source-file-name build-file-name)))
5323b4b0 1725 (if buildfile-dir
6df19241 1726 (let* ((temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f)))
5323b4b0
RS
1727 (setq args (flymake-get-syntax-check-program-args temp-source-file-name buildfile-dir
1728 use-relative-base-dir use-relative-source
1729 get-cmdline-f))))
1730 args))
4bcbcb9d 1731
6df19241
SM
1732(defun flymake-simple-make-init ()
1733 (flymake-simple-make-init-impl 'flymake-create-temp-inplace t t "Makefile" 'flymake-get-make-cmdline))
4bcbcb9d 1734
587d108e 1735(defun flymake-master-make-init (get-incl-dirs-f master-file-masks include-regexp)
9a686ad2 1736 "Create make command line for a source file checked via master file compilation."
5323b4b0
RS
1737 (let* ((make-args nil)
1738 (temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
6df19241 1739 get-incl-dirs-f 'flymake-create-temp-inplace
587d108e 1740 master-file-masks include-regexp)))
5323b4b0 1741 (when temp-master-file-name
6df19241 1742 (let* ((buildfile-dir (flymake-init-find-buildfile-dir temp-master-file-name "Makefile")))
5323b4b0
RS
1743 (if buildfile-dir
1744 (setq make-args (flymake-get-syntax-check-program-args
1745 temp-master-file-name buildfile-dir nil nil 'flymake-get-make-cmdline)))))
1746 make-args))
4bcbcb9d 1747
2aa13ec4 1748(defun flymake-find-make-buildfile (source-dir)
5f73367d 1749 (flymake-find-buildfile "Makefile" source-dir))
4bcbcb9d
EZ
1750
1751;;;; .h/make specific
6df19241 1752(defun flymake-master-make-header-init ()
fd09a83f
CY
1753 (flymake-master-make-init
1754 'flymake-get-include-dirs
1755 '("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'")
1756 "[ \t]*#[ \t]*include[ \t]*\"\\([[:word:]0-9/\\_.]*%s\\)\""))
4bcbcb9d
EZ
1757
1758;;;; .java/make specific
6df19241
SM
1759(defun flymake-simple-make-java-init ()
1760 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil "Makefile" 'flymake-get-make-cmdline))
4bcbcb9d 1761
6df19241
SM
1762(defun flymake-simple-ant-java-init ()
1763 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil "build.xml" 'flymake-get-ant-cmdline))
4bcbcb9d 1764
c07fa030 1765(defun flymake-simple-java-cleanup ()
9a686ad2 1766 "Cleanup after `flymake-simple-make-java-init' -- delete temp file and dirs."
c07fa030
SM
1767 (flymake-safe-delete-file flymake-temp-source-file-name)
1768 (when flymake-temp-source-file-name
1769 (flymake-delete-temp-directory
1770 (file-name-directory flymake-temp-source-file-name))))
4bcbcb9d
EZ
1771
1772;;;; perl-specific init-cleanup routines
6df19241 1773(defun flymake-perl-init ()
4bd0a5d0 1774 (let* ((temp-file (flymake-init-create-temp-buffer-copy
6df19241 1775 'flymake-create-temp-inplace))
6fee12e6
SM
1776 (local-file (file-relative-name
1777 temp-file
1778 (file-name-directory buffer-file-name))))
5323b4b0 1779 (list "perl" (list "-wc " local-file))))
eabd11d4
MH
1780
1781;;;; php-specific init-cleanup routines
1782(defun flymake-php-init ()
1783 (let* ((temp-file (flymake-init-create-temp-buffer-copy
1784 'flymake-create-temp-inplace))
1785 (local-file (file-relative-name
1786 temp-file
1787 (file-name-directory buffer-file-name))))
1788 (list "php" (list "-f" local-file "-l"))))
4bcbcb9d
EZ
1789
1790;;;; tex-specific init-cleanup routines
2aa13ec4 1791(defun flymake-get-tex-args (file-name)
9a686ad2 1792 ;;(list "latex" (list "-c-style-errors" file-name))
5323b4b0 1793 (list "texify" (list "--pdf" "--tex-option=-c-style-errors" file-name)))
4bcbcb9d 1794
6df19241
SM
1795(defun flymake-simple-tex-init ()
1796 (flymake-get-tex-args (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace)))
4bcbcb9d 1797
bd77c2ef
GM
1798;; Perhaps there should be a buffer-local variable flymake-master-file
1799;; that people can set to override this stuff. Could inherit from
1800;; the similar AUCTeX variable.
6df19241 1801(defun flymake-master-tex-init ()
5323b4b0 1802 (let* ((temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
6df19241
SM
1803 'flymake-get-include-dirs-dot 'flymake-create-temp-inplace
1804 '("\\.tex\\'")
bd77c2ef 1805 "[ \t]*\\in\\(?:put\\|clude\\)[ \t]*{\\(.*%s\\)}")))
5323b4b0
RS
1806 (when temp-master-file-name
1807 (flymake-get-tex-args temp-master-file-name))))
4bcbcb9d 1808
e02f48d7 1809(defun flymake-get-include-dirs-dot (_base-dir)
5323b4b0 1810 '("."))
4bcbcb9d
EZ
1811
1812;;;; xml-specific init-cleanup routines
6df19241
SM
1813(defun flymake-xml-init ()
1814 (list "xml" (list "val" (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace))))
2aa13ec4
RS
1815
1816(provide 'flymake)
4bcbcb9d
EZ
1817
1818;;; flymake.el ends here