flymake.el 74.2 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
(defsubst flymake-makehash (&optional test)
  (if (fboundp 'make-hash-table)
      (if test (make-hash-table :test test) (make-hash-table))
50 51
    (with-no-warnings
      (makehash test))))
Richard M. Stallman's avatar
Richard M. Stallman committed
52

Stefan Monnier's avatar
Stefan Monnier committed
53 54 55 56 57 58
(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
59 60

(defsubst flymake-replace-regexp-in-string (regexp rep str)
Stefan Monnier's avatar
Stefan Monnier committed
61 62 63
  (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
64 65

(defun flymake-split-string (str pattern)
Richard M. Stallman's avatar
Richard M. Stallman committed
66 67
  "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
68 69 70 71 72 73 74
  (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
75
(defsubst flymake-get-temp-dir ()
Stefan Monnier's avatar
Stefan Monnier committed
76
  (if (fboundp 'temp-directory)
Kim F. Storm's avatar
Kim F. Storm committed
77 78
      (temp-directory)
    temporary-file-directory))
Eli Zaretskii's avatar
Eli Zaretskii committed
79

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

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

(defun flymake-popup-menu (pos menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
91 92 93 94 95 96
  "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
97 98 99 100 101 102 103
      (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
104

Richard M. Stallman's avatar
Richard M. Stallman committed
105
(defun flymake-make-emacs-menu (menu-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
106 107 108 109
  "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
110 111 112 113 114 115 116
  (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
117

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

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

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

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

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

;;;; ]]

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

166
(defun flymake-log (level text &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168 169 170 171
  "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
172 173 174 175 176 177 178 179
  (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
	;;)
180
	)))
Eli Zaretskii's avatar
Eli Zaretskii committed
181

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

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

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

197
(defun flymake-reg-names (pid source-buffer-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
198
  "Associate PID with SOURCE-BUFFER-NAME in `flymake-pid-to-names'."
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201
  (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
202

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

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

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

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

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

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

222
(defvar flymake-output-residual nil)
223

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

425
(defun flymake-master-file-compare (file-one file-two)
Richard M. Stallman's avatar
Richard M. Stallman committed
426
  "Compare two files speccified by FILE-ONE and FILE-TWO.
427 428
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
429 430 431
  (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
432 433

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

438
(defun flymake-check-patch-master-file-buffer (master-file-temp-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
439 440 441 442
					       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.
443 444 445 446 447
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
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 475
  (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
476
		    ;; XEmacs with 'last match not a buffer' error as
Richard M. Stallman's avatar
Richard M. Stallman committed
477
		    ;; check-includes calls replace-in-string
478
		    (flymake-replace-region match-beg match-end
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480 481 482
					    (file-name-nondirectory patched-source-file-name))))
		(forward-line 1)))
	    (when found
	      (flymake-save-buffer-in-file (current-buffer) patched-master-file-name)))
483
	;;+(flymake-log 3 "killing buffer %s" (buffer-name master-file-temp-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
484
	(kill-buffer master-file-temp-buffer)))
485
    ;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
Richard M. Stallman's avatar
Richard M. Stallman committed
486 487 488
    (when found
      (flymake-log 2 "found master file %s" master-file-name))
    found))
Eli Zaretskii's avatar
Eli Zaretskii committed
489

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

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

505
(defun flymake-copy-buffer-to-temp-buffer (buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
506 507 508
  "Copy contents of BUFFER into newly created temp buffer."
  (let ((contents     nil)
	(temp-buffer  nil))
Stefan Monnier's avatar
Stefan Monnier committed
509
    (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
510 511 512 513 514 515
      (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
516

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

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

542
(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
543
  "Save SOURCE-FILE-NAME with a different name.
544
Find master file, patch and save it."
Richard M. Stallman's avatar
Richard M. Stallman committed
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 574
  (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
575

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
602 603 604
    (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
605

606
(defun flymake-process-sentinel (process event)
Richard M. Stallman's avatar
Richard M. Stallman committed
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  "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
625
		(with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
626 627 628

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
656 657 658
    (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
659 660
	  (if (not (with-current-buffer source-buffer
		     flymake-check-was-interrupted))
Richard M. Stallman's avatar
Richard M. Stallman committed
661 662 663 664
	      (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
665

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

681
(defun flymake-parse-residual (source-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
682
  "Parse residual if it's non empty."
Stefan Monnier's avatar
Stefan Monnier committed
683
  (with-current-buffer source-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
684 685 686 687 688 689 690
    (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
691 692

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

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

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

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

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

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

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

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

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

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

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

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

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

(defun flymake-ler-set-file (line-err-info file)
Richard M. Stallman's avatar
Richard M. Stallman committed
731
  (flymake-ler-make-ler file
Eli Zaretskii's avatar
Eli Zaretskii committed
732 733 734
			(flymake-ler-get-line line-err-info)
			(flymake-ler-get-type line-err-info)
			(flymake-ler-get-text line-err-info)
735 736 737
			(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
738
  (flymake-ler-make-ler (flymake-ler-get-file line-err-info)
Eli Zaretskii's avatar
Eli Zaretskii committed
739 740 741
			(flymake-ler-get-line line-err-info)
			(flymake-ler-get-type line-err-info)
			(flymake-ler-get-text line-err-info)
742 743 744
			full-file))

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
758 759 760 761 762
    (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
763

764
(defun flymake-get-err-count (err-info-list type)
Richard M. Stallman's avatar
Richard M. Stallman committed
765 766 767 768 769 770 771 772
  "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))
773 774

(defun flymake-fix-line-numbers (err-info-list min-line max-line)
Richard M. Stallman's avatar
Richard M. Stallman committed
775
  "Replace line numbers with fixed value.
776 777
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
778
The reason for this fix is because some compilers might report
779
line number outside the file being compiled."
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781 782 783 784 785 786 787 788 789 790 791 792
  (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
793

794
(defun flymake-highlight-err-lines (buffer err-info-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
795
  "Highlight error lines in BUFFER using info from ERR-INFO-LIST."
Stefan Monnier's avatar
Stefan Monnier committed
796
  (with-current-buffer buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
797 798 799 800 801
    (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
802

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

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

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

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

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

852
(defface flymake-warnline
Richard M. Stallman's avatar
Richard M. Stallman committed
853 854 855 856
  '((((class color)) (:background "LightBlue2"))
    (t (:bold t)))
  "Face used for marking warning lines."
  :group 'flymake)
857 858
;; backward-compatibility alias
(put 'flymake-warnline-face 'face-alias 'flymake-warnline)
Eli Zaretskii's avatar
Eli Zaretskii committed
859

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

Richard M. Stallman's avatar
Richard M. Stallman committed
875
    (setq beg (point))
Eli Zaretskii's avatar
Eli Zaretskii committed
876

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
883 884 885
    (when (<= end beg)
      (setq beg line-beg)
      (setq end line-end))
886

Richard M. Stallman's avatar
Richard M. Stallman committed
887 888 889 890
    (when (= end beg)
      (goto-char end)
      (forward-line)
      (setq end (point)))
891

Richard M. Stallman's avatar
Richard M. Stallman committed
892
    (if (> (flymake-get-line-err-count line-err-info-list "e") 0)
893 894
	(setq face 'flymake-errline)
      (setq face 'flymake-warnline))
895

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

898
(defun flymake-parse-err-lines (err-info-list source-buffer lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
899 900 901 902 903 904 905 906 907 908 909