Merge branch 'scratch/flymake-refactor-clean-for-emacs-26' into emacs-26
This commit is contained in:
commit
ca08b69549
11 changed files with 2696 additions and 1779 deletions
|
@ -4,7 +4,7 @@
|
|||
@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
|
||||
|
||||
|
@ -35,7 +35,7 @@ modify this GNU manual.''
|
|||
@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
|
||||
|
@ -53,8 +53,8 @@ modify this GNU manual.''
|
|||
* Overview of Flymake::
|
||||
* Installing Flymake::
|
||||
* Using Flymake::
|
||||
* Configuring Flymake::
|
||||
* Flymake Implementation::
|
||||
* Extending Flymake::
|
||||
* The legacy Proc backend::
|
||||
* GNU Free Documentation License::
|
||||
* Index::
|
||||
@end menu
|
||||
|
@ -63,67 +63,56 @@ modify this GNU manual.''
|
|||
@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.
|
||||
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}.
|
||||
|
||||
@code{flymake-goto-next-error} and @code{flymake-goto-prev-error}
|
||||
functions allow for easy navigation to the next/previous erroneous
|
||||
line, respectively.
|
||||
Historically, Flymake used to accept diagnostics from a single, albeit
|
||||
reasonably flexible, backend.
|
||||
|
||||
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.
|
||||
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
|
||||
|
@ -132,10 +121,10 @@ You might also map the most frequently used Flymake functions, such as
|
|||
@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
|
||||
|
@ -161,10 +150,8 @@ line in @code{.emacs}:
|
|||
|
||||
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
|
||||
|
@ -185,21 +172,10 @@ navigate the highlighted 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
|
||||
|
@ -209,45 +185,24 @@ 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 @code{Wait}
|
||||
@tab Some flymake backends haven't reported since the last time they
|
||||
where questioned.
|
||||
|
||||
@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 @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 Flymake:E/W
|
||||
@tab Number of errors/warnings found by the syntax check process.
|
||||
@item @code{?}
|
||||
@tab There are no configured Flymake backends in
|
||||
@code{flymake-diagnostic-functions}.
|
||||
|
||||
@item Flymake:!
|
||||
@tab Flymake was unable to find master file for the current buffer.
|
||||
@item @emph{[nerrors nwarnings]}
|
||||
@tab Normal operation, number of errors/warnings found by the syntax
|
||||
check process.
|
||||
@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
|
||||
|
@ -255,70 +210,20 @@ syntax check tool).
|
|||
|
||||
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.
|
||||
|
@ -327,13 +232,17 @@ 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-warnline
|
||||
A custom face for highlighting lines for which at least one warning
|
||||
and no errors have been reported.
|
||||
@item flymake-warning
|
||||
A custom face for highlighting regions for which a warning has 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
|
||||
|
@ -346,6 +255,76 @@ been reported.
|
|||
@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
|
||||
|
@ -358,7 +337,7 @@ Which fringe (if any) should show the warning/error bitmaps.
|
|||
@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
|
||||
|
@ -369,8 +348,8 @@ has the following format:
|
|||
@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
|
||||
|
@ -390,8 +369,8 @@ 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}.
|
||||
provided by Flymake, @code{flymake-proc-get-real-file-name}, can be
|
||||
used as @code{getfname-function}.
|
||||
|
||||
@end table
|
||||
|
||||
|
@ -399,7 +378,7 @@ 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 @code{flymake-proc-err-line-patterns} list.
|
||||
|
||||
The following sections contain some examples of configuring Flymake
|
||||
support for various syntax check tools.
|
||||
|
@ -415,42 +394,42 @@ checking.
|
|||
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
|
||||
|
@ -462,18 +441,18 @@ In this example we will add support for C files syntax checked by
|
|||
|
||||
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
|
||||
|
@ -492,7 +471,7 @@ our case this target might look like this:
|
|||
|
||||
@verbatim
|
||||
check-syntax:
|
||||
gcc -o /dev/null -S ${CHK_SOURCES}
|
||||
gcc -o /dev/null -S ${CHK_SOURCES} || true
|
||||
@end verbatim
|
||||
|
||||
@noindent
|
||||
|
@ -504,42 +483,25 @@ Automake variable @code{COMPILE}:
|
|||
|
||||
@verbatim
|
||||
check-syntax:
|
||||
$(COMPILE) -o /dev/null -S ${CHK_SOURCES}
|
||||
$(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:
|
||||
|
@ -564,10 +526,10 @@ will also check syntax in the current file. Examples are C/C++ (.h,
|
|||
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
|
||||
|
@ -609,15 +571,16 @@ 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.
|
||||
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
|
||||
|
@ -639,10 +602,10 @@ 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
|
||||
@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.
|
||||
|
||||
|
@ -656,27 +619,27 @@ of every syntax check attempt.
|
|||
@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.
|
||||
|
@ -687,12 +650,12 @@ Buildfile values are also cached.
|
|||
@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
|
||||
|
@ -700,7 +663,7 @@ without prompting the user.
|
|||
|
||||
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,
|
||||
|
@ -709,66 +672,39 @@ 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
|
||||
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
|
||||
|
|
|
@ -1183,7 +1183,29 @@ Each function's symbol gets added to `byte-compile-noruntime-functions'."
|
|||
(compilation-forget-errors)
|
||||
pt))))
|
||||
|
||||
(defvar byte-compile-log-warning-function
|
||||
#'byte-compile--log-warning-for-byte-compile
|
||||
"Function called when encountering a warning or error.
|
||||
Called with arguments (STRING POSITION FILL LEVEL). STRING is a
|
||||
message describing the problem. POSITION is a buffer position
|
||||
where the problem was detected. FILL is a prefix as in
|
||||
`warning-fill-prefix'. LEVEL is the level of the
|
||||
problem (`:warning' or `:error'). POSITION, FILL and LEVEL may be
|
||||
nil.")
|
||||
|
||||
(defun byte-compile-log-warning (string &optional fill level)
|
||||
"Log a byte-compilation warning.
|
||||
STRING, FILL and LEVEL are as described in
|
||||
`byte-compile-log-warning-function', which see."
|
||||
(funcall byte-compile-log-warning-function
|
||||
string byte-compile-last-position
|
||||
fill
|
||||
level))
|
||||
|
||||
(defun byte-compile--log-warning-for-byte-compile (string &optional
|
||||
_position
|
||||
fill
|
||||
level)
|
||||
"Log a message STRING in `byte-compile-log-buffer'.
|
||||
Also log the current function and file if not already done. If
|
||||
FILL is non-nil, set `warning-fill-prefix' to four spaces. LEVEL
|
||||
|
|
|
@ -1147,14 +1147,27 @@ Prefix argument is the same as for `checkdoc-defun'"
|
|||
;; features and behaviors, so we need some ways of specifying
|
||||
;; them, and making them easier to use in the wacked-out interfaces
|
||||
;; people are requesting
|
||||
(defun checkdoc-create-error (text start end &optional unfixable)
|
||||
"Used to create the return error text returned from all engines.
|
||||
(defvar checkdoc-create-error-function #'checkdoc--create-error-for-checkdoc
|
||||
"Function called when Checkdoc encounters an error.
|
||||
Should accept as arguments (TEXT START END &optional UNFIXABLE).
|
||||
|
||||
TEXT is the descriptive text of the error. START and END define the region
|
||||
it is sensible to highlight when describing the problem.
|
||||
Optional argument UNFIXABLE means that the error has no auto-fix available.
|
||||
|
||||
A list of the form (TEXT START END UNFIXABLE) is returned if we are not
|
||||
generating a buffered list of errors."
|
||||
generating a buffered list of errors.")
|
||||
|
||||
(defun checkdoc-create-error (text start end &optional unfixable)
|
||||
"Used to create the return error text returned from all engines.
|
||||
TEXT, START, END and UNFIXABLE conform to
|
||||
`checkdoc-create-error-function', which see."
|
||||
(funcall checkdoc-create-error-function text start end unfixable))
|
||||
|
||||
(defun checkdoc--create-error-for-checkdoc (text start end &optional unfixable)
|
||||
"Create an error for Checkdoc.
|
||||
TEXT, START, END and UNFIXABLE conform to
|
||||
`checkdoc-create-error-function', which see."
|
||||
(if checkdoc-generate-compile-warnings-flag
|
||||
(progn (checkdoc-error start text)
|
||||
nil)
|
||||
|
|
|
@ -243,7 +243,9 @@ Blank lines separate paragraphs. Semicolons start comments.
|
|||
(add-hook 'xref-backend-functions #'elisp--xref-backend nil t)
|
||||
(setq-local project-vc-external-roots-function #'elisp-load-path-roots)
|
||||
(add-hook 'completion-at-point-functions
|
||||
#'elisp-completion-at-point nil 'local))
|
||||
#'elisp-completion-at-point nil 'local)
|
||||
(add-hook 'flymake-diagnostic-functions #'elisp-flymake-checkdoc nil t)
|
||||
(add-hook 'flymake-diagnostic-functions #'elisp-flymake-byte-compile nil t))
|
||||
|
||||
;; Font-locking support.
|
||||
|
||||
|
@ -810,7 +812,7 @@ non-nil result supercedes the xrefs produced by
|
|||
(apply #'nconc
|
||||
(let (lst)
|
||||
(dolist (sym (apropos-internal regexp))
|
||||
(push (elisp--xref-find-definitions sym) lst))
|
||||
(push (elisp--xref-find-definitions sym) lst))
|
||||
(nreverse lst))))
|
||||
|
||||
(defvar elisp--xref-identifier-completion-table
|
||||
|
@ -1109,7 +1111,7 @@ If CHAR is not a character, return nil."
|
|||
;; interactive call would use it.
|
||||
;; FIXME: Is it really the right place for this?
|
||||
(when (eq (car-safe expr) 'interactive)
|
||||
(setq expr
|
||||
(setq expr
|
||||
`(call-interactively
|
||||
(lambda (&rest args) ,expr args))))
|
||||
expr)))))
|
||||
|
@ -1174,7 +1176,7 @@ POS specifies the starting position where EXP was found and defaults to point."
|
|||
(and (not (special-variable-p var))
|
||||
(save-excursion
|
||||
(zerop (car (syntax-ppss (match-beginning 0)))))
|
||||
(push var vars))))
|
||||
(push var vars))))
|
||||
`(progn ,@(mapcar (lambda (v) `(defvar ,v)) vars) ,exp)))))
|
||||
|
||||
(defun eval-last-sexp (eval-last-sexp-arg-internal)
|
||||
|
@ -1379,7 +1381,7 @@ or elsewhere, return a 1-line docstring."
|
|||
(t (help-function-arglist sym)))))
|
||||
;; Stringify, and store before highlighting, downcasing, etc.
|
||||
(elisp--last-data-store sym (elisp-function-argstring args)
|
||||
'function))))))
|
||||
'function))))))
|
||||
;; Highlight, truncate.
|
||||
(if argstring
|
||||
(elisp--highlight-function-argument
|
||||
|
@ -1588,5 +1590,164 @@ ARGLIST is either a string, or a list of strings or symbols."
|
|||
(replace-match "(" t t str)
|
||||
str)))
|
||||
|
||||
;;; Flymake support
|
||||
|
||||
;; Don't require checkdoc, but forward declare these checkdoc special
|
||||
;; variables. Autoloading them on `checkdoc-current-buffer' is too
|
||||
;; late, they won't be bound dynamically.
|
||||
(defvar checkdoc-create-error-function)
|
||||
(defvar checkdoc-autofix-flag)
|
||||
(defvar checkdoc-generate-compile-warnings-flag)
|
||||
(defvar checkdoc-diagnostic-buffer)
|
||||
(defun elisp-flymake--checkdoc-1 ()
|
||||
"Do actual work for `elisp-flymake-checkdoc'."
|
||||
(let (collected)
|
||||
(let* ((checkdoc-create-error-function
|
||||
(lambda (text start end &optional unfixable)
|
||||
(push (list text start end unfixable) collected)
|
||||
nil))
|
||||
(checkdoc-autofix-flag nil)
|
||||
(checkdoc-generate-compile-warnings-flag nil)
|
||||
(buf (generate-new-buffer " *checkdoc-temp*"))
|
||||
(checkdoc-diagnostic-buffer buf))
|
||||
(unwind-protect
|
||||
(save-excursion
|
||||
(checkdoc-current-buffer t))
|
||||
(kill-buffer buf)))
|
||||
collected))
|
||||
|
||||
;;;###autoload
|
||||
(defun elisp-flymake-checkdoc (report-fn &rest _args)
|
||||
"A Flymake backend for `checkdoc'.
|
||||
Calls REPORT-FN directly."
|
||||
(unless (derived-mode-p 'emacs-lisp-mode)
|
||||
(error "Can only work on `emacs-lisp-mode' buffers"))
|
||||
(funcall report-fn
|
||||
(cl-loop for (text start end _unfixable) in
|
||||
(elisp-flymake--checkdoc-1)
|
||||
collect
|
||||
(flymake-make-diagnostic
|
||||
(current-buffer)
|
||||
start end :note text))))
|
||||
|
||||
(defun elisp-flymake--byte-compile-done (report-fn
|
||||
origin-buffer
|
||||
output-buffer
|
||||
temp-file)
|
||||
(unwind-protect
|
||||
(with-current-buffer
|
||||
origin-buffer
|
||||
(save-excursion
|
||||
(save-restriction
|
||||
(widen)
|
||||
(funcall
|
||||
report-fn
|
||||
(cl-loop with data =
|
||||
(with-current-buffer output-buffer
|
||||
(goto-char (point-min))
|
||||
(search-forward ":elisp-flymake-output-start")
|
||||
(read (point-marker)))
|
||||
for (string pos _fill level) in data
|
||||
do (goto-char pos)
|
||||
for beg = (if (< (point) (point-max))
|
||||
(point)
|
||||
(line-beginning-position))
|
||||
for end = (min
|
||||
(line-end-position)
|
||||
(or (cdr
|
||||
(bounds-of-thing-at-point 'sexp))
|
||||
(point-max)))
|
||||
collect (flymake-make-diagnostic
|
||||
(current-buffer)
|
||||
(if (= beg end) (1- beg) beg)
|
||||
end
|
||||
level
|
||||
string))))))
|
||||
(kill-buffer output-buffer)
|
||||
(ignore-errors (delete-file temp-file))))
|
||||
|
||||
(defvar-local elisp-flymake--byte-compile-process nil
|
||||
"Buffer-local process started for byte-compiling the buffer.")
|
||||
|
||||
;;;###autoload
|
||||
(defun elisp-flymake-byte-compile (report-fn &rest _args)
|
||||
"A Flymake backend for elisp byte compilation.
|
||||
Spawn an Emacs process that byte-compiles a file representing the
|
||||
current buffer state and calls REPORT-FN when done."
|
||||
(interactive (list (lambda (stuff)
|
||||
(message "aha %s" stuff))))
|
||||
(unless (derived-mode-p 'emacs-lisp-mode)
|
||||
(error "Can only work on `emacs-lisp-mode' buffers"))
|
||||
(when elisp-flymake--byte-compile-process
|
||||
(process-put elisp-flymake--byte-compile-process 'elisp-flymake--obsolete t)
|
||||
(when (process-live-p elisp-flymake--byte-compile-process)
|
||||
(kill-process elisp-flymake--byte-compile-process)))
|
||||
(let ((temp-file (make-temp-file "elisp-flymake-byte-compile"))
|
||||
(origin-buffer (current-buffer)))
|
||||
(save-restriction
|
||||
(widen)
|
||||
(write-region (point-min) (point-max) temp-file nil 'nomessage))
|
||||
(let* ((output-buffer (generate-new-buffer " *elisp-flymake-byte-compile*")))
|
||||
(setq
|
||||
elisp-flymake--byte-compile-process
|
||||
(make-process
|
||||
:name "elisp-flymake-byte-compile"
|
||||
:buffer output-buffer
|
||||
:command (list (expand-file-name invocation-name invocation-directory)
|
||||
"-Q"
|
||||
"--batch"
|
||||
;; "--eval" "(setq load-prefer-newer t)" ; for testing
|
||||
"-L" default-directory
|
||||
"-f" "elisp-flymake--batch-compile-for-flymake"
|
||||
temp-file)
|
||||
:connection-type 'pipe
|
||||
:sentinel
|
||||
(lambda (proc _event)
|
||||
(unless (process-live-p proc)
|
||||
(unwind-protect
|
||||
(cond
|
||||
((zerop (process-exit-status proc))
|
||||
(elisp-flymake--byte-compile-done report-fn
|
||||
origin-buffer
|
||||
output-buffer
|
||||
temp-file))
|
||||
((process-get proc 'elisp-flymake--obsolete)
|
||||
(flymake-log :warning "byte-compile process %s obsolete" proc))
|
||||
(t
|
||||
(funcall report-fn
|
||||
:panic
|
||||
:explanation
|
||||
(format "byte-compile process %s died" proc)))))))))
|
||||
:stderr null-device
|
||||
:noquery t)))
|
||||
|
||||
(defun elisp-flymake--batch-compile-for-flymake (&optional file)
|
||||
"Helper for `elisp-flymake-byte-compile'.
|
||||
Runs in a batch-mode Emacs. Interactively use variable
|
||||
`buffer-file-name' for FILE."
|
||||
(interactive (list buffer-file-name))
|
||||
(let* ((file (or file
|
||||
(car command-line-args-left)))
|
||||
(dummy-elc-file)
|
||||
(byte-compile-log-buffer
|
||||
(generate-new-buffer " *dummy-byte-compile-log-buffer*"))
|
||||
(byte-compile-dest-file-function
|
||||
(lambda (source)
|
||||
(setq dummy-elc-file (make-temp-file (file-name-nondirectory source)))))
|
||||
(collected)
|
||||
(byte-compile-log-warning-function
|
||||
(lambda (string &optional position fill level)
|
||||
(push (list string position fill level)
|
||||
collected)
|
||||
t)))
|
||||
(unwind-protect
|
||||
(byte-compile-file file)
|
||||
(ignore-errors
|
||||
(delete-file dummy-elc-file)
|
||||
(kill-buffer byte-compile-log-buffer)))
|
||||
(prin1 :elisp-flymake-output-start)
|
||||
(terpri)
|
||||
(pp collected)))
|
||||
|
||||
(provide 'elisp-mode)
|
||||
;;; elisp-mode.el ends here
|
||||
|
|
1194
lisp/progmodes/flymake-proc.el
Normal file
1194
lisp/progmodes/flymake-proc.el
Normal file
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
@ -1,6 +1,6 @@
|
|||
# Makefile for flymake tests
|
||||
|
||||
CC_OPTS = -Wall
|
||||
CC_OPTS = -Wall -Wextra
|
||||
|
||||
## Recent gcc (e.g. 4.8.2 on RHEL7) can automatically colorize their output,
|
||||
## which can confuse flymake. Set GCC_COLORS to disable that.
|
||||
|
@ -8,6 +8,6 @@ CC_OPTS = -Wall
|
|||
## normally use flymake, so it seems like just avoiding the issue
|
||||
## in this test is fine. Set flymake-log-level to 3 to investigate.
|
||||
check-syntax:
|
||||
GCC_COLORS= $(CC) $(CC_OPTS) ${CHK_SOURCES}
|
||||
GCC_COLORS= $(CC) $(CC_OPTS) ${CHK_SOURCES} || true
|
||||
|
||||
# eof
|
||||
|
|
13
test/lisp/progmodes/flymake-resources/errors-and-warnings.c
Normal file
13
test/lisp/progmodes/flymake-resources/errors-and-warnings.c
Normal file
|
@ -0,0 +1,13 @@
|
|||
/* Flymake should notice an error on the next line, since
|
||||
that file has at least one warning.*/
|
||||
#include "some-problems.h"
|
||||
/* But not this one */
|
||||
#include "no-problems.h"
|
||||
|
||||
int main()
|
||||
{
|
||||
char c = 1000; /* a note and a warning */
|
||||
int bla;
|
||||
char c; if (bla == (void*)3); /* an error, and two warnings */
|
||||
return c;
|
||||
}
|
1
test/lisp/progmodes/flymake-resources/no-problems.h
Normal file
1
test/lisp/progmodes/flymake-resources/no-problems.h
Normal file
|
@ -0,0 +1 @@
|
|||
typedef int no_problems;
|
5
test/lisp/progmodes/flymake-resources/some-problems.h
Normal file
5
test/lisp/progmodes/flymake-resources/some-problems.h
Normal file
|
@ -0,0 +1,5 @@
|
|||
#include <stdio.h>
|
||||
|
||||
strange;
|
||||
|
||||
sint main();
|
|
@ -1,4 +1,4 @@
|
|||
;;; flymake-tests.el --- Test suite for flymake
|
||||
;;; flymake-tests.el --- Test suite for flymake -*- lexical-binding: t -*-
|
||||
|
||||
;; Copyright (C) 2011-2017 Free Software Foundation, Inc.
|
||||
|
||||
|
@ -26,54 +26,295 @@
|
|||
(require 'flymake)
|
||||
|
||||
(defvar flymake-tests-data-directory
|
||||
(expand-file-name "lisp/progmodes/flymake-resources" (getenv "EMACS_TEST_DIRECTORY"))
|
||||
(expand-file-name "lisp/progmodes/flymake-resources"
|
||||
(or (getenv "EMACS_TEST_DIRECTORY")
|
||||
(expand-file-name "../../.."
|
||||
(or load-file-name
|
||||
buffer-file-name))))
|
||||
"Directory containing flymake test data.")
|
||||
|
||||
|
||||
;; Warning predicate
|
||||
(defun flymake-tests--current-face (file predicate)
|
||||
(let ((buffer (find-file-noselect
|
||||
(expand-file-name file flymake-tests-data-directory)))
|
||||
(process-environment (cons "LC_ALL=C" process-environment))
|
||||
(i 0))
|
||||
;;
|
||||
;;
|
||||
(defun flymake-tests--wait-for-backends ()
|
||||
;; Weirdness here... http://debbugs.gnu.org/17647#25
|
||||
;; ... meaning `sleep-for', and even
|
||||
;; `accept-process-output', won't suffice as ways to get
|
||||
;; process filters and sentinels to run, though they do work
|
||||
;; fine in a non-interactive batch session. The only thing
|
||||
;; that will indeed unblock pending process output is
|
||||
;; reading an input event, so, as a workaround, use a dummy
|
||||
;; `read-event' with a very short timeout.
|
||||
(unless noninteractive (read-event "" nil 0.1))
|
||||
(cl-loop repeat 5
|
||||
for notdone = (cl-set-difference (flymake-running-backends)
|
||||
(flymake-reporting-backends))
|
||||
while notdone
|
||||
unless noninteractive do (read-event "" nil 0.1)
|
||||
do (sleep-for (+ 0.5 flymake-no-changes-timeout))
|
||||
finally (when notdone (ert-fail
|
||||
(format "Some backends not reporting yet %s"
|
||||
notdone)))))
|
||||
|
||||
(cl-defun flymake-tests--call-with-fixture (fn file
|
||||
&key (severity-predicate
|
||||
nil sev-pred-supplied-p))
|
||||
"Call FN after flymake setup in FILE, using `flymake-proc`.
|
||||
SEVERITY-PREDICATE is used to setup
|
||||
`flymake-proc-diagnostic-type-pred'"
|
||||
(let* ((file (expand-file-name file flymake-tests-data-directory))
|
||||
(visiting (find-buffer-visiting file))
|
||||
(buffer (or visiting (find-file-noselect file)))
|
||||
(process-environment (cons "LC_ALL=C" process-environment))
|
||||
(warning-minimum-log-level :error))
|
||||
(unwind-protect
|
||||
(with-current-buffer buffer
|
||||
(setq-local flymake-warning-predicate predicate)
|
||||
(goto-char (point-min))
|
||||
(flymake-mode 1)
|
||||
;; Weirdness here... https://debbugs.gnu.org/17647#25
|
||||
(while (and flymake-is-running (< (setq i (1+ i)) 10))
|
||||
(sleep-for (+ 0.5 flymake-no-changes-timeout)))
|
||||
(flymake-goto-next-error)
|
||||
(face-at-point))
|
||||
(and buffer (let (kill-buffer-query-functions) (kill-buffer buffer))))))
|
||||
(save-excursion
|
||||
(when sev-pred-supplied-p
|
||||
(setq-local flymake-proc-diagnostic-type-pred severity-predicate))
|
||||
(goto-char (point-min))
|
||||
(unless flymake-mode (flymake-mode 1))
|
||||
(flymake-tests--wait-for-backends)
|
||||
(funcall fn)))
|
||||
(and buffer
|
||||
(not visiting)
|
||||
(let (kill-buffer-query-functions) (kill-buffer buffer))))))
|
||||
|
||||
(cl-defmacro flymake-tests--with-flymake ((file &rest args)
|
||||
&body body)
|
||||
(declare (indent 1)
|
||||
(debug (sexp &rest form)))
|
||||
`(flymake-tests--call-with-fixture (lambda () ,@body) ,file ,@args))
|
||||
|
||||
(ert-deftest warning-predicate-rx-gcc ()
|
||||
"Test GCC warning via regexp predicate."
|
||||
(skip-unless (and (executable-find "gcc") (executable-find "make")))
|
||||
(should (eq 'flymake-warnline
|
||||
(flymake-tests--current-face "test.c" "^[Ww]arning"))))
|
||||
(flymake-tests--with-flymake
|
||||
("test.c" :severity-predicate "^[Ww]arning")
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning
|
||||
(face-at-point)))))
|
||||
|
||||
(ert-deftest warning-predicate-function-gcc ()
|
||||
"Test GCC warning via function predicate."
|
||||
(skip-unless (and (executable-find "gcc") (executable-find "make")))
|
||||
(should (eq 'flymake-warnline
|
||||
(flymake-tests--current-face "test.c"
|
||||
(lambda (msg) (string-match "^[Ww]arning" msg))))))
|
||||
(flymake-tests--with-flymake
|
||||
("test.c" :severity-predicate
|
||||
(lambda (msg) (string-match "^[Ww]arning" msg)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning
|
||||
(face-at-point)))))
|
||||
|
||||
(ert-deftest warning-predicate-rx-perl ()
|
||||
"Test perl warning via regular expression predicate."
|
||||
(skip-unless (executable-find "perl"))
|
||||
(should (eq 'flymake-warnline
|
||||
(flymake-tests--current-face "test.pl" "^Scalar value"))))
|
||||
(flymake-tests--with-flymake
|
||||
("test.pl" :severity-predicate "^Scalar value")
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning
|
||||
(face-at-point)))))
|
||||
|
||||
(ert-deftest warning-predicate-function-perl ()
|
||||
"Test perl warning via function predicate."
|
||||
(skip-unless (executable-find "perl"))
|
||||
(should (eq 'flymake-warnline
|
||||
(flymake-tests--current-face
|
||||
"test.pl"
|
||||
(lambda (msg) (string-match "^Scalar value" msg))))))
|
||||
(flymake-tests--with-flymake
|
||||
("test.pl" :severity-predicate
|
||||
(lambda (msg) (string-match "^Scalar value" msg)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning
|
||||
(face-at-point)))))
|
||||
|
||||
(ert-deftest different-diagnostic-types ()
|
||||
"Test GCC warning via function predicate."
|
||||
(skip-unless (and (executable-find "gcc") (executable-find "make")))
|
||||
(let ((flymake-wrap-around nil))
|
||||
(flymake-tests--with-flymake
|
||||
("errors-and-warnings.c")
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-note (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point)))
|
||||
(should-error (flymake-goto-next-error nil nil t)))))
|
||||
|
||||
(ert-deftest included-c-header-files ()
|
||||
"Test inclusion of .h header files."
|
||||
(skip-unless (and (executable-find "gcc") (executable-find "make")))
|
||||
(let ((flymake-wrap-around nil))
|
||||
(flymake-tests--with-flymake
|
||||
("some-problems.h")
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point)))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point)))
|
||||
(should-error (flymake-goto-next-error nil nil t)))
|
||||
(flymake-tests--with-flymake
|
||||
("no-problems.h")
|
||||
(should-error (flymake-goto-next-error nil nil t)))))
|
||||
|
||||
(defmacro flymake-tests--assert-set (set
|
||||
should
|
||||
should-not)
|
||||
(declare (indent 1))
|
||||
`(progn
|
||||
,@(cl-loop
|
||||
for s in should
|
||||
collect `(should (memq (quote ,s) ,set)))
|
||||
,@(cl-loop
|
||||
for s in should-not
|
||||
collect `(should-not (memq (quote ,s) ,set)))))
|
||||
|
||||
(defun flymake-tests--diagnose-words
|
||||
(report-fn type words)
|
||||
"Helper. Call REPORT-FN with diagnostics for WORDS in buffer."
|
||||
(funcall report-fn
|
||||
(cl-loop
|
||||
for word in words
|
||||
append
|
||||
(save-excursion
|
||||
(goto-char (point-min))
|
||||
(cl-loop while (word-search-forward word nil t)
|
||||
collect (flymake-make-diagnostic
|
||||
(current-buffer)
|
||||
(match-beginning 0)
|
||||
(match-end 0)
|
||||
type
|
||||
(concat word " is wrong")))))))
|
||||
|
||||
(ert-deftest dummy-backends ()
|
||||
"Test many different kinds of backends."
|
||||
(with-temp-buffer
|
||||
(cl-letf
|
||||
(((symbol-function 'error-backend)
|
||||
(lambda (report-fn)
|
||||
(run-with-timer
|
||||
0.5 nil
|
||||
#'flymake-tests--diagnose-words report-fn :error '("manha" "prognata"))))
|
||||
((symbol-function 'warning-backend)
|
||||
(lambda (report-fn)
|
||||
(run-with-timer
|
||||
0.5 nil
|
||||
#'flymake-tests--diagnose-words report-fn :warning '("ut" "dolor"))))
|
||||
((symbol-function 'sync-backend)
|
||||
(lambda (report-fn)
|
||||
(flymake-tests--diagnose-words report-fn :note '("quis" "commodo"))))
|
||||
((symbol-function 'panicking-backend)
|
||||
(lambda (report-fn)
|
||||
(run-with-timer
|
||||
0.5 nil
|
||||
report-fn :panic :explanation "The spanish inquisition!")))
|
||||
((symbol-function 'crashing-backend)
|
||||
(lambda (_report-fn)
|
||||
;; HACK: Shoosh log during tests
|
||||
(setq-local warning-minimum-log-level :emergency)
|
||||
(error "crashed"))))
|
||||
(insert "Lorem ipsum dolor sit amet, consectetur adipiscing
|
||||
elit, sed do eiusmod tempor incididunt ut labore et dolore
|
||||
manha aliqua. Ut enim ad minim veniam, quis nostrud
|
||||
exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in
|
||||
voluptate velit esse cillum dolore eu fugiat nulla
|
||||
pariatur. Excepteur sint occaecat cupidatat non prognata
|
||||
sunt in culpa qui officia deserunt mollit anim id est
|
||||
laborum.")
|
||||
(let ((flymake-diagnostic-functions
|
||||
(list 'error-backend 'warning-backend 'sync-backend
|
||||
'panicking-backend
|
||||
'crashing-backend
|
||||
))
|
||||
(flymake-wrap-around nil))
|
||||
(flymake-mode)
|
||||
|
||||
(flymake-tests--assert-set (flymake-running-backends)
|
||||
(error-backend warning-backend panicking-backend)
|
||||
(crashing-backend))
|
||||
|
||||
(flymake-tests--assert-set (flymake-disabled-backends)
|
||||
(crashing-backend)
|
||||
(error-backend warning-backend sync-backend
|
||||
panicking-backend))
|
||||
|
||||
(flymake-tests--wait-for-backends)
|
||||
|
||||
(flymake-tests--assert-set (flymake-disabled-backends)
|
||||
(crashing-backend panicking-backend)
|
||||
(error-backend warning-backend sync-backend))
|
||||
|
||||
(goto-char (point-min))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; dolor
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; ut
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point))) ; manha
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; Ut
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-note (face-at-point))) ; quis
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; ut
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-note (face-at-point))) ; commodo
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; dolor
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point))) ; prognata
|
||||
(should-error (flymake-goto-next-error nil nil t))))))
|
||||
|
||||
(ert-deftest recurrent-backend ()
|
||||
"Test a backend that calls REPORT-FN multiple times"
|
||||
(with-temp-buffer
|
||||
(let (tick)
|
||||
(cl-letf
|
||||
(((symbol-function 'eager-backend)
|
||||
(lambda (report-fn)
|
||||
(funcall report-fn nil :explanation "very eager but no diagnostics")
|
||||
(display-buffer (current-buffer))
|
||||
(run-with-timer
|
||||
0.5 nil
|
||||
(lambda ()
|
||||
(flymake-tests--diagnose-words report-fn :warning '("consectetur"))
|
||||
(setq tick t)
|
||||
(run-with-timer
|
||||
0.5 nil
|
||||
(lambda ()
|
||||
(flymake-tests--diagnose-words report-fn :error '("fugiat"))
|
||||
(setq tick t))))))))
|
||||
(insert "Lorem ipsum dolor sit amet, consectetur adipiscing
|
||||
elit, sed do eiusmod tempor incididunt ut labore et dolore
|
||||
manha aliqua. Ut enim ad minim veniam, quis nostrud
|
||||
exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in
|
||||
voluptate velit esse cillum dolore eu fugiat nulla
|
||||
pariatur. Excepteur sint occaecat cupidatat non prognata
|
||||
sunt in culpa qui officia deserunt mollit anim id est
|
||||
laborum.")
|
||||
(let ((flymake-diagnostic-functions
|
||||
(list 'eager-backend))
|
||||
(flymake-wrap-around nil))
|
||||
(flymake-mode)
|
||||
(flymake-tests--assert-set (flymake-running-backends)
|
||||
(eager-backend) ())
|
||||
(cl-loop until tick repeat 4 do (sleep-for 0.2))
|
||||
(setq tick nil)
|
||||
(goto-char (point-max))
|
||||
(flymake-goto-prev-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; consectetur
|
||||
(should-error (flymake-goto-prev-error nil nil t))
|
||||
(cl-loop until tick repeat 4 do (sleep-for 0.2))
|
||||
(flymake-goto-next-error)
|
||||
(should (eq 'flymake-error (face-at-point))) ; fugiat
|
||||
(flymake-goto-prev-error)
|
||||
(should (eq 'flymake-warning (face-at-point))) ; back at consectetur
|
||||
(should-error (flymake-goto-prev-error nil nil t))
|
||||
)))))
|
||||
|
||||
(provide 'flymake-tests)
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue