flymake.el 71.4 KB
Newer Older
Eli Zaretskii's avatar
Eli Zaretskii committed
1 2
;;; flymake.el -- a universal on-the-fly syntax checker

3
;; Copyright (C) 2003, 2004, 2005, 2006  Free Software Foundation
Eli Zaretskii's avatar
Eli Zaretskii committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; Author:  Pavel Kobiakov <pk_at_work@yahoo.com>
;; Maintainer: Pavel Kobiakov <pk_at_work@yahoo.com>
;; Version: 0.3
;; Keywords: c languages tools

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Eli Zaretskii's avatar
Eli Zaretskii committed
26 27 28 29 30 31 32 33 34

;;; Commentary:
;;
;; Flymake is a minor Emacs mode performing on-the-fly syntax
;; checks using the external syntax check tool (for C/C++ this
;; is usually the compiler)

;;; Code:

35 36 37
(defvar flymake-is-running nil
  "If t, flymake syntax check process is running for the current buffer.")
(make-variable-buffer-local 'flymake-is-running)
38

39 40 41
(defvar flymake-timer nil
  "Timer for starting syntax check.")
(make-variable-buffer-local 'flymake-timer)
42

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
(defvar flymake-last-change-time nil
  "Time of last buffer change.")
(make-variable-buffer-local 'flymake-last-change-time)

(defvar flymake-check-start-time nil
  "Time at which syntax check was started.")
(make-variable-buffer-local 'flymake-check-start-time)

(defvar flymake-check-was-interrupted nil
  "Non-nil if syntax check was killed by `flymake-compile'.")
(make-variable-buffer-local 'flymake-check-was-interrupted)

(defvar flymake-err-info nil
  "Sorted list of line numbers and lists of err info in the form (file, err-text).")
(make-variable-buffer-local 'flymake-err-info)

(defvar flymake-new-err-info nil
  "Same as `flymake-err-info', effective when a syntax check is in progress.")
(make-variable-buffer-local 'flymake-new-err-info)
62

Kim F. Storm's avatar
Kim F. Storm committed
63 64
;;;; [[ Xemacs overlay compatibility
(if (featurep 'xemacs) (progn
Eli Zaretskii's avatar
Eli Zaretskii committed
65 66 67 68 69 70
(autoload 'make-overlay            "overlay" "Overlay compatibility kit." t)
(autoload 'overlayp                "overlay" "Overlay compatibility kit." t)
(autoload 'overlays-in             "overlay" "Overlay compatibility kit." t)
(autoload 'delete-overlay          "overlay" "Overlay compatibility kit." t)
(autoload 'overlay-put             "overlay" "Overlay compatibility kit." t)
(autoload 'overlay-get             "overlay" "Overlay compatibility kit." t)
Kim F. Storm's avatar
Kim F. Storm committed
71
))
Eli Zaretskii's avatar
Eli Zaretskii committed
72 73 74
;;;; ]]

;;;; [[ cross-emacs compatibility routines
Kim F. Storm's avatar
Kim F. Storm committed
75 76 77
(defsubst flymake-makehash (&optional test)
  (if (fboundp 'make-hash-table)
      (if test (make-hash-table :test test) (make-hash-table))
78 79
    (with-no-warnings
      (makehash test))))
Richard M. Stallman's avatar
Richard M. Stallman committed
80

Stefan Monnier's avatar
Stefan Monnier committed
81 82 83
(defalias 'flymake-float-time
  (if (fboundp 'float-time)
      'float-time
84 85 86 87
    (if (featurep 'xemacs)
	(lambda ()
	  (multiple-value-bind (s0 s1 s2) (current-time)
	    (+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2)))))))
Kim F. Storm's avatar
Kim F. Storm committed
88

89 90 91 92 93 94 95 96 97 98 99 100
(defalias 'flymake-replace-regexp-in-string
  (if (eval-when-compile (fboundp 'replace-regexp-in-string))
      'replace-regexp-in-string
    (lambda (regexp rep str)
      (replace-in-string str regexp rep))))

(defalias 'flymake-split-string
  (if (condition-case nil (equal (split-string " bc " " " t) '("bc"))
        (error nil))
      (lambda (str pattern) (split-string str pattern t))
    (lambda (str pattern)
      "Split STR into a list of substrings bounded by PATTERN.
Richard M. Stallman's avatar
Richard M. Stallman committed
101
Zero-length substrings at the beginning and end of the list are omitted."
102 103 104 105 106 107 108 109
      (let ((split (split-string str pattern)))
        (if (and (> (length split) 0) (= 0 (length (elt split 0))))
            (setq split (cdr split)))
        (if (and (> (length split) 0) (= 0 (length (elt split (1- (length split))))))
            (setq split (nreverse (cdr (nreverse split)))))
        split))))

(defalias 'flymake-get-temp-dir
Stefan Monnier's avatar
Stefan Monnier committed
110
  (if (fboundp 'temp-directory)
111 112
      'temp-directory
    (lambda () temporary-file-directory)))
Eli Zaretskii's avatar
Eli Zaretskii committed
113

Stefan Monnier's avatar
Stefan Monnier committed
114 115 116 117
(defalias 'flymake-line-beginning-position
  (if (fboundp 'line-beginning-position)
      'line-beginning-position
    (lambda (&optional arg) (save-excursion (beginning-of-line arg) (point)))))
Eli Zaretskii's avatar
Eli Zaretskii committed
118

Stefan Monnier's avatar
Stefan Monnier committed
119 120 121 122
(defalias 'flymake-line-end-position
  (if (fboundp 'line-end-position)
      'line-end-position
    (lambda (&optional arg) (save-excursion (end-of-line arg) (point)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
123

124 125 126

(defun flymake-popup-menu (menu-data)
  "Pop up the flymake menu at point, using the data MENU-DATA.
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128 129 130 131
POS is a list of the form ((X Y) WINDOW), where X and Y are
pixels positions from the top left corner of WINDOW's frame.
MENU-DATA is a list of error and warning messages returned by
`flymake-make-err-menu-data'."
  (if (featurep 'xemacs)
132 133 134
      (let* ((pos         (flymake-get-point-pixel-pos))
             (x-pos       (nth 0 pos))
	     (y-pos       (nth 1 pos))
Kim F. Storm's avatar
Kim F. Storm committed
135 136 137
	     (fake-event-props  '(button 1 x 1 y 1)))
	(setq fake-event-props (plist-put fake-event-props 'x x-pos))
	(setq fake-event-props (plist-put fake-event-props 'y y-pos))
138 139 140 141 142 143
	(popup-menu (flymake-make-xemacs-menu menu-data)
                    (make-event 'button-press fake-event-props)))
    (x-popup-menu (if (eval-when-compile (fboundp 'posn-at-point))
                      (posn-at-point)
                    (list (flymake-get-point-pixel-pos) (selected-window)))
                  (flymake-make-emacs-menu menu-data))))
Eli Zaretskii's avatar
Eli Zaretskii committed
144

Richard M. Stallman's avatar
Richard M. Stallman committed
145
(defun flymake-make-emacs-menu (menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
146 147 148 149
  "Return a menu specifier using MENU-DATA.
MENU-DATA is a list of error and warning messages returned by
`flymake-make-err-menu-data'.
See `x-popup-menu' for the menu specifier format."
Richard M. Stallman's avatar
Richard M. Stallman committed
150 151
  (let* ((menu-title     (nth 0 menu-data))
	 (menu-items     (nth 1 menu-data))
152 153 154
	 (menu-commands  (mapcar (lambda (foo)
                                   (cons (nth 0 foo) (nth 1 foo)))
                                 menu-items)))
Richard M. Stallman's avatar
Richard M. Stallman committed
155
    (list menu-title (cons "" menu-commands))))
Eli Zaretskii's avatar
Eli Zaretskii committed
156

Kim F. Storm's avatar
Kim F. Storm committed
157 158
(if (featurep 'xemacs) (progn

Stefan Monnier's avatar
Stefan Monnier committed
159 160
(defun flymake-nop ())

161
(defun flymake-make-xemacs-menu (menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
162
  "Return a menu specifier using MENU-DATA."
Richard M. Stallman's avatar
Richard M. Stallman committed
163 164 165 166 167 168 169 170
  (let* ((menu-title     (nth 0 menu-data))
	 (menu-items     (nth 1 menu-data))
	 (menu-commands  nil))
    (setq menu-commands (mapcar (lambda (foo)
				  (vector (nth 0 foo) (or (nth 1 foo) '(flymake-nop)) t))
				menu-items))
    (cons menu-title menu-commands)))

Kim F. Storm's avatar
Kim F. Storm committed
171 172
)) ;; xemacs

173 174
(unless (eval-when-compile (fboundp 'posn-at-point))

Richard M. Stallman's avatar
Richard M. Stallman committed
175 176
(defun flymake-current-row ()
  "Return current row number in current frame."
Stefan Monnier's avatar
Stefan Monnier committed
177 178 179
  (if (fboundp 'window-edges)
      (+ (car (cdr (window-edges))) (count-lines (window-start) (point)))
    (count-lines (window-start) (point))))
Richard M. Stallman's avatar
Richard M. Stallman committed
180 181

(defun flymake-selected-frame ()
Stefan Monnier's avatar
Stefan Monnier committed
182 183 184
  (if (fboundp 'window-edges)
      (selected-frame)
    (selected-window)))
Eli Zaretskii's avatar
Eli Zaretskii committed
185

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
(defun flymake-get-point-pixel-pos ()
  "Return point position in pixels: (x, y)."
  (let ((mouse-pos  (mouse-position))
	(pixel-pos  nil)
	(ret        nil))
    (if (car (cdr mouse-pos))
	(progn
	  (set-mouse-position (flymake-selected-frame) (current-column) (flymake-current-row))
	  (setq pixel-pos (mouse-pixel-position))
	  (set-mouse-position (car mouse-pos) (car (cdr mouse-pos)) (cdr (cdr mouse-pos)))
	  (setq ret (list (car (cdr pixel-pos)) (cdr (cdr pixel-pos)))))
      (progn
	(setq ret '(0 0))))
    (flymake-log 3 "mouse pos is %s" ret)
    ret))

) ;; End of (unless (fboundp 'posn-at-point)

Eli Zaretskii's avatar
Eli Zaretskii committed
204 205 206
;;;; ]]

(defcustom flymake-log-level -1
Stefan Monnier's avatar
Stefan Monnier committed
207
  "Logging level, only messages with level lower or equal will be logged.
Eli Zaretskii's avatar
Eli Zaretskii committed
208
-1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG"
Richard M. Stallman's avatar
Richard M. Stallman committed
209 210
  :group 'flymake
  :type 'integer)
Eli Zaretskii's avatar
Eli Zaretskii committed
211

212
(defun flymake-log (level text &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
213 214 215 216 217
  "Log a message at level LEVEL.
If LEVEL is higher than `flymake-log-level', the message is
ignored.  Otherwise, it is printed using `message'.
TEXT is a format control string, and the remaining arguments ARGS
are the string substitutions (see `format')."
Richard M. Stallman's avatar
Richard M. Stallman committed
218 219
  (if (<= level flymake-log-level)
      (let* ((msg (apply 'format text args)))
220
	(message "%s" msg)
Richard M. Stallman's avatar
Richard M. Stallman committed
221 222 223 224 225
	;;(with-temp-buffer
	;;    (insert msg)
	;;   (insert "\n")
	;;   (flymake-save-buffer-in-file (current-buffer) "d:/flymake.log" t)  ; make log file name customizable
	;;)
226
	)))
Eli Zaretskii's avatar
Eli Zaretskii committed
227

228
(defun flymake-ins-after (list pos val)
Richard M. Stallman's avatar
Richard M. Stallman committed
229 230 231 232
  "Insert VAL into LIST after position POS."
  (let ((tmp (copy-sequence list)))	; (???)
    (setcdr (nthcdr pos tmp) (cons val (nthcdr (1+ pos) tmp)))
    tmp))
Eli Zaretskii's avatar
Eli Zaretskii committed
233

234
(defun flymake-set-at (list pos val)
235
  "Set VAL at position POS in LIST."
Richard M. Stallman's avatar
Richard M. Stallman committed
236 237 238
  (let ((tmp (copy-sequence list)))	; (???)
    (setcar (nthcdr pos tmp) val)
    tmp))
Eli Zaretskii's avatar
Eli Zaretskii committed
239

240 241
(defvar flymake-processes nil
  "List of currently active flymake processes.")
Eli Zaretskii's avatar
Eli Zaretskii committed
242

243
(defvar flymake-output-residual nil)
244

Eli Zaretskii's avatar
Eli Zaretskii committed
245
(make-variable-buffer-local 'flymake-output-residual)
246

Richard M. Stallman's avatar
Richard M. Stallman committed
247 248 249 250 251 252 253 254 255 256 257 258
(defcustom flymake-allowed-file-name-masks
  '((".+\\.c$" flymake-simple-make-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.cpp$" flymake-simple-make-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.xml$" flymake-xml-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.html?$" flymake-xml-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.cs$" flymake-simple-make-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.pl$" flymake-perl-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.h$" flymake-master-make-header-init flymake-master-cleanup flymake-get-real-file-name)
    (".+\\.java$" flymake-simple-make-java-init flymake-simple-java-cleanup flymake-get-real-file-name)
    (".+[0-9]+\\.tex$" flymake-master-tex-init flymake-master-cleanup flymake-get-real-file-name)
    (".+\\.tex$" flymake-simple-tex-init flymake-simple-cleanup flymake-get-real-file-name)
    (".+\\.idl$" flymake-simple-make-init flymake-simple-cleanup flymake-get-real-file-name)
259 260 261 262 263 264 265 266 267
    ;; (".+\\.cpp$" 1)
    ;; (".+\\.java$" 3)
    ;; (".+\\.h$" 2 (".+\\.cpp$" ".+\\.c$")
    ;; ("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2))
    ;; (".+\\.idl$" 1)
    ;; (".+\\.odl$" 1)
    ;; (".+[0-9]+\\.tex$" 2 (".+\\.tex$")
    ;; ("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2 ))
    ;; (".+\\.tex$" 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270 271
    )
  "*Files syntax checking is allowed for."
  :group 'flymake
  :type '(repeat (string symbol symbol symbol)))
Eli Zaretskii's avatar
Eli Zaretskii committed
272

273
(defun flymake-get-file-name-mode-and-masks (file-name)
274
  "Return the corresponding entry from `flymake-allowed-file-name-masks'."
Richard M. Stallman's avatar
Richard M. Stallman committed
275 276
  (unless (stringp file-name)
    (error "Invalid file-name"))
277
  (let ((fnm flymake-allowed-file-name-masks)
Richard M. Stallman's avatar
Richard M. Stallman committed
278
	(mode-and-masks  nil))
279 280 281 282
    (while (and (not mode-and-masks) fnm)
      (if (string-match (car (car fnm)) file-name)
	  (setq mode-and-masks (cdr (car fnm))))
      (setq fnm (cdr fnm)))
Richard M. Stallman's avatar
Richard M. Stallman committed
283 284
    (flymake-log 3 "file %s, init=%s" file-name (car mode-and-masks))
    mode-and-masks))
Eli Zaretskii's avatar
Eli Zaretskii committed
285

286
(defun flymake-can-syntax-check-file (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
287
  "Determine whether we can syntax check FILE-NAME.
288
Return nil if we cannot, non-nil if we can."
Richard M. Stallman's avatar
Richard M. Stallman committed
289
  (if (flymake-get-init-function file-name) t nil))
Eli Zaretskii's avatar
Eli Zaretskii committed
290

291
(defun flymake-get-init-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
292 293
  "Return init function to be used for the file."
  (let* ((init-f  (nth 0 (flymake-get-file-name-mode-and-masks file-name))))
294 295
    ;;(flymake-log 0 "calling %s" init-f)
    ;;(funcall init-f (current-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
296
    init-f))
Eli Zaretskii's avatar
Eli Zaretskii committed
297

298
(defun flymake-get-cleanup-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
299 300
  "Return cleanup function to be used for the file."
  (nth 1 (flymake-get-file-name-mode-and-masks file-name)))
Eli Zaretskii's avatar
Eli Zaretskii committed
301

302
(defun flymake-get-real-file-name-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
303
  (or (nth 2 (flymake-get-file-name-mode-and-masks file-name)) 'flymake-get-real-file-name))
Eli Zaretskii's avatar
Eli Zaretskii committed
304 305

(defcustom flymake-buildfile-dirs '("." ".." "../.." "../../.." "../../../.." "../../../../.." "../../../../../.." "../../../../../../.." "../../../../../../../.." "../../../../../../../../.." "../../../../../../../../../.." "../../../../../../../../../../..")
Richard M. Stallman's avatar
Richard M. Stallman committed
306 307 308
  "Dirs to look for buildfile."
  :group 'flymake
  :type '(repeat (string)))
Eli Zaretskii's avatar
Eli Zaretskii committed
309 310 311

(defvar flymake-find-buildfile-cache (flymake-makehash 'equal))

312
(defun flymake-get-buildfile-from-cache (dir-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
313
  (gethash dir-name flymake-find-buildfile-cache))
314 315

(defun flymake-add-buildfile-to-cache (dir-name buildfile)
Richard M. Stallman's avatar
Richard M. Stallman committed
316
  (puthash dir-name buildfile flymake-find-buildfile-cache))
317 318

(defun flymake-clear-buildfile-cache ()
Richard M. Stallman's avatar
Richard M. Stallman committed
319
  (clrhash flymake-find-buildfile-cache))
320 321

(defun flymake-find-buildfile (buildfile-name source-dir-name dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
322
  "Find buildfile starting from current directory.
323
Buildfile includes Makefile, build.xml etc.
Richard M. Stallman's avatar
Richard M. Stallman committed
324 325 326 327 328 329 330
Return its file name if found, or nil if not found."
  (if (flymake-get-buildfile-from-cache source-dir-name)
      (progn
	(flymake-get-buildfile-from-cache source-dir-name))
    (let* ((buildfile-dir          nil)
	   (buildfile              nil)
	   (found                  nil))
331 332
      (while (and (not found) dirs)
	(setq buildfile-dir (concat source-dir-name (car dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
333 334 335
	(setq buildfile (concat buildfile-dir "/" buildfile-name))
	(when (file-exists-p buildfile)
	  (setq found t))
336
	(setq dirs (cdr dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340 341
      (if found
	  (progn
	    (flymake-log 3 "found buildfile at %s/%s" buildfile-dir buildfile-name)
	    (flymake-add-buildfile-to-cache source-dir-name buildfile-dir)
	    buildfile-dir)
Eli Zaretskii's avatar
Eli Zaretskii committed
342
	(progn
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344 345 346 347 348 349 350 351 352 353 354
	  (flymake-log 3 "buildfile for %s not found" source-dir-name)
	  nil)))))

(defun flymake-fix-file-name (name)
  "Replace all occurences of '\' with '/'."
  (when name
    (let* ((new-name (flymake-replace-regexp-in-string "[\\]" "/" (expand-file-name name)))
	   (last-char (elt new-name (1- (length new-name)))))
      (setq new-name (flymake-replace-regexp-in-string "\\./" "" new-name))
      (if (equal "/" (char-to-string last-char))
	  (setq new-name (substring new-name 0 (1- (length new-name)))))
      new-name)))
Eli Zaretskii's avatar
Eli Zaretskii committed
355

356
(defun flymake-same-files (file-name-one file-name-two)
Richard M. Stallman's avatar
Richard M. Stallman committed
357
  "Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
358
Return t if so, nil if not."
Richard M. Stallman's avatar
Richard M. Stallman committed
359 360 361 362 363
  (equal (flymake-fix-file-name file-name-one)
	 (flymake-fix-file-name file-name-two)))

(defun flymake-get-common-file-prefix (string-one string-two)
  "Return common prefix for two file names STRING-ONE and STRING-TWO."
364 365 366 367 368 369
  (setq string-one (file-name-as-directory string-one))
  (setq string-two (file-name-as-directory string-two))
  (let ((n (compare-strings string-one nil nil string-two nil nil)))
    (if (eq n t) string-one
      (setq n (abs (1+ n)))
      (file-name-directory (substring string-one 0 n)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371 372

(defun flymake-build-relative-filename (from-dir to-dir)
  "Return rel: FROM-DIR/rel == TO-DIR."
373
  ;; FIXME: Why not use `file-relative-name'?
Richard M. Stallman's avatar
Richard M. Stallman committed
374 375 376
  (if (not (equal (elt from-dir 0) (elt to-dir 0)))
      (error "First chars in file names %s, %s must be equal (same drive)"
	     from-dir to-dir)
377 378
    (let* ((from (file-name-as-directory (flymake-fix-file-name from-dir)))
	   (to   (file-name-as-directory (flymake-fix-file-name to-dir)))
Richard M. Stallman's avatar
Richard M. Stallman committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
	   (prefix      (flymake-get-common-file-prefix from to))
	   (from-suffix (substring from (length prefix)))
	   (up-count    (length (flymake-split-string from-suffix "[/]")))
	   (to-suffix   (substring to   (length prefix)))
	   (idx         0)
	   (rel         nil))
      (if (and (> (length to-suffix) 0) (equal "/" (char-to-string (elt to-suffix 0))))
	  (setq to-suffix (substring to-suffix 1)))

      (while (< idx up-count)
	(if (> (length rel) 0)
	    (setq rel (concat rel "/")))
	(setq rel (concat rel ".."))
	(setq idx (1+ idx)))
      (if (> (length rel) 0)
	  (setq rel (concat rel "/")))
      (if (> (length to-suffix) 0)
	  (setq rel (concat rel to-suffix)))
      (or rel "./"))))
Eli Zaretskii's avatar
Eli Zaretskii committed
398 399

(defcustom flymake-master-file-dirs '("." "./src" "./UnitTest")
400
  "Dirs where to look for master files."
Richard M. Stallman's avatar
Richard M. Stallman committed
401 402
  :group 'flymake
  :type '(repeat (string)))
Eli Zaretskii's avatar
Eli Zaretskii committed
403 404

(defcustom flymake-master-file-count-limit 32
Richard M. Stallman's avatar
Richard M. Stallman committed
405 406 407
  "Max number of master files to check."
  :group 'flymake
  :type 'integer)
408

Kim F. Storm's avatar
Kim F. Storm committed
409 410
;; This is bound dynamically to pass a parameter to a sort predicate below
(defvar flymake-included-file-name)
Eli Zaretskii's avatar
Eli Zaretskii committed
411

412
(defun flymake-find-possible-master-files (file-name master-file-dirs masks)
413
  "Find (by name and location) all possible master files.
414
Master files are .cpp and .c for and .h.  Files are searched for
415
starting from the .h directory and max max-level parent dirs.
Eli Zaretskii's avatar
Eli Zaretskii committed
416
File contents are not checked."
417
  (let* ((dirs master-file-dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
418
	 (files  nil)
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
	 (done   nil))

    (while (and (not done) dirs)
      (let* ((dir (concat (flymake-fix-file-name (file-name-directory file-name))
			  "/" (car dirs)))
	     (masks masks))
	(while (and (file-exists-p dir) (not done) masks)
	  (let* ((mask        (car masks))
		 (dir-files   (directory-files dir t mask)))

	    (flymake-log 3 "dir %s, %d file(s) for mask %s"
			 dir (length dir-files) mask)
	    (while (and (not done) dir-files)
	      (when (not (file-directory-p (car dir-files)))
		(setq files (cons (car dir-files) files))
Richard M. Stallman's avatar
Richard M. Stallman committed
434 435 436
		(when (>= (length files) flymake-master-file-count-limit)
		  (flymake-log 3 "master file count limit (%d) reached" flymake-master-file-count-limit)
		  (setq done t)))
437 438 439
	      (setq dir-files (cdr dir-files))))
	  (setq masks (cdr masks))))
      (setq dirs (cdr dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
440
    (when files
Kim F. Storm's avatar
Kim F. Storm committed
441 442
      (let ((flymake-included-file-name (file-name-nondirectory file-name)))
	(setq files (sort files 'flymake-master-file-compare))))
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444
    (flymake-log 3 "found %d possible master file(s)" (length files))
    files))
Eli Zaretskii's avatar
Eli Zaretskii committed
445

446
(defun flymake-master-file-compare (file-one file-two)
447
  "Compare two files specified by FILE-ONE and FILE-TWO.
448
This function is used in sort to move most possible file names
449
to the beginning of the list (File.h -> File.cpp moved to top)."
Richard M. Stallman's avatar
Richard M. Stallman committed
450 451 452
  (and (equal (file-name-sans-extension flymake-included-file-name)
	      (file-name-sans-extension (file-name-nondirectory file-one)))
       (not (equal file-one file-two))))
Eli Zaretskii's avatar
Eli Zaretskii committed
453 454

(defcustom flymake-check-file-limit 8192
Richard M. Stallman's avatar
Richard M. Stallman committed
455 456 457
  "Max number of chars to look at when checking possible master file."
  :group 'flymake
  :type 'integer)
Eli Zaretskii's avatar
Eli Zaretskii committed
458

459
(defun flymake-check-patch-master-file-buffer (master-file-temp-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
460 461 462 463
					       master-file-name patched-master-file-name
					       source-file-name patched-source-file-name
					       include-dirs regexp-list)
  "Check if MASTER-FILE-NAME is a master file for SOURCE-FILE-NAME.
464 465 466 467 468
For .cpp master file this means it includes SOURCE-FILE-NAME (.h).
If yes, patch a copy of MASTER-FILE-NAME to include PATCHED-SOURCE-FILE-NAME
instead of SOURCE-FILE-NAME.
Whether a buffer for MATER-FILE-NAME exists, use it as a source
instead of reading master file from disk."
Richard M. Stallman's avatar
Richard M. Stallman committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
  (let* ((found                     nil)
	 (regexp                    (format (nth 0 regexp-list)	; "[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\""
					    (file-name-nondirectory source-file-name)))
	 (path-idx                  (nth 1 regexp-list))
	 (name-idx                  (nth 2 regexp-list))
	 (inc-path                  nil)
	 (inc-name                  nil)
	 (search-limit              flymake-check-file-limit))
    (save-excursion
      (unwind-protect
	  (progn
	    (set-buffer master-file-temp-buffer)
	    (when (> search-limit (point-max))
	      (setq search-limit (point-max)))
	    (flymake-log 3 "checking %s against regexp %s" master-file-name regexp)
	    (goto-char (point-min))
	    (while (and (< (point) search-limit) (re-search-forward regexp search-limit t))
	      (let* ((match-beg   (match-beginning name-idx))
		     (match-end   (match-end name-idx)))

		(flymake-log 3 "found possible match for %s" (file-name-nondirectory source-file-name))
		(setq inc-path (match-string path-idx))
		(setq inc-name (match-string name-idx))
		(when (string= inc-name (file-name-nondirectory source-file-name))
		  (flymake-log 3 "inc-path=%s inc-name=%s" inc-path inc-name)
		  (when (flymake-check-include source-file-name inc-path inc-name include-dirs)
		    (setq found t)
		    ;;  replace-match is not used here as it fails in
497
		    ;; XEmacs with 'last match not a buffer' error as
Richard M. Stallman's avatar
Richard M. Stallman committed
498
		    ;; check-includes calls replace-in-string
499
		    (flymake-replace-region match-beg match-end
Richard M. Stallman's avatar
Richard M. Stallman committed
500 501 502 503
					    (file-name-nondirectory patched-source-file-name))))
		(forward-line 1)))
	    (when found
	      (flymake-save-buffer-in-file (current-buffer) patched-master-file-name)))
504
	;;+(flymake-log 3 "killing buffer %s" (buffer-name master-file-temp-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
505
	(kill-buffer master-file-temp-buffer)))
506
    ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
Richard M. Stallman's avatar
Richard M. Stallman committed
507 508 509
    (when found
      (flymake-log 2 "found master file %s" master-file-name))
    found))
Eli Zaretskii's avatar
Eli Zaretskii committed
510

511
(defun flymake-replace-region (beg end rep)
Richard M. Stallman's avatar
Richard M. Stallman committed
512 513
  "Replace text in BUFFER in region (BEG END) with REP."
  (save-excursion
514 515 516 517
    (goto-char end)
    ;; Insert before deleting, so as to better preserve markers's positions.
    (insert rep)
    (delete-region beg end)))
Eli Zaretskii's avatar
Eli Zaretskii committed
518

519
(defun flymake-read-file-to-temp-buffer (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
520 521
  "Insert contents of FILE-NAME into newly created temp buffer."
  (let* ((temp-buffer (get-buffer-create (generate-new-buffer-name (concat "flymake:" (file-name-nondirectory file-name))))))
Stefan Monnier's avatar
Stefan Monnier committed
522
    (with-current-buffer temp-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
523 524
      (insert-file-contents file-name))
    temp-buffer))
Eli Zaretskii's avatar
Eli Zaretskii committed
525

526
(defun flymake-copy-buffer-to-temp-buffer (buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
527
  "Copy contents of BUFFER into newly created temp buffer."
528 529 530 531 532
  (with-current-buffer
      (get-buffer-create (generate-new-buffer-name
                          (concat "flymake:" (buffer-name buffer))))
    (insert-buffer-substring buffer)
    (current-buffer)))
Eli Zaretskii's avatar
Eli Zaretskii committed
533

534
(defun flymake-check-include (source-file-name inc-path inc-name include-dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
535
  "Check if SOURCE-FILE-NAME can be found in include path.
536
Return t if it can be found via include path using INC-PATH and INC-NAME."
Richard M. Stallman's avatar
Richard M. Stallman committed
537 538
  (if (file-name-absolute-p inc-path)
      (flymake-same-files source-file-name (concat inc-path "/" inc-name))
539
    (let* ((file-name  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
540
	   (found      nil))
541 542 543
      (while (and (not found) include-dirs)
	(setq file-name (concat (file-name-directory source-file-name)
				"/" (car include-dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545 546 547 548
	(if (> (length inc-path) 0)
	    (setq file-name (concat file-name "/" inc-path)))
	(setq file-name (concat file-name "/" inc-name))
	(when (flymake-same-files source-file-name file-name)
	  (setq found t))
549
	(setq include-dirs (cdr include-dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
550
      found)))
Eli Zaretskii's avatar
Eli Zaretskii committed
551

552
(defun flymake-find-buffer-for-file (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
553
  "Check if there exists a buffer visiting FILE-NAME.
554
Return t if so, nil if not."
Richard M. Stallman's avatar
Richard M. Stallman committed
555 556 557
  (let ((buffer-name (get-file-buffer file-name)))
    (if buffer-name
	(get-buffer buffer-name))))
Eli Zaretskii's avatar
Eli Zaretskii committed
558

559
(defun flymake-create-master-file (source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
560
  "Save SOURCE-FILE-NAME with a different name.
561
Find master file, patch and save it."
Richard M. Stallman's avatar
Richard M. Stallman committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
  (let* ((possible-master-files     (flymake-find-possible-master-files source-file-name flymake-master-file-dirs masks))
	 (master-file-count         (length possible-master-files))
	 (idx                       0)
	 (temp-buffer               nil)
	 (master-file-name          nil)
	 (patched-master-file-name  nil)
	 (found                     nil))

    (while (and (not found) (< idx master-file-count))
      (setq master-file-name (nth idx possible-master-files))
      (setq patched-master-file-name (funcall create-temp-f master-file-name "flymake_master"))
      (if (flymake-find-buffer-for-file master-file-name)
	  (setq temp-buffer (flymake-copy-buffer-to-temp-buffer (flymake-find-buffer-for-file master-file-name)))
	(setq temp-buffer (flymake-read-file-to-temp-buffer master-file-name)))
      (setq found
	    (flymake-check-patch-master-file-buffer
	     temp-buffer
	     master-file-name
	     patched-master-file-name
	     source-file-name
	     patched-source-file-name
	     (funcall get-incl-dirs-f (file-name-directory master-file-name))
	     include-regexp-list))
      (setq idx (1+ idx)))
    (if found
	(list master-file-name patched-master-file-name)
      (progn
	(flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count
		     (file-name-nondirectory source-file-name))
	nil))))
Eli Zaretskii's avatar
Eli Zaretskii committed
592

593
(defun flymake-save-buffer-in-file (buffer file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
594 595
  (or buffer
      (error "Invalid buffer"))
Stefan Monnier's avatar
Stefan Monnier committed
596
  (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
597 598 599 600 601
    (save-restriction
      (widen)
      (make-directory (file-name-directory file-name) 1)
      (write-region (point-min) (point-max) file-name nil 566)))
  (flymake-log 3 "saved buffer %s in file %s" (buffer-name buffer) file-name))
Eli Zaretskii's avatar
Eli Zaretskii committed
602

603
(defun flymake-save-string-to-file (file-name data)
Richard M. Stallman's avatar
Richard M. Stallman committed
604 605
  "Save string DATA to file FILE-NAME."
  (write-region data nil file-name nil 566))
Eli Zaretskii's avatar
Eli Zaretskii committed
606

607
(defun flymake-read-file-to-string (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
608 609 610 611
  "Read contents of file FILE-NAME and return as a string."
  (with-temp-buffer
    (insert-file-contents file-name)
    (buffer-substring (point-min) (point-max))))
Eli Zaretskii's avatar
Eli Zaretskii committed
612

613
(defun flymake-process-filter (process output)
Richard M. Stallman's avatar
Richard M. Stallman committed
614
  "Parse OUTPUT and highlight error lines.
615
It's flymake process filter."
616
  (let ((source-buffer (process-buffer process)))
Eli Zaretskii's avatar
Eli Zaretskii committed
617

618 619
    (flymake-log 3 "received %d byte(s) of output from process %d"
                 (length output) (process-id process))
Richard M. Stallman's avatar
Richard M. Stallman committed
620
    (when source-buffer
621 622
      (with-current-buffer source-buffer
        (flymake-parse-output-and-residual output)))))
Eli Zaretskii's avatar
Eli Zaretskii committed
623

624
(defun flymake-process-sentinel (process event)
Richard M. Stallman's avatar
Richard M. Stallman committed
625 626 627 628
  "Sentinel for syntax check buffers."
  (if (memq (process-status process) '(signal exit))
      (let*((exit-status       (process-exit-status process))
	    (command           (process-command process))
629
	    (source-buffer     (process-buffer process))
Richard M. Stallman's avatar
Richard M. Stallman committed
630 631
	    (cleanup-f         (flymake-get-cleanup-function (buffer-file-name source-buffer))))

632 633
	(flymake-log 2 "process %d exited with code %d"
                     (process-id process) exit-status)
Richard M. Stallman's avatar
Richard M. Stallman committed
634 635 636 637 638 639
	(condition-case err
	    (progn
	      (flymake-log 3 "cleaning up using %s" cleanup-f)
	      (funcall cleanup-f source-buffer)

	      (delete-process process)
640
              (setq flymake-processes (delq process flymake-processes))
Richard M. Stallman's avatar
Richard M. Stallman committed
641 642

	      (when source-buffer
Stefan Monnier's avatar
Stefan Monnier committed
643
		(with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
644

645 646
		  (flymake-parse-residual)
		  (flymake-post-syntax-check exit-status command)
Richard M. Stallman's avatar
Richard M. Stallman committed
647
		  (setq flymake-is-running nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
648 649 650 651
	  (error
	   (let ((err-str (format "Error in process sentinel for buffer %s: %s"
				  source-buffer (error-message-string err))))
	     (flymake-log 0 err-str)
Richard M. Stallman's avatar
Richard M. Stallman committed
652 653
	     (with-current-buffer source-buffer
	       (setq flymake-is-running nil))))))))
Eli Zaretskii's avatar
Eli Zaretskii committed
654

655 656 657 658 659 660 661 662
(defun flymake-post-syntax-check (exit-status command)
  (setq flymake-err-info flymake-new-err-info)
  (setq flymake-new-err-info nil)
  (setq flymake-err-info
        (flymake-fix-line-numbers
         flymake-err-info 1 (flymake-count-lines)))
  (flymake-delete-own-overlays)
  (flymake-highlight-err-lines flymake-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
663
  (let (err-count warn-count)
664 665 666 667
    (setq err-count (flymake-get-err-count flymake-err-info "e"))
    (setq warn-count  (flymake-get-err-count flymake-err-info "w"))
    (flymake-log 2 "%s: %d error(s), %d warning(s) in %.2f second(s)"
		 (buffer-name) err-count warn-count
Richard M. Stallman's avatar
Richard M. Stallman committed
668
		 (- (flymake-float-time) flymake-check-start-time))
669
    (setq flymake-check-start-time nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
670

Richard M. Stallman's avatar
Richard M. Stallman committed
671 672
    (if (and (equal 0 err-count) (equal 0 warn-count))
	(if (equal 0 exit-status)
673 674 675
	    (flymake-report-status "" "")	; PASSED
	  (if (not flymake-check-was-interrupted)
	      (flymake-report-fatal-status "CFGERR"
Richard M. Stallman's avatar
Richard M. Stallman committed
676
					   (format "Configuration error has occured while running %s" command))
677 678
	    (flymake-report-status nil ""))) ; "STOPPED"
      (flymake-report-status (format "%d/%d" err-count warn-count) ""))))
Eli Zaretskii's avatar
Eli Zaretskii committed
679

680
(defun flymake-parse-output-and-residual (output)
Richard M. Stallman's avatar
Richard M. Stallman committed
681
  "Split OUTPUT into lines, merge in residual if necessary."
682 683 684 685 686 687 688 689 690 691 692
  (let* ((buffer-residual     flymake-output-residual)
         (total-output        (if buffer-residual (concat buffer-residual output) output))
         (lines-and-residual  (flymake-split-output total-output))
         (lines               (nth 0 lines-and-residual))
         (new-residual        (nth 1 lines-and-residual)))
    (setq flymake-output-residual new-residual)
    (setq flymake-new-err-info
          (flymake-parse-err-lines
           flymake-new-err-info lines))))

(defun flymake-parse-residual ()
Richard M. Stallman's avatar
Richard M. Stallman committed
693
  "Parse residual if it's non empty."
694 695 696 697 698 699
  (when flymake-output-residual
    (setq flymake-new-err-info
          (flymake-parse-err-lines
           flymake-new-err-info
           (list flymake-output-residual)))
    (setq flymake-output-residual nil)))
Eli Zaretskii's avatar
Eli Zaretskii committed
700

701
(defun flymake-er-make-er (line-no line-err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
702
  (list line-no line-err-info-list))
703 704

(defun flymake-er-get-line (err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
705
  (nth 0 err-info))
706 707

(defun flymake-er-get-line-err-info-list (err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
708
  (nth 1 err-info))
Eli Zaretskii's avatar
Eli Zaretskii committed
709 710

;; getters/setters for line-err-info: (file, line, type, text).
711
(defun flymake-ler-make-ler (file line type text &optional full-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
712
  (list file line type text full-file))
713 714

(defun flymake-ler-get-file (line-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
715
  (nth 0 line-err-info))
716 717

(defun flymake-ler-get-line (line-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
718
  (nth 1 line-err-info))
719 720

(defun flymake-ler-get-type (line-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
721
  (nth 2 line-err-info))
722 723

(defun flymake-ler-get-text (line-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
724
  (nth 3 line-err-info))
725 726

(defun flymake-ler-get-full-file (line-err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
727
  (nth 4 line-err-info))
728 729

(defun flymake-ler-set-file (line-err-info file)
Richard M. Stallman's avatar
Richard M. Stallman committed
730
  (flymake-ler-make-ler file
Eli Zaretskii's avatar
Eli Zaretskii committed
731 732 733
			(flymake-ler-get-line line-err-info)
			(flymake-ler-get-type line-err-info)
			(flymake-ler-get-text line-err-info)
734 735 736
			(flymake-ler-get-full-file line-err-info)))

(defun flymake-ler-set-full-file (line-err-info full-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
737
  (flymake-ler-make-ler (flymake-ler-get-file line-err-info)
Eli Zaretskii's avatar
Eli Zaretskii committed
738 739 740
			(flymake-ler-get-line line-err-info)
			(flymake-ler-get-type line-err-info)
			(flymake-ler-get-text line-err-info)
741 742 743
			full-file))

(defun flymake-ler-set-line (line-err-info line)
Richard M. Stallman's avatar
Richard M. Stallman committed
744
  (flymake-ler-make-ler (flymake-ler-get-file line-err-info)
Eli Zaretskii's avatar
Eli Zaretskii committed
745 746 747
			line
			(flymake-ler-get-type line-err-info)
			(flymake-ler-get-text line-err-info)
748
			(flymake-ler-get-full-file line-err-info)))
Eli Zaretskii's avatar
Eli Zaretskii committed
749

750
(defun flymake-get-line-err-count (line-err-info-list type)
Richard M. Stallman's avatar
Richard M. Stallman committed
751
  "Return number of errors of specified TYPE.
752
Value of TYPE is either \"e\" or \"w\"."
Richard M. Stallman's avatar
Richard M. Stallman committed
753 754 755
  (let* ((idx        0)
	 (count      (length line-err-info-list))
	 (err-count  0))
Eli Zaretskii's avatar
Eli Zaretskii committed
756

Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759 760 761
    (while (< idx count)
      (when (equal type (flymake-ler-get-type (nth idx line-err-info-list)))
	(setq err-count (1+ err-count)))
      (setq idx (1+ idx)))
    err-count))
Eli Zaretskii's avatar
Eli Zaretskii committed
762

763
(defun flymake-get-err-count (err-info-list type)
Richard M. Stallman's avatar
Richard M. Stallman committed
764 765 766 767 768 769 770 771
  "Return number of errors of specified TYPE for ERR-INFO-LIST."
  (let* ((idx        0)
	 (count      (length err-info-list))
	 (err-count  0))
    (while (< idx count)
      (setq err-count (+ err-count (flymake-get-line-err-count (nth 1 (nth idx err-info-list)) type)))
      (setq idx (1+ idx)))
    err-count))
772 773

(defun flymake-fix-line-numbers (err-info-list min-line max-line)
Richard M. Stallman's avatar
Richard M. Stallman committed
774
  "Replace line numbers with fixed value.
775 776
If line-numbers is less than MIN-LINE, set line numbers to MIN-LINE.
If line numbers is greater than MAX-LINE, set line numbers to MAX-LINE.
Kim F. Storm's avatar
Kim F. Storm committed
777
The reason for this fix is because some compilers might report
778
line number outside the file being compiled."
Richard M. Stallman's avatar
Richard M. Stallman committed
779 780 781 782 783 784 785 786 787 788 789 790 791
  (let* ((count     (length err-info-list))
	 (err-info  nil)
	 (line      0))
    (while (> count 0)
      (setq err-info (nth (1- count) err-info-list))
      (setq line (flymake-er-get-line err-info))
      (when (or (< line min-line) (> line max-line))
	(setq line (if (< line min-line) min-line max-line))
	(setq err-info-list (flymake-set-at err-info-list (1- count)
					    (flymake-er-make-er line
								(flymake-er-get-line-err-info-list err-info)))))
      (setq count (1- count))))
  err-info-list)
Eli Zaretskii's avatar
Eli Zaretskii committed
792

793
(defun flymake-highlight-err-lines (err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
794
  "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
795 796 797
  (save-excursion
    (dolist (err err-info-list)
      (flymake-highlight-line (car err) (nth 1 err)))))
Eli Zaretskii's avatar
Eli Zaretskii committed
798

799
(defun flymake-overlay-p (ov)
Richard M. Stallman's avatar
Richard M. Stallman committed
800 801
  "Determine whether overlay OV was created by flymake."
  (and (overlayp ov) (overlay-get ov 'flymake-overlay)))
Eli Zaretskii's avatar
Eli Zaretskii committed
802

803
(defun flymake-make-overlay (beg end tooltip-text face mouse-face)
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805 806 807 808 809 810 811
  "Allocate a flymake overlay in range BEG and END."
  (when (not (flymake-region-has-flymake-overlays beg end))
    (let ((ov (make-overlay beg end nil t t)))
      (overlay-put ov 'face           face)
      (overlay-put ov 'mouse-face     mouse-face)
      (overlay-put ov 'help-echo      tooltip-text)
      (overlay-put ov 'flymake-overlay  t)
      (overlay-put ov 'priority 100)
812
      ;;+(flymake-log 3 "created overlay %s" ov)
Richard M. Stallman's avatar
Richard M. Stallman committed
813 814
      ov)
    (flymake-log 3 "created an overlay at (%d-%d)" beg end)))
Eli Zaretskii's avatar
Eli Zaretskii committed
815

816
(defun flymake-delete-own-overlays ()
Richard M. Stallman's avatar
Richard M. Stallman committed
817
  "Delete all flymake overlays in BUFFER."
818 819 820 821 822
  (dolist (ol (overlays-in (point-min) (point-max)))
    (when (flymake-overlay-p ol)
      (delete-overlay ol)
      ;;+(flymake-log 3 "deleted overlay %s" ol)
      )))
Eli Zaretskii's avatar
Eli Zaretskii committed
823

824
(defun flymake-region-has-flymake-overlays (beg end)
Richard M. Stallman's avatar
Richard M. Stallman committed
825
  "Check if region specified by BEG and END has overlay.
826
Return t if it has at least one flymake overlay, nil if no overlay."
Richard M. Stallman's avatar
Richard M. Stallman committed
827 828 829 830 831
  (let ((ov                  (overlays-in beg end))
	(has-flymake-overlays  nil))
    (while (consp ov)
      (when (flymake-overlay-p (car ov))
	(setq has-flymake-overlays t))
Stefan Monnier's avatar
Stefan Monnier committed
832 833
      (setq ov (cdr ov)))
    has-flymake-overlays))
Eli Zaretskii's avatar
Eli Zaretskii committed
834

835
(defface flymake-errline
836 837
  ;;+   '((((class color)) (:foreground "OrangeRed" :bold t :underline t))
  ;;+   '((((class color)) (:underline "OrangeRed"))
Richard M. Stallman's avatar
Richard M. Stallman committed
838 839 840 841
  '((((class color)) (:background "LightPink"))
    (t (:bold t)))
  "Face used for marking error lines."
  :group 'flymake)
Eli Zaretskii's avatar
Eli Zaretskii committed
842

843
(defface flymake-warnline
Richard M. Stallman's avatar
Richard M. Stallman committed
844 845 846 847
  '((((class color)) (:background "LightBlue2"))
    (t (:bold t)))
  "Face used for marking warning lines."
  :group 'flymake)
Eli Zaretskii's avatar
Eli Zaretskii committed
848

849
(defun flymake-highlight-line (line-no line-err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
850
  "Highlight line LINE-NO in current buffer.
851
Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting."
Richard M. Stallman's avatar
Richard M. Stallman committed
852 853 854 855 856 857 858 859 860 861 862
  (goto-line line-no)
  (let* ((line-beg (flymake-line-beginning-position))
	 (line-end (flymake-line-end-position))
	 (beg      line-beg)
	 (end      line-end)
	 (tooltip-text (flymake-ler-get-text (nth 0 line-err-info-list)))
	 (face     nil))

    (goto-char line-beg)
    (while (looking-at "[ \t]")
      (forward-char))
Eli Zaretskii's avatar
Eli Zaretskii committed
863

Richard M. Stallman's avatar
Richard M. Stallman committed
864
    (setq beg (point))
Eli Zaretskii's avatar
Eli Zaretskii committed
865

Richard M. Stallman's avatar
Richard M. Stallman committed
866 867 868
    (goto-char line-end)
    (while (and (looking-at "[ \t\r\n]") (> (point) 1))
      (backward-char))
Eli Zaretskii's avatar
Eli Zaretskii committed
869

Richard M. Stallman's avatar
Richard M. Stallman committed
870
    (setq end (1+ (point)))
Eli Zaretskii's avatar
Eli Zaretskii committed
871

Richard M. Stallman's avatar
Richard M. Stallman committed
872 873 874
    (when (<= end beg)
      (setq beg line-beg)
      (setq end line-end))
875

Richard M. Stallman's avatar
Richard M. Stallman committed
876 877 878 879
    (when (= end beg)
      (goto-char end)
      (forward-line)
      (setq end (point)))
880

Richard M. Stallman's avatar
Richard M. Stallman committed
881
    (if (> (flymake-get-line-err-count line-err-info-list "e") 0)
882 883
	(setq face 'flymake-errline)
      (setq face 'flymake-warnline))
884

Richard M. Stallman's avatar
Richard M. Stallman committed
885
    (flymake-make-overlay beg end tooltip-text face nil)))
Eli Zaretskii's avatar
Eli Zaretskii committed
886

887
(defun flymake-parse-err-lines (err-info-list lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
888 889 890 891 892
  "Parse err LINES, store info in ERR-INFO-LIST."
  (let* ((count              (length lines))
	 (idx                0)
	 (line-err-info      nil)
	 (real-file-name     nil)
893
	 (source-file-name   buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
894 895 896 897 898
	 (get-real-file-name-f (flymake-get-real-file-name-function source-file-name)))

    (while (< idx count)
      (setq line-err-info (flymake-parse-line (nth idx lines)))
      (when line-err-info
899
	(setq real-file-name (funcall get-real-file-name-f (current-buffer) (flymake-ler-get-file line-err-info)))
Richard M. Stallman's avatar
Richard M. Stallman committed
900 901 902 903 904 905 906 907 908 909
	(setq line-err-info (flymake-ler-set-full-file line-err-info real-file-name))

	(if (flymake-same-files real-file-name source-file-name)
	    (setq line-err-info (flymake-ler-set-file line-err-info nil))
	  (setq line-err-info (flymake-ler-set-file line-err-info (file-name-nondirectory real-file-name))))

	(setq err-info-list (flymake-add-err-info err-info-list line-err-info)))
      (flymake-log 3 "parsed '%s', %s line-err-info" (nth idx lines) (if line-err-info "got" "no"))
      (setq idx (1+ idx)))
    err-info-list))
Eli Zaretskii's avatar
Eli Zaretskii committed
910

911
(defun flymake-split-output (output)
Richard M. Stallman's avatar
Richard M. Stallman committed
912
  "Split OUTPUT into lines.