53 lines
1.8 KiB
Text
53 lines
1.8 KiB
Text
Compiler plugins.
|
|
|
|
|
|
== Overview ==
|
|
|
|
This directory contains code for compiler plugins. These are used to perform
|
|
additional actions during compilation (such as additional warnings) and
|
|
also to perform mass code refactoring.
|
|
|
|
Currently only the Clang compiler is supported (http://wiki.documentfoundation.org/Development/Clang).
|
|
|
|
|
|
== Usage ==
|
|
|
|
Compiler plugins are enabled automatically by --enable-dbgutil if Clang headers
|
|
are found or explicitly using --enable-compiler-plugins.
|
|
|
|
|
|
== Functionality ==
|
|
|
|
There are two kinds of plugin actions:
|
|
- compile checks - these are run during normal compilation
|
|
- rewriters - these must be run manually and modify source files
|
|
|
|
Each source has a comment saying whether it's compile check or a rewriter
|
|
and description of functionality.
|
|
|
|
=== Compile checks ===
|
|
|
|
Used during normal compilation to perform additional checks.
|
|
All warnings and errors are marked '[loplugin]' in the message.
|
|
|
|
|
|
=== Rewriters ===
|
|
|
|
Rewriters analyse and possibly modify given source files.
|
|
Usage: make COMPILER_PLUGIN_TOOL=<rewriter_name>
|
|
Additional optional make arguments:
|
|
- it is possible to also pass FORCE_COMPILE_ALL=1 to make to trigger rebuild of all source files,
|
|
even those that are up to date.
|
|
- UPDATE_FILES=<scope> - limits which modified files will be actually written back with the changes
|
|
- mainfile - only the main .cxx file will be modifed (default)
|
|
- all - all source files involved will be modified (possibly even header files from other LO modules),
|
|
3rd party header files are however never modified
|
|
- <module> - only files in the given LO module (toplevel directory) will be modified (including headers)
|
|
|
|
Modifications will be written directly to the source files.
|
|
|
|
|
|
== Code documentation / howtos ==
|
|
|
|
http://wiki.documentfoundation.org/Clang_plugins
|
|
|