clang-tools
11.0.0
|
Contains options for clang-tidy. More...
#include <ClangTidyOptions.h>
Classes | |
struct | ClangTidyValue |
Helper structure for storing option value with priority of the value. More... | |
Public Types | |
typedef std::pair< std::string, std::string > | StringPair |
typedef std::map< std::string, ClangTidyValue > | OptionMap |
typedef std::vector< std::string > | ArgList |
Public Member Functions | |
ClangTidyOptions | mergeWith (const ClangTidyOptions &Other, unsigned Order) const |
Creates a new ClangTidyOptions instance combined from all fields of this instance overridden by the fields of Other that have a value. More... | |
Static Public Member Functions | |
static ClangTidyOptions | getDefaults () |
These options are used for all settings that haven't been overridden by the OptionsProvider . More... | |
Public Attributes | |
llvm::Optional< std::string > | Checks |
Checks filter. More... | |
llvm::Optional< std::string > | WarningsAsErrors |
WarningsAsErrors filter. More... | |
llvm::Optional< std::string > | HeaderFilterRegex |
Output warnings from headers matching this filter. More... | |
llvm::Optional< bool > | SystemHeaders |
Output warnings from system headers matching HeaderFilterRegex . More... | |
llvm::Optional< std::string > | FormatStyle |
Format code around applied fixes with clang-format using this style. More... | |
llvm::Optional< std::string > | User |
Specifies the name or e-mail of the user running clang-tidy. More... | |
OptionMap | CheckOptions |
Key-value mapping used to store check-specific options. More... | |
llvm::Optional< ArgList > | ExtraArgs |
Add extra compilation arguments to the end of the list. More... | |
llvm::Optional< ArgList > | ExtraArgsBefore |
Add extra compilation arguments to the start of the list. More... | |
llvm::Optional< bool > | InheritParentConfig |
Only used in the FileOptionsProvider and ConfigOptionsProvider. More... | |
llvm::Optional< bool > | UseColor |
Use colors in diagnostics. If missing, it will be auto detected. More... | |
Contains options for clang-tidy.
These options may be read from configuration files, and may be different for different translation units.
Definition at line 50 of file ClangTidyOptions.h.
typedef std::vector<std::string> clang::tidy::ClangTidyOptions::ArgList |
Definition at line 116 of file ClangTidyOptions.h.
typedef std::map<std::string, ClangTidyValue> clang::tidy::ClangTidyOptions::OptionMap |
Definition at line 111 of file ClangTidyOptions.h.
typedef std::pair<std::string, std::string> clang::tidy::ClangTidyOptions::StringPair |
Definition at line 110 of file ClangTidyOptions.h.
|
static |
These options are used for all settings that haven't been overridden by the OptionsProvider
.
Allow no checks and no headers by default. This method initializes check-specific options by calling ClangTidyModule::getModuleOptions()
of each registered ClangTidyModule
.
Definition at line 109 of file ClangTidyOptions.cpp.
References Checks, FormatStyle, HeaderFilterRegex, mergeWith(), SystemHeaders, User, and WarningsAsErrors.
Referenced by clang::tidy::ClangTidyContext::getOptionsForFile().
ClangTidyOptions clang::tidy::ClangTidyOptions::mergeWith | ( | const ClangTidyOptions & | Other, |
unsigned | Order | ||
) | const |
Creates a new ClangTidyOptions
instance combined from all fields of this instance overridden by the fields of Other
that have a value.
Order
specifies precedence of Other
option.
Definition at line 147 of file ClangTidyOptions.cpp.
Referenced by getDefaults(), and clang::tidy::ClangTidyContext::getOptionsForFile().
OptionMap clang::tidy::ClangTidyOptions::CheckOptions |
Key-value mapping used to store check-specific options.
Definition at line 114 of file ClangTidyOptions.h.
Referenced by clang::tidy::llvm_check::LLVMModule::getModuleOptions(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::Checks |
Checks filter.
Definition at line 66 of file ClangTidyOptions.h.
Referenced by getDefaults(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<ArgList> clang::tidy::ClangTidyOptions::ExtraArgs |
Add extra compilation arguments to the end of the list.
Definition at line 119 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<ArgList> clang::tidy::ClangTidyOptions::ExtraArgsBefore |
Add extra compilation arguments to the start of the list.
Definition at line 122 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::FormatStyle |
Format code around applied fixes with clang-format using this style.
Can be one of:
See clang-format documentation for more about configuring format style.
Definition at line 90 of file ClangTidyOptions.h.
Referenced by getDefaults(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::HeaderFilterRegex |
Output warnings from headers matching this filter.
Warnings from main files will always be displayed.
Definition at line 73 of file ClangTidyOptions.h.
Referenced by getDefaults(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<bool> clang::tidy::ClangTidyOptions::InheritParentConfig |
Only used in the FileOptionsProvider and ConfigOptionsProvider.
If true and using a FileOptionsProvider, it will take a configuration file in the parent directory (if any exists) and apply this config file on top of the parent one. IF true and using a ConfigOptionsProvider, it will apply this config on top of any configuation file it finds in the directory using the same logic as FileOptionsProvider. If false or missing, only this configuration file will be used.
Definition at line 131 of file ClangTidyOptions.h.
Referenced by clang::tidy::ConfigOptionsProvider::getRawOptions(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<bool> clang::tidy::ClangTidyOptions::SystemHeaders |
Output warnings from system headers matching HeaderFilterRegex
.
Definition at line 76 of file ClangTidyOptions.h.
Referenced by getDefaults().
llvm::Optional<bool> clang::tidy::ClangTidyOptions::UseColor |
Use colors in diagnostics. If missing, it will be auto detected.
Definition at line 134 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::User |
Specifies the name or e-mail of the user running clang-tidy.
This option is used, for example, to place the correct user name in TODO() comments in the relevant check.
Definition at line 96 of file ClangTidyOptions.h.
Referenced by getDefaults(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::WarningsAsErrors |
WarningsAsErrors filter.
Definition at line 69 of file ClangTidyOptions.h.
Referenced by getDefaults(), and llvm::yaml::MappingTraits< ClangTidyOptions >::mapping().