flymake.el 74.1 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, 2005  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 24 25 26 27 28 29 30 31 32 33 34

;; 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
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; 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:

Kim F. Storm's avatar
Kim F. Storm committed
35 36
;;;; [[ Xemacs overlay compatibility
(if (featurep 'xemacs) (progn
Eli Zaretskii's avatar
Eli Zaretskii committed
37 38 39 40 41 42
(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
43
))
Eli Zaretskii's avatar
Eli Zaretskii committed
44 45 46
;;;; ]]

;;;; [[ cross-emacs compatibility routines
Kim F. Storm's avatar
Kim F. Storm committed
47 48 49 50
(defsubst flymake-makehash (&optional test)
  (if (fboundp 'make-hash-table)
      (if test (make-hash-table :test test) (make-hash-table))
    (makehash test)))
Richard M. Stallman's avatar
Richard M. Stallman committed
51

Stefan Monnier's avatar
Stefan Monnier committed
52 53 54 55 56 57
(defalias 'flymake-float-time
  (if (fboundp 'float-time)
      'float-time
    (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
58 59

(defsubst flymake-replace-regexp-in-string (regexp rep str)
Stefan Monnier's avatar
Stefan Monnier committed
60 61 62
  (if (fboundp 'replace-regexp-in-string)
      (replace-regexp-in-string regexp rep str)
    (replace-in-string str regexp rep)))
Kim F. Storm's avatar
Kim F. Storm committed
63 64

(defun flymake-split-string (str pattern)
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66
  "Split STR into a list of substrings bounded by PATTERN.
Zero-length substrings at the beginning and end of the list are omitted."
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69 70 71 72 73
  (let* ((splitted (split-string str pattern)))
    (if (and (> (length splitted) 0) (= 0 (length (elt splitted 0))))
	(setq splitted (cdr splitted)))
    (if (and (> (length splitted) 0) (= 0 (length (elt splitted (1- (length splitted))))))
	(setq splitted (reverse (cdr (reverse splitted)))))
    splitted))

Kim F. Storm's avatar
Kim F. Storm committed
74
(defsubst flymake-get-temp-dir ()
Stefan Monnier's avatar
Stefan Monnier committed
75
  (if (fboundp 'temp-directory)
Kim F. Storm's avatar
Kim F. Storm committed
76 77
      (temp-directory)
    temporary-file-directory))
Eli Zaretskii's avatar
Eli Zaretskii committed
78

Stefan Monnier's avatar
Stefan Monnier committed
79 80 81 82
(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
83

Stefan Monnier's avatar
Stefan Monnier committed
84 85 86 87
(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
88 89

(defun flymake-popup-menu (pos menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91 92 93 94 95
  "Pop up the flymake menu at position POS, using the data MENU-DATA.
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)
Kim F. Storm's avatar
Kim F. Storm committed
96 97 98 99 100 101 102
      (let* ((x-pos       (nth 0 (nth 0 pos)))
	     (y-pos       (nth 1 (nth 0 pos)))
	     (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))
	(popup-menu (flymake-make-xemacs-menu menu-data) (make-event 'button-press fake-event-props)))
    (x-popup-menu pos (flymake-make-emacs-menu menu-data))))
Eli Zaretskii's avatar
Eli Zaretskii committed
103

Richard M. Stallman's avatar
Richard M. Stallman committed
104
(defun flymake-make-emacs-menu (menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108
  "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
109 110 111 112 113 114 115
  (let* ((menu-title     (nth 0 menu-data))
	 (menu-items     (nth 1 menu-data))
	 (menu-commands  nil))
    (setq menu-commands (mapcar (lambda (foo)
				  (cons (nth 0 foo) (nth 1 foo)))
				menu-items))
    (list menu-title (cons "" menu-commands))))
Eli Zaretskii's avatar
Eli Zaretskii committed
116

Kim F. Storm's avatar
Kim F. Storm committed
117 118
(if (featurep 'xemacs) (progn

Stefan Monnier's avatar
Stefan Monnier committed
119 120
(defun flymake-nop ())

121
(defun flymake-make-xemacs-menu (menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
122
  "Return a menu specifier using MENU-DATA."
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  (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)))

(defun flymake-xemacs-window-edges (&optional window)
  (let ((edges  (window-pixel-edges window))
	tmp)
    (setq tmp edges)
    (setcar tmp (/ (car tmp) (face-width 'default)))
    (setq tmp (cdr tmp))
    (setcar tmp (/ (car tmp) (face-height 'default)))
    (setq tmp (cdr tmp))
    (setcar tmp (/ (car tmp) (face-width 'default)))
    (setq tmp (cdr tmp))
    (setcar tmp (/ (car tmp) (face-height 'default)))
    edges))

Kim F. Storm's avatar
Kim F. Storm committed
144 145
)) ;; xemacs

Richard M. Stallman's avatar
Richard M. Stallman committed
146 147
(defun flymake-current-row ()
  "Return current row number in current frame."
Stefan Monnier's avatar
Stefan Monnier committed
148 149 150
  (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
151 152

(defun flymake-selected-frame ()
Stefan Monnier's avatar
Stefan Monnier committed
153 154 155
  (if (fboundp 'window-edges)
      (selected-frame)
    (selected-window)))
Eli Zaretskii's avatar
Eli Zaretskii committed
156 157 158 159

;;;; ]]

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

165
(defun flymake-log (level text &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168 169 170
  "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
171 172 173 174 175 176 177 178
  (if (<= level flymake-log-level)
      (let* ((msg (apply 'format text args)))
	(message msg)
	;;(with-temp-buffer
	;;    (insert msg)
	;;   (insert "\n")
	;;   (flymake-save-buffer-in-file (current-buffer) "d:/flymake.log" t)  ; make log file name customizable
	;;)
179
	)))
Eli Zaretskii's avatar
Eli Zaretskii committed
180

181
(defun flymake-ins-after (list pos val)
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184 185
  "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
186

187
(defun flymake-set-at (list pos val)
188
  "Set VAL at position POS in LIST."
Richard M. Stallman's avatar
Richard M. Stallman committed
189 190 191
  (let ((tmp (copy-sequence list)))	; (???)
    (setcar (nthcdr pos tmp) val)
    tmp))
Eli Zaretskii's avatar
Eli Zaretskii committed
192

193
(defvar flymake-pid-to-names (flymake-makehash)
Richard M. Stallman's avatar
Richard M. Stallman committed
194
  "Hash table mapping PIDs to source buffer names and output files.")
Eli Zaretskii's avatar
Eli Zaretskii committed
195

196
(defun flymake-reg-names (pid source-buffer-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
197
  "Associate PID with SOURCE-BUFFER-NAME in `flymake-pid-to-names'."
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200
  (unless (stringp source-buffer-name)
    (error "Invalid buffer name"))
  (puthash pid (list source-buffer-name) flymake-pid-to-names))
Eli Zaretskii's avatar
Eli Zaretskii committed
201

202
(defun flymake-get-source-buffer-name (pid)
Richard M. Stallman's avatar
Richard M. Stallman committed
203
  "Return buffer name associated with PID in `flymake-pid-to-names'."
Richard M. Stallman's avatar
Richard M. Stallman committed
204
  (nth 0 (gethash pid flymake-pid-to-names)))
Eli Zaretskii's avatar
Eli Zaretskii committed
205

206
(defun flymake-unreg-names (pid)
Richard M. Stallman's avatar
Richard M. Stallman committed
207
  "Remove the entry associated with PID from `flymake-pid-to-names'."
Richard M. Stallman's avatar
Richard M. Stallman committed
208
  (remhash pid flymake-pid-to-names))
Eli Zaretskii's avatar
Eli Zaretskii committed
209

210 211
(defvar flymake-buffer-data (flymake-makehash)
  "Data specific to syntax check tool, in name-value pairs.")
Eli Zaretskii's avatar
Eli Zaretskii committed
212 213 214

(make-variable-buffer-local 'flymake-buffer-data)

215
(defun flymake-get-buffer-value (buffer name)
Richard M. Stallman's avatar
Richard M. Stallman committed
216
  (gethash name (with-current-buffer buffer flymake-buffer-data)))
217 218

(defun flymake-set-buffer-value (buffer name value)
Richard M. Stallman's avatar
Richard M. Stallman committed
219
  (puthash name value (with-current-buffer buffer flymake-buffer-data)))
220

221
(defvar flymake-output-residual nil)
222

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

Richard M. Stallman's avatar
Richard M. Stallman committed
225 226 227 228 229 230 231 232 233 234 235 236
(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)
237 238 239 240 241 242 243 244 245
    ;; (".+\\.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
246 247 248 249
    )
  "*Files syntax checking is allowed for."
  :group 'flymake
  :type '(repeat (string symbol symbol symbol)))
Eli Zaretskii's avatar
Eli Zaretskii committed
250

251
(defun flymake-get-file-name-mode-and-masks (file-name)
252
  "Return the corresponding entry from `flymake-allowed-file-name-masks'."
Richard M. Stallman's avatar
Richard M. Stallman committed
253 254
  (unless (stringp file-name)
    (error "Invalid file-name"))
255
  (let ((fnm flymake-allowed-file-name-masks)
Richard M. Stallman's avatar
Richard M. Stallman committed
256
	(mode-and-masks  nil))
257 258 259 260
    (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
261 262
    (flymake-log 3 "file %s, init=%s" file-name (car mode-and-masks))
    mode-and-masks))
Eli Zaretskii's avatar
Eli Zaretskii committed
263

264
(defun flymake-can-syntax-check-file (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
265
  "Determine whether we can syntax check FILE-NAME.
266
Return nil if we cannot, non-nil if we can."
Richard M. Stallman's avatar
Richard M. Stallman committed
267
  (if (flymake-get-init-function file-name) t nil))
Eli Zaretskii's avatar
Eli Zaretskii committed
268

269
(defun flymake-get-init-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
270 271
  "Return init function to be used for the file."
  (let* ((init-f  (nth 0 (flymake-get-file-name-mode-and-masks file-name))))
272 273
    ;;(flymake-log 0 "calling %s" init-f)
    ;;(funcall init-f (current-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
274
    init-f))
Eli Zaretskii's avatar
Eli Zaretskii committed
275

276
(defun flymake-get-cleanup-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
277 278
  "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
279

280
(defun flymake-get-real-file-name-function (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
281
  (or (nth 2 (flymake-get-file-name-mode-and-masks file-name)) 'flymake-get-real-file-name))
Eli Zaretskii's avatar
Eli Zaretskii committed
282 283

(defcustom flymake-buildfile-dirs '("." ".." "../.." "../../.." "../../../.." "../../../../.." "../../../../../.." "../../../../../../.." "../../../../../../../.." "../../../../../../../../.." "../../../../../../../../../.." "../../../../../../../../../../..")
Richard M. Stallman's avatar
Richard M. Stallman committed
284 285 286
  "Dirs to look for buildfile."
  :group 'flymake
  :type '(repeat (string)))
Eli Zaretskii's avatar
Eli Zaretskii committed
287 288 289

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

290
(defun flymake-get-buildfile-from-cache (dir-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
291
  (gethash dir-name flymake-find-buildfile-cache))
292 293

(defun flymake-add-buildfile-to-cache (dir-name buildfile)
Richard M. Stallman's avatar
Richard M. Stallman committed
294
  (puthash dir-name buildfile flymake-find-buildfile-cache))
295 296

(defun flymake-clear-buildfile-cache ()
Richard M. Stallman's avatar
Richard M. Stallman committed
297
  (clrhash flymake-find-buildfile-cache))
298 299

(defun flymake-find-buildfile (buildfile-name source-dir-name dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
300
  "Find buildfile starting from current directory.
301
Buildfile includes Makefile, build.xml etc.
Richard M. Stallman's avatar
Richard M. Stallman committed
302 303 304 305 306 307 308
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))
309 310
      (while (and (not found) dirs)
	(setq buildfile-dir (concat source-dir-name (car dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
311 312 313
	(setq buildfile (concat buildfile-dir "/" buildfile-name))
	(when (file-exists-p buildfile)
	  (setq found t))
314
	(setq dirs (cdr dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316 317 318 319
      (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
320
	(progn
Richard M. Stallman's avatar
Richard M. Stallman committed
321 322 323 324 325 326 327 328 329 330 331 332
	  (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
333

334
(defun flymake-same-files (file-name-one file-name-two)
Richard M. Stallman's avatar
Richard M. Stallman committed
335
  "Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
336
Return t if so, nil if not."
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340 341
  (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."
342 343 344 345 346 347
  (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
348 349 350

(defun flymake-build-relative-filename (from-dir to-dir)
  "Return rel: FROM-DIR/rel == TO-DIR."
351
  ;; FIXME: Why not use `file-relative-name'?
Richard M. Stallman's avatar
Richard M. Stallman committed
352 353 354
  (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)
355 356
    (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
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
	   (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
376 377

(defcustom flymake-master-file-dirs '("." "./src" "./UnitTest")
378
  "Dirs where to look for master files."
Richard M. Stallman's avatar
Richard M. Stallman committed
379 380
  :group 'flymake
  :type '(repeat (string)))
Eli Zaretskii's avatar
Eli Zaretskii committed
381 382

(defcustom flymake-master-file-count-limit 32
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385
  "Max number of master files to check."
  :group 'flymake
  :type 'integer)
386

Kim F. Storm's avatar
Kim F. Storm committed
387 388
;; 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
389

390
(defun flymake-find-possible-master-files (file-name master-file-dirs masks)
391 392
  "Find (by name and location) all possible master files.
Master files are .cpp and .c for and .h. Files are searched for
393
starting from the .h directory and max max-level parent dirs.
Eli Zaretskii's avatar
Eli Zaretskii committed
394
File contents are not checked."
395
  (let* ((dirs master-file-dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
396
	 (files  nil)
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
	 (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
412 413 414
		(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)))
415 416 417
	      (setq dir-files (cdr dir-files))))
	  (setq masks (cdr masks))))
      (setq dirs (cdr dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
418
    (when files
Kim F. Storm's avatar
Kim F. Storm committed
419 420
      (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
421 422
    (flymake-log 3 "found %d possible master file(s)" (length files))
    files))
Eli Zaretskii's avatar
Eli Zaretskii committed
423

424
(defun flymake-master-file-compare (file-one file-two)
Richard M. Stallman's avatar
Richard M. Stallman committed
425
  "Compare two files speccified by FILE-ONE and FILE-TWO.
426 427
This function is used in sort to move most possible file names
to the beginning of the list (File.h -> File.cpp moved to top."
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430
  (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
431 432

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

437
(defun flymake-check-patch-master-file-buffer (master-file-temp-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
438 439 440 441
					       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.
442 443 444 445 446
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
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
  (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
475
		    ;; XEmacs with 'last match not a buffer' error as
Richard M. Stallman's avatar
Richard M. Stallman committed
476
		    ;; check-includes calls replace-in-string
477
		    (flymake-replace-region match-beg match-end
Richard M. Stallman's avatar
Richard M. Stallman committed
478 479 480 481
					    (file-name-nondirectory patched-source-file-name))))
		(forward-line 1)))
	    (when found
	      (flymake-save-buffer-in-file (current-buffer) patched-master-file-name)))
482
	;;+(flymake-log 3 "killing buffer %s" (buffer-name master-file-temp-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
483
	(kill-buffer master-file-temp-buffer)))
484
    ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
Richard M. Stallman's avatar
Richard M. Stallman committed
485 486 487
    (when found
      (flymake-log 2 "found master file %s" master-file-name))
    found))
Eli Zaretskii's avatar
Eli Zaretskii committed
488

489
(defun flymake-replace-region (beg end rep)
Richard M. Stallman's avatar
Richard M. Stallman committed
490 491
  "Replace text in BUFFER in region (BEG END) with REP."
  (save-excursion
492 493 494 495
    (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
496

497
(defun flymake-read-file-to-temp-buffer (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
498 499
  "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
500
    (with-current-buffer temp-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502
      (insert-file-contents file-name))
    temp-buffer))
Eli Zaretskii's avatar
Eli Zaretskii committed
503

504
(defun flymake-copy-buffer-to-temp-buffer (buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506 507
  "Copy contents of BUFFER into newly created temp buffer."
  (let ((contents     nil)
	(temp-buffer  nil))
Stefan Monnier's avatar
Stefan Monnier committed
508
    (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
509 510 511 512 513 514
      (setq contents (buffer-string))

      (setq temp-buffer (get-buffer-create (generate-new-buffer-name (concat "flymake:" (buffer-name buffer)))))
      (set-buffer temp-buffer)
      (insert contents))
    temp-buffer))
Eli Zaretskii's avatar
Eli Zaretskii committed
515

516
(defun flymake-check-include (source-file-name inc-path inc-name include-dirs)
Richard M. Stallman's avatar
Richard M. Stallman committed
517
  "Check if SOURCE-FILE-NAME can be found in include path.
518
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
519 520
  (if (file-name-absolute-p inc-path)
      (flymake-same-files source-file-name (concat inc-path "/" inc-name))
521
    (let* ((file-name  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
522
	   (found      nil))
523 524 525
      (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
526 527 528 529 530
	(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))
531
	(setq include-dirs (cdr include-dirs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
532
      found)))
Eli Zaretskii's avatar
Eli Zaretskii committed
533

534
(defun flymake-find-buffer-for-file (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
535
  "Check if there exists a buffer visiting FILE-NAME.
536
Return t if so, nil if not."
Richard M. Stallman's avatar
Richard M. Stallman committed
537 538 539
  (let ((buffer-name (get-file-buffer file-name)))
    (if buffer-name
	(get-buffer buffer-name))))
Eli Zaretskii's avatar
Eli Zaretskii committed
540

541
(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
542
  "Save SOURCE-FILE-NAME with a different name.
543
Find master file, patch and save it."
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
  (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
574

575
(defun flymake-save-buffer-in-file (buffer file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
576 577
  (or buffer
      (error "Invalid buffer"))
Stefan Monnier's avatar
Stefan Monnier committed
578
  (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580 581 582 583
    (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
584

585
(defun flymake-save-string-to-file (file-name data)
Richard M. Stallman's avatar
Richard M. Stallman committed
586 587
  "Save string DATA to file FILE-NAME."
  (write-region data nil file-name nil 566))
Eli Zaretskii's avatar
Eli Zaretskii committed
588

589
(defun flymake-read-file-to-string (file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
590 591 592 593
  "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
594

595
(defun flymake-process-filter (process output)
Richard M. Stallman's avatar
Richard M. Stallman committed
596
  "Parse OUTPUT and highlight error lines.
597
It's flymake process filter."
Richard M. Stallman's avatar
Richard M. Stallman committed
598 599
  (let* ((pid               (process-id process))
	 (source-buffer     (get-buffer (flymake-get-source-buffer-name pid))))
Eli Zaretskii's avatar
Eli Zaretskii committed
600

Richard M. Stallman's avatar
Richard M. Stallman committed
601 602 603
    (flymake-log 3 "received %d byte(s) of output from process %d" (length output) pid)
    (when source-buffer
      (flymake-parse-output-and-residual source-buffer output))))
Eli Zaretskii's avatar
Eli Zaretskii committed
604

605
(defun flymake-process-sentinel (process event)
Richard M. Stallman's avatar
Richard M. Stallman committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
  "Sentinel for syntax check buffers."
  (if (memq (process-status process) '(signal exit))
      (let*((exit-status       (process-exit-status process))
	    (command           (process-command process))
	    (pid               (process-id process))
	    (source-buffer     (get-buffer (flymake-get-source-buffer-name pid)))
	    (cleanup-f         (flymake-get-cleanup-function (buffer-file-name source-buffer))))

	(flymake-log 2 "process %d exited with code %d" pid exit-status)
	(condition-case err
	    (progn
	      (flymake-log 3 "cleaning up using %s" cleanup-f)
	      (funcall cleanup-f source-buffer)

	      (flymake-unreg-names pid)
	      (delete-process process)

	      (when source-buffer
Stefan Monnier's avatar
Stefan Monnier committed
624
		(with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
625 626 627

		  (flymake-parse-residual source-buffer)
		  (flymake-post-syntax-check source-buffer exit-status command)
Richard M. Stallman's avatar
Richard M. Stallman committed
628
		  (setq flymake-is-running nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
629 630 631 632
	  (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
633 634
	     (with-current-buffer source-buffer
	       (setq flymake-is-running nil))))))))
Eli Zaretskii's avatar
Eli Zaretskii committed
635

636
(defun flymake-post-syntax-check (source-buffer exit-status command)
Richard M. Stallman's avatar
Richard M. Stallman committed
637 638 639 640 641 642
  (with-current-buffer source-buffer
    (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 source-buffer))))
Richard M. Stallman's avatar
Richard M. Stallman committed
643
  (flymake-delete-own-overlays source-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
644 645 646 647 648 649 650
  (flymake-highlight-err-lines
   source-buffer (with-current-buffer source-buffer flymake-err-info))
  (let (err-count warn-count)
    (with-current-buffer source-buffer
      (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)"
Richard M. Stallman's avatar
Richard M. Stallman committed
651
		 (buffer-name source-buffer) err-count warn-count
Richard M. Stallman's avatar
Richard M. Stallman committed
652 653 654
		 (- (flymake-float-time) flymake-check-start-time))
      (setq flymake-check-start-time nil))

Richard M. Stallman's avatar
Richard M. Stallman committed
655 656 657
    (if (and (equal 0 err-count) (equal 0 warn-count))
	(if (equal 0 exit-status)
	    (flymake-report-status source-buffer "" "")	; PASSED
Richard M. Stallman's avatar
Richard M. Stallman committed
658 659
	  (if (not (with-current-buffer source-buffer
		     flymake-check-was-interrupted))
Richard M. Stallman's avatar
Richard M. Stallman committed
660 661 662 663
	      (flymake-report-fatal-status (current-buffer) "CFGERR"
					   (format "Configuration error has occured while running %s" command))
	    (flymake-report-status source-buffer nil ""))) ; "STOPPED"
      (flymake-report-status source-buffer (format "%d/%d" err-count warn-count) ""))))
Eli Zaretskii's avatar
Eli Zaretskii committed
664

665
(defun flymake-parse-output-and-residual (source-buffer output)
Richard M. Stallman's avatar
Richard M. Stallman committed
666
  "Split OUTPUT into lines, merge in residual if necessary."
Stefan Monnier's avatar
Stefan Monnier committed
667
  (with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
668
    (let* ((buffer-residual     flymake-output-residual)
Richard M. Stallman's avatar
Richard M. Stallman committed
669 670 671 672
	   (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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
673 674 675 676 677 678
      (with-current-buffer source-buffer
	(setq flymake-output-residual new-residual)
	(setq flymake-new-err-info
	      (flymake-parse-err-lines
	       flymake-new-err-info
	       source-buffer lines))))))
Eli Zaretskii's avatar
Eli Zaretskii committed
679

680
(defun flymake-parse-residual (source-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
681
  "Parse residual if it's non empty."
Stefan Monnier's avatar
Stefan Monnier committed
682
  (with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
683 684 685 686 687 688 689
    (when flymake-output-residual
      (setq flymake-new-err-info
	    (flymake-parse-err-lines
	     flymake-new-err-info
	     source-buffer
	     (list flymake-output-residual)))
      (setq flymake-output-residual nil))))
Eli Zaretskii's avatar
Eli Zaretskii committed
690 691

(defvar flymake-err-info nil
692 693
  "Sorted list of line numbers and lists of err info in the form (file, err-text).")

Eli Zaretskii's avatar
Eli Zaretskii committed
694
(make-variable-buffer-local 'flymake-err-info)
695 696

(defun flymake-er-make-er (line-no line-err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
697
  (list line-no line-err-info-list))
698 699

(defun flymake-er-get-line (err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
700
  (nth 0 err-info))
701 702

(defun flymake-er-get-line-err-info-list (err-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
703
  (nth 1 err-info))
Eli Zaretskii's avatar
Eli Zaretskii committed
704 705

(defvar flymake-new-err-info nil
706 707
  "Same as 'flymake-err-info', effective when a syntax check is in progress.")

Eli Zaretskii's avatar
Eli Zaretskii committed
708
(make-variable-buffer-local 'flymake-new-err-info)
709

Eli Zaretskii's avatar
Eli Zaretskii committed
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 eigher 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 (buffer err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
794
  "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
Stefan Monnier's avatar
Stefan Monnier committed
795
  (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799 800
    (let* ((idx    0)
	   (count  (length err-info-list)))
      (while (< idx count)
	(flymake-highlight-line (car (nth idx err-info-list)) (nth 1 (nth idx err-info-list)))
	(setq idx (1+ idx))))))
Eli Zaretskii's avatar
Eli Zaretskii committed
801

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

806
(defun flymake-make-overlay (beg end tooltip-text face mouse-face)
Richard M. Stallman's avatar
Richard M. Stallman committed
807 808 809 810 811 812 813 814
  "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)
815
      ;;+(flymake-log 3 "created overlay %s" ov)
Richard M. Stallman's avatar
Richard M. Stallman committed
816 817
      ov)
    (flymake-log 3 "created an overlay at (%d-%d)" beg end)))
Eli Zaretskii's avatar
Eli Zaretskii committed
818

819
(defun flymake-delete-own-overlays (buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
820
  "Delete all flymake overlays in BUFFER."
Stefan Monnier's avatar
Stefan Monnier committed
821
  (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
822 823 824 825
    (let ((ov (overlays-in (point-min) (point-max))))
      (while (consp ov)
	(when (flymake-overlay-p (car ov))
	  (delete-overlay (car ov))
826
	  ;;+(flymake-log 3 "deleted overlay %s" ov)
Richard M. Stallman's avatar
Richard M. Stallman committed
827 828
	  )
	(setq ov (cdr ov))))))
Eli Zaretskii's avatar
Eli Zaretskii committed
829

830
(defun flymake-region-has-flymake-overlays (beg end)
Richard M. Stallman's avatar
Richard M. Stallman committed
831
  "Check if region specified by BEG and END has overlay.
832
Return t if it has at least one flymake overlay, nil if no overlay."
Richard M. Stallman's avatar
Richard M. Stallman committed
833 834 835 836 837
  (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
838 839
      (setq ov (cdr ov)))
    has-flymake-overlays))
Eli Zaretskii's avatar
Eli Zaretskii committed
840 841

(defface flymake-errline-face
842 843
  ;;+   '((((class color)) (:foreground "OrangeRed" :bold t :underline t))
  ;;+   '((((class color)) (:underline "OrangeRed"))
Richard M. Stallman's avatar
Richard M. Stallman committed
844 845 846 847
  '((((class color)) (:background "LightPink"))
    (t (:bold t)))
  "Face used for marking error lines."
  :group 'flymake)
Eli Zaretskii's avatar
Eli Zaretskii committed
848 849

(defface flymake-warnline-face
Richard M. Stallman's avatar
Richard M. Stallman committed
850 851 852 853
  '((((class color)) (:background "LightBlue2"))
    (t (:bold t)))
  "Face used for marking warning lines."
  :group 'flymake)
Eli Zaretskii's avatar
Eli Zaretskii committed
854

855
(defun flymake-highlight-line (line-no line-err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
856
  "Highlight line LINE-NO in current buffer.
857
Perhaps use text from LINE-ERR-INFO-ILST to enhance highlighting."
Richard M. Stallman's avatar
Richard M. Stallman committed
858 859 860 861 862 863 864 865 866 867 868
  (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
869

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
878 879 880
    (when (<= end beg)
      (setq beg line-beg)
      (setq end line-end))
881

Richard M. Stallman's avatar
Richard M. Stallman committed
882 883 884 885
    (when (= end beg)
      (goto-char end)
      (forward-line)
      (setq end (point)))
886

Richard M. Stallman's avatar
Richard M. Stallman committed
887 888 889
    (if (> (flymake-get-line-err-count line-err-info-list "e") 0)
	(setq face 'flymake-errline-face)
      (setq face 'flymake-warnline-face))
890

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

893
(defun flymake-parse-err-lines (err-info-list source-buffer lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  "Parse err LINES, store info in ERR-INFO-LIST."
  (let* ((count              (length lines))
	 (idx                0)
	 (line-err-info      nil)
	 (real-file-name     nil)
	 (source-file-name   (buffer-file-name source-buffer))
	 (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
	(setq real-file-name (funcall get-real-file-name-f source-buffer (flymake-ler-get-file line-err-info)))
	(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
916

917
(defun flymake-split-output (output)