1 ;;; flymake.el -- a universal on-the-fly syntax checker
3 ;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 ;; Author: Pavel Kobyakov <pk_at_work@yahoo.com>
6 ;; Maintainer: Pavel Kobyakov <pk_at_work@yahoo.com>
8 ;; Keywords: c languages tools
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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)
33 ;; - Only uses "Makefile", not "makefile" or "GNUmakefile"
34 ;; (from http://bugs.debian.org/337339).
38 (eval-when-compile (require 'cl
))
39 (if (featurep 'xemacs
) (require 'overlay
))
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
)
45 (defvar flymake-timer nil
46 "Timer for starting syntax check.")
47 (make-variable-buffer-local 'flymake-timer
)
49 (defvar flymake-last-change-time nil
50 "Time of last buffer change.")
51 (make-variable-buffer-local 'flymake-last-change-time
)
53 (defvar flymake-check-start-time nil
54 "Time at which syntax check was started.")
55 (make-variable-buffer-local 'flymake-check-start-time
)
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
)
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
)
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
)
69 ;;;; [[ cross-emacs compatibility routines
70 (defsubst flymake-makehash
(&optional test
)
71 (if (fboundp 'make-hash-table
)
72 (if test
(make-hash-table :test test
) (make-hash-table))
76 (defalias 'flymake-float-time
77 (if (fboundp 'float-time
)
79 (if (featurep 'xemacs
)
81 (multiple-value-bind (s0 s1 s2
) (values-list (current-time))
82 (+ (* (float (ash 1 16)) s0
) (float s1
) (* 0.0000001 s2
)))))))
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
))))
90 (defalias 'flymake-split-string
91 (if (condition-case nil
(equal (split-string " bc " " " t
) '("bc"))
93 (lambda (str pattern
) (split-string str pattern t
))
95 "Split STR into a list of substrings bounded by PATTERN.
96 Zero-length substrings at the beginning and end of the list are omitted."
97 (let ((split (split-string str pattern
)))
98 (while (equal (car split
) "") (setq split
(cdr split
)))
99 (setq split
(nreverse split
))
100 (while (equal (car split
) "") (setq split
(cdr split
)))
103 (defalias 'flymake-get-temp-dir
104 (if (fboundp 'temp-directory
)
106 (lambda () temporary-file-directory
)))
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,
110 relative to top left corner of WINDOW, as a mouse-1 click
111 event (identical to the event that would be triggered by clicking
112 mouse button 1 at the top left corner of the glyph).
114 POSITION and WINDOW default to the position of point in the
117 DX 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))
123 (let* ((pos (posn-at-point position window
))
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
)))
133 (defun flymake-popup-menu (menu-data)
134 "Pop up the flymake menu at point, using the data MENU-DATA.
135 POS is a list of the form ((X Y) WINDOW), where X and Y are
136 pixels positions from the top left corner of WINDOW's frame.
137 MENU-DATA is a list of error and warning messages returned by
138 `flymake-make-err-menu-data'."
139 (if (featurep 'xemacs
)
140 (let* ((pos (flymake-get-point-pixel-pos))
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
))
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
))
149 (flymake-posn-at-point-as-event)
150 (list (flymake-get-point-pixel-pos) (selected-window)))
151 (flymake-make-emacs-menu menu-data
))))
153 (defun flymake-make-emacs-menu (menu-data)
154 "Return a menu specifier using MENU-DATA.
155 MENU-DATA is a list of error and warning messages returned by
156 `flymake-make-err-menu-data'.
157 See `x-popup-menu' for the menu specifier format."
158 (let* ((menu-title (nth 0 menu-data
))
159 (menu-items (nth 1 menu-data
))
160 (menu-commands (mapcar (lambda (foo)
161 (cons (nth 0 foo
) (nth 1 foo
)))
163 (list menu-title
(cons "" menu-commands
))))
165 (if (featurep 'xemacs
) (progn
167 (defun flymake-nop ())
169 (defun flymake-make-xemacs-menu (menu-data)
170 "Return a menu specifier using MENU-DATA."
171 (let* ((menu-title (nth 0 menu-data
))
172 (menu-items (nth 1 menu-data
))
174 (setq menu-commands
(mapcar (lambda (foo)
175 (vector (nth 0 foo
) (or (nth 1 foo
) '(flymake-nop)) t
))
177 (cons menu-title menu-commands
)))
181 (unless (eval-when-compile (fboundp 'posn-at-point
))
183 (defun flymake-current-row ()
184 "Return current row number in current frame."
185 (if (fboundp 'window-edges
)
186 (+ (car (cdr (window-edges))) (count-lines (window-start) (point)))
187 (count-lines (window-start) (point))))
189 (defun flymake-selected-frame ()
190 (if (fboundp 'window-edges
)
194 (defun flymake-get-point-pixel-pos ()
195 "Return point position in pixels: (x, y)."
196 (let ((mouse-pos (mouse-position))
199 (if (car (cdr mouse-pos
))
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
)))))
207 (flymake-log 3 "mouse pos is %s" ret
)
210 ) ;; End of (unless (fboundp 'posn-at-point)
214 (defcustom flymake-log-level -
1
215 "Logging level, only messages with level lower or equal will be logged.
216 -1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG"
220 (defun flymake-log (level text
&rest args
)
221 "Log a message at level LEVEL.
222 If LEVEL is higher than `flymake-log-level', the message is
223 ignored. Otherwise, it is printed using `message'.
224 TEXT is a format control string, and the remaining arguments ARGS
225 are the string substitutions (see `format')."
226 (if (<= level flymake-log-level
)
227 (let* ((msg (apply 'format text args
)))
232 ;; (flymake-save-buffer-in-file "d:/flymake.log" t) ; make log file name customizable
236 (defun flymake-ins-after (list pos val
)
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
)))
242 (defun flymake-set-at (list pos val
)
243 "Set VAL at position POS in LIST."
244 (let ((tmp (copy-sequence list
))) ; (???)
245 (setcar (nthcdr pos tmp
) val
)
248 (defvar flymake-processes nil
249 "List of currently active flymake processes.")
251 (defvar flymake-output-residual nil
)
253 (make-variable-buffer-local 'flymake-output-residual
)
255 (defgroup flymake nil
256 "A universal on-the-fly syntax checker."
260 (defcustom flymake-allowed-file-name-masks
261 '(("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'" flymake-simple-make-init
)
262 ("\\.xml\\'" flymake-xml-init
)
263 ("\\.html?\\'" flymake-xml-init
)
264 ("\\.cs\\'" flymake-simple-make-init
)
265 ("\\.p[ml]\\'" flymake-perl-init
)
266 ("\\.php[345]?\\'" flymake-php-init
)
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
)
270 ("\\.tex\\'" flymake-simple-tex-init
)
271 ("\\.idl\\'" flymake-simple-make-init
)
274 ;; ("\\.h\\'" 2 ("\\.cpp\\'" "\\.c\\'")
275 ;; ("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2))
278 ;; ("[0-9]+\\.tex\\'" 2 ("\\.tex\\'")
279 ;; ("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2 ))
282 "Files syntax checking is allowed for."
284 :type
'(repeat (string symbol symbol symbol
)))
286 (defun flymake-get-file-name-mode-and-masks (file-name)
287 "Return the corresponding entry from `flymake-allowed-file-name-masks'."
288 (unless (stringp file-name
)
289 (error "Invalid file-name"))
290 (let ((fnm flymake-allowed-file-name-masks
)
291 (mode-and-masks nil
))
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
)))
296 (flymake-log 3 "file %s, init=%s" file-name
(car mode-and-masks
))
299 (defun flymake-can-syntax-check-file (file-name)
300 "Determine whether we can syntax check FILE-NAME.
301 Return nil if we cannot, non-nil if we can."
302 (if (flymake-get-init-function file-name
) t nil
))
304 (defun flymake-get-init-function (file-name)
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
))))
307 ;;(flymake-log 0 "calling %s" init-f)
308 ;;(funcall init-f (current-buffer))
311 (defun flymake-get-cleanup-function (file-name)
312 "Return cleanup function to be used for the file."
313 (or (nth 1 (flymake-get-file-name-mode-and-masks file-name
))
314 'flymake-simple-cleanup
))
316 (defun flymake-get-real-file-name-function (file-name)
317 (or (nth 2 (flymake-get-file-name-mode-and-masks file-name
))
318 'flymake-get-real-file-name
))
320 (defvar flymake-find-buildfile-cache
(flymake-makehash 'equal
))
322 (defun flymake-get-buildfile-from-cache (dir-name)
323 (gethash dir-name flymake-find-buildfile-cache
))
325 (defun flymake-add-buildfile-to-cache (dir-name buildfile
)
326 (puthash dir-name buildfile flymake-find-buildfile-cache
))
328 (defun flymake-clear-buildfile-cache ()
329 (clrhash flymake-find-buildfile-cache
))
331 (defun flymake-find-buildfile (buildfile-name source-dir-name
)
332 "Find buildfile starting from current directory.
333 Buildfile includes Makefile, build.xml etc.
334 Return its file name if found, or nil if not found."
335 (or (flymake-get-buildfile-from-cache source-dir-name
)
336 (let* ((file (locate-dominating-file source-dir-name buildfile-name
)))
339 (flymake-log 3 "found buildfile at %s" file
)
340 (flymake-add-buildfile-to-cache source-dir-name file
)
343 (flymake-log 3 "buildfile for %s not found" source-dir-name
)
346 (defun flymake-fix-file-name (name)
347 "Replace all occurrences of '\' with '/'."
349 (setq name
(expand-file-name name
))
350 (setq name
(abbreviate-file-name name
))
351 (setq name
(directory-file-name name
))
354 (defun flymake-same-files (file-name-one file-name-two
)
355 "Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
356 Return t if so, nil if not."
357 (equal (flymake-fix-file-name file-name-one
)
358 (flymake-fix-file-name file-name-two
)))
360 (defcustom flymake-master-file-dirs
'("." "./src" "./UnitTest")
361 "Dirs where to look for master files."
363 :type
'(repeat (string)))
365 (defcustom flymake-master-file-count-limit
32
366 "Max number of master files to check."
370 ;; This is bound dynamically to pass a parameter to a sort predicate below
371 (defvar flymake-included-file-name
)
373 (defun flymake-find-possible-master-files (file-name master-file-dirs masks
)
374 "Find (by name and location) all possible master files.
375 Master files include .cpp and .c for .h. Files are searched for
376 starting from the .h directory and max max-level parent dirs.
377 File contents are not checked."
378 (let* ((dirs master-file-dirs
)
382 (while (and (not done
) dirs
)
383 (let* ((dir (expand-file-name (car dirs
) (file-name-directory file-name
)))
385 (while (and (file-exists-p dir
) (not done
) masks
)
386 (let* ((mask (car masks
))
387 (dir-files (directory-files dir t mask
)))
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
))
394 (when (>= (length files
) flymake-master-file-count-limit
)
395 (flymake-log 3 "master file count limit (%d) reached" flymake-master-file-count-limit
)
397 (setq dir-files
(cdr dir-files
))))
398 (setq masks
(cdr masks
))))
399 (setq dirs
(cdr dirs
)))
401 (let ((flymake-included-file-name (file-name-nondirectory file-name
)))
402 (setq files
(sort files
'flymake-master-file-compare
))))
403 (flymake-log 3 "found %d possible master file(s)" (length files
))
406 (defun flymake-master-file-compare (file-one file-two
)
407 "Compare two files specified by FILE-ONE and FILE-TWO.
408 This function is used in sort to move most possible file names
409 to the beginning of the list (File.h -> File.cpp moved to top)."
410 (and (equal (file-name-sans-extension flymake-included-file-name
)
411 (file-name-sans-extension (file-name-nondirectory file-one
)))
412 (not (equal file-one file-two
))))
414 (defcustom flymake-check-file-limit
8192
415 "Maximum number of chars to look at when checking possible master file.
416 Nil means search the entire file."
418 :type
'(choice (const :tag
"No limit" nil
)
419 (integer :tag
"Characters")))
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
426 "Check if MASTER-FILE-NAME is a master file for SOURCE-FILE-NAME.
427 If yes, patch a copy of MASTER-FILE-NAME to include PATCHED-SOURCE-FILE-NAME
428 instead of SOURCE-FILE-NAME.
430 For example, foo.cpp is a master file if it includes foo.h.
432 Whether a buffer for MATER-FILE-NAME exists, use it as a source
433 instead of reading master file from disk."
434 (let* ((source-file-nondir (file-name-nondirectory source-file-name
))
435 (source-file-extension (file-name-extension source-file-nondir
))
436 (source-file-nonext (file-name-sans-extension source-file-nondir
))
439 (search-limit flymake-check-file-limit
))
441 (format regexp
; "[ \t]*#[ \t]*include[ \t]*\"\\(.*%s\\)\""
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
))))
451 (with-current-buffer master-file-temp-buffer
452 (if (or (not search-limit
)
453 (> search-limit
(point-max)))
454 (setq search-limit
(point-max)))
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)))
463 (flymake-log 3 "found possible match for %s" source-file-nondir
)
464 (setq inc-name
(match-string 1))
465 (and (> (length source-file-extension
) 1)
466 (string-equal source-file-extension
"tex")
467 (not (string-match (format "\\.%s\\'" source-file-extension
)
469 (setq inc-name
(concat inc-name
"." source-file-extension
)))
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
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
483 (file-name-nondirectory patched-source-file-name
))))
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
))
490 ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
492 (flymake-log 2 "found master file %s" master-file-name
))
495 (defun flymake-replace-region (beg end rep
)
496 "Replace text in BUFFER in region (BEG END) with REP."
499 ;; Insert before deleting, so as to better preserve markers's positions.
501 (delete-region beg end
)))
503 (defun flymake-read-file-to-temp-buffer (file-name)
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
))))))
506 (with-current-buffer temp-buffer
507 (insert-file-contents file-name
))
510 (defun flymake-copy-buffer-to-temp-buffer (buffer)
511 "Copy contents of BUFFER into newly created temp buffer."
513 (get-buffer-create (generate-new-buffer-name
514 (concat "flymake:" (buffer-name buffer
))))
515 (insert-buffer-substring buffer
)
518 (defun flymake-check-include (source-file-name inc-name include-dirs
)
519 "Check if SOURCE-FILE-NAME can be found in include path.
520 Return 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
526 (concat (file-name-directory source-file-name
)
527 "/" (car include-dirs
)
529 (setq include-dirs
(cdr include-dirs
)))
532 (defun flymake-find-buffer-for-file (file-name)
533 "Check if there exists a buffer visiting FILE-NAME.
534 Return t if so, nil if not."
535 (let ((buffer-name (get-file-buffer file-name
)))
537 (get-buffer buffer-name
))))
539 (defun flymake-create-master-file (source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp
)
540 "Save SOURCE-FILE-NAME with a different name.
541 Find master file, patch and save it."
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
))
546 (master-file-name nil
)
547 (patched-master-file-name nil
)
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
)))
557 (flymake-check-patch-master-file-buffer
560 patched-master-file-name
562 patched-source-file-name
563 (funcall get-incl-dirs-f
(file-name-directory master-file-name
))
567 (list master-file-name patched-master-file-name
)
569 (flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count
570 (file-name-nondirectory source-file-name
))
573 (defun flymake-save-buffer-in-file (file-name)
574 (make-directory (file-name-directory file-name
) 1)
575 (write-region nil nil file-name nil
566)
576 (flymake-log 3 "saved buffer %s in file %s" (buffer-name) file-name
))
578 (defun flymake-save-string-to-file (file-name data
)
579 "Save string DATA to file FILE-NAME."
580 (write-region data nil file-name nil
566))
582 (defun flymake-read-file-to-string (file-name)
583 "Read contents of file FILE-NAME and return as a string."
585 (insert-file-contents file-name
)
586 (buffer-substring (point-min) (point-max))))
588 (defun flymake-process-filter (process output
)
589 "Parse OUTPUT and highlight error lines.
590 It's flymake process filter."
591 (let ((source-buffer (process-buffer process
)))
593 (flymake-log 3 "received %d byte(s) of output from process %d"
594 (length output
) (process-id process
))
595 (when (buffer-live-p source-buffer
)
596 (with-current-buffer source-buffer
597 (flymake-parse-output-and-residual output
)))))
599 (defun flymake-process-sentinel (process _event
)
600 "Sentinel for syntax check buffers."
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
))))
607 (flymake-log 2 "process %d exited with code %d"
608 (process-id process
) exit-status
)
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
)))
616 (delete-process process
)
617 (setq flymake-processes
(delq process flymake-processes
))
619 (when (buffer-live-p source-buffer
)
620 (with-current-buffer source-buffer
622 (flymake-parse-residual)
623 (flymake-post-syntax-check exit-status command
)
624 (setq flymake-is-running nil
))))
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
))))))))
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
)
640 (let (err-count warn-count
)
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
645 (- (flymake-float-time) flymake-check-start-time
))
646 (setq flymake-check-start-time nil
)
648 (if (and (equal 0 err-count
) (equal 0 warn-count
))
649 (if (equal 0 exit-status
)
650 (flymake-report-status "" "") ; PASSED
651 (if (not flymake-check-was-interrupted
)
652 (flymake-report-fatal-status "CFGERR"
653 (format "Configuration error has occurred while running %s" command
))
654 (flymake-report-status nil
""))) ; "STOPPED"
655 (flymake-report-status (format "%d/%d" err-count warn-count
) ""))))
657 (defun flymake-parse-output-and-residual (output)
658 "Split OUTPUT into lines, merge in residual if necessary."
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
))))
669 (defun flymake-parse-residual ()
670 "Parse residual if it's non empty."
671 (when flymake-output-residual
672 (setq flymake-new-err-info
673 (flymake-parse-err-lines
675 (list flymake-output-residual
)))
676 (setq flymake-output-residual nil
)))
678 (defun flymake-er-make-er (line-no line-err-info-list
)
679 (list line-no line-err-info-list
))
681 (defun flymake-er-get-line (err-info)
684 (defun flymake-er-get-line-err-info-list (err-info)
687 (defstruct (flymake-ler
689 (:constructor flymake-ler-make-ler
(file line type text
&optional full-file
)))
690 file line type text full-file
)
692 (defun flymake-ler-set-file (line-err-info file
)
693 (flymake-ler-make-ler file
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
)))
699 (defun flymake-ler-set-full-file (line-err-info full-file
)
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
)
706 (defun flymake-ler-set-line (line-err-info line
)
707 (flymake-ler-make-ler (flymake-ler-file line-err-info
)
709 (flymake-ler-type line-err-info
)
710 (flymake-ler-text line-err-info
)
711 (flymake-ler-full-file line-err-info
)))
713 (defun flymake-get-line-err-count (line-err-info-list type
)
714 "Return number of errors of specified TYPE.
715 Value of TYPE is either \"e\" or \"w\"."
717 (count (length line-err-info-list
))
721 (when (equal type
(flymake-ler-type (nth idx line-err-info-list
)))
722 (setq err-count
(1+ err-count
)))
726 (defun flymake-get-err-count (err-info-list type
)
727 "Return number of errors of specified TYPE for ERR-INFO-LIST."
729 (count (length err-info-list
))
732 (setq err-count
(+ err-count
(flymake-get-line-err-count (nth 1 (nth idx err-info-list
)) type
)))
736 (defun flymake-fix-line-numbers (err-info-list min-line max-line
)
737 "Replace line numbers with fixed value.
738 If line-numbers is less than MIN-LINE, set line numbers to MIN-LINE.
739 If line numbers is greater than MAX-LINE, set line numbers to MAX-LINE.
740 The reason for this fix is because some compilers might report
741 line number outside the file being compiled."
742 (let* ((count (length err-info-list
))
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
))))
756 (defun flymake-highlight-err-lines (err-info-list)
757 "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
759 (dolist (err err-info-list
)
760 (flymake-highlight-line (car err
) (nth 1 err
)))))
762 (defun flymake-overlay-p (ov)
763 "Determine whether overlay OV was created by flymake."
764 (and (overlayp ov
) (overlay-get ov
'flymake-overlay
)))
766 (defun flymake-make-overlay (beg end tooltip-text face mouse-face
)
767 "Allocate a flymake overlay in range BEG and END."
768 (when (not (flymake-region-has-flymake-overlays beg end
))
769 (let ((ov (make-overlay beg end nil t t
)))
770 (overlay-put ov
'face face
)
771 (overlay-put ov
'mouse-face mouse-face
)
772 (overlay-put ov
'help-echo tooltip-text
)
773 (overlay-put ov
'flymake-overlay t
)
774 (overlay-put ov
'priority
100)
775 ;;+(flymake-log 3 "created overlay %s" ov)
777 (flymake-log 3 "created an overlay at (%d-%d)" beg end
)))
779 (defun flymake-delete-own-overlays ()
780 "Delete all flymake overlays in BUFFER."
781 (dolist (ol (overlays-in (point-min) (point-max)))
782 (when (flymake-overlay-p ol
)
784 ;;+(flymake-log 3 "deleted overlay %s" ol)
787 (defun flymake-region-has-flymake-overlays (beg end
)
788 "Check if region specified by BEG and END has overlay.
789 Return t if it has at least one flymake overlay, nil if no overlay."
790 (let ((ov (overlays-in beg end
))
791 (has-flymake-overlays nil
))
793 (when (flymake-overlay-p (car ov
))
794 (setq has-flymake-overlays t
))
796 has-flymake-overlays
))
798 (defface flymake-errline
799 '((((class color
) (background dark
)) (:background
"Firebrick4"))
800 (((class color
) (background light
)) (:background
"LightPink"))
802 "Face used for marking error lines."
805 (defface flymake-warnline
806 '((((class color
) (background dark
)) (:background
"DarkBlue"))
807 (((class color
) (background light
)) (:background
"LightBlue2"))
809 "Face used for marking warning lines."
812 (defun flymake-highlight-line (line-no line-err-info-list
)
813 "Highlight line LINE-NO in current buffer.
814 Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting."
815 (goto-char (point-min))
816 (forward-line (1- line-no
))
817 (let* ((line-beg (point-at-bol))
818 (line-end (point-at-eol))
821 (tooltip-text (flymake-ler-text (nth 0 line-err-info-list
)))
825 (while (looking-at "[ \t]")
831 (while (and (looking-at "[ \t\r\n]") (> (point) 1))
834 (setq end
(1+ (point)))
845 (if (> (flymake-get-line-err-count line-err-info-list
"e") 0)
846 (setq face
'flymake-errline
)
847 (setq face
'flymake-warnline
))
849 (flymake-make-overlay beg end tooltip-text face nil
)))
851 (defun flymake-parse-err-lines (err-info-list lines
)
852 "Parse err LINES, store info in ERR-INFO-LIST."
853 (let* ((count (length lines
))
857 (source-file-name buffer-file-name
)
858 (get-real-file-name-f (flymake-get-real-file-name-function source-file-name
)))
861 (setq line-err-info
(flymake-parse-line (nth idx lines
)))
863 (setq real-file-name
(funcall get-real-file-name-f
864 (flymake-ler-file line-err-info
)))
865 (setq line-err-info
(flymake-ler-set-full-file line-err-info real-file-name
))
867 (when (flymake-same-files real-file-name source-file-name
)
868 (setq line-err-info
(flymake-ler-set-file line-err-info nil
))
869 (setq err-info-list
(flymake-add-err-info err-info-list line-err-info
))))
870 (flymake-log 3 "parsed '%s', %s line-err-info" (nth idx lines
) (if line-err-info
"got" "no"))
874 (defun flymake-split-output (output)
875 "Split OUTPUT into lines.
876 Return last one as residual if it does not end with newline char.
877 Returns ((LINES) RESIDUAL)."
878 (when (and output
(> (length output
) 0))
879 (let* ((lines (flymake-split-string output
"[\n\r]+"))
880 (complete (equal "\n" (char-to-string (aref output
(1- (length output
))))))
883 (setq residual
(car (last lines
)))
884 (setq lines
(butlast lines
)))
885 (list lines residual
))))
887 (defun flymake-reformat-err-line-patterns-from-compile-el (original-list)
888 "Grab error line patterns from ORIGINAL-LIST in compile.el format.
889 Convert it to flymake internal format."
890 (let* ((converted-list '()))
891 (dolist (item original-list
)
892 (setq item
(cdr item
))
893 (let ((regexp (nth 0 item
))
897 (if (consp file
) (setq file
(car file
)))
898 (if (consp line
) (setq line
(car line
)))
899 (if (consp col
) (setq col
(car col
)))
901 (when (not (functionp line
))
902 (setq converted-list
(cons (list regexp file line col
) converted-list
)))))
907 (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
911 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
914 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\|Semantic Error\\):[ \t\n]*\\(.+\\)\\)"
917 ("midl[ ]*:[ ]*\\(command line error .*\\)"
920 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\),[0-9]+)\: \\(\\(error\\|warning\\|fatal error\\) \\(CS[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
923 ("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 2 3 nil
1)
925 ("\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)" 2 3 nil
1)
926 ;; LaTeX warnings (fileless) ("\\(LaTeX \\(Warning\\|Error\\): .*\\) on input line \\([0-9]+\\)" 20 3 nil 1)
927 ;; ant/javac. Note this also matches gcc warnings!
928 (" *\\(\\[javac\\] *\\)?\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\\(?:\:[0-9]+\\)?\:[ \t\n]*\\(.+\\)"
930 ;; compilation-error-regexp-alist)
931 (flymake-reformat-err-line-patterns-from-compile-el compilation-error-regexp-alist-alist
))
932 "Patterns for matching error/warning lines. Each pattern has the form
933 \(REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX).
934 Use `flymake-reformat-err-line-patterns-from-compile-el' to add patterns
937 ;;(defcustom flymake-err-line-patterns
939 ;; ; MS Visual C++ 6.0
940 ;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
943 ;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\):[ \t\n]*\\(.+\\)\\)"
945 ;; "patterns for matching error/warning lines, (regexp file-idx line-idx err-text-idx)"
947 ;; :type '(repeat (string number number number))
950 (defun flymake-parse-line (line)
951 "Parse LINE to see if it is an error or warning.
952 Return its components if so, nil otherwise."
953 (let ((raw-file-name nil
)
957 (patterns flymake-err-line-patterns
)
959 (while (and patterns
(not matched
))
960 (when (string-match (car (car patterns
)) line
)
961 (let* ((file-idx (nth 1 (car patterns
)))
962 (line-idx (nth 2 (car patterns
))))
964 (setq raw-file-name
(if file-idx
(match-string file-idx line
) nil
))
965 (setq line-no
(if line-idx
(string-to-number (match-string line-idx line
)) 0))
966 (setq err-text
(if (> (length (car patterns
)) 4)
967 (match-string (nth 4 (car patterns
)) line
)
968 (flymake-patch-err-text (substring line
(match-end 0)))))
969 (or err-text
(setq err-text
"<no error text>"))
970 (if (and err-text
(string-match "^[wW]arning" err-text
))
973 (flymake-log 3 "parse line: file-idx=%s line-idx=%s file=%s line=%s text=%s" file-idx line-idx
974 raw-file-name line-no err-text
)
976 (setq patterns
(cdr patterns
)))
978 (flymake-ler-make-ler raw-file-name line-no err-type err-text
)
981 (defun flymake-find-err-info (err-info-list line-no
)
982 "Find (line-err-info-list pos) for specified LINE-NO."
984 (let* ((line-err-info-list nil
)
986 (count (length err-info-list
)))
988 (while (and (< pos count
) (< (car (nth pos err-info-list
)) line-no
))
990 (when (and (< pos count
) (equal (car (nth pos err-info-list
)) line-no
))
991 (setq line-err-info-list
(flymake-er-get-line-err-info-list (nth pos err-info-list
))))
992 (list line-err-info-list pos
))
995 (defun flymake-line-err-info-is-less-or-equal (line-one line-two
)
996 (or (string< (flymake-ler-type line-one
) (flymake-ler-type line-two
))
997 (and (string= (flymake-ler-type line-one
) (flymake-ler-type line-two
))
998 (not (flymake-ler-file line-one
)) (flymake-ler-file line-two
))
999 (and (string= (flymake-ler-type line-one
) (flymake-ler-type line-two
))
1000 (or (and (flymake-ler-file line-one
) (flymake-ler-file line-two
))
1001 (and (not (flymake-ler-file line-one
)) (not (flymake-ler-file line-two
)))))))
1003 (defun flymake-add-line-err-info (line-err-info-list line-err-info
)
1004 "Update LINE-ERR-INFO-LIST with the error LINE-ERR-INFO.
1005 For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'.
1006 The new element is inserted in the proper position, according to
1007 the predicate `flymake-line-err-info-is-less-or-equal'.
1008 The updated value of LINE-ERR-INFO-LIST is returned."
1009 (if (not line-err-info-list
)
1010 (list line-err-info
)
1011 (let* ((count (length line-err-info-list
))
1013 (while (and (< idx count
) (flymake-line-err-info-is-less-or-equal (nth idx line-err-info-list
) line-err-info
))
1014 (setq idx
(1+ idx
)))
1015 (cond ((equal 0 idx
) (setq line-err-info-list
(cons line-err-info line-err-info-list
)))
1016 (t (setq line-err-info-list
(flymake-ins-after line-err-info-list
(1- idx
) line-err-info
))))
1017 line-err-info-list
)))
1019 (defun flymake-add-err-info (err-info-list line-err-info
)
1020 "Update ERR-INFO-LIST with the error LINE-ERR-INFO, preserving sort order.
1021 Returns the updated value of ERR-INFO-LIST.
1022 For the format of ERR-INFO-LIST, see `flymake-err-info'.
1023 For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'."
1024 (let* ((line-no (if (flymake-ler-file line-err-info
) 1 (flymake-ler-line line-err-info
)))
1025 (info-and-pos (flymake-find-err-info err-info-list line-no
))
1026 (exists (car info-and-pos
))
1027 (pos (nth 1 info-and-pos
))
1028 (line-err-info-list nil
)
1032 (setq line-err-info-list
(flymake-er-get-line-err-info-list (car (nthcdr pos err-info-list
)))))
1033 (setq line-err-info-list
(flymake-add-line-err-info line-err-info-list line-err-info
))
1035 (setq err-info
(flymake-er-make-er line-no line-err-info-list
))
1036 (cond (exists (setq err-info-list
(flymake-set-at err-info-list pos err-info
)))
1037 ((equal 0 pos
) (setq err-info-list
(cons err-info err-info-list
)))
1038 (t (setq err-info-list
(flymake-ins-after err-info-list
(1- pos
) err-info
))))
1041 (defun flymake-get-project-include-dirs-imp (basedir)
1042 "Include dirs for the project current file belongs to."
1043 (if (flymake-get-project-include-dirs-from-cache basedir
)
1045 (flymake-get-project-include-dirs-from-cache basedir
))
1047 (let* ((command-line (concat "make -C "
1048 (shell-quote-argument basedir
)
1049 " DUMPVARS=INCLUDE_DIRS dumpvars"))
1050 (output (shell-command-to-string command-line
))
1051 (lines (flymake-split-string output
"\n"))
1052 (count (length lines
))
1055 (while (and (< idx count
) (not (string-match "^INCLUDE_DIRS=.*" (nth idx lines
))))
1056 (setq idx
(1+ idx
)))
1058 (let* ((inc-lines (flymake-split-string (nth idx lines
) " *-I"))
1059 (inc-count (length inc-lines
)))
1060 (while (> inc-count
0)
1061 (when (not (string-match "^INCLUDE_DIRS=.*" (nth (1- inc-count
) inc-lines
)))
1062 (push (flymake-replace-regexp-in-string "\"" "" (nth (1- inc-count
) inc-lines
)) inc-dirs
))
1063 (setq inc-count
(1- inc-count
)))))
1064 (flymake-add-project-include-dirs-to-cache basedir inc-dirs
)
1067 (defcustom flymake-get-project-include-dirs-function
'flymake-get-project-include-dirs-imp
1068 "Function used to get project include dirs, one parameter: basedir name."
1072 (defun flymake-get-project-include-dirs (basedir)
1073 (funcall flymake-get-project-include-dirs-function basedir
))
1075 (defun flymake-get-system-include-dirs ()
1076 "System include dirs - from the 'INCLUDE' env setting."
1077 (let* ((includes (getenv "INCLUDE")))
1078 (if includes
(flymake-split-string includes path-separator
) nil
)))
1080 (defvar flymake-project-include-dirs-cache
(flymake-makehash 'equal
))
1082 (defun flymake-get-project-include-dirs-from-cache (base-dir)
1083 (gethash base-dir flymake-project-include-dirs-cache
))
1085 (defun flymake-add-project-include-dirs-to-cache (base-dir include-dirs
)
1086 (puthash base-dir include-dirs flymake-project-include-dirs-cache
))
1088 (defun flymake-clear-project-include-dirs-cache ()
1089 (clrhash flymake-project-include-dirs-cache
))
1091 (defun flymake-get-include-dirs (base-dir)
1092 "Get dirs to use when resolving local file names."
1093 (let* ((include-dirs (append '(".") (flymake-get-project-include-dirs base-dir
) (flymake-get-system-include-dirs))))
1096 ;; (defun flymake-restore-formatting ()
1097 ;; "Remove any formatting made by flymake."
1100 ;; (defun flymake-get-program-dir (buffer)
1101 ;; "Get dir to start program in."
1102 ;; (unless (bufferp buffer)
1103 ;; (error "Invalid buffer"))
1104 ;; (with-current-buffer buffer
1105 ;; default-directory))
1107 (defun flymake-safe-delete-file (file-name)
1108 (when (and file-name
(file-exists-p file-name
))
1109 (delete-file file-name
)
1110 (flymake-log 1 "deleted file %s" file-name
)))
1112 (defun flymake-safe-delete-directory (dir-name)
1115 (delete-directory dir-name
)
1116 (flymake-log 1 "deleted dir %s" dir-name
))
1118 (flymake-log 1 "Failed to delete dir %s, error ignored" dir-name
))))
1120 (defcustom flymake-compilation-prevents-syntax-check t
1121 "If non-nil, don't start syntax check if compilation is running."
1125 (defun flymake-start-syntax-check ()
1126 "Start syntax checking for current buffer."
1128 (flymake-log 3 "flymake is running: %s" flymake-is-running
)
1129 (when (and (not flymake-is-running
)
1130 (flymake-can-syntax-check-file buffer-file-name
))
1131 (when (or (not flymake-compilation-prevents-syntax-check
)
1132 (not (flymake-compilation-is-running))) ;+ (flymake-rep-ort-status buffer "COMP")
1133 (flymake-clear-buildfile-cache)
1134 (flymake-clear-project-include-dirs-cache)
1136 (setq flymake-check-was-interrupted nil
)
1138 (let* ((source-file-name buffer-file-name
)
1139 (init-f (flymake-get-init-function source-file-name
))
1140 (cleanup-f (flymake-get-cleanup-function source-file-name
))
1141 (cmd-and-args (funcall init-f
))
1142 (cmd (nth 0 cmd-and-args
))
1143 (args (nth 1 cmd-and-args
))
1144 (dir (nth 2 cmd-and-args
)))
1145 (if (not cmd-and-args
)
1147 (flymake-log 0 "init function %s for %s failed, cleaning up" init-f source-file-name
)
1148 (funcall cleanup-f
))
1150 (setq flymake-last-change-time nil
)
1151 (flymake-start-syntax-check-process cmd args dir
)))))))
1153 (defun flymake-start-syntax-check-process (cmd args dir
)
1154 "Start syntax check process."
1157 (let ((default-directory (or dir default-directory
)))
1159 (flymake-log 3 "starting process on dir %s" dir
))
1160 (apply 'start-file-process
1161 "flymake-proc" (current-buffer) cmd args
))))
1162 (set-process-sentinel process
'flymake-process-sentinel
)
1163 (set-process-filter process
'flymake-process-filter
)
1164 (push process flymake-processes
)
1166 (setq flymake-is-running t
)
1167 (setq flymake-last-change-time nil
)
1168 (setq flymake-check-start-time
(flymake-float-time))
1170 (flymake-report-status nil
"*")
1171 (flymake-log 2 "started process %d, command=%s, dir=%s"
1172 (process-id process
) (process-command process
)
1176 (let* ((err-str (format "Failed to launch syntax check process '%s' with args %s: %s"
1177 cmd args
(error-message-string err
)))
1178 (source-file-name buffer-file-name
)
1179 (cleanup-f (flymake-get-cleanup-function source-file-name
)))
1180 (flymake-log 0 err-str
)
1182 (flymake-report-fatal-status "PROCERR" err-str
)))))
1184 (defun flymake-kill-process (proc)
1185 "Kill process PROC."
1187 (let* ((buf (process-buffer proc
)))
1188 (when (buffer-live-p buf
)
1189 (with-current-buffer buf
1190 (setq flymake-check-was-interrupted t
))))
1191 (flymake-log 1 "killed process %d" (process-id proc
)))
1193 (defun flymake-stop-all-syntax-checks ()
1194 "Kill all syntax check processes."
1196 (while flymake-processes
1197 (flymake-kill-process (pop flymake-processes
))))
1199 (defun flymake-compilation-is-running ()
1200 (and (boundp 'compilation-in-progress
)
1201 compilation-in-progress
))
1203 (defun flymake-compile ()
1204 "Kill all flymake syntax checks, start compilation."
1206 (flymake-stop-all-syntax-checks)
1207 (call-interactively 'compile
))
1209 (defcustom flymake-no-changes-timeout
0.5
1210 "Time to wait after last change before starting compilation."
1214 (defun flymake-on-timer-event (buffer)
1215 "Start a syntax check for buffer BUFFER if necessary."
1216 (when (buffer-live-p buffer
)
1217 (with-current-buffer buffer
1218 (when (and (not flymake-is-running
)
1219 flymake-last-change-time
1220 (> (- (flymake-float-time) flymake-last-change-time
)
1221 flymake-no-changes-timeout
))
1223 (setq flymake-last-change-time nil
)
1224 (flymake-log 3 "starting syntax check as more than 1 second passed since last change")
1225 (flymake-start-syntax-check)))))
1227 (defun flymake-current-line-no ()
1228 "Return number of current line in current buffer."
1229 (count-lines (point-min) (if (eobp) (point) (1+ (point)))))
1231 (defun flymake-count-lines ()
1232 "Return number of lines in buffer BUFFER."
1233 (count-lines (point-min) (point-max)))
1235 (defun flymake-display-err-menu-for-current-line ()
1236 "Display a menu with errors/warnings for current line if it has errors and/or warnings."
1238 (let* ((line-no (flymake-current-line-no))
1239 (line-err-info-list (nth 0 (flymake-find-err-info flymake-err-info line-no
)))
1240 (menu-data (flymake-make-err-menu-data line-no line-err-info-list
))
1244 (setq choice
(flymake-popup-menu menu-data
))
1245 (flymake-log 3 "choice=%s" choice
)
1248 (flymake-log 1 "no errors for line %d" line-no
))))
1250 (defun flymake-make-err-menu-data (line-no line-err-info-list
)
1251 "Make a (menu-title (item-title item-action)*) list with errors/warnings from LINE-ERR-INFO-LIST."
1252 (let* ((menu-items nil
))
1253 (when line-err-info-list
1254 (let* ((count (length line-err-info-list
))
1255 (menu-item-text nil
))
1257 (setq menu-item-text
(flymake-ler-text (nth (1- count
) line-err-info-list
)))
1258 (let* ((file (flymake-ler-file (nth (1- count
) line-err-info-list
)))
1259 (full-file (flymake-ler-full-file (nth (1- count
) line-err-info-list
)))
1260 (line (flymake-ler-line (nth (1- count
) line-err-info-list
))))
1262 (setq menu-item-text
(concat menu-item-text
" - " file
"(" (format "%d" line
) ")")))
1263 (setq menu-items
(cons (list menu-item-text
1264 (if file
(list 'flymake-goto-file-and-line full-file line
) nil
))
1266 (setq count
(1- count
)))
1267 (flymake-log 3 "created menu-items with %d item(s)" (length menu-items
))))
1269 (let* ((menu-title (format "Line %d: %d error(s), %d warning(s)" line-no
1270 (flymake-get-line-err-count line-err-info-list
"e")
1271 (flymake-get-line-err-count line-err-info-list
"w"))))
1272 (list menu-title menu-items
))
1275 (defun flymake-goto-file-and-line (file line
)
1276 "Try to get buffer for FILE and goto line LINE in it."
1277 (if (not (file-exists-p file
))
1278 (flymake-log 1 "File %s does not exist" file
)
1280 (goto-char (point-min))
1281 (forward-line (1- line
))))
1283 ;; flymake minor mode declarations
1284 (defvar flymake-mode-line nil
)
1286 (make-variable-buffer-local 'flymake-mode-line
)
1288 (defvar flymake-mode-line-e-w nil
)
1290 (make-variable-buffer-local 'flymake-mode-line-e-w
)
1292 (defvar flymake-mode-line-status nil
)
1294 (make-variable-buffer-local 'flymake-mode-line-status
)
1296 (defun flymake-report-status (e-w &optional status
)
1297 "Show status in mode line."
1299 (setq flymake-mode-line-e-w e-w
))
1301 (setq flymake-mode-line-status status
))
1302 (let* ((mode-line " Flymake"))
1303 (when (> (length flymake-mode-line-e-w
) 0)
1304 (setq mode-line
(concat mode-line
":" flymake-mode-line-e-w
)))
1305 (setq mode-line
(concat mode-line flymake-mode-line-status
))
1306 (setq flymake-mode-line mode-line
)
1307 (force-mode-line-update)))
1309 (defun flymake-display-warning (warning)
1310 "Display a warning to user."
1311 (message-box warning
))
1313 (defcustom flymake-gui-warnings-enabled t
1314 "Enables/disables GUI warnings."
1318 (defun flymake-report-fatal-status (status warning
)
1319 "Display a warning and switch flymake mode off."
1320 (when flymake-gui-warnings-enabled
1321 (flymake-display-warning (format "Flymake: %s. Flymake will be switched OFF" warning
))
1324 (flymake-log 0 "switched OFF Flymake mode for buffer %s due to fatal status %s, warning %s"
1325 (buffer-name) status warning
))
1327 (defcustom flymake-start-syntax-check-on-find-file t
1328 "Start syntax check on find file."
1333 (define-minor-mode flymake-mode
1334 "Toggle on-the-fly syntax checking.
1335 With a prefix argument ARG, enable the mode if ARG is positive,
1336 and disable it otherwise. If called from Lisp, enable the mode
1337 if ARG is omitted or nil."
1338 :group
'flymake
:lighter flymake-mode-line
1341 ;; Turning the mode ON.
1344 ((not buffer-file-name
)
1345 (message "Flymake unable to run without a buffer file name"))
1346 ((not (flymake-can-syntax-check-file buffer-file-name
))
1347 (flymake-log 2 "flymake cannot check syntax in buffer %s" (buffer-name)))
1349 (add-hook 'after-change-functions
'flymake-after-change-function nil t
)
1350 (add-hook 'after-save-hook
'flymake-after-save-hook nil t
)
1351 (add-hook 'kill-buffer-hook
'flymake-kill-buffer-hook nil t
)
1352 ;;+(add-hook 'find-file-hook 'flymake-find-file-hook)
1354 (flymake-report-status "" "")
1357 (run-at-time nil
1 'flymake-on-timer-event
(current-buffer)))
1359 (when flymake-start-syntax-check-on-find-file
1360 (flymake-start-syntax-check)))))
1362 ;; Turning the mode OFF.
1364 (remove-hook 'after-change-functions
'flymake-after-change-function t
)
1365 (remove-hook 'after-save-hook
'flymake-after-save-hook t
)
1366 (remove-hook 'kill-buffer-hook
'flymake-kill-buffer-hook t
)
1367 ;;+(remove-hook 'find-file-hook (function flymake-find-file-hook) t)
1369 (flymake-delete-own-overlays)
1372 (cancel-timer flymake-timer
)
1373 (setq flymake-timer nil
))
1375 (setq flymake-is-running nil
))))
1378 (defun flymake-mode-on ()
1379 "Turn flymake mode on."
1381 (flymake-log 1 "flymake mode turned ON for buffer %s" (buffer-name)))
1384 (defun flymake-mode-off ()
1385 "Turn flymake mode off."
1387 (flymake-log 1 "flymake mode turned OFF for buffer %s" (buffer-name)))
1389 (defcustom flymake-start-syntax-check-on-newline t
1390 "Start syntax check if newline char was added/removed from the buffer."
1394 (defun flymake-after-change-function (start stop _len
)
1395 "Start syntax check for current buffer if it isn't already running."
1396 ;;+(flymake-log 0 "setting change time to %s" (flymake-float-time))
1397 (let((new-text (buffer-substring start stop
)))
1398 (when (and flymake-start-syntax-check-on-newline
(equal new-text
"\n"))
1399 (flymake-log 3 "starting syntax check as new-line has been seen")
1400 (flymake-start-syntax-check))
1401 (setq flymake-last-change-time
(flymake-float-time))))
1403 (defun flymake-after-save-hook ()
1404 (if (local-variable-p 'flymake-mode
(current-buffer)) ; (???) other way to determine whether flymake is active in buffer being saved?
1406 (flymake-log 3 "starting syntax check as buffer was saved")
1407 (flymake-start-syntax-check)))) ; no more mode 3. cannot start check if mode 3 (to temp copies) is active - (???)
1409 (defun flymake-kill-buffer-hook ()
1411 (cancel-timer flymake-timer
)
1412 (setq flymake-timer nil
)))
1415 (defun flymake-find-file-hook ()
1416 ;;+(when flymake-start-syntax-check-on-find-file
1417 ;;+ (flymake-log 3 "starting syntax check on file open")
1418 ;;+ (flymake-start-syntax-check)
1420 (when (and (not (local-variable-p 'flymake-mode
(current-buffer)))
1421 (flymake-can-syntax-check-file buffer-file-name
))
1423 (flymake-log 3 "automatically turned ON flymake mode")))
1425 (defun flymake-get-first-err-line-no (err-info-list)
1426 "Return first line with error."
1428 (flymake-er-get-line (car err-info-list
))))
1430 (defun flymake-get-last-err-line-no (err-info-list)
1431 "Return last line with error."
1433 (flymake-er-get-line (nth (1- (length err-info-list
)) err-info-list
))))
1435 (defun flymake-get-next-err-line-no (err-info-list line-no
)
1436 "Return next line with error."
1438 (let* ((count (length err-info-list
))
1440 (while (and (< idx count
) (>= line-no
(flymake-er-get-line (nth idx err-info-list
))))
1441 (setq idx
(1+ idx
)))
1443 (flymake-er-get-line (nth idx err-info-list
))))))
1445 (defun flymake-get-prev-err-line-no (err-info-list line-no
)
1446 "Return previous line with error."
1448 (let* ((count (length err-info-list
)))
1449 (while (and (> count
0) (<= line-no
(flymake-er-get-line (nth (1- count
) err-info-list
))))
1450 (setq count
(1- count
)))
1452 (flymake-er-get-line (nth (1- count
) err-info-list
))))))
1454 (defun flymake-skip-whitespace ()
1455 "Move forward until non-whitespace is reached."
1456 (while (looking-at "[ \t]")
1459 (defun flymake-goto-line (line-no)
1460 "Go to line LINE-NO, then skip whitespace."
1461 (goto-char (point-min))
1462 (forward-line (1- line-no
))
1463 (flymake-skip-whitespace))
1465 (defun flymake-goto-next-error ()
1466 "Go to next error in err ring."
1468 (let ((line-no (flymake-get-next-err-line-no flymake-err-info
(flymake-current-line-no))))
1470 (setq line-no
(flymake-get-first-err-line-no flymake-err-info
))
1471 (flymake-log 1 "passed end of file"))
1473 (flymake-goto-line line-no
)
1474 (flymake-log 1 "no errors in current buffer"))))
1476 (defun flymake-goto-prev-error ()
1477 "Go to previous error in err ring."
1479 (let ((line-no (flymake-get-prev-err-line-no flymake-err-info
(flymake-current-line-no))))
1481 (setq line-no
(flymake-get-last-err-line-no flymake-err-info
))
1482 (flymake-log 1 "passed beginning of file"))
1484 (flymake-goto-line line-no
)
1485 (flymake-log 1 "no errors in current buffer"))))
1487 (defun flymake-patch-err-text (string)
1488 (if (string-match "^[\n\t :0-9]*\\(.*\\)$" string
)
1489 (match-string 1 string
)
1492 ;;;; general init-cleanup and helper routines
1493 (defun flymake-create-temp-inplace (file-name prefix
)
1494 (unless (stringp file-name
)
1495 (error "Invalid file-name"))
1497 (setq prefix
"flymake"))
1498 (let* ((temp-name (concat (file-name-sans-extension file-name
)
1500 (and (file-name-extension file-name
)
1501 (concat "." (file-name-extension file-name
))))))
1502 (flymake-log 3 "create-temp-inplace: file=%s temp=%s" file-name temp-name
)
1505 (defun flymake-create-temp-with-folder-structure (file-name _prefix
)
1506 (unless (stringp file-name
)
1507 (error "Invalid file-name"))
1509 (let* ((dir (file-name-directory file-name
))
1510 ;; Not sure what this slash-pos is all about, but I guess it's just
1511 ;; trying to remove the leading / of absolute file names.
1512 (slash-pos (string-match "/" dir
))
1513 (temp-dir (expand-file-name (substring dir
(1+ slash-pos
))
1514 (flymake-get-temp-dir))))
1516 (file-truename (expand-file-name (file-name-nondirectory file-name
)
1519 (defun flymake-delete-temp-directory (dir-name)
1520 "Attempt to delete temp dir created by `flymake-create-temp-with-folder-structure', do not fail on error."
1521 (let* ((temp-dir (flymake-get-temp-dir))
1522 (suffix (substring dir-name
(1+ (length temp-dir
)))))
1524 (while (> (length suffix
) 0)
1525 (setq suffix
(directory-file-name suffix
))
1526 ;;+(flymake-log 0 "suffix=%s" suffix)
1527 (flymake-safe-delete-directory
1528 (file-truename (expand-file-name suffix temp-dir
)))
1529 (setq suffix
(file-name-directory suffix
)))))
1531 (defvar flymake-temp-source-file-name nil
)
1532 (make-variable-buffer-local 'flymake-temp-source-file-name
)
1534 (defvar flymake-master-file-name nil
)
1535 (make-variable-buffer-local 'flymake-master-file-name
)
1537 (defvar flymake-temp-master-file-name nil
)
1538 (make-variable-buffer-local 'flymake-temp-master-file-name
)
1540 (defvar flymake-base-dir nil
)
1541 (make-variable-buffer-local 'flymake-base-dir
)
1543 (defun flymake-init-create-temp-buffer-copy (create-temp-f)
1544 "Make a temporary copy of the current buffer, save its name in buffer data and return the name."
1545 (let* ((source-file-name buffer-file-name
)
1546 (temp-source-file-name (funcall create-temp-f source-file-name
"flymake")))
1548 (flymake-save-buffer-in-file temp-source-file-name
)
1549 (setq flymake-temp-source-file-name temp-source-file-name
)
1550 temp-source-file-name
))
1552 (defun flymake-simple-cleanup ()
1553 "Do cleanup after `flymake-init-create-temp-buffer-copy'.
1555 (flymake-safe-delete-file flymake-temp-source-file-name
)
1556 (setq flymake-last-change-time nil
))
1558 (defun flymake-get-real-file-name (file-name-from-err-msg)
1559 "Translate file name from error message to \"real\" file name.
1560 Return full-name. Names are real, not patched."
1561 (let* ((real-name nil
)
1562 (source-file-name buffer-file-name
)
1563 (master-file-name flymake-master-file-name
)
1564 (temp-source-file-name flymake-temp-source-file-name
)
1565 (temp-master-file-name flymake-temp-master-file-name
)
1567 (list flymake-base-dir
1568 (file-name-directory source-file-name
)
1569 (if master-file-name
(file-name-directory master-file-name
))))
1570 (files (list (list source-file-name source-file-name
)
1571 (list temp-source-file-name source-file-name
)
1572 (list master-file-name master-file-name
)
1573 (list temp-master-file-name master-file-name
))))
1575 (when (equal 0 (length file-name-from-err-msg
))
1576 (setq file-name-from-err-msg source-file-name
))
1578 (setq real-name
(flymake-get-full-patched-file-name file-name-from-err-msg base-dirs files
))
1579 ;; if real-name is nil, than file name from err msg is none of the files we've patched
1581 (setq real-name
(flymake-get-full-nonpatched-file-name file-name-from-err-msg base-dirs
)))
1583 (setq real-name file-name-from-err-msg
))
1584 (setq real-name
(flymake-fix-file-name real-name
))
1585 (flymake-log 3 "get-real-file-name: file-name=%s real-name=%s" file-name-from-err-msg real-name
)
1588 (defun flymake-get-full-patched-file-name (file-name-from-err-msg base-dirs files
)
1589 (let* ((base-dirs-count (length base-dirs
))
1590 (file-count (length files
))
1593 (while (and (not real-name
) (> base-dirs-count
0))
1594 (setq file-count
(length files
))
1595 (while (and (not real-name
) (> file-count
0))
1596 (let* ((this-dir (nth (1- base-dirs-count
) base-dirs
))
1597 (this-file (nth 0 (nth (1- file-count
) files
)))
1598 (this-real-name (nth 1 (nth (1- file-count
) files
))))
1599 ;;+(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)
1600 (when (and this-dir this-file
(flymake-same-files
1601 (expand-file-name file-name-from-err-msg this-dir
)
1603 (setq real-name this-real-name
)))
1604 (setq file-count
(1- file-count
)))
1605 (setq base-dirs-count
(1- base-dirs-count
)))
1608 (defun flymake-get-full-nonpatched-file-name (file-name-from-err-msg base-dirs
)
1609 (let* ((real-name nil
))
1610 (if (file-name-absolute-p file-name-from-err-msg
)
1611 (setq real-name file-name-from-err-msg
)
1612 (let* ((base-dirs-count (length base-dirs
)))
1613 (while (and (not real-name
) (> base-dirs-count
0))
1614 (let* ((full-name (expand-file-name file-name-from-err-msg
1615 (nth (1- base-dirs-count
) base-dirs
))))
1616 (if (file-exists-p full-name
)
1617 (setq real-name full-name
))
1618 (setq base-dirs-count
(1- base-dirs-count
))))))
1621 (defun flymake-init-find-buildfile-dir (source-file-name buildfile-name
)
1622 "Find buildfile, store its dir in buffer data and return its dir, if found."
1623 (let* ((buildfile-dir
1624 (flymake-find-buildfile buildfile-name
1625 (file-name-directory source-file-name
))))
1627 (setq flymake-base-dir buildfile-dir
)
1628 (flymake-log 1 "no buildfile (%s) for %s" buildfile-name source-file-name
)
1629 (flymake-report-fatal-status
1630 "NOMK" (format "No buildfile (%s) found for %s"
1631 buildfile-name source-file-name
)))))
1633 (defun flymake-init-create-temp-source-and-master-buffer-copy (get-incl-dirs-f create-temp-f master-file-masks include-regexp
)
1634 "Find master file (or buffer), create its copy along with a copy of the source file."
1635 (let* ((source-file-name buffer-file-name
)
1636 (temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f
))
1637 (master-and-temp-master (flymake-create-master-file
1638 source-file-name temp-source-file-name
1639 get-incl-dirs-f create-temp-f
1640 master-file-masks include-regexp
)))
1642 (if (not master-and-temp-master
)
1644 (flymake-log 1 "cannot find master file for %s" source-file-name
)
1645 (flymake-report-status "!" "") ; NOMASTER
1647 (setq flymake-master-file-name
(nth 0 master-and-temp-master
))
1648 (setq flymake-temp-master-file-name
(nth 1 master-and-temp-master
)))))
1650 (defun flymake-master-cleanup ()
1651 (flymake-simple-cleanup)
1652 (flymake-safe-delete-file flymake-temp-master-file-name
))
1654 ;;;; make-specific init-cleanup routines
1655 (defun flymake-get-syntax-check-program-args (source-file-name base-dir use-relative-base-dir use-relative-source get-cmd-line-f
)
1656 "Create a command line for syntax check using GET-CMD-LINE-F."
1657 (funcall get-cmd-line-f
1658 (if use-relative-source
1659 (file-relative-name source-file-name base-dir
)
1661 (if use-relative-base-dir
1662 (file-relative-name base-dir
1663 (file-name-directory source-file-name
))
1666 (defun flymake-get-make-cmdline (source base-dir
)
1671 (concat "CHK_SOURCES=" source
)
1672 "SYNTAX_CHECK_MODE=1"
1675 (defun flymake-get-ant-cmdline (source base-dir
)
1678 (concat base-dir
"/" "build.xml")
1679 (concat "-DCHK_SOURCES=" source
)
1682 (defun flymake-simple-make-init-impl (create-temp-f use-relative-base-dir use-relative-source build-file-name get-cmdline-f
)
1683 "Create syntax check command line for a directly checked source file.
1684 Use CREATE-TEMP-F for creating temp copy."
1686 (source-file-name buffer-file-name
)
1687 (buildfile-dir (flymake-init-find-buildfile-dir source-file-name build-file-name
)))
1689 (let* ((temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f
)))
1690 (setq args
(flymake-get-syntax-check-program-args temp-source-file-name buildfile-dir
1691 use-relative-base-dir use-relative-source
1695 (defun flymake-simple-make-init ()
1696 (flymake-simple-make-init-impl 'flymake-create-temp-inplace t t
"Makefile" 'flymake-get-make-cmdline
))
1698 (defun flymake-master-make-init (get-incl-dirs-f master-file-masks include-regexp
)
1699 "Create make command line for a source file checked via master file compilation."
1700 (let* ((make-args nil
)
1701 (temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
1702 get-incl-dirs-f
'flymake-create-temp-inplace
1703 master-file-masks include-regexp
)))
1704 (when temp-master-file-name
1705 (let* ((buildfile-dir (flymake-init-find-buildfile-dir temp-master-file-name
"Makefile")))
1707 (setq make-args
(flymake-get-syntax-check-program-args
1708 temp-master-file-name buildfile-dir nil nil
'flymake-get-make-cmdline
)))))
1711 (defun flymake-find-make-buildfile (source-dir)
1712 (flymake-find-buildfile "Makefile" source-dir
))
1714 ;;;; .h/make specific
1715 (defun flymake-master-make-header-init ()
1716 (flymake-master-make-init
1717 'flymake-get-include-dirs
1718 '("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'")
1719 "[ \t]*#[ \t]*include[ \t]*\"\\([[:word:]0-9/\\_.]*%s\\)\""))
1721 ;;;; .java/make specific
1722 (defun flymake-simple-make-java-init ()
1723 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil
"Makefile" 'flymake-get-make-cmdline
))
1725 (defun flymake-simple-ant-java-init ()
1726 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil
"build.xml" 'flymake-get-ant-cmdline
))
1728 (defun flymake-simple-java-cleanup ()
1729 "Cleanup after `flymake-simple-make-java-init' -- delete temp file and dirs."
1730 (flymake-safe-delete-file flymake-temp-source-file-name
)
1731 (when flymake-temp-source-file-name
1732 (flymake-delete-temp-directory
1733 (file-name-directory flymake-temp-source-file-name
))))
1735 ;;;; perl-specific init-cleanup routines
1736 (defun flymake-perl-init ()
1737 (let* ((temp-file (flymake-init-create-temp-buffer-copy
1738 'flymake-create-temp-inplace
))
1739 (local-file (file-relative-name
1741 (file-name-directory buffer-file-name
))))
1742 (list "perl" (list "-wc " local-file
))))
1744 ;;;; php-specific init-cleanup routines
1745 (defun flymake-php-init ()
1746 (let* ((temp-file (flymake-init-create-temp-buffer-copy
1747 'flymake-create-temp-inplace
))
1748 (local-file (file-relative-name
1750 (file-name-directory buffer-file-name
))))
1751 (list "php" (list "-f" local-file
"-l"))))
1753 ;;;; tex-specific init-cleanup routines
1754 (defun flymake-get-tex-args (file-name)
1755 ;;(list "latex" (list "-c-style-errors" file-name))
1756 (list "texify" (list "--pdf" "--tex-option=-c-style-errors" file-name
)))
1758 (defun flymake-simple-tex-init ()
1759 (flymake-get-tex-args (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace
)))
1761 ;; Perhaps there should be a buffer-local variable flymake-master-file
1762 ;; that people can set to override this stuff. Could inherit from
1763 ;; the similar AUCTeX variable.
1764 (defun flymake-master-tex-init ()
1765 (let* ((temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
1766 'flymake-get-include-dirs-dot
'flymake-create-temp-inplace
1768 "[ \t]*\\in\\(?:put\\|clude\\)[ \t]*{\\(.*%s\\)}")))
1769 (when temp-master-file-name
1770 (flymake-get-tex-args temp-master-file-name
))))
1772 (defun flymake-get-include-dirs-dot (_base-dir)
1775 ;;;; xml-specific init-cleanup routines
1776 (defun flymake-xml-init ()
1777 (list "xml" (list "val" (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace
))))
1781 ;;; flymake.el ends here