Mercurial > emacs
changeset 55822:ffbaa3e438cd
New file.
| author | Eli Zaretskii <eliz@gnu.org> |
|---|---|
| date | Sat, 29 May 2004 12:55:24 +0000 |
| parents | e0c7eecbf3a9 |
| children | 9c428c3c87f3 |
| files | lisp/progmodes/flymake.el man/flymake.texi |
| diffstat | 2 files changed, 3270 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lisp/progmodes/flymake.el Sat May 29 12:55:24 2004 +0000 @@ -0,0 +1,2503 @@ +;;; flymake.el -- a universal on-the-fly syntax checker + +;; Copyright (C) 2003 Free Software Foundation + +;; 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: + +;;;_* Provide +(provide 'flymake) + +;;;; [[ Overlay compatibility +(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) +;;;; ]] + +;;;; [[ cross-emacs compatibility routines +(defvar flymake-emacs + (cond + ((string-match "XEmacs" emacs-version) 'xemacs) + (t 'emacs) + ) + "Currently used emacs flavor" +) + +(defun flymake-makehash(&optional test) + (cond + ((equal flymake-emacs 'xemacs) (if test (make-hash-table :test test) (make-hash-table))) + (t (makehash test)) + ) +) + +(defun flymake-time-to-float(&optional tm) + "Convert `current-time` to a float number of seconds." + (multiple-value-bind (s0 s1 s2) (or tm (current-time)) + (+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2))) +) +(defun flymake-float-time() + (cond + ((equal flymake-emacs 'xemacs) (flymake-time-to-float (current-time))) + (t (float-time)) + ) +) + +(defun flymake-replace-regexp-in-string(regexp rep str) + (cond + ((equal flymake-emacs 'xemacs) (replace-in-string str regexp rep)) + (t (replace-regexp-in-string regexp rep str)) + ) +) + +(defun flymake-split-string-remove-empty-edges(str pattern) + "split, then remove first and/or last in case it's empty" + (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 + ) +) +(defun flymake-split-string(str pattern) + (cond + ((equal flymake-emacs 'xemacs) (flymake-split-string-remove-empty-edges str pattern)) + (t (split-string str pattern)) + ) +) + +(defun flymake-get-temp-dir() + (cond + ((equal flymake-emacs 'xemacs) (temp-directory)) + (t temporary-file-directory) + ) +) + +(defun flymake-line-beginning-position() + (save-excursion + (beginning-of-line) + (point) + ) +) + +(defun flymake-line-end-position() + (save-excursion + (end-of-line) + (point) + ) +) + +(defun flymake-popup-menu(pos menu-data) + (cond + ((equal flymake-emacs 'xemacs) + (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)) + ) + ) + (t (x-popup-menu pos (flymake-make-emacs-menu menu-data))) + ) +) + +(defun flymake-make-emacs-menu(menu-data) + (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)) + ) +) + +(defun flymake-nop() +) + +(defun flymake-make-xemacs-menu(menu-data) + (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 + ) +) + +(defun flymake-current-row() + "return current row in current frame" + (cond + ((equal flymake-emacs 'xemacs) (count-lines (window-start) (point))) + (t (+ (car (cdr (window-edges))) (count-lines (window-start) (point)))) + ) +) + +(defun flymake-selected-frame() + (cond + ((equal flymake-emacs 'xemacs) (selected-window)) + (t (selected-frame)) + ) +) + +;;;; ]] + +(defcustom flymake-log-level -1 + "Logging level, only messages with level > flymake-log-level will not be logged +-1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG" + :group 'flymake + :type 'integer +) + +(defun flymake-log(level text &rest args) + "Log a message with optional arguments" + (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 + ;) + ) + ) +) + +(defun flymake-ins-after(list pos val) + "insert val into list after position pos" + (let ((tmp (copy-sequence list))) ; (???) + (setcdr (nthcdr pos tmp) (cons val (nthcdr (1+ pos) tmp))) + tmp + ) +) + +(defun flymake-set-at(list pos val) + "set val at position pos in list" + (let ((tmp (copy-sequence list))) ; (???) + (setcar (nthcdr pos tmp) val) + tmp + ) +) + +(defvar flymake-pid-to-names(flymake-makehash) + "pid -> source buffer name, output file name mapping" +) + +(defun flymake-reg-names(pid source-buffer-name) + "Save into in pid map" + (unless (stringp source-buffer-name) + (error "invalid buffer name") + ) + (puthash pid (list source-buffer-name) flymake-pid-to-names) +) + +(defun flymake-get-source-buffer-name(pid) + "Return buffer name stored in pid map" + (nth 0 (gethash pid flymake-pid-to-names)) +) + +(defun flymake-unreg-names(pid) + "Delete pid->buffer name mapping" + (remhash pid flymake-pid-to-names) +) + +(defun flymake-get-buffer-var(buffer var-name) + "switch to buffer if necessary and return local variable var" + (unless (bufferp buffer) + (error "invalid buffer") + ) + + (if (eq buffer (current-buffer)) + (symbol-value var-name) + ;else + (save-excursion + (set-buffer buffer) + (symbol-value var-name) + ) + ) +) + +(defun flymake-set-buffer-var(buffer var-name var-value) + "switch to buffer if necessary and set local variable var-name to var-value" + (unless (bufferp buffer) + (error "invalid buffer") + ) + + (if (eq buffer (current-buffer)) + (set var-name var-value) + ;else + (save-excursion + (set-buffer buffer) + (set var-name var-value) + ) + ) +) + +(defvar flymake-buffer-data(flymake-makehash) + "data specific to syntax check tool, in name-value pairs" +) +(make-variable-buffer-local 'flymake-buffer-data) +(defun flymake-get-buffer-data(buffer) + (flymake-get-buffer-var buffer 'flymake-buffer-data) +) +(defun flymake-set-buffer-data(buffer data) + (flymake-set-buffer-var buffer 'flymake-buffer-data data) +) +(defun flymake-get-buffer-value(buffer name) + (gethash name (flymake-get-buffer-data buffer)) +) +(defun flymake-set-buffer-value(buffer name value) + (puthash name value (flymake-get-buffer-data buffer)) +) + +(defvar flymake-output-residual nil + "" +) +(make-variable-buffer-local 'flymake-output-residual) +(defun flymake-get-buffer-output-residual(buffer) + (flymake-get-buffer-var buffer 'flymake-output-residual) +) +(defun flymake-set-buffer-output-residual(buffer residual) + (flymake-set-buffer-var buffer 'flymake-output-residual residual) +) + +(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) +; (".+\\.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) + ) + "*Files syntax checking is allowed for" + :group 'flymake + :type '(repeat (string symbol symbol symbol)) +) + +(defun flymake-get-file-name-mode-and-masks(file-name) + "return the corresponding entry from flymake-allowed-file-name-masks" + (unless (stringp file-name) + (error "invalid file-name") + ) + (let ((count (length flymake-allowed-file-name-masks)) + (idx 0) + (mode-and-masks nil)) + (while (and (not mode-and-masks) (< idx count)) + (if (string-match (nth 0 (nth idx flymake-allowed-file-name-masks)) file-name) + (setq mode-and-masks (cdr (nth idx flymake-allowed-file-name-masks))) + ) + (setq idx (1+ idx)) + ) + (flymake-log 3 "file %s, init=%s" file-name (car mode-and-masks)) + mode-and-masks + ) +) + +(defun flymake-can-syntax-check-file(file-name) + "Determine whether we can syntax check file-name: nil if cannot, non-nil if can" + (if (flymake-get-init-function file-name) + t + ;else + nil + ) +) + +(defun flymake-get-init-function(file-name) + "return init function to be used for the file" + (let* ((init-f (nth 0 (flymake-get-file-name-mode-and-masks file-name)))) + ;(flymake-log 0 "calling %s" init-f) + ;(funcall init-f (current-buffer)) + ) + (nth 0 (flymake-get-file-name-mode-and-masks file-name)) +) + +(defun flymake-get-cleanup-function(file-name) + "return cleanup function to be used for the file" + (nth 1 (flymake-get-file-name-mode-and-masks file-name)) +) + +(defun flymake-get-real-file-name-function(file-name) + "" + (or (nth 2 (flymake-get-file-name-mode-and-masks file-name)) 'flymake-get-real-file-name) +) + +(defcustom flymake-buildfile-dirs '("." ".." "../.." "../../.." "../../../.." "../../../../.." "../../../../../.." "../../../../../../.." "../../../../../../../.." "../../../../../../../../.." "../../../../../../../../../.." "../../../../../../../../../../..") + "dirs to look for buildfile" + :group 'flymake + :type '(repeat (string)) +) + +(defvar flymake-find-buildfile-cache (flymake-makehash 'equal)) +(defun flymake-get-buildfile-from-cache(dir-name) + (gethash dir-name flymake-find-buildfile-cache) +) +(defun flymake-add-buildfile-to-cache(dir-name buildfile) + (puthash dir-name buildfile flymake-find-buildfile-cache) +) +(defun flymake-clear-buildfile-cache() + (clrhash flymake-find-buildfile-cache) +) + +(defun flymake-find-buildfile(buildfile-name source-dir-name dirs) + "find buildfile (i.e. Makefile, build.xml, etc.) starting from current directory. Return its path or nil if not found" + (if (flymake-get-buildfile-from-cache source-dir-name) + (progn + (flymake-get-buildfile-from-cache source-dir-name) + ) + ;else + (let* ((buildfile-dir nil) + (buildfile nil) + (dir-count (length dirs)) + (dir-idx 0) + (found nil)) + + (while (and (not found) (< dir-idx dir-count)) + + (setq buildfile-dir (concat source-dir-name (nth dir-idx dirs))) + (setq buildfile (concat buildfile-dir "/" buildfile-name)) + + (when (file-exists-p buildfile) + (setq found t) + ) + + (setq dir-idx (1+ dir-idx)) + ) + (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 + ) + ;else + (progn + (flymake-log 3 "buildfile for %s not found" source-dir-name) + nil + ) + ) + ) + ) +) + +(defun flymake-fix-path-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 + ) + ) +) + +(defun flymake-same-files(file-name-one file-name-two) + "t if file-name-one and file-name-two actually point to the same file" + (equal (flymake-fix-path-name file-name-one) (flymake-fix-path-name file-name-two)) +) + +(defun flymake-ensure-ends-with-slash(path) + (if (not (= (elt path (1- (length path))) (string-to-char "/"))) + (concat path "/") + ;else + path + ) +) + +(defun flymake-get-common-path-prefix(string-one string-two) + "return common prefix for two paths" + (when (and string-one string-two) + (let* ((slash-pos-one -1) + (slash-pos-two -1) + (done nil) + (prefix nil)) + + (setq string-one (flymake-ensure-ends-with-slash string-one)) + (setq string-two (flymake-ensure-ends-with-slash string-two)) + + (while (not done) + (setq slash-pos-one (string-match "/" string-one (1+ slash-pos-one))) + (setq slash-pos-two (string-match "/" string-two (1+ slash-pos-two))) + + (if (and slash-pos-one slash-pos-two + (= slash-pos-one slash-pos-two) + (string= (substring string-one 0 slash-pos-one) (substring string-two 0 slash-pos-two))) + (progn + (setq prefix (substring string-one 0 (1+ slash-pos-one))) + ) + ;else + (setq done t) + ) + ) + prefix + ) + ) +) + +(defun flymake-build-relative-path(from-dir to-dir) + "return rel: from-dir/rel == to-dir" + (if (not (equal (elt from-dir 0) (elt to-dir 0))) + (error "first chars in paths %s, %s must be equal (same drive)" from-dir to-dir) + ;else + (let* ((from (flymake-ensure-ends-with-slash (flymake-fix-path-name from-dir))) + (to (flymake-ensure-ends-with-slash (flymake-fix-path-name to-dir))) + (prefix (flymake-get-common-path-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 "./") + ) + ) +) + +(defcustom flymake-master-file-dirs '("." "./src" "./UnitTest") + "dirs where to llok for master files" + :group 'flymake + :type '(repeat (string)) +) + +(defcustom flymake-master-file-count-limit 32 + "max number of master files to check" + :group 'flymake + :type 'integer +) + +(defun flymake-find-possible-master-files(file-name master-file-dirs masks) + "find (by name and location) all posible master files, which are .cpp and .c for and .h. +Files are searched for starting from the .h directory and max max-level parent dirs. +File contents are not checked." + (let* ((dir-idx 0) + (dir-count (length master-file-dirs)) + (files nil) + (done nil) + (masks-count (length masks))) + + (while (and (not done) (< dir-idx dir-count)) + (let* ((dir (concat (flymake-fix-path-name (file-name-directory file-name)) "/" (nth dir-idx master-file-dirs))) + (masks-idx 0)) + (while (and (file-exists-p dir) (not done) (< masks-idx masks-count)) + (let* ((mask (nth masks-idx masks)) + (dir-files (directory-files dir t mask)) + (file-count (length dir-files)) + (file-idx 0)) + + (flymake-log 3 "dir %s, %d file(s) for mask %s" dir file-count mask) + (while (and (not done) (< file-idx file-count)) + (when (not (file-directory-p (nth file-idx dir-files))) + (setq files (cons (nth file-idx dir-files) files)) + (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) + ) + ) + (setq file-idx (1+ file-idx)) + ) + ) + (setq masks-idx (1+ masks-idx)) + ) + ) + (setq dir-idx (1+ dir-idx)) + ) + (when files + (setq flymake-included-file-name (file-name-nondirectory file-name)) + (setq files (sort files 'flymake-master-file-compare)) + (setq flymake-included-file-name nil) + ) + (flymake-log 3 "found %d possible master file(s)" (length files)) + files + ) +) + +(defvar flymake-included-file-name nil ; this is used to pass a parameter to a sort predicate below + "" +) + +(defun flymake-master-file-compare(file-one file-two) + "used in sort to move most possible file names to the beginning of the list (File.h -> File.cpp moved to top" + (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)) + ) +) + +(defcustom flymake-check-file-limit 8192 + "max number of chars to look at when checking possible master file" + :group 'flymake + :type 'integer +) + +(defun flymake-check-patch-master-file-buffer(master-file-temp-buffer + master-file-name patched-master-file-name + source-file-name patched-source-file-name + include-dirs regexp-list) + "check whether master-file-name is indeed a master file for source-file-name. +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. +Whenether a buffer for master-file-name exists, use it as a source instead of reading master file from disk" + (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 xemacs with + ; 'last match not a buffer' error as check-includes calls replace-in-string + (flymake-replace-region (current-buffer) match-beg match-end + (file-name-nondirectory patched-source-file-name)) + ) + ) + (forward-line 1) + ) + ) + (when found + (flymake-save-buffer-in-file (current-buffer) patched-master-file-name) + ) + ) + ;+(flymake-log 3 "killing buffer %s" (buffer-name master-file-temp-buffer)) + (kill-buffer master-file-temp-buffer) + ) + ) + ;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found) + (when found + (flymake-log 2 "found master file %s" master-file-name) + ) + found + ) +) + +(defun flymake-replace-region(buffer beg end rep) + "replace text in buffer in region (beg; end) with rep" + (save-excursion + (delete-region beg end) + (goto-char beg) + (insert rep) + ) +) + +(defun flymake-read-file-to-temp-buffer(file-name) + "isert 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)))))) + (save-excursion + (set-buffer temp-buffer) + (insert-file-contents file-name) + ) + temp-buffer + ) +) + +(defun flymake-copy-buffer-to-temp-buffer(buffer) + "copy contents of buffer into newly created temp buffer" + (let ((contents nil) + (temp-buffer nil)) + (save-excursion + (set-buffer buffer) + (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 + ) +) + +(defun flymake-check-include(source-file-name inc-path inc-name include-dirs) + "t if source-file-name is the one found via include dirs using inc-path and inc-name" + (if (file-name-absolute-p inc-path) + (flymake-same-files source-file-name (concat inc-path "/" inc-name)) + ;else + (let* ((count (length include-dirs)) + (idx 0) + (file-name nil) + (found nil)) + (while (and (not found) (< idx count)) + (setq file-name (concat (file-name-directory source-file-name) "/" (nth idx include-dirs))) + (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) + ) + (setq idx (1+ idx)) + ) + found + ) + ) +) + +(defun flymake-find-buffer-for-file(file-name) + "buffer if there exists a buffer visiting file-name, nil otherwise" + (let ((buffer-name (get-file-buffer file-name))) + (if buffer-name + (get-buffer buffer-name) + ) + ) +) + +(defun flymake-create-master-file(source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp-list) + "save source-file-name with a different name, find master file, patch it and save it to." + (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))) + ;else + (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) + ;else + (progn + (flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count + (file-name-nondirectory source-file-name)) + nil + ) + ) + ) +) + +(defun flymake-save-buffer-in-file(buffer file-name) + (or buffer + (error "invalid buffer") + ) + (save-excursion + (save-restriction + (set-buffer buffer) + (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) +) + +(defun flymake-save-string-to-file(file-name data) + "save string data to file file-name" + (write-region data nil file-name nil 566) +) + +(defun flymake-read-file-to-string(file-name) + "read file contents and return them as a string" + (with-temp-buffer + (insert-file-contents file-name) + (buffer-substring (point-min) (point-max)) + ) +) + +(defun flymake-process-filter(process output) + "flymake process filter: parse output, highlight err lines" + (let* ((pid (process-id process)) + (source-buffer (get-buffer (flymake-get-source-buffer-name pid)))) + + (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) + ) + ) +) + +(defun flymake-process-sentinel(process event) + "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 + (save-excursion + (set-buffer source-buffer) + + (flymake-parse-residual source-buffer) + (flymake-post-syntax-check source-buffer) + (flymake-set-buffer-is-running source-buffer nil) + ) + ) + ) + (error + (let ((err-str (format "Error in process sentinel for buffer %s: %s" + source-buffer (error-message-string err)))) + (flymake-log 0 err-str) + (flymake-set-buffer-is-running source-buffer nil) + ) + ) + ) + ) + ) +) + +(defun flymake-post-syntax-check(source-buffer) + "" + (flymake-set-buffer-err-info source-buffer (flymake-get-buffer-new-err-info source-buffer)) + (flymake-set-buffer-new-err-info source-buffer nil) + + (flymake-set-buffer-err-info source-buffer (flymake-fix-line-numbers + (flymake-get-buffer-err-info source-buffer) + 1 + (flymake-count-lines source-buffer))) + (flymake-delete-own-overlays source-buffer) + (flymake-highlight-err-lines source-buffer (flymake-get-buffer-err-info source-buffer)) + + (let ((err-count (flymake-get-err-count (flymake-get-buffer-err-info source-buffer) "e")) + (warn-count (flymake-get-err-count (flymake-get-buffer-err-info source-buffer) "w"))) + + (flymake-log 2 "%s: %d error(s), %d warning(s) in %.2f second(s)" + (buffer-name source-buffer) err-count warn-count + (- (flymake-float-time) (flymake-get-buffer-check-start-time source-buffer))) + (flymake-set-buffer-check-start-time source-buffer nil) + (if (and (equal 0 err-count) (equal 0 warn-count)) + (if (equal 0 exit-status) + (flymake-report-status source-buffer "" "") ; PASSED + ;else + (if (not (flymake-get-buffer-check-was-interrupted source-buffer)) + (flymake-report-fatal-status (current-buffer) "CFGERR" + (format "Configuration error has occured while running %s" command)) + ;else + (flymake-report-status source-buffer nil "") ; "STOPPED" + ) + ) + ;else + (flymake-report-status source-buffer (format "%d/%d" err-count warn-count) "") + ) + ) +) + +(defun flymake-parse-output-and-residual(source-buffer output) + "split output into lines, merge in residual if necessary" + (save-excursion + (set-buffer source-buffer) + (let* ((buffer-residual (flymake-get-buffer-output-residual source-buffer)) + (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))) + + (flymake-set-buffer-output-residual source-buffer new-residual) + (flymake-set-buffer-new-err-info source-buffer (flymake-parse-err-lines + (flymake-get-buffer-new-err-info source-buffer) + source-buffer lines)) + ) + ) +) + +(defun flymake-parse-residual(source-buffer) + "parse residual if it's non empty" + (save-excursion + (set-buffer source-buffer) + (when (flymake-get-buffer-output-residual source-buffer) + (flymake-set-buffer-new-err-info source-buffer (flymake-parse-err-lines + (flymake-get-buffer-new-err-info source-buffer) + source-buffer + (list (flymake-get-buffer-output-residual source-buffer)))) + (flymake-set-buffer-output-residual source-buffer nil) + ) + ) +) + +(defvar flymake-err-info nil + "sorted list of line numbers and lists of err info in the form (file, err-text)." +) +(make-variable-buffer-local 'flymake-err-info) +(defun flymake-get-buffer-err-info(buffer) + (flymake-get-buffer-var buffer 'flymake-err-info) +) +(defun flymake-set-buffer-err-info(buffer err-info) + (flymake-set-buffer-var buffer 'flymake-err-info err-info) +) +(defun flymake-er-make-er(line-no line-err-info-list) + (list line-no line-err-info-list) +) +(defun flymake-er-get-line(err-info) + (nth 0 err-info) +) +(defun flymake-er-get-line-err-info-list(err-info) + (nth 1 err-info) +) + +(defvar flymake-new-err-info nil + "the same as flymake -err-info, effective when a syntax check is in progress" +) +(make-variable-buffer-local 'flymake-new-err-info) +(defun flymake-get-buffer-new-err-info(buffer) + (flymake-get-buffer-var buffer 'flymake-new-err-info) +) +(defun flymake-set-buffer-new-err-info(buffer new-err-info) + (flymake-set-buffer-var buffer 'flymake-new-err-info new-err-info) +) + +;; getters/setters for line-err-info: (file, line, type, text). +(defun flymake-ler-make-ler(file line type text &optional full-file) + (list file line type text full-file) +) +(defun flymake-ler-get-file(line-err-info) + (nth 0 line-err-info) +) +(defun flymake-ler-get-line(line-err-info) + (nth 1 line-err-info) +) +(defun flymake-ler-get-type(line-err-info) + (nth 2 line-err-info) +) +(defun flymake-ler-get-text(line-err-info) + (nth 3 line-err-info) +) +(defun flymake-ler-get-full-file(line-err-info) + (nth 4 line-err-info) +) +(defun flymake-ler-set-file(line-err-info file) + (flymake-ler-make-ler file + (flymake-ler-get-line line-err-info) + (flymake-ler-get-type line-err-info) + (flymake-ler-get-text line-err-info) + (flymake-ler-get-full-file line-err-info)) +) +(defun flymake-ler-set-full-file(line-err-info full-file) + (flymake-ler-make-ler (flymake-ler-get-file line-err-info) + (flymake-ler-get-line line-err-info) + (flymake-ler-get-type line-err-info) + (flymake-ler-get-text line-err-info) + full-file) +) +(defun flymake-ler-set-line(line-err-info line) + (flymake-ler-make-ler (flymake-ler-get-file line-err-info) + line + (flymake-ler-get-type line-err-info) + (flymake-ler-get-text line-err-info) + (flymake-ler-get-full-file line-err-info)) +) + +(defun flymake-get-line-err-count(line-err-info-list type) + "return number of errors of specified type - e or w" + (let* ((idx 0) + (count (length line-err-info-list)) + (err-count 0)) + + (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 + ) +) + +(defun flymake-get-err-count(err-info-list type) + "return number of errors of specified type for the 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 + ) +) + +(defun flymake-fix-line-numbers(err-info-list min-line max-line) + "replace line-numbers < min-line with min-line and > max-line with max-line - as some compilers might report line number outside the file being compiled" + (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 +) + +(defun flymake-highlight-err-lines(buffer err-info-list) + "highlight err-lines in buffer using info from err-info-list" + (save-excursion + (set-buffer buffer) + (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)) + ) + ) + ) +) + +(defun flymake-overlay-p(ov) + "Determine whether overlay was created by flymake" + (and (overlayp ov) (overlay-get ov 'flymake-overlay)) +) + +(defun flymake-make-overlay(beg end tooltip-text face mouse-face) + "Allocate a flymake overlay in range beg 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) + ;+(flymake-log 3 "created overlay %s" ov) + ov + ) + (flymake-log 3 "created an overlay at (%d-%d)" beg end) + ) +) + +(defun flymake-delete-own-overlays(buffer) + "Delete all flymake overlays in buffer" + (save-excursion + (set-buffer buffer) + (let ((ov (overlays-in (point-min) (point-max)))) + (while (consp ov) + (when (flymake-overlay-p (car ov)) + (delete-overlay (car ov)) + ;+(flymake-log 3 "deleted overlay %s" ov) + ) + (setq ov (cdr ov)) + ) + ) + ) +) + +(defun flymake-region-has-flymake-overlays(beg end) + "t if specified regions has at least one flymake overlay, nil otrherwise" + (let ((ov (overlays-in beg end)) + (has-flymake-overlays nil)) + (while (consp ov) + (when (flymake-overlay-p (car ov)) + (setq has-flymake-overlays t) + ) + (setq ov (cdr ov)) + ) + ) +) + +(defface flymake-errline-face +;+ '((((class color)) (:foreground "OrangeRed" :bold t :underline t)) +;+ '((((class color)) (:underline "OrangeRed")) + '((((class color)) (:background "LightPink")) + (t (:bold t))) + "Face used for marking error lines" + :group 'flymake +) + +(defface flymake-warnline-face + '((((class color)) (:background "LightBlue2")) + (t (:bold t))) + "Face used for marking warning lines" + :group 'flymake +) + + +(defun flymake-highlight-line(line-no line-err-info-list) + "highlight line line-no in current buffer, perhaps use text from line-err-info-list to enhance highlighting" + (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) + ) + + (setq beg (point)) + + (goto-char line-end) + (while (and (looking-at "[ \t\r\n]") (> (point) 1)) + (backward-char) + ) + + (setq end (1+ (point))) + + (when (<= end beg) + (setq beg line-beg) + (setq end line-end) + ) + (when (= end beg) + (goto-char end) + (forward-line) + (setq end (point)) + ) + (if (> (flymake-get-line-err-count line-err-info-list "e") 0) + (setq face 'flymake-errline-face) + ;else + (setq face 'flymake-warnline-face) + ) + (flymake-make-overlay beg end tooltip-text face nil) + ) +) + +(defun flymake-parse-err-lines(err-info-list source-buffer lines) + "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)) + ;else + (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 + ) +) + +(defun flymake-split-output(output) + "split output into lines, return last one as residual if it does not end with newline char. Returns ((lines) residual)" + (when (and output (> (length output) 0)) + (let* ((lines (flymake-split-string output "[\n\r]+")) + (complete (equal "\n" (char-to-string (aref output (1- (length output)))))) + (residual nil)) + (when (not complete) + (setq residual (car (last lines))) + (setq lines (butlast lines)) + ) + (list lines residual) + ) + ) +) + +(eval-when-compile (require 'compile)) +(defvar flymake-err-line-patterns ; regexp file-idx line-idx col-idx (optional) text-idx(optional), match-end to end of string is error text + (append + '( + ; MS Visual C++ 6.0 + ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)" + 1 3 nil 4) + ; jikes + ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\|Semantic Error\\):[ \t\n]*\\(.+\\)\\)" + 1 3 nil 4) + ; MS midl + ("midl[ ]*:[ ]*\\(command line error .*\\)" + nil nil nil 1) + ; MS C# + ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\),[0-9]+)\: \\(\\(error\\|warning\\|fatal error\\) \\(CS[0-9]+\\):[ \t\n]*\\(.+\\)\\)" + 1 3 nil 4) + ; perl + ("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 2 3 nil 1) + ; LaTeX warnings (fileless) ("\\(LaTeX \\(Warning\\|Error\\): .*\\) on input line \\([0-9]+\\)" 20 3 nil 1) + ; ant/javac + (" *\\(\\[javac\\]\\)? *\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[ \t\n]*\\(.+\\)" + 2 4 nil 5) + ) + compilation-error-regexp-alist) + "patterns for matching error/warning lines, (regexp file-idx line-idx err-text-idx)" +) +;(defcustom flymake-err-line-patterns +; '( +; ; MS Visual C++ 6.0 +; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \: \\(\\(error\\|warning\\|fatal error\\) \\(C[0-9]+\\):[ \t\n]*\\(.+\\)\\)" +; 1 3 4) +; ; jikes +; ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)\:\\([0-9]+\\)\:[0-9]+\:[0-9]+\:[0-9]+\: \\(\\(Error\\|Warning\\|Caution\\):[ \t\n]*\\(.+\\)\\)" +; 1 3 4)) +; "patterns for matching error/warning lines, (regexp file-idx line-idx err-text-idx)" +; :group 'flymake +; :type '(repeat (string number number number)) +;) + +(defun flymake-parse-line(line) + "parse line to see whether it's an error of warning, return it's components or nil for no match" + (let ((raw-file-name nil) + (line-no 0) + (err-type "e") + (err-text nil) + (count (length flymake-err-line-patterns)) + (idx 0) + (matched nil)) + (while (and (< idx count) (not matched)) + (when (string-match (car (nth idx flymake-err-line-patterns)) line) + (let* ((file-idx (nth 1 (nth idx flymake-err-line-patterns))) + (line-idx (nth 2 (nth idx flymake-err-line-patterns)))) + + (setq raw-file-name (if file-idx (match-string file-idx line) nil)) + (setq line-no (if line-idx (string-to-int (match-string line-idx line)) 0)) + (setq err-text (if (> (length (nth idx flymake-err-line-patterns)) 4) + (match-string (nth 4 (nth idx flymake-err-line-patterns)) line) + (flymake-patch-err-text (substring line (match-end 0))))) + (or err-text (setq err-text "<no error text>")) + (if (and err-text (string-match "^[wW]arning" err-text)) + (setq err-type "w") + ) + (flymake-log 3 "parse line: file-idx=%s line-idx=%s file=%s line=%s text=%s" file-idx line-idx + raw-file-name line-no err-text) + (setq matched t) + ) + ) + (setq idx (1+ idx)) + ) + (if matched + (flymake-ler-make-ler raw-file-name line-no err-type err-text) + ; else + () + ) + ) +) + +(defun flymake-find-err-info(err-info-list line-no) + "find (line-err-info-list pos) for specified line-no" + (if err-info-list + (let* ((line-err-info-list nil) + (pos 0) + (count (length err-info-list))) + + (while (and (< pos count) (< (car (nth pos err-info-list)) line-no)) + (setq pos (1+ pos)) + ) + (when (and (< pos count) (equal (car (nth pos err-info-list)) line-no)) + (setq line-err-info-list (flymake-er-get-line-err-info-list (nth pos err-info-list))) + ) + (list line-err-info-list pos) + ) + ;else + '(nil 0) + ) +) + +(defun flymake-line-err-info-is-less-or-equal(line-one line-two) + (or (string< (flymake-ler-get-type line-one) (flymake-ler-get-type line-two)) + (and (string= (flymake-ler-get-type line-one) (flymake-ler-get-type line-two)) + (not (flymake-ler-get-file line-one)) (flymake-ler-get-file line-two) + ) + (and (string= (flymake-ler-get-type line-one) (flymake-ler-get-type line-two)) + (or (and (flymake-ler-get-file line-one) (flymake-ler-get-file line-two)) + (and (not (flymake-ler-get-file line-one)) (not (flymake-ler-get-file line-two))) + ) + ) + ) +) + +(defun flymake-add-line-err-info(line-err-info-list line-err-info) + "insert new err info favoring sorting: err-type e/w, filename nil/non-nill" + (if (not line-err-info-list) + (list line-err-info) + ;else + (let* ((count (length line-err-info-list)) + (idx 0)) + (while (and (< idx count) (flymake-line-err-info-is-less-or-equal (nth idx line-err-info-list) line-err-info)) + (setq idx (1+ idx)) + ) + (cond ((equal 0 idx) (setq line-err-info-list (cons line-err-info line-err-info-list))) + (t (setq line-err-info-list (flymake-ins-after line-err-info-list (1- idx) line-err-info))) + ) + line-err-info-list + ) + ) +) + +(defun flymake-add-err-info(err-info-list line-err-info) + "add error info (file line type text) to err info list preserving sort order" + (let* ((count (length err-info-list)) + (line-no (if (flymake-ler-get-file line-err-info) 1 (flymake-ler-get-line line-err-info))) + (info-and-pos (flymake-find-err-info err-info-list line-no)) + (exists (car info-and-pos)) + (pos (nth 1 info-and-pos)) + (line-err-info-list nil) + (err-info nil)) + + (if exists + (setq line-err-info-list (flymake-er-get-line-err-info-list (car (nthcdr pos err-info-list)))) + ) + (setq line-err-info-list (flymake-add-line-err-info line-err-info-list line-err-info)) + + (setq err-info (flymake-er-make-er line-no line-err-info-list)) + (cond (exists (setq err-info-list (flymake-set-at err-info-list pos err-info))) + ((equal 0 pos) (setq err-info-list (cons err-info err-info-list))) + (t (setq err-info-list (flymake-ins-after err-info-list (1- pos) err-info))) + ) + err-info-list + ) +) + +(defun flymake-get-project-include-dirs-imp(basedir) + "include dirs for the project current file belongs to" + (if (flymake-get-project-include-dirs-from-cache basedir) + (progn + (flymake-get-project-include-dirs-from-cache basedir) + ) + ;else + (let* ((command-line (concat "make -C\"" basedir "\" DUMPVARS=INCLUDE_DIRS dumpvars")) + (output (shell-command-to-string command-line)) + (lines (flymake-split-string output "\n")) + (count (length lines)) + (idx 0) + (inc-dirs nil)) + (while (and (< idx count) (not (string-match "^INCLUDE_DIRS=.*" (nth idx lines)))) + (setq idx (1+ idx)) + ) + (when (< idx count) + (let* ((inc-lines (flymake-split-string (nth idx lines) " *-I")) + (inc-count (length inc-lines))) + (while (> inc-count 0) + (when (not (string-match "^INCLUDE_DIRS=.*" (nth (1- inc-count) inc-lines))) + (setq inc-dirs (cons (flymake-replace-regexp-in-string "\"" "" (nth (1- inc-count) inc-lines)) inc-dirs)) + ) + (setq inc-count (1- inc-count)) + ) + ) + ) + (flymake-add-project-include-dirs-to-cache basedir inc-dirs) + inc-dirs + ) + ) +) + +(defcustom flymake-get-project-include-dirs-function 'flymake-get-project-include-dirs-imp + "function used to get project inc dirs, one paramater: basedir name" + :group 'flymake + :type 'function +) + +(defun flymake-get-project-include-dirs(basedir) + (funcall flymake-get-project-include-dirs-function basedir) +) + +(defun flymake-get-system-include-dirs() + "system include dirs - from the 'INCLUDE' env setting" + (let* ((includes (getenv "INCLUDE"))) + (if includes (flymake-split-string includes path-separator) nil) + ) +) + +(defvar flymake-project-include-dirs-cache (flymake-makehash 'equal)) +(defun flymake-get-project-include-dirs-from-cache(base-dir) + (gethash base-dir flymake-project-include-dirs-cache) +) +(defun flymake-add-project-include-dirs-to-cache(base-dir include-dirs) + (puthash base-dir include-dirs flymake-project-include-dirs-cache) +) +(defun flymake-clear-project-include-dirs-cache() + (clrhash flymake-project-include-dirs-cache) +) + +(defun flymake-get-include-dirs(base-dir) + "dirs to use when resolving local filenames" + (let* ((include-dirs (append '(".") (flymake-get-project-include-dirs base-dir) (flymake-get-system-include-dirs)))) + include-dirs + ) +) + +(defun flymake-find-file(rel-file-name include-dirs) + "iterate through include-dirs, return first 'include-dir/rel-file-name' that exists, or just rel-file-name if not" + (let* ((count (length include-dirs)) + (idx 0) + (found nil) + (full-file-name rel-file-name)) + + (while (and (not found) (< idx count)) + (let* ((dir (nth idx include-dirs))) + (setq full-file-name (concat dir "/" rel-file-name)) + (when (file-exists-p full-file-name) + (setq done t) + ) + ) + (setq idx (1+ idx)) + ) + (if found + full-file-name + ;else + rel-file-name + ) + ) +) + +(defun flymake-restore-formatting(source-buffer) + "Remove any formatting made by flymake" +) + +(defun flymake-get-program-dir(buffer) + "dir to start profram in" + (unless (bufferp buffer) + (error "invlid buffer") + ) + (save-excursion + (set-buffer buffer) + default-directory + ) +) + +(defun flymake-safe-delete-file(file-name) + (when (and file-name (file-exists-p file-name)) + (delete-file file-name) + (flymake-log 1 "deleted file %s" file-name) + ) +) + +(defun flymake-safe-delete-directory(dir-name) + (condition-case err + (progn + (delete-directory dir-name) + (flymake-log 1 "deleted dir %s" dir-name) + ) + (error + (flymake-log 1 "failed to delete dir %s, error ignored" dir-name) + ) + ) +) + +(defcustom flymake-compilation-prevents-syntax-check t + "if non-nil, syntax check won't be started in case compilation is running" + :group 'flymake + :type 'boolean +) + +(defun flymake-start-syntax-check(buffer) + "start syntax checking for buffer" + (unless (bufferp buffer) + (error "expected a buffer") + ) + (save-excursion + (set-buffer buffer) + (flymake-log 3 "flymake is running: %s" (flymake-get-buffer-is-running buffer)) + (when (and (not (flymake-get-buffer-is-running buffer)) + (flymake-can-syntax-check-file (buffer-file-name buffer))) + (when (or (not flymake-compilation-prevents-syntax-check) + (not (flymake-compilation-is-running))) ;+ (flymake-rep-ort-status buffer "COMP") + (flymake-clear-buildfile-cache) + (flymake-clear-project-include-dirs-cache) + + (flymake-set-buffer-check-was-interrupted buffer nil) + (flymake-set-buffer-data buffer (flymake-makehash 'equal)) + + (let* ((source-file-name (buffer-file-name buffer)) + (init-f (flymake-get-init-function source-file-name)) + (cleanup-f (flymake-get-cleanup-function source-file-name)) + (cmd-and-args (funcall init-f buffer)) + (cmd (nth 0 cmd-and-args)) + (args (nth 1 cmd-and-args)) + (dir (nth 2 cmd-and-args))) + (if (not cmd-and-args) + (progn + (flymake-log 0 "init function %s for %s failed, cleaning up" init-f source-file-name) + (funcall cleanup-f buffer) + ) + ;else + (progn + (flymake-set-buffer-last-change-time buffer nil) + (flymake-start-syntax-check-process buffer cmd args dir) + ) + ) + ) + ) + ) + ) +) + +(defun flymake-start-syntax-check-process(buffer cmd args dir) + "start syntax check-process" + + (let* ((process nil)) + (condition-case err + (progn + (when dir + (let ((default-directory dir)) + (flymake-log 3 "starting process on dir %s" default-directory) + ) + ) + (setq process (get-process (apply 'start-process "flymake-proc" nil cmd args))) + (set-process-sentinel process 'flymake-process-sentinel) + (set-process-filter process 'flymake-process-filter) + + (flymake-reg-names (process-id process) (buffer-name buffer)) + + (flymake-set-buffer-is-running buffer t) + (flymake-set-buffer-last-change-time buffer nil) + (flymake-set-buffer-check-start-time buffer (flymake-float-time)) + + (flymake-report-status buffer nil "*") + (flymake-log 2 "started process %d, command=%s, dir=%s" + (process-id process) (process-command process) default-directory) + process + ) + (error + (let ((err-str (format "Failed to launch syntax check process '%s' with args %s: %s" + cmd args (error-message-string err))) + (source-file-name (buffer-file-name buffer)) + (cleanup-f (flymake-get-cleanup-function source-file-name))) + (flymake-log 0 err-str) + (funcall cleanup-f buffer) + (flymake-report-fatal-status buffer "PROCERR" err-str) + ) + ) + ) + ) +) + +(defun flymake-kill-process(pid &optional rest) + "kill process pid" + (signal-process pid 9) + (let* ((buffer-name (flymake-get-source-buffer-name pid))) + (when (and buffer-name (get-buffer buffer-name)) + (flymake-set-buffer-check-was-interrupted (get-buffer buffer-name) t) + ) + ) + (flymake-log 1 "killed process %d" pid) +) + +(defun flymake-stop-all-syntax-checks() + "kill all syntax check processes" + (interactive) + (let ((pids (copy-hash-table flymake-pid-to-names))) + (maphash 'flymake-kill-process pids) + ) +) + +(defun flymake-compilation-is-running() + (and (boundp 'compilation-in-progress) + compilation-in-progress) +) + +(defun flymake-compile() + "kill all flymake syntax checks, start compilation" + (interactive) + (flymake-stop-all-syntax-checks) + (call-interactively 'compile) +) + +(defvar flymake-is-running nil + "t if flymake syntax check process is running for the current buffer" +) +(make-variable-buffer-local 'flymake-is-running) +(defun flymake-get-buffer-is-running(buffer) + (flymake-get-buffer-var buffer 'flymake-is-running) +) +(defun flymake-set-buffer-is-running(buffer is-running) + (flymake-set-buffer-var buffer 'flymake-is-running is-running) +) + +(defvar flymake-timer nil + "timer for starting syntax checks" +) +(make-variable-buffer-local 'flymake-timer) +(defun flymake-get-buffer-timer(buffer) + (flymake-get-buffer-var buffer 'flymake-timer) +) +(defun flymake-set-buffer-timer(buffer timer) + (flymake-set-buffer-var buffer 'flymake-timer timer) +) + +(defvar flymake-last-change-time nil + "time of last buffer change" +) +(make-variable-buffer-local 'flymake-last-change-time) +(defun flymake-get-buffer-last-change-time(buffer) + (flymake-get-buffer-var buffer 'flymake-last-change-time) +) +(defun flymake-set-buffer-last-change-time(buffer change-time) + (flymake-set-buffer-var buffer 'flymake-last-change-time change-time) +) + +(defvar flymake-check-start-time nil + "time at which syntax check was started") +(make-variable-buffer-local 'flymake-check-start-time) +(defun flymake-get-buffer-check-start-time(buffer) + (flymake-get-buffer-var buffer 'flymake-check-start-time) +) +(defun flymake-set-buffer-check-start-time(buffer check-start-time) + (flymake-set-buffer-var buffer 'flymake-check-start-time check-start-time) +) + +(defvar flymake-check-was-interrupted nil + "t if syntax check was killed by flymake-compile" +) +(make-variable-buffer-local 'flymake-check-was-interrupted) +(defun flymake-get-buffer-check-was-interrupted(buffer) + (flymake-get-buffer-var buffer 'flymake-check-was-interrupted) +) +(defun flymake-set-buffer-check-was-interrupted(buffer interrupted) + (flymake-set-buffer-var buffer 'flymake-check-was-interrupted interrupted) +) + +(defcustom flymake-no-changes-timeout 0.5 + "time to wait after last change before starting compilation" + :group 'flymake + :type 'number +) + +(defun flymake-on-timer-event(buffer) + "start a syntax check for buffer if necessary" + ;+(flymake-log 3 "timer: running=%s, time=%s, cur-time=%s" (flymake-get-buffer-is-running buffer) (flymake-get-buffer-last-change-time buffer) (flymake-float-time)) + + (when (and (bufferp buffer) (not (flymake-get-buffer-is-running buffer))) + (save-excursion + (set-buffer buffer) + (when (and (flymake-get-buffer-last-change-time buffer) + (> (flymake-float-time) (+ flymake-no-changes-timeout (flymake-get-buffer-last-change-time buffer)))) + (flymake-set-buffer-last-change-time buffer nil) + (flymake-log 3 "starting syntax check as more than 1 second passed since last change") + (flymake-start-syntax-check buffer) + ) + ) + ) +) + +(defun flymake-start-syntax-check-for-current-buffer() + "run flymake-start-syntax-check for current buffer if it isn't already running" + (interactive) + (flymake-start-syntax-check (current-buffer)) +) + +(defun flymake-current-line-no() + "return number of current line in current buffer" + (interactive) + (let ((beg (point-min)) + (end (if (= (point) (point-max)) (point) (1+ (point))))) + (count-lines beg end) + ) +) + +(defun flymake-get-line-count(buffer) + "return number of lines in buffer" + (unless (bufferp buffer) + (error "invalid buffer") + ) + (save-excursion + (set-buffer buffer) + (count-lines (point-min) (point-max)) + ) +) + +(defun flymake-count-lines(buffer) + "return number of lines in buffer" + (save-excursion + (set-buffer buffer) + (count-lines (point-min) (point-max)) + ) +) + +(defun flymake-get-point-pixel-pos() + "return point position in pixels: (x, y)" + (let ((mouse-pos (mouse-position)) + (pixel-pos nil) + (ret nil)) + (if (car (cdr mouse-pos)) + (progn + (set-mouse-position (flymake-selected-frame) (current-column) (flymake-current-row)) + (setq pixel-pos (mouse-pixel-position)) + (set-mouse-position (car mouse-pos) (car (cdr mouse-pos)) (cdr (cdr mouse-pos))) + (setq ret (list (car (cdr pixel-pos)) (cdr (cdr pixel-pos)))) + ) + ;else + (progn + (setq ret '(0 0)) + ) + ) + (flymake-log 3 "mouse pos is %s" ret) + ret + ) +) + +(defun flymake-display-err-menu-for-current-line() + "Display a menu with errors/warnings for current line if it has errors and/or warnings" + (interactive) + (let* ((line-no (flymake-current-line-no)) + (line-err-info-list (nth 0 (flymake-find-err-info (flymake-get-buffer-err-info (current-buffer)) line-no))) + (menu-data (flymake-make-err-menu-data line-no line-err-info-list)) + (choice nil) + (mouse-pos (flymake-get-point-pixel-pos)) + (moved-mouse-pos (list (car mouse-pos) (+ 10 (car (cdr mouse-pos))))) + (menu-pos (list (flymake-get-point-pixel-pos) (selected-window)))) + (if menu-data + (progn + (setq choice (flymake-popup-menu menu-pos menu-data)) + (flymake-log 3 "choice=%s" choice) + (when choice + (eval choice) + ) + ) + ;else + (flymake-log 1 "no errors for line %d" line-no) + ) + ) +) + +(defun flymake-make-err-menu-data(line-no line-err-info-list) + "Make a (menu-title (item-title item-action)*) list with errors/warnings from line-err-info" + (let* ((menu-items nil)) + (when line-err-info-list + (let* ((count (length line-err-info-list)) + (menu-item-text nil)) + (while (> count 0) + (setq menu-item-text (flymake-ler-get-text (nth (1- count) line-err-info-list))) + (let* ((file (flymake-ler-get-file (nth (1- count) line-err-info-list))) + (full-file (flymake-ler-get-full-file (nth (1- count) line-err-info-list))) + (line (flymake-ler-get-line (nth (1- count) line-err-info-list)))) + (if file + (setq menu-item-text (concat menu-item-text " - " file "(" (format "%d" line) ")")) + ) + (setq menu-items (cons (list menu-item-text + (if file (list 'flymake-goto-file-and-line full-file line) nil)) + menu-items)) + ) + (setq count (1- count)) + ) + (flymake-log 3 "created menu-items with %d item(s)" (length menu-items)) + ) + ) + (if menu-items + (let* ((menu-title (format "Line %d: %d error(s), %d warning(s)" line-no + (flymake-get-line-err-count line-err-info-list "e") + (flymake-get-line-err-count line-err-info-list "w")))) + (list menu-title menu-items) + ) + ;else + nil + ) + ) +) + +(defun flymake-goto-file-and-line(file line) + "try to get buffer for file and goto line line in it" + (if (not (file-exists-p file)) + (flymake-log 1 "file %s does not exists" file) + ;else + (progn + (find-file file) + (goto-line line) + ) + ) +) +;; flymake minor mode declarations + +(defvar flymake-mode nil) +(make-variable-buffer-local 'flymake-mode) + +(defvar flymake-mode-line nil + "" +) +(make-variable-buffer-local 'flymake-mode-line) +(defun flymake-get-buffer-mode-line(buffer) + (flymake-get-buffer-var buffer 'flymake-mode-line) +) +(defun flymake-set-buffer-mode-line(buffer mode-line-string) + (flymake-set-buffer-var buffer 'flymake-mode-line mode-line-string) +) + +(defvar flymake-mode-line-e-w nil) +(make-variable-buffer-local 'flymake-mode-line-e-w) +(defun flymake-get-buffer-mode-line-e-w(buffer) + (flymake-get-buffer-var buffer 'flymake-mode-line-e-w) +) +(defun flymake-set-buffer-mode-line-e-w(buffer e-w) + (flymake-set-buffer-var buffer 'flymake-mode-line-e-w e-w) +) + +(defvar flymake-mode-line-status nil) +(make-variable-buffer-local 'flymake-mode-line-status) +(defun flymake-get-buffer-mode-line-status(buffer) + (flymake-get-buffer-var buffer 'flymake-mode-line-status) +) +(defun flymake-set-buffer-mode-line-status(buffer status) + (flymake-set-buffer-var buffer 'flymake-mode-line-status status) +) + +(defun flymake-report-status(buffer e-w &optional status) + "show status in the mode line" + (when (bufferp buffer) + (save-excursion + (set-buffer buffer) + (when e-w + (flymake-set-buffer-mode-line-e-w buffer e-w) + ) + (when status + (flymake-set-buffer-mode-line-status buffer status) + ) + (let* ((mode-line " Flymake")) + (when (> (length (flymake-get-buffer-mode-line-e-w buffer)) 0) + (setq mode-line (concat mode-line ":" (flymake-get-buffer-mode-line-e-w buffer))) + ) + (setq mode-line (concat mode-line (flymake-get-buffer-mode-line-status buffer))) + (flymake-set-buffer-mode-line buffer mode-line) + (force-mode-line-update) + ) + ) + ) +) + +(defun flymake-display-warning(warning) + "display a warning to the user" + (message-box warning) +) + +(defcustom flymake-gui-warnings-enabled t + "enables/disables gui warnings" + :group 'flymake + :type 'boolean +) + +(defun flymake-report-fatal-status(buffer status warning) + "display a warning and switch flymake mode OFF" + (when flymake-gui-warnings-enabled + (flymake-display-warning (format "Flymake: %s. Flymake will be switched OFF" warning)) + ) + (save-excursion + (set-buffer buffer) + (flymake-mode 0) + (flymake-log 0 "switched OFF Flymake mode for buffer %s due to fatal status %s, warning %s" + (buffer-name buffer) status warning) + ) +) + +(defun flymake-mode(&optional arg) + "toggle flymake-mode" + (interactive) + (let ((old-flymake-mode flymake-mode)) + + (setq turn-on + (if (null arg) + (not flymake-mode) + ;else + (> (prefix-numeric-value arg) 0)) + ) + + (if turn-on + (if (flymake-can-syntax-check-file (buffer-file-name)) + (flymake-mode-on) + ;else + (flymake-log 2 "flymake cannot check syntax in buffer %s" (buffer-name)) + ) + ;else + (flymake-mode-off) + ) + (force-mode-line-update) + ) +) + +;;;###autoload +(unless (assq 'flymake-mode minor-mode-alist) + (setq minor-mode-alist (cons '(flymake-mode flymake-mode-line) minor-mode-alist)) +) + +;;;###autoload +(defun flymake-mode-on() + "turn flymake mode on" + (when (not flymake-mode) + (make-local-variable 'after-change-functions) + (setq after-change-functions (cons 'flymake-after-change-function after-change-functions)) + (add-hook 'after-save-hook 'flymake-after-save-hook) + (add-hook 'kill-buffer-hook 'flymake-kill-buffer-hook) + ;+(add-hook 'find-file-hooks 'flymake-find-file-hook) + + (flymake-report-status (current-buffer) "" "") + + (flymake-set-buffer-timer (current-buffer) (run-at-time nil 1 'flymake-on-timer-event (current-buffer))) + + (setq flymake-mode t) + (flymake-log 1 "flymake mode turned ON for buffer %s" (buffer-name (current-buffer))) + (when flymake-start-syntax-check-on-find-file + (flymake-start-syntax-check-for-current-buffer) ; will be started by on-load hook + ) + ) +) + +;;;###autoload +(defun flymake-mode-off() + "turn flymake mode off" + (when flymake-mode + (setq after-change-functions (delq 'flymake-after-change-function after-change-functions)) + (remove-hook 'after-save-hook (function flymake-after-save-hook) t) + (remove-hook 'kill-buffer-hook (function flymake-kill-buffer-hook) t) + ;+(remove-hook 'find-file-hooks (function flymake-find-file-hook) t) + + (flymake-delete-own-overlays (current-buffer)) + + (when (flymake-get-buffer-timer (current-buffer)) + (cancel-timer (flymake-get-buffer-timer (current-buffer))) + (flymake-set-buffer-timer (current-buffer) nil) + ) + + (flymake-set-buffer-is-running (current-buffer) nil) + + (setq flymake-mode nil) + (flymake-log 1 "flymake mode turned OFF for buffer %s" (buffer-name (current-buffer))) + ) +) + +(defcustom flymake-start-syntax-check-on-newline t + "start syntax check if newline char was added/removed from the buffer" + :group 'flymake + :type 'boolean +) + +(defun flymake-after-change-function(start stop len) + "Start syntax check for current buffer if it isn't already running" + ;+(flymake-log 0 "setting change time to %s" (flymake-float-time)) + (let((new-text (buffer-substring start stop))) + (when (and flymake-start-syntax-check-on-newline (equal new-text "\n")) + (flymake-log 3 "starting syntax check as new-line has been seen") + (flymake-start-syntax-check-for-current-buffer) + ) + (flymake-set-buffer-last-change-time (current-buffer) (flymake-float-time)) + ) +) + +(defun flymake-after-save-hook() + (if (local-variable-p 'flymake-mode (current-buffer)) ; (???) other way to determine whether flymake is active in buffer being saved? + (progn + (flymake-log 3 "starting syntax check as buffer was saved") + (flymake-start-syntax-check-for-current-buffer) ; no more mode 3. cannot start check if mode 3 (to temp copies) is active - (???) + ) + ) +) + +(defun flymake-kill-buffer-hook() + (when (flymake-get-buffer-timer (current-buffer)) + (cancel-timer (flymake-get-buffer-timer (current-buffer))) + (flymake-set-buffer-timer (current-buffer) nil) + ) +) + +(defcustom flymake-start-syntax-check-on-find-file t + "statr syntax check on find file" + :group 'flymake + :type 'boolean +) + +(defun flymake-find-file-hook() + ;+(when flymake-start-syntax-check-on-find-file + ;+ (flymake-log 3 "starting syntax check on file open") + ;+ (flymake-start-syntax-check-for-current-buffer) + ;+) + (when (and (not (local-variable-p 'flymake-mode (current-buffer))) + (flymake-can-syntax-check-file (buffer-file-name (current-buffer)))) + (flymake-mode) + (flymake-log 3 "automatically turned ON flymake mode") + ) +) + +(defun flymake-get-first-err-line-no(err-info-list) + "return first line-no with error" + (when err-info-list + (flymake-er-get-line (car err-info-list)) + ) +) + +(defun flymake-get-last-err-line-no(err-info-list) + "return last line-no with error" + (when err-info-list + (flymake-er-get-line (nth (1- (length err-info-list)) err-info-list)) + ) +) + +(defun flymake-get-next-err-line-no(err-info-list line-no) + "return next line with erroe" + (when err-info-list + (let* ((count (length err-info-list)) + (idx 0)) + (while (and (< idx count) (>= line-no (flymake-er-get-line (nth idx err-info-list)))) + (setq idx (1+ idx)) + ) + (if (< idx count) + (flymake-er-get-line (nth idx err-info-list)) + ) + ) + ) +) + +(defun flymake-get-prev-err-line-no(err-info-list line-no) + "return prev line with error" + (when err-info-list + (let* ((count (length err-info-list))) + (while (and (> count 0) (<= line-no (flymake-er-get-line (nth (1- count) err-info-list)))) + (setq count (1- count)) + ) + (if (> count 0) + (flymake-er-get-line (nth (1- count) err-info-list)) + ) + ) + ) +) + +(defun flymake-skip-whitespace() + "move forward until nonwhitespace is reached" + (while (looking-at "[ \t]") + (forward-char) + ) +) + +(defun flymake-goto-line(line-no) + "goto-line, then skip whitespace" + (goto-line line-no) + (flymake-skip-whitespace) +) + +(defun flymake-goto-next-error() + "go to next error in err ring" + (interactive) + (let ((line-no (flymake-get-next-err-line-no (flymake-get-buffer-err-info (current-buffer)) (flymake-current-line-no)))) + (when (not line-no) + (setq line-no (flymake-get-first-err-line-no (flymake-get-buffer-err-info (current-buffer)))) + (flymake-log 1 "passed end of file") + ) + (if line-no + (flymake-goto-line line-no) + ;else + (flymake-log 1 "no errors in current buffer") + ) + ) +) + +(defun flymake-goto-prev-error() + "go to prev error in err ring" + (interactive) + (let ((line-no (flymake-get-prev-err-line-no (flymake-get-buffer-err-info (current-buffer)) (flymake-current-line-no)))) + (when (not line-no) + (setq line-no (flymake-get-last-err-line-no (flymake-get-buffer-err-info (current-buffer)))) + (flymake-log 1 "passed beginning of file") + ) + (if line-no + (flymake-goto-line line-no) + ;else + (flymake-log 1 "no errors in current buffer") + ) + ) +) + +(defun flymake-patch-err-text(string) + (if (string-match "^[\n\t :0-9]*\\(.*\\)$" string) + (match-string 1 string) + ;else + string + ) +) + +;;;; general init-cleanup and helper routines + +(defun flymake-create-temp-inplace(file-name prefix) + (unless (stringp file-name) + (error "invalid file-name") + ) + (or prefix + (setq prefix "flymake") + ) + (let* ((temp-name (concat (file-name-sans-extension file-name) + "_" prefix + (and (file-name-extension file-name) + (concat "." (file-name-extension file-name)))))) + (flymake-log 3 "create-temp-inplace: file=%s temp=%s" file-name temp-name) + temp-name + ) +) + +(defun flymake-create-temp-with-folder-structure(file-name prefix) + (unless (stringp file-name) + (error "invalid file-name") + ) + + (let* ((dir (file-name-directory file-name)) + (slash-pos (string-match "/" dir)) + (temp-dir (concat (flymake-ensure-ends-with-slash (flymake-get-temp-dir)) (substring dir (1+ slash-pos))))) + + (file-truename (concat (flymake-ensure-ends-with-slash temp-dir) + (file-name-nondirectory file-name))) + ) +) + +(defun flymake-strrchr(str ch) + (let* ((count (length str)) + (pos nil)) + (while (and (not pos) (> count 0)) + (if (= ch (elt str (1- count))) + (setq pos (1- count)) + ) + (setq count (1- count)) + ) + pos + ) +) + +(defun flymake-delete-temp-directory(dir-name) + "attempt to delete temp dir created by flymake-create-temp-with-folder-structure, do not fail on error" + (let* ((temp-dir (flymake-get-temp-dir)) + (suffix (substring dir-name (1+ (length temp-dir)))) + (slash-pos nil)) + + (while (> (length suffix) 0) + ;+(flymake-log 0 "suffix=%s" suffix) + (flymake-safe-delete-directory (file-truename (concat (flymake-ensure-ends-with-slash temp-dir) suffix))) + (setq slash-pos (flymake-strrchr suffix (string-to-char "/"))) + (if slash-pos + (setq suffix (substring suffix 0 slash-pos)) + ;else + (setq suffix "") + ) + ) + ) +) + +(defun flymake-init-create-temp-buffer-copy(buffer create-temp-f) + "make a temporary copy of the current buffer, save its name in buffer data and return the name" + (let* ((source-file-name (buffer-file-name buffer)) + (temp-source-file-name (funcall create-temp-f source-file-name "flymake"))) + + (flymake-save-buffer-in-file buffer temp-source-file-name) + (flymake-set-buffer-value buffer "temp-source-file-name" temp-source-file-name) + + temp-source-file-name + ) +) + +(defun flymake-simple-cleanup(buffer) + "cleanup after flymake-init-create-temp-buffer-copy -- delete temp file" + (let* ((temp-source-file-name (flymake-get-buffer-value buffer "temp-source-file-name"))) + (flymake-safe-delete-file temp-source-file-name) + (flymake-set-buffer-last-change-time buffer nil) + ) +) + +(defun flymake-get-real-file-name(buffer file-name-from-err-msg) + "Translate file name from error message to `real' file name. Return full-name. Names are real, not patched" + (let* ((real-name nil) + (source-file-name (buffer-file-name buffer)) + (master-file-name (flymake-get-buffer-value buffer "master-file-name")) + (temp-source-file-name (flymake-get-buffer-value buffer "temp-source-file-name")) + (temp-master-file-name (flymake-get-buffer-value buffer "temp-master-file-name")) + (base-dirs (list (flymake-get-buffer-value buffer "base-dir") + (file-name-directory source-file-name) + (if master-file-name (file-name-directory master-file-name) nil))) + (files (list (list source-file-name source-file-name) + (list temp-source-file-name source-file-name) + (list master-file-name master-file-name) + (list temp-master-file-name master-file-name)))) + + (when (equal 0 (length file-name-from-err-msg)) + (setq file-name-from-err-msg source-file-name) + ) + + (setq real-name (flymake-get-full-patched-file-name file-name-from-err-msg base-dirs files)) + ; if real-name is nil, than file name from err msg is none of the files we've patched + (if (not real-name) + (setq real-name (flymake-get-full-nonpatched-file-name file-name-from-err-msg base-dirs)) + ) + (if (not real-name) + (setq real-name file-name-from-err-msg) + ) + (setq real-name (flymake-fix-path-name real-name)) + (flymake-log 3 "get-real-file-name: file-name=%s real-name=%s" file-name-from-err-msg real-name) + real-name + ) +) + +(defun flymake-get-full-patched-file-name(file-name-from-err-msg base-dirs files) + (let* ((base-dirs-count (length base-dirs)) + (file-count (length files)) + (real-name nil)) + + (while (and (not real-name) (> base-dirs-count 0)) + (setq file-count (length files)) + (while (and (not real-name) (> file-count 0)) + (let* ((this-dir (nth (1- base-dirs-count) base-dirs)) + (this-file (nth 0 (nth (1- file-count) files))) + (this-real-name (nth 1 (nth (1- file-count) files)))) + ;+(flymake-log 0 "this-dir=%s this-file=%s this-real=%s msg-file=%s" this-dir this-file this-real-name file-name-from-err-msg) + (when (and this-dir this-file (flymake-same-files + (flymake-get-absolute-file-name-basedir file-name-from-err-msg this-dir) + this-file)) + (setq real-name this-real-name) + ) + ) + (setq file-count (1- file-count)) + ) + (setq base-dirs-count (1- base-dirs-count)) + ) + real-name + ) +) + +(defun flymake-get-full-nonpatched-file-name(file-name-from-err-msg base-dirs) + (let* ((real-name nil)) + (if (file-name-absolute-p file-name-from-err-msg) + (setq real-name file-name-from-err-msg) + ;else + (let* ((base-dirs-count (length base-dirs))) + (while (and (not real-name) (> base-dirs-count 0)) + (let* ((full-name (flymake-get-absolute-file-name-basedir file-name-from-err-msg + (nth (1- base-dirs-count) base-dirs)))) + (if (file-exists-p full-name) + (setq real-name full-name) + ) + (setq base-dirs-count (1- base-dirs-count)) + ) + ) + ) + ) + real-name + ) +) + +(defun flymake-get-absolute-file-name-basedir(file-name dir-name) + (if (file-name-absolute-p file-name) + file-name + ;else + (concat dir-name "/" file-name) + ) +) + +(defun flymake-init-find-buildfile-dir(buffer source-file-name buildfile-name) + "find buildfile, store its dir in buffer data and return its dir, if found" + (let* ((buildfile-dir (flymake-find-buildfile buildfile-name + (file-name-directory source-file-name) + flymake-buildfile-dirs))) + (if (not buildfile-dir) + (progn + (flymake-log 1 "no buildfile (%s) for %s" buildfile-name source-file-name) + (flymake-report-fatal-status buffer "NOMK" (format "No buildfile (%s) found for %s" buildfile-name source-file-name)) + ) + ;else + (progn + (flymake-set-buffer-value buffer "base-dir" buildfile-dir) + ) + ) + buildfile-dir + ) +) + +(defun flymake-init-create-temp-source-and-master-buffer-copy(buffer get-incl-dirs-f create-temp-f master-file-masks include-regexp-list) + "find master file (or buffer), create it's copy along with a copy of the source file" + (let* ((source-file-name (buffer-file-name buffer)) + (temp-source-file-name (flymake-init-create-temp-buffer-copy buffer create-temp-f)) + (master-file-name nil) + (temp-master-file-name nil) + (master-and-temp-master (flymake-create-master-file + source-file-name temp-source-file-name + get-incl-dirs-f create-temp-f + master-file-masks include-regexp-list))) + + (if (not master-and-temp-master) + (progn + (flymake-log 1 "cannot find master file for %s" source-file-name) + (flymake-report-status buffer "!" "") ; NOMASTER + ) + ;else + (progn + (setq master-file-name (nth 0 master-and-temp-master)) + (setq temp-master-file-name (nth 1 master-and-temp-master)) + (flymake-set-buffer-value buffer "master-file-name" master-file-name) + (flymake-set-buffer-value buffer "temp-master-file-name" temp-master-file-name) + ) + ) + temp-master-file-name + ) +) + +(defun flymake-master-cleanup(buffer) + (flymake-simple-cleanup buffer) + (flymake-safe-delete-file (flymake-get-buffer-value buffer "temp-master-file-name")) +) + +;;;; make-specific init-cleanup routines + +(defun flymake-get-syntax-check-program-args(source-file-name base-dir use-relative-base-dir use-relative-source get-cmd-line-f) + "create a command line for the syntax check command, using get-cmd-line-f" + (let* ((my-base-dir base-dir) + (my-source source-file-name)) + + (when use-relative-base-dir + (setq my-base-dir (flymake-build-relative-path (file-name-directory source-file-name) base-dir)) + ) + + (when use-relative-source + (setq my-source (concat (flymake-build-relative-path base-dir (file-name-directory source-file-name)) + (file-name-nondirectory source-file-name))) + ) + + (funcall get-cmd-line-f my-source my-base-dir) + ) +) + +(defun flymake-get-make-cmdline(source base-dir) + (list "make" + (list "-s" + "-C" + base-dir + (concat "CHK_SOURCES=" source) + "SYNTAX_CHECK_MODE=1" + "check-syntax")) +) + +(defun flymake-get-ant-cmdline(source base-dir) + (list "ant" + (list "-buildfile" + (concat base-dir "/" "build.xml") + (concat "-DCHK_SOURCES=" source) + "check-syntax")) +) + +(defun flymake-simple-make-init-impl(buffer create-temp-f use-relative-base-dir use-relative-source build-file-name get-cmdline-f) + "create syntax check command line for a directly checked source file, use create-temp-f for creating temp copy" + (let* ((args nil) + (source-file-name (buffer-file-name buffer)) + (buildfile-dir (flymake-init-find-buildfile-dir buffer source-file-name build-file-name))) + (if buildfile-dir + (let* ((temp-source-file-name (flymake-init-create-temp-buffer-copy buffer create-temp-f))) + (setq args (flymake-get-syntax-check-program-args temp-source-file-name buildfile-dir + use-relative-base-dir use-relative-source + get-cmdline-f)) + ) + ) + + args + ) +) + +(defun flymake-simple-make-init(buffer) + (flymake-simple-make-init-impl buffer 'flymake-create-temp-inplace t t "Makefile" 'flymake-get-make-cmdline) +) + +(defun flymake-master-make-init(buffer get-incl-dirs-f master-file-masks include-regexp-list) + "create make command line for a source file checked via master file compilation" + (let* ((make-args nil) + (temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy + buffer get-incl-dirs-f 'flymake-create-temp-inplace + master-file-masks include-regexp-list))) + (when temp-master-file-name + (let* ((buildfile-dir (flymake-init-find-buildfile-dir buffer temp-master-file-name "Makefile"))) + (if buildfile-dir + (setq make-args (flymake-get-syntax-check-program-args + temp-master-file-name buildfile-dir nil nil 'flymake-get-make-cmdline)) + ) + ) + ) + + make-args + ) +) + +(defun flymake-find-make-buildfile(source-dir) + (flymake-find-buildfile "Makefile" source-dir flymake-buildfile-dirs) +) + +;;;; .h/make specific +(defun flymake-master-make-header-init(buffer) + (flymake-master-make-init buffer + 'flymake-get-include-dirs + '(".+\\.cpp$" ".+\\.c$") + '("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2)) +) + +;;;; .java/make specific +(defun flymake-simple-make-java-init(buffer) + (flymake-simple-make-init-impl buffer 'flymake-create-temp-with-folder-structure nil nil "Makefile" 'flymake-get-make-cmdline) +) + +(defun flymake-simple-ant-java-init(buffer) + (flymake-simple-make-init-impl buffer 'flymake-create-temp-with-folder-structure nil nil "build.xml" 'flymake-get-ant-cmdline) +) + +(defun flymake-simple-java-cleanup(buffer) + "cleanup after flymake-simple-make-java-init -- delete temp file and dirs" + (let* ((temp-source-file-name (flymake-get-buffer-value buffer "temp-source-file-name"))) + (flymake-safe-delete-file temp-source-file-name) + (when temp-source-file-name + (flymake-delete-temp-directory (file-name-directory temp-source-file-name)) + ) + ) +) + +;;;; perl-specific init-cleanup routines + +(defun flymake-perl-init(buffer) + (let* ((temp-file (flymake-init-create-temp-buffer-copy buffer 'flymake-create-temp-inplace)) + (local-file (concat (flymake-build-relative-path (file-name-directory (buffer-file-name (current-buffer))) + (file-name-directory temp-file)) + (file-name-nondirectory temp-file)))) + (list "perl" (list "-wc " local-file)) + ) +) + +;;;; tex-specific init-cleanup routines + +(defun flymake-get-tex-args(file-name) + ;(list "latex" (list "-c-style-errors" file-name)) + (list "texify" (list "--pdf" "--tex-option=-c-style-errors" file-name)) +) + +(defun flymake-simple-tex-init(buffer) + (flymake-get-tex-args (flymake-init-create-temp-buffer-copy buffer 'flymake-create-temp-inplace)) +) + +(defun flymake-master-tex-init(buffer) + (let* ((temp-master-file-name (flymake-init-create-temp-source-and-master-buffer-copy + buffer 'flymake-get-include-dirs-dot 'flymake-create-temp-inplace + '(".+\\.tex$") + '("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2)))) + (when temp-master-file-name + (flymake-get-tex-args temp-master-file-name) + ) + ) +) + +(defun flymake-get-include-dirs-dot(base-dir) + '(".") +) + +;;;; xml-specific init-cleanup routines + +(defun flymake-xml-init(buffer) + (list "xml" (list "val" (flymake-init-create-temp-buffer-copy buffer 'flymake-create-temp-inplace))) +) + +;;; flymake.el ends here
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/flymake.texi Sat May 29 12:55:24 2004 +0000 @@ -0,0 +1,767 @@ +\input texinfo @c -*-texinfo-*- +@comment %**start of header +@setfilename ../info/flymake +@set VERSION 0.3 +@set UPDATED April 2004 +@settitle GNU Flymake @value{VERSION} +@syncodeindex pg cp +@comment %**end of header + +@copying +This manual is for GNU Flymake (version @value{VERSION}, @value{UPDATED}), +which is a universal on-the-fly syntax checker for GNU Emacs. + +Copyright @copyright{} 2004 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License'' +in the Emacs manual. + +(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify +this GNU Manual, like GNU software. Copies published by the Free +Software Foundation raise funds for GNU development.'' + +This document is part of a collection distributed under the GNU Free +Documentation License. If you want to distribute this document +separately from the collection, you can do so by adding a copy of the +license to the document, as described in section 6 of the license. +@end quotation +@end copying + +@dircategory Emacs +@direntry +* Flymake: (flymake). A universal on-the-fly syntax checker. +@end direntry + +@titlepage +@title GNU Flymake +@subtitle for version @value{VERSION}, @value{UPDATED} +@author Pavel Kobiakov(@email{pk_at_work@@yahoo.com}) +@page +@vskip 0pt plus 1filll +@end titlepage + +@contents + +@ifnottex +@node Top +@top GNU Flymake +@end ifnottex + +@menu +* Overview of Flymake:: +* Obtaining Flymake:: +* Installing Flymake:: +* Using Flymake:: +* Configuring Flymake:: +* Flymake Implementation:: +* Index:: +@end menu + +@node Overview of Flymake +@chapter Overview +@cindex Overview of Flymake + +Flymake is a universal on-the-fly syntax checker implemented as an +Emacs minor mode. Flymake runs the pre-configured syntax check tool +(compiler for C++ files, @code{perl} for perl files, etc.) in the +background, passing it a temporary copy of the current buffer, and +parses the output for known error/warning message patterns. Flymake +then highlights erroneous lines (i.e. lines for which at least one +error or warning has been reported by the syntax check tool), and +displays an overall buffer status in the mode line. Status information +displayed by Flymake contains total number of errors and warnings +reported for the buffer during the last syntax check. + +@code{flymake-goto-next-error} and @code{flymake-goto-prev-error} +functions allow for easy navigation to the next/previous erroneous +line, respectively. + +Calling @code{flymake-display-err-menu-for-current-line} will popup a +menu containing error messages reported by the syntax check tool for +the current line. Errors/warnings belonging to another file, such as a +@code{.h} header file included by a @code{.c} file, are shown in the +current buffer as belonging to the first line. Menu items for such +messages also contain a filename and a line number. Selecting such a +menu item will automatically open the file and jump to the line with +error. + +Syntax check is done 'on-the-fly'. It is started whenever + +@itemize @bullet +@item buffer is loaded +@item a newline character is added to the buffer +@item some changes were made to the buffer more than @code{0.5} seconds ago (the +delay is configurable). +@end itemize + +Flymake is a universal syntax checker in the sense that it's easily +extended to support new syntax check tools and error message +patterns. @xref{Configuring Flymake}. + +@node Obtaining Flymake +@chapter Obtaining Flymake +@cindex Getting Flymake + +Release versions of Flymake can be downloaded from +@* @url{https://sourceforge.net/project/showfiles.php?group_id=77501}. +You can also try current version available via CVS at @url{https://}. + +Flymake's homepage is at @url{http://flymake.sourceforge.net}. + +@node Installing Flymake +@chapter Installing +@cindex Installing Flymake + + +Flymake is packaged in a single file, @code{flymake.el}. + +To install/update Flymake, place @code{flymake.el} to a directory +somewhere on Emacs load path. You might also want to byte-compile +@code{flymake.el} to improve performance. + +Also, place the following line in the @code{.emacs} file. + +@lisp +(require 'flymake) +@end lisp + +You might also map the most frequently used Flymake functions, such as +@code{flymake-goto-next-error}, to some keyboard shortcuts: + +@lisp +(global-set-key [f3] 'flymake-display-err-menu-for-current-line) +(global-set-key [f4] 'flymake-goto-next-error) +@end lisp + +@node Using Flymake +@chapter Using Flymake +@cindex Using Flymake + +@menu +* Flymake mode:: +* Running the syntax check:: +* Navigating to error lines:: +* Viewing error messages:: +* Syntax check statuses:: +* Troubleshooting:: +@end menu + +@node Flymake mode +@section Flymake mode +@cindex flymake-mode + +Flymake is an Emacs minor mode. To use Flymake, you +must first activate @code{flymake-mode} by using the +@code{flymake-mode} function. + +Instead of manually activating @code{flymake-mode}, you can configure +Flymake to automatically enable @code{flymake-mode} upon opening any +file for which syntax check is possible. To do so, place the following +line in @code{.emacs}: + +@lisp +(add-hook 'find-file-hooks 'flymake-find-file-hook) +@end lisp + +@node Running the syntax check +@section Running the syntax check +@cindex Manually starting the syntax check + +When @code{flymake-mode} is active, syntax check is started +automatically on any of the three conditions mentioned above. Syntax +check can also be started manually by using the +@code{flymake-start-syntax-check-for-current-buffer} function. This +can be used, for example, when changes were made to some other buffer +affecting the current buffer. + +@node Navigating to error lines +@section Navigating to error lines +@cindex Navigating to error lines + +After syntax check is completed, lines for which at least one error or +warning has been reported are highlighted, and total number of errors +and warning is shown in the mode line. Use the following functions to +navigate the highlighted lines. + +@multitable @columnfractions 0.25 0.75 + +@item @code{flymake-goto-next-error} +@tab Moves point to the next erroneous line, if any. + +@item @code{flymake-goto-prev-error} +@tab Moves point to the previous erroneous line. + +@end multitable + +These functions treat erroneous lines as a linked list. Therefore, +@code{flymake-goto-next-error} will go to the first erroneous line +when invoked in the end of the buffer. + +@node Viewing error messages +@section Viewing error messages +@cindex Viewing error messages + +To view error messages belonging to the current line, use the +@code{flymake-display-err-menu-for-current-line} function. If there's +at least one error or warning reported for the current line, this +function will display a popup menu with error/warning texts. +Selecting the menu item whose error belongs to another file brings +forward that file with the help of the +@code{flymake-goto-file-and-line} function. + +@node Syntax check statuses +@section Syntax check statuses +@cindex Syntax check statuses + +After syntax check is finished, its status is displayed in the mode line. +The following statuses are defined. + +@multitable @columnfractions 0.25 0.75 +@item Flymake* or Flymake:E/W* +@tab Flymake is currently running. For the second case, E/W contains the + error and warning count for the previous run. + +@item Flymake +@tab Syntax check is not running. Usually this means syntax check was + successfully passed (no errors, no warnings). Other possibilities are: + syntax check was killed as a result of executing + @code{flymake-compile}, or syntax check cannot start as compilation + is currently in progress. + +@item Flymake:E/W +@tab Number of errors/warnings found by the syntax check process. + +@item Flymake:! +@tab Flymake was unable to find master file for the current buffer. +@end multitable + +The following errors cause a warning message and switch flymake mode +OFF for the buffer. + +@multitable @columnfractions 0.25 0.75 +@item CFGERR +@tab Syntax check process returned nonzero exit code, but no + errors/warnings were reported. This indicates a possible configuration + error (for example, no suitable error message patterns for the + syntax check tool). + +@item NOMASTER +@tab Flymake was unable to find master file for the current buffer. + +@item NOMK +@tab Flymake was unable to find a suitable buildfile for the current buffer. + +@item PROCERR +@tab Flymake was unable to launch a syntax check process. +@end multitable + + +@node Troubleshooting +@section Troubleshooting +@cindex Logging +@cindex Troubleshooting + +Flymake uses a simple logging facility for indicating important points +in the control flow. The logging facility sends logging messages to +the @code{*Messages*} buffer. The information logged can be used for +resolving various problems related to Flymake. + +Logging output is controlled by the @code{flymake-log-level} +variable. @code{3} is the most verbose level, and @code{-1} switches +logging off. + +@node Configuring Flymake +@chapter Configuring and Extending Flymake +@cindex Configuring and Extending Flymake + +@menu +* Customizable variables:: +* Adding support for a new syntax check tool:: +@end menu + +Flymake was designed to be easily extended for supporting new syntax +check tools and error message patterns. + +@node Customizable variables +@section Customizable variables +@cindex Customizable variables + +This section summarises variables used for Flymake +configuration. + +@table @code +@item flymake-log-level +Controls logging output, see @ref{Troubleshooting}. + +@item flymake-allowed-file-name-masks +A list of @code{(filename-regexp, init-function, cleanup-function +getfname-function)} for configuring syntax check tools. @xref{Adding +support for a new syntax check tool}. + +@item flymake-buildfile-dirs +A list of directories (relative paths) for searching a +buildfile. @xref{Locating the buildfile}. + +@item flymake-master-file-dirs +A list of directories for searching a master file. @xref{Locating a +master file}. + +@item flymake-get-project-include-dirs-function +A function used for obtaining a list of project include dirs (C/C++ +specific). @xref{Getting the include directories}. + +@item flymake-master-file-count-limit +@itemx flymake-check-file-limit +Used when looking for a master file. @xref{Locating a master file}. + +@item flymake-err-line-patterns +Patterns for error/warning messages in the form @code{(regexp file-idx +line-idx err-text-idx)}. @xref{Parsing the output}. + +@item flymake-compilation-prevents-syntax-check +A flag indicating whether compilation and syntax check of the same +file cannot be run simultaneously. + +@item flymake-no-changes-timeout +If any changes are made to the buffer, syntax check is automatically +started after @code{flymake-no-changes-timeout} seconds. + +@item flymake-gui-warnings-enabled +A boolean flag indicating whether Flymake will show message boxes for +non-recoverable errors. If @code{flymake-gui-warnings-enabled} is +@code{nil}, these errors will only be logged to the @code{*Messages*} +buffer. + +@item flymake-start-syntax-check-on-newline +A boolean flag indicating whether to start syntax check after a +newline character is added to the buffer. + +@item flymake-errline-face +A custom face for highlighting lines for which at least one error has +been reported. + +@item flymake-warnline-face +A custom face for highlighting lines for which at least one warning +and no errors have been reported. + +@end table + +@node Adding support for a new syntax check tool +@section Adding support for a new syntax check tool +@cindex Adding support for a new syntax check tool + +@menu +* Example -- Configuring a tool called directly:: +* Example -- Configuring a tool called via make:: +@end menu + +Syntax check tools are configured using the +@code{flymake-allowed-file-name-masks} list. Each item of this list +has the following format: + +@lisp +(filename-regexp, init-function, cleanup-function, getfname-function) +@end lisp + +@table @code +@item filename-regexp +This field is used as a key for locating init/cleanup/getfname +functions for the buffer. Items in +@code{flymake-allowed-file-name-masks} are searched sequentially. The +first item with @code{filename-regexp} matching buffer filename is +selected. If no match is found, @code{flymake-mode} is switched off. + +@item init-function +@code{init-function} is required to initialise the syntax check, +usually by creating a temporary copy of the buffer contents. The +function must return @code{(list cmd-name arg-list)}. If +@code{init-function} returns null, syntax check is aborted, by +@code{flymake-mode} is not switched off. + +@item cleanup-function +@code{cleanup-function} is called after the syntax check process is +complete and should take care of proper deinitialization, which is +usually deleting a temporary copy created by the @code{init-function}. + +@item getfname-function +This function is used for translating filenames reported by the syntax +check tool into ``real'' filenames. Filenames reported by the tool +will be different from the real ones, as actually the tool works with +the temporary copy. In most cases, the default implementation +provided by Flymake, @code{flymake-get-real-file-name}, can be used as +@code{getfname-function}. + +@end table + +To add support for a new syntax check tool, write corresponding +@code{init-function}, and, optionally @code{cleanup-function} and +@code{getfname-function}. If the format of error messages reported by +the new tool is not yet supported by Flymake, add a new entry to +the @code{flymake-err-line-patterns} list. + +The following sections contain some examples of configuring Flymake +support for various syntax check tools. + +@node Example -- Configuring a tool called directly +@subsection Example -- Configuring a tool called directly +@cindex Adding support for perl + +In this example, we will add support for @code{perl} as a syntax check +tool. @code{perl} supports the @code{-c} option which does syntax +checking. + +First, we write the @code{init-function}: + +@lisp +(defun flymake-perl-init(buffer) + (let* ((temp-file (flymake-init-create-temp-buffer-copy + buffer + 'flymake-create-temp-inplace)) + (local-file (concat (flymake-build-relative-path + (file-name-directory + (buffer-file-name + (current-buffer))) + (file-name-directory temp-file)) + (file-name-nondirectory temp-file)))) + (list "perl" (list "-wc " local-file)) + ) +) +@end lisp + +@code{flymake-perl-init} creates a temporary copy of the buffer +contents with the help of +@code{flymake-init-create-temp-buffer-copy}, and builds an appropriate +command line. + +Next, we add a new entry to the +@code{flymake-allowed-file-name-masks}: + +@lisp +(setq flymake-allowed-file-name-masks + (cons '(".+\\.pl$" + flymake-perl-init + flymake-simple-cleanup + flymake-get-real-file-name) + flymake-allowed-file-name-masks)) +@end lisp + +Note that we use standard @code{cleanup-function} and +@code{getfname-function}. + +Finally, we add an entry to @code{flymake-err-line-patterns}: + +@lisp +(setq flymake-err-line-patterns + (cons '("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 2 3 nil 1) + flymake-err-line-patterns)) +@end lisp + +@node Example -- Configuring a tool called via make +@subsection Example -- Configuring a tool called via make +@cindex Adding support for C (gcc+make) + +In this example we will add support for C files syntax checked by +@code{gcc} called via @code{make}. + +We're not required to write any new functions, as Flymake already has +functions for @code{make}. We just add a new entry to the +@code{flymake-allowed-file-name-masks}: + +@lisp +(setq flymake-allowed-file-name-masks + (cons '(".+\\.c$" + flymake-simple-make-init + flymake-simple-cleanup + flymake-get-real-file-name) + flymake-allowed-file-name-masks)) +@end lisp + +@code{flymake-simple-make-init} builds the following @code{make} +command line: + +@lisp +(list "make" + (list "-s" + "-C" + base-dir + (concat "CHK_SOURCES=" source) + "SYNTAX_CHECK_MODE=1" + "check-syntax")) +@end lisp + +@code{base-dir} is a directory containing @code{Makefile}, see @ref{Locating the buildfile}. + +Thus, @code{Makefile} must contain the @code{check-syntax} target. In +our case this target might look like this: + +@verbatim +check-syntax: + gcc -o nul -S ${CHK_SOURCES} +@end verbatim + +The format of error messages reported by @code{gcc} is already +supported by Flymake, so we don't have to add a new entry to +@code{flymake-err-line-patterns}. + +@node Flymake Implementation +@chapter Flymake Implementation +@cindex Implementation details + +@menu +* Determining whether syntax check is possible:: +* Making a temporary copy:: +* Locating a master file:: +* Getting the include directories:: +* Locating the buildfile:: +* Starting the syntax check process:: +* Parsing the output:: +* Highlighting erroneous lines:: +* Interaction with other modes:: +@end menu + +Syntax check is started by calling @code{flymake-start-syntax-check-for-current-buffer}. +Flymake first determines whether it is able to do syntax +check. It then saves a copy of the buffer in a temporary file in the +buffer's directory (or in the system temp directory -- for java +files), creates a syntax check command and launches a process with +this command. The output is parsed using a list of error message patterns, +and error information (file name, line number, type and text) is +saved. After the process has finished, Flymake highlights erroneous +lines in the buffer using the accumulated error information. + +@node Determining whether syntax check is possible +@section Determining whether syntax check is possible +@cindex Syntax check models +@cindex Master file + +Syntax check is considered possible if there's an entry in +@code{flymake-allowed-file-name-masks} matching buffer's filename and +its @code{init-function} returns non-nil value. + +Two syntax check modes are distinguished: + +@enumerate + +@item +Buffer can be syntax checked in a standalone fashion, that is, the +file (its temporary copy, in fact) can be passed over to the compiler to +do the syntax check. Examples are C/C++ (.c, .cpp) and Java (.java) +sources. + +@item +Buffer can be syntax checked, but additional file, called master file, +is required to perform this operation. A master file is a file that +includes the current file, so that running a syntax check tool on it +will also check syntax in the current file. Examples are C/C++ (.h, +.hpp) headers. + +@end enumerate + +These modes are handled inside init/cleanup/getfname functions, see +@ref{Adding support for a new syntax check tool}. + +Flymake contains implementations of all functionality required to +support different syntax check modes described above (making +temporary copies, finding master files, etc.), as well as some +tool-specific (routines for @code{make}, @code{Ant}, etc.) code. + + +@node Making a temporary copy +@section Making a temporary copy +@cindex Temporary copy of the buffer +@cindex Master file + +After the possibility of the syntax check has been determined, a +temporary copy of the current buffer is made so that the most recent +unsaved changes could be seen by the syntax check tool. Making a copy +is quite straightforward in a standalone case (mode @code{1}), as it's +just saving buffer contents to a temporary file. + +Things get trickier, however, when master file is involved, as it +requires to + +@itemize @bullet +@item locate a master file +@item patch it to include the current file using its new (temporary) +name. +@end itemize + +Locating a master file is discussed in the following section. + +Patching just changes all appropriate lines of the master file so that they +use the new (temporary) name of the current file. For example, suppose current +file name is @code{file.h}, the master file is @code{file.cpp}, and +it includes current file via @code{#include "file.h"}. Current file's copy +is saved to file @code{file_flymake.h}, so the include line must be +changed to @code{#include "file_flymake.h"}. Finally, patched master file +is saved to @code{file_flymake_master.cpp}, and the last one is passed to +the syntax check tool. + +@node Locating a master file +@section Locating a master file +@cindex Master file + +Master file is located in two steps. + +First, a list of possible master files is built. A simple name +matching is used to find the files. For a C++ header @code{file.h}, +Flymake searches for all @code{.cpp} files in the directories whose relative paths are +stored in a customizable variable @code{flymake-master-file-dirs}, which +usually contains something like @code{("." "./src")}. No more than +@code{flymake-master-file-count-limit} entries is added to the master file +list. The list is then sorted to move files with names @code{file.cpp} to +the top. + +Next, each master file in a list is checked to contain the appropriate +include directives. No more than @code{flymake-check-file-limit} of each +file are parsed. + +For @code{file.h}, the include directives to look for are +@code{#include "file.h"}, @code{#include "../file.h"}, etc. Each +include is checked against a list of include directories +(see @ref{Getting the include directories}) to be sure it points to the +correct @code{file.h}. + +First matching master file found stops the search. The master file is then +patched and saved to disk. In case no master file is found, syntax check is +aborted, and corresponding status (!) is reported in the mode line. + +@node Getting the include directories +@section Getting the include directories +@cindex Include directories (C/C++ specific) + +Two sets of include directories are distinguished: system include directories +and project include directories. The former is just the contents of the +@code{INCLUDE} environment variable. The latter is not so easy to obtain, +and the way it can be obtained can vary greatly for different projects. +Therefore, a customizable variable +@code{flymake-get-project-include-dirs-function} is used to provide the +way to implement the desired behaviour. + +The default implementation, @code{flymake-get-project-include-dirs-imp}, +uses a @code{make} call. This requires a correct base directory, that is, a +directory containing a correct @code{Makefile}, to be determined. + +As obtaining the project include directories might be a costly operation, its +return value is cached in the hash table. The cache is cleared in the beginning +of every syntax check attempt. + +@node Locating the buildfile +@section Locating the buildfile +@cindex Locating the buildfile +@cindex buildfile, locating +@cindex Makefile, locating + +Flymake can be configured to use different tools for performing syntax +checks. For example, it can use direct compiler call to syntax check a perl +script or a call to @code{make} for a more complicated case of a +@code{C/C++} source. The general idea is that simple files, like perl +scripts and html pages, can be checked by directly invoking a +corresponding tool. Files that are usually more complex and generally +used as part of larger projects, might require non-trivial options to +be passed to the syntax check tool, like include directories for +C++. The latter files are syntax checked using some build tool, like +@code{make} or @code{Ant}. + +All @code{make} configuration data is usually stored in a file called +@code{Makefile}. To allow for future extensions, flymake uses a notion of +buildfile to reference the 'project configuration' file. + +Special function, @code{flymake-find-buildfile} is provided for locating buildfiles. +Searching for a buildfile is done in a manner similar to that of searching +for possible master files. A customizable variable +@code{flymake-buildfile-dirs} holds a list of relative paths to the +buildfile. They are checked sequentially until a buildfile is found. In case +there's no build file, syntax check is aborted. + +Buildfile values are also cached. + +@node Starting the syntax check process +@section Starting the syntax check process +@cindex Syntax check process + +The command line (command name and the list of arguments) for launching a process is returned by the +initialization function. Flymake then just calls @code{start-process} +to start an asynchronous process and configures process filter and +sentinel which is used for processing the output of the syntax check +tool. + +@node Parsing the output +@section Parsing the output +@cindex Parsing the output + +The output generated by the syntax check tool is parsed in the process +filter/sentinel using the error message patterns stored in the +@code{flymake-err-line-patterns} variable. This variable contains a +list of items of the form @code{(regexp file-idx line-idx +err-text-idx)}, used to determine whether a particular line is an +error message and extract file name, line number and error text, +respectively. Error type (error/warning) is also guessed by matching +error text with the '@code{^[wW]arning}' pattern. Anything that was not +classified as a warning is considered an error. Type is then used to +sort error menu items, which shows error messages first. + +Flymake is also able to interpret error message patterns missing err-text-idx +information. This is done by merely taking the rest of the matched line +(@code{(substring line (match-end 0))}) as error text. This trick allows +to make use of a huge collection of error message line patterns from +@code{compile.el}. All these error patterns are appended to +the end of @code{flymake-err-line-patterns}. + +The error information obtained is saved in a buffer local +variable. The buffer for which the process output belongs is +determined from the process-id@w{}->@w{}buffer mapping updated +after every process launch/exit. + +@node Highlighting erroneous lines +@section Highlighting erroneous lines +@cindex Erroneous lines, faces + +Highlighting is implemented with overlays and happens in the process +sentinel, after calling the cleanup function. Two customizable faces +are used: @code{flymake-errline-face} and +@code{flymake-warnline-face}. Errors belonging outside the current +buffer are considered to belong to line 1 of the current buffer. + +@node Interaction with other modes +@section Interaction with other modes +@cindex Interaction with other modes +@cindex Interaction with compile mode + +The only mode flymake currently knows about is @code{compile}. + +Flymake can be configured to not start syntax check if it thinks the +compilation is in progress. The check is made by the +@code{flymake-compilation-is-running}, which tests the +@code{compilation-in-progress} variable. The reason why this might be +useful is saving CPU time in case both syntax check and compilation +are very CPU intensive. The original reason for adding this feature, +though, was working around a locking problem with MS Visual C++ compiler. + +Flymake also provides an alternative command for starting compilation, +@code{flymake-compile}: + +@lisp +(defun flymake-compile() + "kill all flymake syntax checks, start compilation" + (interactive) + (flymake-stop-all-syntax-checks) + (call-interactively 'compile) +) +@end lisp + +It just kills all the active syntax check processes before calling +@code{compile}. + +@node Index +@unnumbered Index + +@printindex cp + +@bye