1 ;;; flymake.el -- a universal on-the-fly syntax checker
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Pavel Kobyakov <pk_at_work@yahoo.com>
7 ;; Maintainer: Pavel Kobyakov <pk_at_work@yahoo.com>
9 ;; Keywords: c languages tools
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Flymake is a minor Emacs mode performing on-the-fly syntax
29 ;; checks using the external syntax check tool (for C/C++ this
30 ;; is usually the compiler)
34 ;; - Only uses "Makefile", not "makefile" or "GNUmakefile"
35 ;; (from http://bugs.debian.org/337339).
39 (eval-when-compile (require 'cl
))
40 (if (featurep 'xemacs
) (require 'overlay
))
42 (defvar flymake-is-running nil
43 "If t, flymake syntax check process is running for the current buffer.")
44 (make-variable-buffer-local 'flymake-is-running
)
46 (defvar flymake-timer nil
47 "Timer for starting syntax check.")
48 (make-variable-buffer-local 'flymake-timer
)
50 (defvar flymake-last-change-time nil
51 "Time of last buffer change.")
52 (make-variable-buffer-local 'flymake-last-change-time
)
54 (defvar flymake-check-start-time nil
55 "Time at which syntax check was started.")
56 (make-variable-buffer-local 'flymake-check-start-time
)
58 (defvar flymake-check-was-interrupted nil
59 "Non-nil if syntax check was killed by `flymake-compile'.")
60 (make-variable-buffer-local 'flymake-check-was-interrupted
)
62 (defvar flymake-err-info nil
63 "Sorted list of line numbers and lists of err info in the form (file, err-text).")
64 (make-variable-buffer-local 'flymake-err-info
)
66 (defvar flymake-new-err-info nil
67 "Same as `flymake-err-info', effective when a syntax check is in progress.")
68 (make-variable-buffer-local 'flymake-new-err-info
)
70 ;;;; [[ cross-emacs compatibility routines
71 (defsubst flymake-makehash
(&optional test
)
72 (if (fboundp 'make-hash-table
)
73 (if test
(make-hash-table :test test
) (make-hash-table))
77 (defalias 'flymake-float-time
78 (if (fboundp 'float-time
)
80 (if (featurep 'xemacs
)
82 (multiple-value-bind (s0 s1 s2
) (values-list (current-time))
83 (+ (* (float (ash 1 16)) s0
) (float s1
) (* 0.0000001 s2
)))))))
85 (defalias 'flymake-replace-regexp-in-string
86 (if (eval-when-compile (fboundp 'replace-regexp-in-string
))
87 'replace-regexp-in-string
88 (lambda (regexp rep str
)
89 (replace-in-string str regexp rep
))))
91 (defalias 'flymake-split-string
92 (if (condition-case nil
(equal (split-string " bc " " " t
) '("bc"))
94 (lambda (str pattern
) (split-string str pattern t
))
96 "Split STR into a list of substrings bounded by PATTERN.
97 Zero-length substrings at the beginning and end of the list are omitted."
98 (let ((split (split-string str pattern
)))
99 (while (equal (car split
) "") (setq split
(cdr split
)))
100 (setq split
(nreverse split
))
101 (while (equal (car split
) "") (setq split
(cdr split
)))
104 (defalias 'flymake-get-temp-dir
105 (if (fboundp 'temp-directory
)
107 (lambda () temporary-file-directory
)))
109 (defalias 'flymake-line-beginning-position
110 (if (fboundp 'line-beginning-position
)
111 'line-beginning-position
112 (lambda (&optional arg
) (save-excursion (beginning-of-line arg
) (point)))))
114 (defalias 'flymake-line-end-position
115 (if (fboundp 'line-end-position
)
117 (lambda (&optional arg
) (save-excursion (end-of-line arg
) (point)))))
119 (defun flymake-posn-at-point-as-event (&optional position window dx dy
)
120 "Return pixel position of top left corner of glyph at POSITION,
121 relative to top left corner of WINDOW, as a mouse-1 click
122 event (identical to the event that would be triggered by clicking
123 mouse button 1 at the top left corner of the glyph).
125 POSITION and WINDOW default to the position of point in the
128 DX and DY specify optional offsets from the top left of the glyph."
129 (unless window
(setq window
(selected-window)))
130 (unless position
(setq position
(window-point window
)))
131 (unless dx
(setq dx
0))
132 (unless dy
(setq dy
0))
134 (let* ((pos (posn-at-point position window
))
136 (edges (window-inside-pixel-edges window
))
137 (win-x-y (window-pixel-edges window
)))
138 ;; adjust for window edges
139 (setcar (nthcdr 2 pos
)
140 (cons (+ (car x-y
) (car edges
) (- (car win-x-y
)) dx
)
141 (+ (cdr x-y
) (cadr edges
) (- (cadr win-x-y
)) dy
)))
142 (list 'mouse-1 pos
)))
144 (defun flymake-popup-menu (menu-data)
145 "Pop up the flymake menu at point, using the data MENU-DATA.
146 POS is a list of the form ((X Y) WINDOW), where X and Y are
147 pixels positions from the top left corner of WINDOW's frame.
148 MENU-DATA is a list of error and warning messages returned by
149 `flymake-make-err-menu-data'."
150 (if (featurep 'xemacs
)
151 (let* ((pos (flymake-get-point-pixel-pos))
154 (fake-event-props '(button 1 x
1 y
1)))
155 (setq fake-event-props
(plist-put fake-event-props
'x x-pos
))
156 (setq fake-event-props
(plist-put fake-event-props
'y y-pos
))
157 (popup-menu (flymake-make-xemacs-menu menu-data
)
158 (make-event 'button-press fake-event-props
)))
159 (x-popup-menu (if (eval-when-compile (fboundp 'posn-at-point
))
160 (flymake-posn-at-point-as-event)
161 (list (flymake-get-point-pixel-pos) (selected-window)))
162 (flymake-make-emacs-menu menu-data
))))
164 (defun flymake-make-emacs-menu (menu-data)
165 "Return a menu specifier using MENU-DATA.
166 MENU-DATA is a list of error and warning messages returned by
167 `flymake-make-err-menu-data'.
168 See `x-popup-menu' for the menu specifier format."
169 (let* ((menu-title (nth 0 menu-data
))
170 (menu-items (nth 1 menu-data
))
171 (menu-commands (mapcar (lambda (foo)
172 (cons (nth 0 foo
) (nth 1 foo
)))
174 (list menu-title
(cons "" menu-commands
))))
176 (if (featurep 'xemacs
) (progn
178 (defun flymake-nop ())
180 (defun flymake-make-xemacs-menu (menu-data)
181 "Return a menu specifier using MENU-DATA."
182 (let* ((menu-title (nth 0 menu-data
))
183 (menu-items (nth 1 menu-data
))
185 (setq menu-commands
(mapcar (lambda (foo)
186 (vector (nth 0 foo
) (or (nth 1 foo
) '(flymake-nop)) t
))
188 (cons menu-title menu-commands
)))
192 (unless (eval-when-compile (fboundp 'posn-at-point
))
194 (defun flymake-current-row ()
195 "Return current row number in current frame."
196 (if (fboundp 'window-edges
)
197 (+ (car (cdr (window-edges))) (count-lines (window-start) (point)))
198 (count-lines (window-start) (point))))
200 (defun flymake-selected-frame ()
201 (if (fboundp 'window-edges
)
205 (defun flymake-get-point-pixel-pos ()
206 "Return point position in pixels: (x, y)."
207 (let ((mouse-pos (mouse-position))
210 (if (car (cdr mouse-pos
))
212 (set-mouse-position (flymake-selected-frame) (current-column) (flymake-current-row))
213 (setq pixel-pos
(mouse-pixel-position))
214 (set-mouse-position (car mouse-pos
) (car (cdr mouse-pos
)) (cdr (cdr mouse-pos
)))
215 (setq ret
(list (car (cdr pixel-pos
)) (cdr (cdr pixel-pos
)))))
218 (flymake-log 3 "mouse pos is %s" ret
)
221 ) ;; End of (unless (fboundp 'posn-at-point)
225 (defcustom flymake-log-level -
1
226 "Logging level, only messages with level lower or equal will be logged.
227 -1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG"
231 (defun flymake-log (level text
&rest args
)
232 "Log a message at level LEVEL.
233 If LEVEL is higher than `flymake-log-level', the message is
234 ignored. Otherwise, it is printed using `message'.
235 TEXT is a format control string, and the remaining arguments ARGS
236 are the string substitutions (see `format')."
237 (if (<= level flymake-log-level
)
238 (let* ((msg (apply 'format text args
)))
243 ;; (flymake-save-buffer-in-file "d:/flymake.log" t) ; make log file name customizable
247 (defun flymake-ins-after (list pos val
)
248 "Insert VAL into LIST after position POS."
249 (let ((tmp (copy-sequence list
))) ; (???)
250 (setcdr (nthcdr pos tmp
) (cons val
(nthcdr (1+ pos
) tmp
)))
253 (defun flymake-set-at (list pos val
)
254 "Set VAL at position POS in LIST."
255 (let ((tmp (copy-sequence list
))) ; (???)
256 (setcar (nthcdr pos tmp
) val
)
259 (defvar flymake-processes nil
260 "List of currently active flymake processes.")
262 (defvar flymake-output-residual nil
)
264 (make-variable-buffer-local 'flymake-output-residual
)
266 (defgroup flymake nil
267 "A universal on-the-fly syntax checker."
271 (defcustom flymake-allowed-file-name-masks
272 '(("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'" flymake-simple-make-init
)
273 ("\\.xml\\'" flymake-xml-init
)
274 ("\\.html?\\'" flymake-xml-init
)
275 ("\\.cs\\'" flymake-simple-make-init
)
276 ("\\.p[ml]\\'" flymake-perl-init
)
277 ("\\.php[345]?\\'" flymake-php-init
)
278 ("\\.h\\'" flymake-master-make-header-init flymake-master-cleanup
)
279 ("\\.java\\'" flymake-simple-make-java-init flymake-simple-java-cleanup
)
280 ("[0-9]+\\.tex\\'" flymake-master-tex-init flymake-master-cleanup
)
281 ("\\.tex\\'" flymake-simple-tex-init
)
282 ("\\.idl\\'" flymake-simple-make-init
)
285 ;; ("\\.h\\'" 2 ("\\.cpp\\'" "\\.c\\'")
286 ;; ("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2))
289 ;; ("[0-9]+\\.tex\\'" 2 ("\\.tex\\'")
290 ;; ("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2 ))
293 "Files syntax checking is allowed for."
295 :type
'(repeat (string symbol symbol symbol
)))
297 (defun flymake-get-file-name-mode-and-masks (file-name)
298 "Return the corresponding entry from `flymake-allowed-file-name-masks'."
299 (unless (stringp file-name
)
300 (error "Invalid file-name"))
301 (let ((fnm flymake-allowed-file-name-masks
)
302 (mode-and-masks nil
))
303 (while (and (not mode-and-masks
) fnm
)
304 (if (string-match (car (car fnm
)) file-name
)
305 (setq mode-and-masks
(cdr (car fnm
))))
306 (setq fnm
(cdr fnm
)))
307 (flymake-log 3 "file %s, init=%s" file-name
(car mode-and-masks
))
310 (defun flymake-can-syntax-check-file (file-name)
311 "Determine whether we can syntax check FILE-NAME.
312 Return nil if we cannot, non-nil if we can."
313 (if (flymake-get-init-function file-name
) t nil
))
315 (defun flymake-get-init-function (file-name)
316 "Return init function to be used for the file."
317 (let* ((init-f (nth 0 (flymake-get-file-name-mode-and-masks file-name
))))
318 ;;(flymake-log 0 "calling %s" init-f)
319 ;;(funcall init-f (current-buffer))
322 (defun flymake-get-cleanup-function (file-name)
323 "Return cleanup function to be used for the file."
324 (or (nth 1 (flymake-get-file-name-mode-and-masks file-name
))
325 'flymake-simple-cleanup
))
327 (defun flymake-get-real-file-name-function (file-name)
328 (or (nth 2 (flymake-get-file-name-mode-and-masks file-name
))
329 'flymake-get-real-file-name
))
331 (defvar flymake-find-buildfile-cache
(flymake-makehash 'equal
))
333 (defun flymake-get-buildfile-from-cache (dir-name)
334 (gethash dir-name flymake-find-buildfile-cache
))
336 (defun flymake-add-buildfile-to-cache (dir-name buildfile
)
337 (puthash dir-name buildfile flymake-find-buildfile-cache
))
339 (defun flymake-clear-buildfile-cache ()
340 (clrhash flymake-find-buildfile-cache
))
342 (defun flymake-find-buildfile (buildfile-name source-dir-name
)
343 "Find buildfile starting from current directory.
344 Buildfile includes Makefile, build.xml etc.
345 Return its file name if found, or nil if not found."
346 (or (flymake-get-buildfile-from-cache source-dir-name
)
347 (let* ((file (locate-dominating-file source-dir-name buildfile-name
)))
350 (flymake-log 3 "found buildfile at %s" file
)
351 (flymake-add-buildfile-to-cache source-dir-name file
)
354 (flymake-log 3 "buildfile for %s not found" source-dir-name
)
357 (defun flymake-fix-file-name (name)
358 "Replace all occurrences of '\' with '/'."
360 (setq name
(expand-file-name name
))
361 (setq name
(abbreviate-file-name name
))
362 (setq name
(directory-file-name name
))
365 (defun flymake-same-files (file-name-one file-name-two
)
366 "Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
367 Return t if so, nil if not."
368 (equal (flymake-fix-file-name file-name-one
)
369 (flymake-fix-file-name file-name-two
)))
371 (defcustom flymake-master-file-dirs
'("." "./src" "./UnitTest")
372 "Dirs where to look for master files."
374 :type
'(repeat (string)))
376 (defcustom flymake-master-file-count-limit
32
377 "Max number of master files to check."
381 ;; This is bound dynamically to pass a parameter to a sort predicate below
382 (defvar flymake-included-file-name
)
384 (defun flymake-find-possible-master-files (file-name master-file-dirs masks
)
385 "Find (by name and location) all possible master files.
386 Master files include .cpp and .c for .h. Files are searched for
387 starting from the .h directory and max max-level parent dirs.
388 File contents are not checked."
389 (let* ((dirs master-file-dirs
)
393 (while (and (not done
) dirs
)
394 (let* ((dir (expand-file-name (car dirs
) (file-name-directory file-name
)))
396 (while (and (file-exists-p dir
) (not done
) masks
)
397 (let* ((mask (car masks
))
398 (dir-files (directory-files dir t mask
)))
400 (flymake-log 3 "dir %s, %d file(s) for mask %s"
401 dir
(length dir-files
) mask
)
402 (while (and (not done
) dir-files
)
403 (when (not (file-directory-p (car dir-files
)))
404 (setq files
(cons (car dir-files
) files
))
405 (when (>= (length files
) flymake-master-file-count-limit
)
406 (flymake-log 3 "master file count limit (%d) reached" flymake-master-file-count-limit
)
408 (setq dir-files
(cdr dir-files
))))
409 (setq masks
(cdr masks
))))
410 (setq dirs
(cdr dirs
)))
412 (let ((flymake-included-file-name (file-name-nondirectory file-name
)))
413 (setq files
(sort files
'flymake-master-file-compare
))))
414 (flymake-log 3 "found %d possible master file(s)" (length files
))
417 (defun flymake-master-file-compare (file-one file-two
)
418 "Compare two files specified by FILE-ONE and FILE-TWO.
419 This function is used in sort to move most possible file names
420 to the beginning of the list (File.h -> File.cpp moved to top)."
421 (and (equal (file-name-sans-extension flymake-included-file-name
)
422 (file-name-sans-extension (file-name-nondirectory file-one
)))
423 (not (equal file-one file-two
))))
425 (defcustom flymake-check-file-limit
8192
426 "Max number of chars to look at when checking possible master file."
430 (defun flymake-check-patch-master-file-buffer
431 (master-file-temp-buffer
432 master-file-name patched-master-file-name
433 source-file-name patched-source-file-name
435 "Check if MASTER-FILE-NAME is a master file for SOURCE-FILE-NAME.
436 If yes, patch a copy of MASTER-FILE-NAME to include PATCHED-SOURCE-FILE-NAME
437 instead of SOURCE-FILE-NAME.
439 For example, foo.cpp is a master file if it includes foo.h.
441 Whether a buffer for MATER-FILE-NAME exists, use it as a source
442 instead of reading master file from disk."
443 (let* ((source-file-nondir (file-name-nondirectory source-file-name
))
446 (search-limit flymake-check-file-limit
))
448 (format regexp
; "[ \t]*#[ \t]*include[ \t]*\"\\(.*%s\\)\""
449 (regexp-quote source-file-nondir
)))
451 (with-current-buffer master-file-temp-buffer
452 (when (> search-limit
(point-max))
453 (setq search-limit
(point-max)))
454 (flymake-log 3 "checking %s against regexp %s"
455 master-file-name regexp
)
456 (goto-char (point-min))
457 (while (and (< (point) search-limit
)
458 (re-search-forward regexp search-limit t
))
459 (let ((match-beg (match-beginning 1))
460 (match-end (match-end 1)))
462 (flymake-log 3 "found possible match for %s" source-file-nondir
)
463 (setq inc-name
(match-string 1))
464 (when (eq t
(compare-strings
465 source-file-nondir nil nil
466 inc-name
(- (length inc-name
)
467 (length source-file-nondir
)) nil
))
468 (flymake-log 3 "inc-name=%s" inc-name
)
469 (when (flymake-check-include source-file-name inc-name
472 ;; replace-match is not used here as it fails in
473 ;; XEmacs with 'last match not a buffer' error as
474 ;; check-includes calls replace-in-string
475 (flymake-replace-region
477 (file-name-nondirectory patched-source-file-name
))))
480 (flymake-save-buffer-in-file patched-master-file-name
)))
481 ;;+(flymake-log 3 "killing buffer %s"
482 ;; (buffer-name master-file-temp-buffer))
483 (kill-buffer master-file-temp-buffer
))
484 ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
486 (flymake-log 2 "found master file %s" master-file-name
))
489 (defun flymake-replace-region (beg end rep
)
490 "Replace text in BUFFER in region (BEG END) with REP."
493 ;; Insert before deleting, so as to better preserve markers's positions.
495 (delete-region beg end
)))
497 (defun flymake-read-file-to-temp-buffer (file-name)
498 "Insert contents of FILE-NAME into newly created temp buffer."
499 (let* ((temp-buffer (get-buffer-create (generate-new-buffer-name (concat "flymake:" (file-name-nondirectory file-name
))))))
500 (with-current-buffer temp-buffer
501 (insert-file-contents file-name
))
504 (defun flymake-copy-buffer-to-temp-buffer (buffer)
505 "Copy contents of BUFFER into newly created temp buffer."
507 (get-buffer-create (generate-new-buffer-name
508 (concat "flymake:" (buffer-name buffer
))))
509 (insert-buffer-substring buffer
)
512 (defun flymake-check-include (source-file-name inc-name include-dirs
)
513 "Check if SOURCE-FILE-NAME can be found in include path.
514 Return t if it can be found via include path using INC-NAME."
515 (if (file-name-absolute-p inc-name
)
516 (flymake-same-files source-file-name inc-name
)
517 (while (and include-dirs
518 (not (flymake-same-files
520 (concat (file-name-directory source-file-name
)
521 "/" (car include-dirs
)
523 (setq include-dirs
(cdr include-dirs
)))
526 (defun flymake-find-buffer-for-file (file-name)
527 "Check if there exists a buffer visiting FILE-NAME.
528 Return t if so, nil if not."
529 (let ((buffer-name (get-file-buffer file-name
)))
531 (get-buffer buffer-name
))))
533 (defun flymake-create-master-file (source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp
)
534 "Save SOURCE-FILE-NAME with a different name.
535 Find master file, patch and save it."
536 (let* ((possible-master-files (flymake-find-possible-master-files source-file-name flymake-master-file-dirs masks
))
537 (master-file-count (length possible-master-files
))
540 (master-file-name nil
)
541 (patched-master-file-name nil
)
544 (while (and (not found
) (< idx master-file-count
))
545 (setq master-file-name
(nth idx possible-master-files
))
546 (setq patched-master-file-name
(funcall create-temp-f master-file-name
"flymake_master"))
547 (if (flymake-find-buffer-for-file master-file-name
)
548 (setq temp-buffer
(flymake-copy-buffer-to-temp-buffer (flymake-find-buffer-for-file master-file-name
)))
549 (setq temp-buffer
(flymake-read-file-to-temp-buffer master-file-name
)))
551 (flymake-check-patch-master-file-buffer
554 patched-master-file-name
556 patched-source-file-name
557 (funcall get-incl-dirs-f
(file-name-directory master-file-name
))
561 (list master-file-name patched-master-file-name
)
563 (flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count
564 (file-name-nondirectory source-file-name
))
567 (defun flymake-save-buffer-in-file (file-name)
568 (make-directory (file-name-directory file-name
) 1)
569 (write-region nil nil file-name nil
566)
570 (flymake-log 3 "saved buffer %s in file %s" (buffer-name) file-name
))
572 (defun flymake-save-string-to-file (file-name data
)
573 "Save string DATA to file FILE-NAME."
574 (write-region data nil file-name nil
566))
576 (defun flymake-read-file-to-string (file-name)
577 "Read contents of file FILE-NAME and return as a string."
579 (insert-file-contents file-name
)
580 (buffer-substring (point-min) (point-max))))
582 (defun flymake-process-filter (process output
)
583 "Parse OUTPUT and highlight error lines.
584 It's flymake process filter."
585 (let ((source-buffer (process-buffer process
)))
587 (flymake-log 3 "received %d byte(s) of output from process %d"
588 (length output
) (process-id process
))
589 (when (buffer-live-p source-buffer
)
590 (with-current-buffer source-buffer
591 (flymake-parse-output-and-residual output
)))))
593 (defun flymake-process-sentinel (process event
)
594 "Sentinel for syntax check buffers."
595 (when (memq (process-status process
) '(signal exit
))
596 (let* ((exit-status (process-exit-status process
))
597 (command (process-command process
))
598 (source-buffer (process-buffer process
))
599 (cleanup-f (flymake-get-cleanup-function (buffer-file-name source-buffer
))))
601 (flymake-log 2 "process %d exited with code %d"
602 (process-id process
) exit-status
)
605 (flymake-log 3 "cleaning up using %s" cleanup-f
)
606 (when (buffer-live-p source-buffer
)
607 (with-current-buffer source-buffer
608 (funcall cleanup-f
)))
610 (delete-process process
)
611 (setq flymake-processes
(delq process flymake-processes
))
613 (when (buffer-live-p source-buffer
)
614 (with-current-buffer source-buffer
616 (flymake-parse-residual)
617 (flymake-post-syntax-check exit-status command
)
618 (setq flymake-is-running nil
))))
620 (let ((err-str (format "Error in process sentinel for buffer %s: %s"
621 source-buffer
(error-message-string err
))))
622 (flymake-log 0 err-str
)
623 (with-current-buffer source-buffer
624 (setq flymake-is-running nil
))))))))
626 (defun flymake-post-syntax-check (exit-status command
)
627 (setq flymake-err-info flymake-new-err-info
)
628 (setq flymake-new-err-info nil
)
629 (setq flymake-err-info
630 (flymake-fix-line-numbers
631 flymake-err-info
1 (flymake-count-lines)))
632 (flymake-delete-own-overlays)
633 (flymake-highlight-err-lines flymake-err-info
)
634 (let (err-count warn-count
)
635 (setq err-count
(flymake-get-err-count flymake-err-info
"e"))
636 (setq warn-count
(flymake-get-err-count flymake-err-info
"w"))
637 (flymake-log 2 "%s: %d error(s), %d warning(s) in %.2f second(s)"
638 (buffer-name) err-count warn-count
639 (- (flymake-float-time) flymake-check-start-time
))
640 (setq flymake-check-start-time nil
)
642 (if (and (equal 0 err-count
) (equal 0 warn-count
))
643 (if (equal 0 exit-status
)
644 (flymake-report-status "" "") ; PASSED
645 (if (not flymake-check-was-interrupted
)
646 (flymake-report-fatal-status "CFGERR"
647 (format "Configuration error has occurred while running %s" command
))
648 (flymake-report-status nil
""))) ; "STOPPED"
649 (flymake-report-status (format "%d/%d" err-count warn-count
) ""))))
651 (defun flymake-parse-output-and-residual (output)
652 "Split OUTPUT into lines, merge in residual if necessary."
653 (let* ((buffer-residual flymake-output-residual
)
654 (total-output (if buffer-residual
(concat buffer-residual output
) output
))
655 (lines-and-residual (flymake-split-output total-output
))
656 (lines (nth 0 lines-and-residual
))
657 (new-residual (nth 1 lines-and-residual
)))
658 (setq flymake-output-residual new-residual
)
659 (setq flymake-new-err-info
660 (flymake-parse-err-lines
661 flymake-new-err-info lines
))))
663 (defun flymake-parse-residual ()
664 "Parse residual if it's non empty."
665 (when flymake-output-residual
666 (setq flymake-new-err-info
667 (flymake-parse-err-lines
669 (list flymake-output-residual
)))
670 (setq flymake-output-residual nil
)))
672 (defun flymake-er-make-er (line-no line-err-info-list
)
673 (list line-no line-err-info-list
))
675 (defun flymake-er-get-line (err-info)
678 (defun flymake-er-get-line-err-info-list (err-info)
681 (defstruct (flymake-ler
683 (:constructor flymake-ler-make-ler
(file line type text
&optional full-file
)))
684 file line type text full-file
)
686 (defun flymake-ler-set-file (line-err-info file
)
687 (flymake-ler-make-ler file
688 (flymake-ler-line line-err-info
)
689 (flymake-ler-type line-err-info
)
690 (flymake-ler-text line-err-info
)
691 (flymake-ler-full-file line-err-info
)))
693 (defun flymake-ler-set-full-file (line-err-info full-file
)
694 (flymake-ler-make-ler (flymake-ler-file line-err-info
)
695 (flymake-ler-line line-err-info
)
696 (flymake-ler-type line-err-info
)
697 (flymake-ler-text line-err-info
)
700 (defun flymake-ler-set-line (line-err-info line
)
701 (flymake-ler-make-ler (flymake-ler-file line-err-info
)
703 (flymake-ler-type line-err-info
)
704 (flymake-ler-text line-err-info
)
705 (flymake-ler-full-file line-err-info
)))
707 (defun flymake-get-line-err-count (line-err-info-list type
)
708 "Return number of errors of specified TYPE.
709 Value of TYPE is either \"e\" or \"w\"."
711 (count (length line-err-info-list
))
715 (when (equal type
(flymake-ler-type (nth idx line-err-info-list
)))
716 (setq err-count
(1+ err-count
)))
720 (defun flymake-get-err-count (err-info-list type
)
721 "Return number of errors of specified TYPE for ERR-INFO-LIST."
723 (count (length err-info-list
))
726 (setq err-count
(+ err-count
(flymake-get-line-err-count (nth 1 (nth idx err-info-list
)) type
)))
730 (defun flymake-fix-line-numbers (err-info-list min-line max-line
)
731 "Replace line numbers with fixed value.
732 If line-numbers is less than MIN-LINE, set line numbers to MIN-LINE.
733 If line numbers is greater than MAX-LINE, set line numbers to MAX-LINE.
734 The reason for this fix is because some compilers might report
735 line number outside the file being compiled."
736 (let* ((count (length err-info-list
))
740 (setq err-info
(nth (1- count
) err-info-list
))
741 (setq line
(flymake-er-get-line err-info
))
742 (when (or (< line min-line
) (> line max-line
))
743 (setq line
(if (< line min-line
) min-line max-line
))
744 (setq err-info-list
(flymake-set-at err-info-list
(1- count
)
745 (flymake-er-make-er line
746 (flymake-er-get-line-err-info-list err-info
)))))
747 (setq count
(1- count
))))
750 (defun flymake-highlight-err-lines (err-info-list)
751 "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
753 (dolist (err err-info-list
)
754 (flymake-highlight-line (car err
) (nth 1 err
)))))
756 (defun flymake-overlay-p (ov)
757 "Determine whether overlay OV was created by flymake."
758 (and (overlayp ov
) (overlay-get ov
'flymake-overlay
)))
760 (defun flymake-make-overlay (beg end tooltip-text face mouse-face
)
761 "Allocate a flymake overlay in range BEG and END."
762 (when (not (flymake-region-has-flymake-overlays beg end
))
763 (let ((ov (make-overlay beg end nil t t
)))
764 (overlay-put ov
'face face
)
765 (overlay-put ov
'mouse-face mouse-face
)
766 (overlay-put ov
'help-echo tooltip-text
)
767 (overlay-put ov
'flymake-overlay t
)
768 (overlay-put ov
'priority
100)
769 ;;+(flymake-log 3 "created overlay %s" ov)
771 (flymake-log 3 "created an overlay at (%d-%d)" beg end
)))
773 (defun flymake-delete-own-overlays ()
774 "Delete all flymake overlays in BUFFER."
775 (dolist (ol (overlays-in (point-min) (point-max)))
776 (when (flymake-overlay-p ol
)
778 ;;+(flymake-log 3 "deleted overlay %s" ol)
781 (defun flymake-region-has-flymake-overlays (beg end
)
782 "Check if region specified by BEG and END has overlay.
783 Return t if it has at least one flymake overlay, nil if no overlay."
784 (let ((ov (overlays-in beg end
))
785 (has-flymake-overlays nil
))
787 (when (flymake-overlay-p (car ov
))
788 (setq has-flymake-overlays t
))
790 has-flymake-overlays
))
792 (defface flymake-errline
793 '((((class color
) (background dark
)) (:background
"Firebrick4"))
794 (((class color
) (background light
)) (:background
"LightPink"))
796 "Face used for marking error lines."
799 (defface flymake-warnline
800 '((((class color
) (background dark
)) (:background
"DarkBlue"))
801 (((class color
) (background light
)) (:background
"LightBlue2"))
803 "Face used for marking warning lines."
806 (defun flymake-highlight-line (line-no line-err-info-list
)
807 "Highlight line LINE-NO in current buffer.
808 Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting."
809 (goto-char (point-min))
810 (forward-line (1- line-no
))
811 (let* ((line-beg (flymake-line-beginning-position))
812 (line-end (flymake-line-end-position))
815 (tooltip-text (flymake-ler-text (nth 0 line-err-info-list
)))
819 (while (looking-at "[ \t]")
825 (while (and (looking-at "[ \t\r\n]") (> (point) 1))
828 (setq end
(1+ (point)))
839 (if (> (flymake-get-line-err-count line-err-info-list
"e") 0)
840 (setq face
'flymake-errline
)
841 (setq face
'flymake-warnline
))
843 (flymake-make-overlay beg end tooltip-text face nil
)))
845 (defun flymake-parse-err-lines (err-info-list lines
)
846 "Parse err LINES, store info in ERR-INFO-LIST."
847 (let* ((count (length lines
))
851 (source-file-name buffer-file-name
)
852 (get-real-file-name-f (flymake-get-real-file-name-function source-file-name
)))
855 (setq line-err-info
(flymake-parse-line (nth idx lines
)))
857 (setq real-file-name
(funcall get-real-file-name-f
858 (flymake-ler-file line-err-info
)))
859 (setq line-err-info
(flymake-ler-set-full-file line-err-info real-file-name
))
861 (when (flymake-same-files real-file-name source-file-name
)
862 (setq line-err-info
(flymake-ler-set-file line-err-info nil
))
863 (setq err-info-list
(flymake-add-err-info err-info-list line-err-info
))))
864 (flymake-log 3 "parsed '%s', %s line-err-info" (nth idx lines
) (if line-err-info
"got" "no"))
868 (defun flymake-split-output (output)
869 "Split OUTPUT into lines.
870 Return last one as residual if it does not end with newline char.
871 Returns ((LINES) RESIDUAL)."
872 (when (and output
(> (length output
) 0))
873 (let* ((lines (flymake-split-string output
"[\n\r]+"))
874 (complete (equal "\n" (char-to-string (aref output
(1- (length output
))))))
877 (setq residual
(car (last lines
)))
878 (setq lines
(butlast lines
)))
879 (list lines residual
))))
881 (defun flymake-reformat-err-line-patterns-from-compile-el (original-list)
882 "Grab error line patterns from ORIGINAL-LIST in compile.el format.
883 Convert it to flymake internal format."
884 (let* ((converted-list '()))
885 (dolist (item original-list
)
886 (setq item
(cdr item
))
887 (let ((regexp (nth 0 item
))
891 (if (consp file
) (setq file
(car file
)))
892 (if (consp line
) (setq line
(car line
)))
893 (if (consp col
) (setq col
(car col
)))
895 (when (not (functionp line
))
896 (setq converted-list
(cons (list regexp file line col
) converted-list
)))))
901 (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
905 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
908 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\|Semantic Error\\):[ \t\n]*\\(.+\\)\\)"
911 ("midl[ ]*:[ ]*\\(command line error .*\\)"
914 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\),[0-9]+)\: \\(\\(error\\|warning\\|fatal error\\) \\(CS[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
917 ("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 2 3 nil
1)
919 ("\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)" 2 3 nil
1)
920 ;; LaTeX warnings (fileless) ("\\(LaTeX \\(Warning\\|Error\\): .*\\) on input line \\([0-9]+\\)" 20 3 nil 1)
922 (" *\\(\\[javac\\] *\\)?\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[ \t\n]*\\(.+\\)"
924 ;; compilation-error-regexp-alist)
925 (flymake-reformat-err-line-patterns-from-compile-el compilation-error-regexp-alist-alist
))
926 "Patterns for matching error/warning lines. Each pattern has the form
927 \(REGEXP FILE-IDX LINE-IDX COL-IDX ERR-TEXT-IDX).
928 Use `flymake-reformat-err-line-patterns-from-compile-el' to add patterns
931 ;;(defcustom flymake-err-line-patterns
933 ;; ; MS Visual C++ 6.0
934 ;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)"
937 ;; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\):[ \t\n]*\\(.+\\)\\)"
939 ;; "patterns for matching error/warning lines, (regexp file-idx line-idx err-text-idx)"
941 ;; :type '(repeat (string number number number))
944 (defun flymake-parse-line (line)
945 "Parse LINE to see if it is an error or warning.
946 Return its components if so, nil otherwise."
947 (let ((raw-file-name nil
)
951 (patterns flymake-err-line-patterns
)
953 (while (and patterns
(not matched
))
954 (when (string-match (car (car patterns
)) line
)
955 (let* ((file-idx (nth 1 (car patterns
)))
956 (line-idx (nth 2 (car patterns
))))
958 (setq raw-file-name
(if file-idx
(match-string file-idx line
) nil
))
959 (setq line-no
(if line-idx
(string-to-number (match-string line-idx line
)) 0))
960 (setq err-text
(if (> (length (car patterns
)) 4)
961 (match-string (nth 4 (car patterns
)) line
)
962 (flymake-patch-err-text (substring line
(match-end 0)))))
963 (or err-text
(setq err-text
"<no error text>"))
964 (if (and err-text
(string-match "^[wW]arning" err-text
))
967 (flymake-log 3 "parse line: file-idx=%s line-idx=%s file=%s line=%s text=%s" file-idx line-idx
968 raw-file-name line-no err-text
)
970 (setq patterns
(cdr patterns
)))
972 (flymake-ler-make-ler raw-file-name line-no err-type err-text
)
975 (defun flymake-find-err-info (err-info-list line-no
)
976 "Find (line-err-info-list pos) for specified LINE-NO."
978 (let* ((line-err-info-list nil
)
980 (count (length err-info-list
)))
982 (while (and (< pos count
) (< (car (nth pos err-info-list
)) line-no
))
984 (when (and (< pos count
) (equal (car (nth pos err-info-list
)) line-no
))
985 (setq line-err-info-list
(flymake-er-get-line-err-info-list (nth pos err-info-list
))))
986 (list line-err-info-list pos
))
989 (defun flymake-line-err-info-is-less-or-equal (line-one line-two
)
990 (or (string< (flymake-ler-type line-one
) (flymake-ler-type line-two
))
991 (and (string= (flymake-ler-type line-one
) (flymake-ler-type line-two
))
992 (not (flymake-ler-file line-one
)) (flymake-ler-file line-two
))
993 (and (string= (flymake-ler-type line-one
) (flymake-ler-type line-two
))
994 (or (and (flymake-ler-file line-one
) (flymake-ler-file line-two
))
995 (and (not (flymake-ler-file line-one
)) (not (flymake-ler-file line-two
)))))))
997 (defun flymake-add-line-err-info (line-err-info-list line-err-info
)
998 "Update LINE-ERR-INFO-LIST with the error LINE-ERR-INFO.
999 For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'.
1000 The new element is inserted in the proper position, according to
1001 the predicate `flymake-line-err-info-is-less-or-equal'.
1002 The updated value of LINE-ERR-INFO-LIST is returned."
1003 (if (not line-err-info-list
)
1004 (list line-err-info
)
1005 (let* ((count (length line-err-info-list
))
1007 (while (and (< idx count
) (flymake-line-err-info-is-less-or-equal (nth idx line-err-info-list
) line-err-info
))
1008 (setq idx
(1+ idx
)))
1009 (cond ((equal 0 idx
) (setq line-err-info-list
(cons line-err-info line-err-info-list
)))
1010 (t (setq line-err-info-list
(flymake-ins-after line-err-info-list
(1- idx
) line-err-info
))))
1011 line-err-info-list
)))
1013 (defun flymake-add-err-info (err-info-list line-err-info
)
1014 "Update ERR-INFO-LIST with the error LINE-ERR-INFO, preserving sort order.
1015 Returns the updated value of ERR-INFO-LIST.
1016 For the format of ERR-INFO-LIST, see `flymake-err-info'.
1017 For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'."
1018 (let* ((line-no (if (flymake-ler-file line-err-info
) 1 (flymake-ler-line line-err-info
)))
1019 (info-and-pos (flymake-find-err-info err-info-list line-no
))
1020 (exists (car info-and-pos
))
1021 (pos (nth 1 info-and-pos
))
1022 (line-err-info-list nil
)
1026 (setq line-err-info-list
(flymake-er-get-line-err-info-list (car (nthcdr pos err-info-list
)))))
1027 (setq line-err-info-list
(flymake-add-line-err-info line-err-info-list line-err-info
))
1029 (setq err-info
(flymake-er-make-er line-no line-err-info-list
))
1030 (cond (exists (setq err-info-list
(flymake-set-at err-info-list pos err-info
)))
1031 ((equal 0 pos
) (setq err-info-list
(cons err-info err-info-list
)))
1032 (t (setq err-info-list
(flymake-ins-after err-info-list
(1- pos
) err-info
))))
1035 (defun flymake-get-project-include-dirs-imp (basedir)
1036 "Include dirs for the project current file belongs to."
1037 (if (flymake-get-project-include-dirs-from-cache basedir
)
1039 (flymake-get-project-include-dirs-from-cache basedir
))
1041 (let* ((command-line (concat "make -C "
1042 (shell-quote-argument basedir
)
1043 " DUMPVARS=INCLUDE_DIRS dumpvars"))
1044 (output (shell-command-to-string command-line
))
1045 (lines (flymake-split-string output
"\n"))
1046 (count (length lines
))
1049 (while (and (< idx count
) (not (string-match "^INCLUDE_DIRS=.*" (nth idx lines
))))
1050 (setq idx
(1+ idx
)))
1052 (let* ((inc-lines (flymake-split-string (nth idx lines
) " *-I"))
1053 (inc-count (length inc-lines
)))
1054 (while (> inc-count
0)
1055 (when (not (string-match "^INCLUDE_DIRS=.*" (nth (1- inc-count
) inc-lines
)))
1056 (push (flymake-replace-regexp-in-string "\"" "" (nth (1- inc-count
) inc-lines
)) inc-dirs
))
1057 (setq inc-count
(1- inc-count
)))))
1058 (flymake-add-project-include-dirs-to-cache basedir inc-dirs
)
1061 (defcustom flymake-get-project-include-dirs-function
'flymake-get-project-include-dirs-imp
1062 "Function used to get project include dirs, one parameter: basedir name."
1066 (defun flymake-get-project-include-dirs (basedir)
1067 (funcall flymake-get-project-include-dirs-function basedir
))
1069 (defun flymake-get-system-include-dirs ()
1070 "System include dirs - from the 'INCLUDE' env setting."
1071 (let* ((includes (getenv "INCLUDE")))
1072 (if includes
(flymake-split-string includes path-separator
) nil
)))
1074 (defvar flymake-project-include-dirs-cache
(flymake-makehash 'equal
))
1076 (defun flymake-get-project-include-dirs-from-cache (base-dir)
1077 (gethash base-dir flymake-project-include-dirs-cache
))
1079 (defun flymake-add-project-include-dirs-to-cache (base-dir include-dirs
)
1080 (puthash base-dir include-dirs flymake-project-include-dirs-cache
))
1082 (defun flymake-clear-project-include-dirs-cache ()
1083 (clrhash flymake-project-include-dirs-cache
))
1085 (defun flymake-get-include-dirs (base-dir)
1086 "Get dirs to use when resolving local file names."
1087 (let* ((include-dirs (append '(".") (flymake-get-project-include-dirs base-dir
) (flymake-get-system-include-dirs))))
1090 ;; (defun flymake-restore-formatting ()
1091 ;; "Remove any formatting made by flymake."
1094 ;; (defun flymake-get-program-dir (buffer)
1095 ;; "Get dir to start program in."
1096 ;; (unless (bufferp buffer)
1097 ;; (error "Invalid buffer"))
1098 ;; (with-current-buffer buffer
1099 ;; default-directory))
1101 (defun flymake-safe-delete-file (file-name)
1102 (when (and file-name
(file-exists-p file-name
))
1103 (delete-file file-name
)
1104 (flymake-log 1 "deleted file %s" file-name
)))
1106 (defun flymake-safe-delete-directory (dir-name)
1109 (delete-directory dir-name
)
1110 (flymake-log 1 "deleted dir %s" dir-name
))
1112 (flymake-log 1 "Failed to delete dir %s, error ignored" dir-name
))))
1114 (defcustom flymake-compilation-prevents-syntax-check t
1115 "If non-nil, syntax check won't be started in case compilation is running."
1119 (defun flymake-start-syntax-check ()
1120 "Start syntax checking for current buffer."
1122 (flymake-log 3 "flymake is running: %s" flymake-is-running
)
1123 (when (and (not flymake-is-running
)
1124 (flymake-can-syntax-check-file buffer-file-name
))
1125 (when (or (not flymake-compilation-prevents-syntax-check
)
1126 (not (flymake-compilation-is-running))) ;+ (flymake-rep-ort-status buffer "COMP")
1127 (flymake-clear-buildfile-cache)
1128 (flymake-clear-project-include-dirs-cache)
1130 (setq flymake-check-was-interrupted nil
)
1132 (let* ((source-file-name buffer-file-name
)
1133 (init-f (flymake-get-init-function source-file-name
))
1134 (cleanup-f (flymake-get-cleanup-function source-file-name
))
1135 (cmd-and-args (funcall init-f
))
1136 (cmd (nth 0 cmd-and-args
))
1137 (args (nth 1 cmd-and-args
))
1138 (dir (nth 2 cmd-and-args
)))
1139 (if (not cmd-and-args
)
1141 (flymake-log 0 "init function %s for %s failed, cleaning up" init-f source-file-name
)
1142 (funcall cleanup-f
))
1144 (setq flymake-last-change-time nil
)
1145 (flymake-start-syntax-check-process cmd args dir
)))))))
1147 (defun flymake-start-syntax-check-process (cmd args dir
)
1148 "Start syntax check process."
1149 (let* ((process nil
))
1153 (let ((default-directory dir
))
1154 (flymake-log 3 "starting process on dir %s" default-directory
)))
1155 (setq process
(apply 'start-process
"flymake-proc" (current-buffer) cmd args
))
1156 (set-process-sentinel process
'flymake-process-sentinel
)
1157 (set-process-filter process
'flymake-process-filter
)
1158 (push process flymake-processes
)
1160 (setq flymake-is-running t
)
1161 (setq flymake-last-change-time nil
)
1162 (setq flymake-check-start-time
(flymake-float-time))
1164 (flymake-report-status nil
"*")
1165 (flymake-log 2 "started process %d, command=%s, dir=%s"
1166 (process-id process
) (process-command process
)
1170 (let* ((err-str (format "Failed to launch syntax check process '%s' with args %s: %s"
1171 cmd args
(error-message-string err
)))
1172 (source-file-name buffer-file-name
)
1173 (cleanup-f (flymake-get-cleanup-function source-file-name
)))
1174 (flymake-log 0 err-str
)
1176 (flymake-report-fatal-status "PROCERR" err-str
))))))
1178 (defun flymake-kill-process (proc)
1179 "Kill process PROC."
1181 (let* ((buf (process-buffer proc
)))
1182 (when (buffer-live-p buf
)
1183 (with-current-buffer buf
1184 (setq flymake-check-was-interrupted t
))))
1185 (flymake-log 1 "killed process %d" (process-id proc
)))
1187 (defun flymake-stop-all-syntax-checks ()
1188 "Kill all syntax check processes."
1190 (while flymake-processes
1191 (flymake-kill-process (pop flymake-processes
))))
1193 (defun flymake-compilation-is-running ()
1194 (and (boundp 'compilation-in-progress
)
1195 compilation-in-progress
))
1197 (defun flymake-compile ()
1198 "Kill all flymake syntax checks, start compilation."
1200 (flymake-stop-all-syntax-checks)
1201 (call-interactively 'compile
))
1203 (defcustom flymake-no-changes-timeout
0.5
1204 "Time to wait after last change before starting compilation."
1208 (defun flymake-on-timer-event (buffer)
1209 "Start a syntax check for buffer BUFFER if necessary."
1210 (when (buffer-live-p buffer
)
1211 (with-current-buffer buffer
1212 (when (and (not flymake-is-running
)
1213 flymake-last-change-time
1214 (> (- (flymake-float-time) flymake-last-change-time
)
1215 flymake-no-changes-timeout
))
1217 (setq flymake-last-change-time nil
)
1218 (flymake-log 3 "starting syntax check as more than 1 second passed since last change")
1219 (flymake-start-syntax-check)))))
1221 (defun flymake-current-line-no ()
1222 "Return number of current line in current buffer."
1223 (count-lines (point-min) (if (eobp) (point) (1+ (point)))))
1225 (defun flymake-count-lines ()
1226 "Return number of lines in buffer BUFFER."
1227 (count-lines (point-min) (point-max)))
1229 (defun flymake-display-err-menu-for-current-line ()
1230 "Display a menu with errors/warnings for current line if it has errors and/or warnings."
1232 (let* ((line-no (flymake-current-line-no))
1233 (line-err-info-list (nth 0 (flymake-find-err-info flymake-err-info line-no
)))
1234 (menu-data (flymake-make-err-menu-data line-no line-err-info-list
))
1238 (setq choice
(flymake-popup-menu menu-data
))
1239 (flymake-log 3 "choice=%s" choice
)
1242 (flymake-log 1 "no errors for line %d" line-no
))))
1244 (defun flymake-make-err-menu-data (line-no line-err-info-list
)
1245 "Make a (menu-title (item-title item-action)*) list with errors/warnings from LINE-ERR-INFO-LIST."
1246 (let* ((menu-items nil
))
1247 (when line-err-info-list
1248 (let* ((count (length line-err-info-list
))
1249 (menu-item-text nil
))
1251 (setq menu-item-text
(flymake-ler-text (nth (1- count
) line-err-info-list
)))
1252 (let* ((file (flymake-ler-file (nth (1- count
) line-err-info-list
)))
1253 (full-file (flymake-ler-full-file (nth (1- count
) line-err-info-list
)))
1254 (line (flymake-ler-line (nth (1- count
) line-err-info-list
))))
1256 (setq menu-item-text
(concat menu-item-text
" - " file
"(" (format "%d" line
) ")")))
1257 (setq menu-items
(cons (list menu-item-text
1258 (if file
(list 'flymake-goto-file-and-line full-file line
) nil
))
1260 (setq count
(1- count
)))
1261 (flymake-log 3 "created menu-items with %d item(s)" (length menu-items
))))
1263 (let* ((menu-title (format "Line %d: %d error(s), %d warning(s)" line-no
1264 (flymake-get-line-err-count line-err-info-list
"e")
1265 (flymake-get-line-err-count line-err-info-list
"w"))))
1266 (list menu-title menu-items
))
1269 (defun flymake-goto-file-and-line (file line
)
1270 "Try to get buffer for FILE and goto line LINE in it."
1271 (if (not (file-exists-p file
))
1272 (flymake-log 1 "File %s does not exist" file
)
1274 (goto-char (point-min))
1275 (forward-line (1- line
))))
1277 ;; flymake minor mode declarations
1278 (defvar flymake-mode-line nil
)
1280 (make-variable-buffer-local 'flymake-mode-line
)
1282 (defvar flymake-mode-line-e-w nil
)
1284 (make-variable-buffer-local 'flymake-mode-line-e-w
)
1286 (defvar flymake-mode-line-status nil
)
1288 (make-variable-buffer-local 'flymake-mode-line-status
)
1290 (defun flymake-report-status (e-w &optional status
)
1291 "Show status in mode line."
1293 (setq flymake-mode-line-e-w e-w
))
1295 (setq flymake-mode-line-status status
))
1296 (let* ((mode-line " Flymake"))
1297 (when (> (length flymake-mode-line-e-w
) 0)
1298 (setq mode-line
(concat mode-line
":" flymake-mode-line-e-w
)))
1299 (setq mode-line
(concat mode-line flymake-mode-line-status
))
1300 (setq flymake-mode-line mode-line
)
1301 (force-mode-line-update)))
1303 (defun flymake-display-warning (warning)
1304 "Display a warning to user."
1305 (message-box warning
))
1307 (defcustom flymake-gui-warnings-enabled t
1308 "Enables/disables GUI warnings."
1312 (defun flymake-report-fatal-status (status warning
)
1313 "Display a warning and switch flymake mode off."
1314 (when flymake-gui-warnings-enabled
1315 (flymake-display-warning (format "Flymake: %s. Flymake will be switched OFF" warning
))
1318 (flymake-log 0 "switched OFF Flymake mode for buffer %s due to fatal status %s, warning %s"
1319 (buffer-name) status warning
))
1321 (defcustom flymake-start-syntax-check-on-find-file t
1322 "Start syntax check on find file."
1327 (define-minor-mode flymake-mode
1328 "Minor mode to do on-the-fly syntax checking.
1329 When called interactively, toggles the minor mode.
1330 With arg, turn Flymake mode on if and only if arg is positive."
1331 :group
'flymake
:lighter flymake-mode-line
1334 ;; Turning the mode ON.
1336 (if (not (flymake-can-syntax-check-file buffer-file-name
))
1337 (flymake-log 2 "flymake cannot check syntax in buffer %s" (buffer-name))
1338 (add-hook 'after-change-functions
'flymake-after-change-function nil t
)
1339 (add-hook 'after-save-hook
'flymake-after-save-hook nil t
)
1340 (add-hook 'kill-buffer-hook
'flymake-kill-buffer-hook nil t
)
1341 ;;+(add-hook 'find-file-hook 'flymake-find-file-hook)
1343 (flymake-report-status "" "")
1346 (run-at-time nil
1 'flymake-on-timer-event
(current-buffer)))
1348 (when flymake-start-syntax-check-on-find-file
1349 (flymake-start-syntax-check))))
1351 ;; Turning the mode OFF.
1353 (remove-hook 'after-change-functions
'flymake-after-change-function t
)
1354 (remove-hook 'after-save-hook
'flymake-after-save-hook t
)
1355 (remove-hook 'kill-buffer-hook
'flymake-kill-buffer-hook t
)
1356 ;;+(remove-hook 'find-file-hook (function flymake-find-file-hook) t)
1358 (flymake-delete-own-overlays)
1361 (cancel-timer flymake-timer
)
1362 (setq flymake-timer nil
))
1364 (setq flymake-is-running nil
))))
1367 (defun flymake-mode-on ()
1368 "Turn flymake mode on."
1370 (flymake-log 1 "flymake mode turned ON for buffer %s" (buffer-name)))
1373 (defun flymake-mode-off ()
1374 "Turn flymake mode off."
1376 (flymake-log 1 "flymake mode turned OFF for buffer %s" (buffer-name)))
1378 (defcustom flymake-start-syntax-check-on-newline t
1379 "Start syntax check if newline char was added/removed from the buffer."
1383 (defun flymake-after-change-function (start stop len
)
1384 "Start syntax check for current buffer if it isn't already running."
1385 ;;+(flymake-log 0 "setting change time to %s" (flymake-float-time))
1386 (let((new-text (buffer-substring start stop
)))
1387 (when (and flymake-start-syntax-check-on-newline
(equal new-text
"\n"))
1388 (flymake-log 3 "starting syntax check as new-line has been seen")
1389 (flymake-start-syntax-check))
1390 (setq flymake-last-change-time
(flymake-float-time))))
1392 (defun flymake-after-save-hook ()
1393 (if (local-variable-p 'flymake-mode
(current-buffer)) ; (???) other way to determine whether flymake is active in buffer being saved?
1395 (flymake-log 3 "starting syntax check as buffer was saved")
1396 (flymake-start-syntax-check)))) ; no more mode 3. cannot start check if mode 3 (to temp copies) is active - (???)
1398 (defun flymake-kill-buffer-hook ()
1400 (cancel-timer flymake-timer
)
1401 (setq flymake-timer nil
)))
1403 (defun flymake-find-file-hook ()
1404 ;;+(when flymake-start-syntax-check-on-find-file
1405 ;;+ (flymake-log 3 "starting syntax check on file open")
1406 ;;+ (flymake-start-syntax-check)
1408 (when (and (not (local-variable-p 'flymake-mode
(current-buffer)))
1409 (flymake-can-syntax-check-file buffer-file-name
))
1411 (flymake-log 3 "automatically turned ON flymake mode")))
1413 (defun flymake-get-first-err-line-no (err-info-list)
1414 "Return first line with error."
1416 (flymake-er-get-line (car err-info-list
))))
1418 (defun flymake-get-last-err-line-no (err-info-list)
1419 "Return last line with error."
1421 (flymake-er-get-line (nth (1- (length err-info-list
)) err-info-list
))))
1423 (defun flymake-get-next-err-line-no (err-info-list line-no
)
1424 "Return next line with error."
1426 (let* ((count (length err-info-list
))
1428 (while (and (< idx count
) (>= line-no
(flymake-er-get-line (nth idx err-info-list
))))
1429 (setq idx
(1+ idx
)))
1431 (flymake-er-get-line (nth idx err-info-list
))))))
1433 (defun flymake-get-prev-err-line-no (err-info-list line-no
)
1434 "Return previous line with error."
1436 (let* ((count (length err-info-list
)))
1437 (while (and (> count
0) (<= line-no
(flymake-er-get-line (nth (1- count
) err-info-list
))))
1438 (setq count
(1- count
)))
1440 (flymake-er-get-line (nth (1- count
) err-info-list
))))))
1442 (defun flymake-skip-whitespace ()
1443 "Move forward until non-whitespace is reached."
1444 (while (looking-at "[ \t]")
1447 (defun flymake-goto-line (line-no)
1448 "Go to line LINE-NO, then skip whitespace."
1449 (goto-char (point-min))
1450 (forward-line (1- line-no
))
1451 (flymake-skip-whitespace))
1453 (defun flymake-goto-next-error ()
1454 "Go to next error in err ring."
1456 (let ((line-no (flymake-get-next-err-line-no flymake-err-info
(flymake-current-line-no))))
1458 (setq line-no
(flymake-get-first-err-line-no flymake-err-info
))
1459 (flymake-log 1 "passed end of file"))
1461 (flymake-goto-line line-no
)
1462 (flymake-log 1 "no errors in current buffer"))))
1464 (defun flymake-goto-prev-error ()
1465 "Go to previous error in err ring."
1467 (let ((line-no (flymake-get-prev-err-line-no flymake-err-info
(flymake-current-line-no))))
1469 (setq line-no
(flymake-get-last-err-line-no flymake-err-info
))
1470 (flymake-log 1 "passed beginning of file"))
1472 (flymake-goto-line line-no
)
1473 (flymake-log 1 "no errors in current buffer"))))
1475 (defun flymake-patch-err-text (string)
1476 (if (string-match "^[\n\t :0-9]*\\(.*\\)$" string
)
1477 (match-string 1 string
)
1480 ;;;; general init-cleanup and helper routines
1481 (defun flymake-create-temp-inplace (file-name prefix
)
1482 (unless (stringp file-name
)
1483 (error "Invalid file-name"))
1485 (setq prefix
"flymake"))
1486 (let* ((temp-name (concat (file-name-sans-extension file-name
)
1488 (and (file-name-extension file-name
)
1489 (concat "." (file-name-extension file-name
))))))
1490 (flymake-log 3 "create-temp-inplace: file=%s temp=%s" file-name temp-name
)
1493 (defun flymake-create-temp-with-folder-structure (file-name prefix
)
1494 (unless (stringp file-name
)
1495 (error "Invalid file-name"))
1497 (let* ((dir (file-name-directory file-name
))
1498 ;; Not sure what this slash-pos is all about, but I guess it's just
1499 ;; trying to remove the leading / of absolute file names.
1500 (slash-pos (string-match "/" dir
))
1501 (temp-dir (expand-file-name (substring dir
(1+ slash-pos
))
1502 (flymake-get-temp-dir))))
1504 (file-truename (expand-file-name (file-name-nondirectory file-name
)
1507 (defun flymake-delete-temp-directory (dir-name)
1508 "Attempt to delete temp dir created by `flymake-create-temp-with-folder-structure', do not fail on error."
1509 (let* ((temp-dir (flymake-get-temp-dir))
1510 (suffix (substring dir-name
(1+ (length temp-dir
)))))
1512 (while (> (length suffix
) 0)
1513 (setq suffix
(directory-file-name suffix
))
1514 ;;+(flymake-log 0 "suffix=%s" suffix)
1515 (flymake-safe-delete-directory
1516 (file-truename (expand-file-name suffix temp-dir
)))
1517 (setq suffix
(file-name-directory suffix
)))))
1519 (defvar flymake-temp-source-file-name nil
)
1520 (make-variable-buffer-local 'flymake-temp-source-file-name
)
1522 (defvar flymake-master-file-name nil
)
1523 (make-variable-buffer-local 'flymake-master-file-name
)
1525 (defvar flymake-temp-master-file-name nil
)
1526 (make-variable-buffer-local 'flymake-temp-master-file-name
)
1528 (defvar flymake-base-dir nil
)
1529 (make-variable-buffer-local 'flymake-base-dir
)
1531 (defun flymake-init-create-temp-buffer-copy (create-temp-f)
1532 "Make a temporary copy of the current buffer, save its name in buffer data and return the name."
1533 (let* ((source-file-name buffer-file-name
)
1534 (temp-source-file-name (funcall create-temp-f source-file-name
"flymake")))
1536 (flymake-save-buffer-in-file temp-source-file-name
)
1537 (setq flymake-temp-source-file-name temp-source-file-name
)
1538 temp-source-file-name
))
1540 (defun flymake-simple-cleanup ()
1541 "Do cleanup after `flymake-init-create-temp-buffer-copy'.
1543 (flymake-safe-delete-file flymake-temp-source-file-name
)
1544 (setq flymake-last-change-time nil
))
1546 (defun flymake-get-real-file-name (file-name-from-err-msg)
1547 "Translate file name from error message to \"real\" file name.
1548 Return full-name. Names are real, not patched."
1549 (let* ((real-name nil
)
1550 (source-file-name buffer-file-name
)
1551 (master-file-name flymake-master-file-name
)
1552 (temp-source-file-name flymake-temp-source-file-name
)
1553 (temp-master-file-name flymake-temp-master-file-name
)
1555 (list flymake-base-dir
1556 (file-name-directory source-file-name
)
1557 (if master-file-name
(file-name-directory master-file-name
))))
1558 (files (list (list source-file-name source-file-name
)
1559 (list temp-source-file-name source-file-name
)
1560 (list master-file-name master-file-name
)
1561 (list temp-master-file-name master-file-name
))))
1563 (when (equal 0 (length file-name-from-err-msg
))
1564 (setq file-name-from-err-msg source-file-name
))
1566 (setq real-name
(flymake-get-full-patched-file-name file-name-from-err-msg base-dirs files
))
1567 ;; if real-name is nil, than file name from err msg is none of the files we've patched
1569 (setq real-name
(flymake-get-full-nonpatched-file-name file-name-from-err-msg base-dirs
)))
1571 (setq real-name file-name-from-err-msg
))
1572 (setq real-name
(flymake-fix-file-name real-name
))
1573 (flymake-log 3 "get-real-file-name: file-name=%s real-name=%s" file-name-from-err-msg real-name
)
1576 (defun flymake-get-full-patched-file-name (file-name-from-err-msg base-dirs files
)
1577 (let* ((base-dirs-count (length base-dirs
))
1578 (file-count (length files
))
1581 (while (and (not real-name
) (> base-dirs-count
0))
1582 (setq file-count
(length files
))
1583 (while (and (not real-name
) (> file-count
0))
1584 (let* ((this-dir (nth (1- base-dirs-count
) base-dirs
))
1585 (this-file (nth 0 (nth (1- file-count
) files
)))
1586 (this-real-name (nth 1 (nth (1- file-count
) files
))))
1587 ;;+(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)
1588 (when (and this-dir this-file
(flymake-same-files
1589 (expand-file-name file-name-from-err-msg this-dir
)
1591 (setq real-name this-real-name
)))
1592 (setq file-count
(1- file-count
)))
1593 (setq base-dirs-count
(1- base-dirs-count
)))
1596 (defun flymake-get-full-nonpatched-file-name (file-name-from-err-msg base-dirs
)
1597 (let* ((real-name nil
))
1598 (if (file-name-absolute-p file-name-from-err-msg
)
1599 (setq real-name file-name-from-err-msg
)
1600 (let* ((base-dirs-count (length base-dirs
)))
1601 (while (and (not real-name
) (> base-dirs-count
0))
1602 (let* ((full-name (expand-file-name file-name-from-err-msg
1603 (nth (1- base-dirs-count
) base-dirs
))))
1604 (if (file-exists-p full-name
)
1605 (setq real-name full-name
))
1606 (setq base-dirs-count
(1- base-dirs-count
))))))
1609 (defun flymake-init-find-buildfile-dir (source-file-name buildfile-name
)
1610 "Find buildfile, store its dir in buffer data and return its dir, if found."
1611 (let* ((buildfile-dir
1612 (flymake-find-buildfile buildfile-name
1613 (file-name-directory source-file-name
))))
1615 (setq flymake-base-dir buildfile-dir
)
1616 (flymake-log 1 "no buildfile (%s) for %s" buildfile-name source-file-name
)
1617 (flymake-report-fatal-status
1618 "NOMK" (format "No buildfile (%s) found for %s"
1619 buildfile-name source-file-name
)))))
1621 (defun flymake-init-create-temp-source-and-master-buffer-copy (get-incl-dirs-f create-temp-f master-file-masks include-regexp
)
1622 "Find master file (or buffer), create its copy along with a copy of the source file."
1623 (let* ((source-file-name buffer-file-name
)
1624 (temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f
))
1625 (master-and-temp-master (flymake-create-master-file
1626 source-file-name temp-source-file-name
1627 get-incl-dirs-f create-temp-f
1628 master-file-masks include-regexp
)))
1630 (if (not master-and-temp-master
)
1632 (flymake-log 1 "cannot find master file for %s" source-file-name
)
1633 (flymake-report-status "!" "") ; NOMASTER
1635 (setq flymake-master-file-name
(nth 0 master-and-temp-master
))
1636 (setq flymake-temp-master-file-name
(nth 1 master-and-temp-master
)))))
1638 (defun flymake-master-cleanup ()
1639 (flymake-simple-cleanup)
1640 (flymake-safe-delete-file flymake-temp-master-file-name
))
1642 ;;;; make-specific init-cleanup routines
1643 (defun flymake-get-syntax-check-program-args (source-file-name base-dir use-relative-base-dir use-relative-source get-cmd-line-f
)
1644 "Create a command line for syntax check using GET-CMD-LINE-F."
1645 (funcall get-cmd-line-f
1646 (if use-relative-source
1647 (file-relative-name source-file-name base-dir
)
1649 (if use-relative-base-dir
1650 (file-relative-name base-dir
1651 (file-name-directory source-file-name
))
1654 (defun flymake-get-make-cmdline (source base-dir
)
1659 (concat "CHK_SOURCES=" source
)
1660 "SYNTAX_CHECK_MODE=1"
1663 (defun flymake-get-ant-cmdline (source base-dir
)
1666 (concat base-dir
"/" "build.xml")
1667 (concat "-DCHK_SOURCES=" source
)
1670 (defun flymake-simple-make-init-impl (create-temp-f use-relative-base-dir use-relative-source build-file-name get-cmdline-f
)
1671 "Create syntax check command line for a directly checked source file.
1672 Use CREATE-TEMP-F for creating temp copy."
1674 (source-file-name buffer-file-name
)
1675 (buildfile-dir (flymake-init-find-buildfile-dir source-file-name build-file-name
)))
1677 (let* ((temp-source-file-name (flymake-init-create-temp-buffer-copy create-temp-f
)))
1678 (setq args
(flymake-get-syntax-check-program-args temp-source-file-name buildfile-dir
1679 use-relative-base-dir use-relative-source
1683 (defun flymake-simple-make-init ()
1684 (flymake-simple-make-init-impl 'flymake-create-temp-inplace t t
"Makefile" 'flymake-get-make-cmdline
))
1686 (defun flymake-master-make-init (get-incl-dirs-f master-file-masks include-regexp
)
1687 "Create make command line for a source file checked via master file compilation."
1688 (let* ((make-args nil
)
1689 (temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
1690 get-incl-dirs-f
'flymake-create-temp-inplace
1691 master-file-masks include-regexp
)))
1692 (when temp-master-file-name
1693 (let* ((buildfile-dir (flymake-init-find-buildfile-dir temp-master-file-name
"Makefile")))
1695 (setq make-args
(flymake-get-syntax-check-program-args
1696 temp-master-file-name buildfile-dir nil nil
'flymake-get-make-cmdline
)))))
1699 (defun flymake-find-make-buildfile (source-dir)
1700 (flymake-find-buildfile "Makefile" source-dir
))
1702 ;;;; .h/make specific
1703 (defun flymake-master-make-header-init ()
1704 (flymake-master-make-init
1705 'flymake-get-include-dirs
1706 '("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'")
1707 "[ \t]*#[ \t]*include[ \t]*\"\\([[:word:]0-9/\\_.]*%s\\)\""))
1709 ;;;; .java/make specific
1710 (defun flymake-simple-make-java-init ()
1711 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil
"Makefile" 'flymake-get-make-cmdline
))
1713 (defun flymake-simple-ant-java-init ()
1714 (flymake-simple-make-init-impl 'flymake-create-temp-with-folder-structure nil nil
"build.xml" 'flymake-get-ant-cmdline
))
1716 (defun flymake-simple-java-cleanup ()
1717 "Cleanup after `flymake-simple-make-java-init' -- delete temp file and dirs."
1718 (flymake-safe-delete-file flymake-temp-source-file-name
)
1719 (when flymake-temp-source-file-name
1720 (flymake-delete-temp-directory
1721 (file-name-directory flymake-temp-source-file-name
))))
1723 ;;;; perl-specific init-cleanup routines
1724 (defun flymake-perl-init ()
1725 (let* ((temp-file (flymake-init-create-temp-buffer-copy
1726 'flymake-create-temp-inplace
))
1727 (local-file (file-relative-name
1729 (file-name-directory buffer-file-name
))))
1730 (list "perl" (list "-wc " local-file
))))
1732 ;;;; php-specific init-cleanup routines
1733 (defun flymake-php-init ()
1734 (let* ((temp-file (flymake-init-create-temp-buffer-copy
1735 'flymake-create-temp-inplace
))
1736 (local-file (file-relative-name
1738 (file-name-directory buffer-file-name
))))
1739 (list "php" (list "-f" local-file
"-l"))))
1741 ;;;; tex-specific init-cleanup routines
1742 (defun flymake-get-tex-args (file-name)
1743 ;;(list "latex" (list "-c-style-errors" file-name))
1744 (list "texify" (list "--pdf" "--tex-option=-c-style-errors" file-name
)))
1746 (defun flymake-simple-tex-init ()
1747 (flymake-get-tex-args (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace
)))
1749 (defun flymake-master-tex-init ()
1750 (let* ((temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy
1751 'flymake-get-include-dirs-dot
'flymake-create-temp-inplace
1753 "[ \t]*\\input[ \t]*{\\(.*%s\\)}")))
1754 (when temp-master-file-name
1755 (flymake-get-tex-args temp-master-file-name
))))
1757 (defun flymake-get-include-dirs-dot (base-dir)
1760 ;;;; xml-specific init-cleanup routines
1761 (defun flymake-xml-init ()
1762 (list "xml" (list "val" (flymake-init-create-temp-buffer-copy 'flymake-create-temp-inplace
))))
1766 ;; arch-tag: 8f0d6090-061d-4cac-8862-7c151c4a02dd
1767 ;;; flymake.el ends here