@set VERSION 0.3
@set UPDATED April 2004
@settitle GNU Flymake @value{VERSION}
-@include docstyle.texi
+@include ../emacs/docstyle.texi
@syncodeindex pg cp
@comment %**end of header
@titlepage
@title GNU Flymake
@subtitle for version @value{VERSION}, @value{UPDATED}
-@author Pavel Kobiakov(@email{pk_at_work@@yahoo.com})
+@author Pavel Kobiakov(@email{pk_at_work@@yahoo.com}) and João Távora.
@page
@vskip 0pt plus 1filll
@insertcopying
* Overview of Flymake::
* Installing Flymake::
* Using Flymake::
-* Configuring Flymake::
-* Flymake Implementation::
+* Extending Flymake::
+* The legacy Proc backend::
* GNU Free Documentation License::
* Index::
@end menu
@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.
+Flymake is a universal on-the-fly buffer checker implemented as an
+Emacs minor mode. When enabled, Flymake visually annotates the buffer
+with diagnostic information coming from one or more different sources,
+or @emph{backends}.
+
+Historically, Flymake used to accept diagnostics from a single, albeit
+reasonably flexible, backend.
+
+This backend isn't (yet) obsolete and so is still available as a
+fallback and active by default(@pxref{The legacy Proc backend}). It works by
+selecting a syntax check tool from a preconfigured list (compiler for
+C++ files, @code{perl} for perl files, etc.), and executing it in the
+background, passing it a temporary file which is a copy of the current
+buffer, and parsing the output for known error/warning message
+patterns.
+
+Flymake annotates the buffer by highlighting problematic buffer
+regions with a special space. It also displays an overall buffer
+status in the mode line. Status information displayed by Flymake
+contains totals for different types of diagnostics.
+
+@code{flymake-goto-next-error} and @code{flymake-goto-prev-error} are
+commands that allow easy navigation to the next/previous erroneous
+line, respectively. If might be a good idea to map them to @kbd{M-n}
+and @kbd{M-p} in @code{flymake-mode}, by adding to your init file:
+
+@lisp
+(define-key flymake-mode-map (kbd "M-n") 'flymake-goto-next-error)
+(define-key flymake-mode-map (kbd "M-p") 'flymake-goto-prev-error)
+@end lisp
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 @code{flymake-mode} is started;
+@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}.
+extended to support new backends. @xref{Customizable variables}.
@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
+Flymake is included with Emacs and its main commands, like
+@code{flymake-mode}, are autoloaded. This means there is usually
+nothing to do by way of installation.
@node Using Flymake
@chapter Using Flymake
@menu
* Flymake mode::
* Running the syntax check::
-* Navigating to error lines::
-* Viewing error messages::
+* Navigating to error lines:: @c * Viewing error messages::
* Syntax check statuses::
* Troubleshooting::
+* Customizable variables::
@end menu
@node Flymake mode
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.
+check can also be started manually by using the @code{flymake-start}
+function.
@node Navigating to error lines
@section Navigating to error lines
@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.
+If the user option @code{flymake-wrap-around} is active
+(@pxref{Customizable variables}), these functions treat diagnostics
+as a linked list. Therefore, @code{flymake-goto-next-error} will go
+to the first diagnostic when invoked in the end of the buffer.
@node Syntax check statuses
@section Syntax check statuses
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.
+@item @code{Wait}
+@tab Some flymake backends haven't reported since the last time they
+where questioned.
+
+@item @code{!}
+@tab All the configured Flymake backends have disabled themselves.
+Left-clicking the ``Flymake'' mode line indicator beings the user
+@code{*Flymake log*} buffer where these situations may be investigated
+
+@item @code{?}
+@tab There are no configured Flymake backends in
+@code{flymake-diagnostic-functions}.
+
+@item @emph{[nerrors nwarnings]}
+@tab Normal operation, number of errors/warnings found by the syntax
+check process.
@end multitable
-
@node Troubleshooting
@section Troubleshooting
@cindex Logging
Flymake uses a simple logging facility for indicating important points
in the control flow. The logging facility sends logging messages to
-the @file{*Messages*} buffer. The information logged can be used for
+the @file{*Flymake log*} 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.
+Logging output is controlled by the Emacs @code{warning-minimum-log-level}
+and @code{warning-minimum-level} variables.
@node Customizable variables
@section Customizable variables
@cindex Customizable variables
-This section summarizes variables used for Flymake
-configuration.
+This section summarizes variables used for the configuration of the
+Flymake user interface.
@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}.
-
-@ignore
-@item flymake-buildfile-dirs
-A list of directories (relative paths) for searching a
-buildfile. @xref{Locating the buildfile}.
-@end ignore
-
-@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 col-idx err-text-idx)}. @xref{Parsing the output}.
-
-@item flymake-warning-predicate
-Predicate to classify error text as warning. @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.
A boolean flag indicating whether to start syntax check after a
newline character is added to the buffer.
-@item flymake-errline
-A custom face for highlighting lines for which at least one error has
-been reported.
+@item flymake-error
+A custom face for highlighting regions for which an error has been
+reported.
+
+@item flymake-warning
+A custom face for highlighting regions for which a warning has been
+reported.
-@item flymake-warnline
-A custom face for highlighting lines for which at least one warning
-and no errors have been reported.
+@item flymake-note
+A custom face for highlighting regions for which a note has been
+reported.
@item flymake-error-bitmap
A bitmap used in the fringe to mark lines for which an error has
@item flymake-fringe-indicator-position
Which fringe (if any) should show the warning/error bitmaps.
+@item flymake-wrap-around
+If non-nil, moving to errors with @code{flymake-goto-next-error} and
+@code{flymake-goto-prev-error} wraps around buffer boundaries.
+
+@end table
+
+@node Extending Flymake
+@chapter Extending Flymake
+@cindex Extending Flymake
+
+@node The legacy Proc backend
+@chapter The legacy ``Proc'' backend
+@cindex The legacy Proc backend
+
+@menu
+* Proc customization variables::
+* Adding support for a new syntax check tool::
+* Implementation overview::
+* Making a temporary copy::
+* Locating a master file::
+* Getting the include directories::
+* Locating the buildfile::
+* Starting the syntax check process::
+* Parsing the output::
+* Interaction with other modes::
+@end menu
+
+The backend @code{flymake-proc-legacy-backend} was originally designed
+to be extended for supporting new syntax check tools and error message
+patterns. It is also controlled by its own set of customization variables
+
+@node Proc customization variables
+@section Customization variables for the Proc backend
+@cindex Proc customization variables
+
+@table @code
+@item flymake-proc-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-proc-master-file-dirs
+A list of directories for searching a master file. @xref{Locating a
+master file}.
+
+@item flymake-proc-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-proc-master-file-count-limit
+@itemx flymake-proc-check-file-limit
+Used when looking for a master file. @xref{Locating a master file}.
+
+@item flymake-proc-err-line-patterns
+Patterns for error/warning messages in the form @code{(regexp file-idx
+line-idx col-idx err-text-idx)}. @xref{Parsing the output}.
+
+@item flymake-proc-diagnostic-type-pred
+A function to classify a diagnostic text as particular type of
+error. Should be a function taking an error text and returning one of
+the symbols indexing @code{flymake-diagnostic-types-alist}. If non-nil
+is returned but there is no such symbol in that table, a warning is
+assumed. If nil is returned, an error is assumed. Can also be a
+regular expression that should match only warnings. This variable
+replaces the old @code{flymake-warning-re} and
+@code{flymake-warning-predicate}.
+
+@item flymake-proc-compilation-prevents-syntax-check
+A flag indicating whether compilation and syntax check of the same
+file cannot be run simultaneously.
@end table
@node Adding support for a new syntax check tool
@end menu
Syntax check tools are configured using the
-@code{flymake-allowed-file-name-masks} list. Each item of this list
+@code{flymake-proc-allowed-file-name-masks} list. Each item of this list
has the following format:
@lisp
@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
+@code{flymake-proc-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
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}.
+provided by Flymake, @code{flymake-proc-get-real-file-name}, can be
+used as @code{getfname-function}.
@end table
@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 @code{flymake-proc-err-line-patterns} list.
The following sections contain some examples of configuring Flymake
support for various syntax check tools.
First, we write the @code{init-function}:
@lisp
-(defun flymake-perl-init ()
- (let* ((temp-file (flymake-init-create-temp-buffer-copy
- 'flymake-create-temp-inplace))
+(defun flymake-proc-perl-init ()
+ (let* ((temp-file (flymake-proc-init-create-temp-buffer-copy
+ 'flymake-proc-create-temp-inplace))
(local-file (file-relative-name
temp-file
(file-name-directory buffer-file-name))))
(list "perl" (list "-wc " local-file))))
@end lisp
-@code{flymake-perl-init} creates a temporary copy of the buffer
+@code{flymake-proc-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
+@code{flymake-proc-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}:
+@code{flymake-proc-allowed-file-name-masks}:
@lisp
-(setq flymake-allowed-file-name-masks
+(setq flymake-proc-allowed-file-name-masks
(cons '(".+\\.pl$"
- flymake-perl-init
- flymake-simple-cleanup
- flymake-get-real-file-name)
- flymake-allowed-file-name-masks))
+ flymake-proc-perl-init
+ flymake-proc-simple-cleanup
+ flymake-proc-get-real-file-name)
+ flymake-proc-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}:
+Finally, we add an entry to @code{flymake-proc-err-line-patterns}:
@lisp
-(setq flymake-err-line-patterns
+(setq flymake-proc-err-line-patterns
(cons '("\\(.*\\) at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]"
2 3 nil 1)
- flymake-err-line-patterns))
+ flymake-proc-err-line-patterns))
@end lisp
@node Example---Configuring a tool called via make
We're not required to write any new functions, as Flymake already has
functions for @command{make}. We just add a new entry to the
-@code{flymake-allowed-file-name-masks}:
+@code{flymake-proc-allowed-file-name-masks}:
@lisp
-(setq flymake-allowed-file-name-masks
+(setq flymake-proc-allowed-file-name-masks
(cons '(".+\\.c$"
- flymake-simple-make-init
- flymake-simple-cleanup
- flymake-get-real-file-name)
- flymake-allowed-file-name-masks))
+ flymake-proc-simple-make-init
+ flymake-proc-simple-cleanup
+ flymake-proc-get-real-file-name)
+ flymake-proc-allowed-file-name-masks))
@end lisp
-@code{flymake-simple-make-init} builds the following @command{make}
+@code{flymake-proc-simple-make-init} builds the following @command{make}
command line:
@lisp
$(COMPILE) -o /dev/null -S ${CHK_SOURCES} || true
@end verbatim
-@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
+@node Implementation overview
+@section Implementation overview
@cindex Syntax check models
@cindex Master file
+@code{flymake-proc-legacy-backend} 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.
+
Syntax check is considered possible if there's an entry in
-@code{flymake-allowed-file-name-masks} matching buffer's filename and
+@code{flymake-proc-allowed-file-name-masks} matching buffer's filename and
its @code{init-function} returns non-@code{nil} value.
Two syntax check modes are distinguished:
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 Make, Ant, etc.)@: code.
+The Proc backend 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 Make, Ant, etc.)@: code.
@node Making a temporary copy
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.
+the Proc backend searches for all @code{.cpp} files in the directories
+whose relative paths are stored in a customizable variable
+@code{flymake-proc-master-file-dirs}, which usually contains something
+like @code{("." "./src")}. No more than
+@code{flymake-proc-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
+include directives. No more than @code{flymake-proc-check-file-limit} of each
file are parsed.
For @code{file.h}, the include directives to look for are
@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
+@code{flymake-proc-get-project-include-dirs-function} is used to provide the
way to implement the desired behavior.
-The default implementation, @code{flymake-get-project-include-dirs-imp},
+The default implementation, @code{flymake-proc-get-project-include-dirs-imp},
uses a @command{make} call. This requires a correct base directory, that is, a
directory containing a correct @file{Makefile}, to be determined.
@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 @command{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
-Make or Ant.
+The Proc backend 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 @command{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 Make or Ant.
All 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.
+Special function, @code{flymake-proc-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.
@ignore
A customizable variable
-@code{flymake-buildfile-dirs} holds a list of relative paths to the
+@code{flymake-proc-buildfile-dirs} holds a list of relative paths to the
buildfile. They are checked sequentially until a buildfile is found.
@end ignore
In case there's no build file, syntax check is aborted.
@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 a process filter and
-sentinel, which are used for processing the output of the syntax check
-tool. When exiting Emacs, running Flymake processes will be killed
-without prompting the user.
+The command line (command name and the list of arguments) for
+launching a process is returned by the initialization function. The
+Proc backend then just starts an asynchronous process and configures a
+process filter and sentinel, which are used for processing the output
+of the syntax check tool. When exiting Emacs, running processes will
+be killed without prompting the user.
@node Parsing the output
@section 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
+@code{flymake-proc-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,
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
-making 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 Proc backend 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 making 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-proc-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} and
-@code{flymake-warnline}. Errors belonging outside the current
-buffer are considered to belong to line 1 of the current buffer.
-
-@c This manual does not use vindex.
-@c @vindex flymake-fringe-indicator-position
-@c @vindex flymake-error-bitmap
-@c @vindex flymake-warning-bitmap
-If the option @code{flymake-fringe-indicator-position} is non-@code{nil},
-errors and warnings are also highlighted in the left or right fringe,
-using the bitmaps specified by @code{flymake-error-bitmap}
-and @code{flymake-warning-bitmap}.
-
@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}.
+The only mode the Proc backend 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
+The Proc backend can be configured to not start syntax check if it
+thinks the compilation is in progress, by testing 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.
+compiler. The variable in question is
+@code{flymake-proc-compilation-prevents-syntax-check}.
-Flymake also provides an alternative command for starting compilation,
-@code{flymake-compile}:
-
-@lisp
-(defun flymake-compile ()
- "Kill all flymake syntax checks then 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}.
+The Proc backend also provides an alternative command for starting
+compilation, @code{flymake-proc-compile}. It just kills all the active
+syntax check processes before calling @code{compile}.
@node GNU Free Documentation License
@appendix GNU Free Documentation License
projects / emacs.git / commitdiff