clang-tools
7.0.0
|
Contains options for clang-tidy. More...
#include <ClangTidyOptions.h>
Public Types | |
typedef std::pair< std::string, std::string > | StringPair |
typedef std::map< std::string, std::string > | OptionMap |
typedef std::vector< std::string > | ArgList |
Public Member Functions | |
ClangTidyOptions | mergeWith (const ClangTidyOptions &Other) 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... | |
Contains options for clang-tidy.
These options may be read from configuration files, and may be different for different translation units.
Definition at line 51 of file ClangTidyOptions.h.
typedef std::vector<std::string> clang::tidy::ClangTidyOptions::ArgList |
Definition at line 103 of file ClangTidyOptions.h.
typedef std::map<std::string, std::string> clang::tidy::ClangTidyOptions::OptionMap |
Definition at line 98 of file ClangTidyOptions.h.
typedef std::pair<std::string, std::string> clang::tidy::ClangTidyOptions::StringPair |
Definition at line 97 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 105 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 | ) | const |
Creates a new ClangTidyOptions
instance combined from all fields of this instance overridden by the fields of Other
that have a value.
Definition at line 143 of file ClangTidyOptions.cpp.
References CheckOptions, Checks, ExtraArgs, ExtraArgsBefore, FormatStyle, HeaderFilterRegex, clang::tidy::mergeCommaSeparatedLists(), clang::tidy::mergeVectors(), clang::tidy::overrideValue(), SystemHeaders, User, and WarningsAsErrors.
Referenced by getDefaults(), clang::tidy::ClangTidyOptionsProvider::getOptions(), and clang::tidy::ClangTidyContext::getOptionsForFile().
OptionMap clang::tidy::ClangTidyOptions::CheckOptions |
Key-value mapping used to store check-specific options.
Definition at line 101 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::Checks |
Checks filter.
Definition at line 65 of file ClangTidyOptions.h.
Referenced by getDefaults(), llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), mergeWith(), and clang::tidy::ClangTidyContext::setCurrentFile().
llvm::Optional<ArgList> clang::tidy::ClangTidyOptions::ExtraArgs |
Add extra compilation arguments to the end of the list.
Definition at line 106 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
llvm::Optional<ArgList> clang::tidy::ClangTidyOptions::ExtraArgsBefore |
Add extra compilation arguments to the start of the list.
Definition at line 109 of file ClangTidyOptions.h.
Referenced by llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
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 89 of file ClangTidyOptions.h.
Referenced by getDefaults(), llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
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 72 of file ClangTidyOptions.h.
Referenced by getDefaults(), clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic(), llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
llvm::Optional<bool> clang::tidy::ClangTidyOptions::SystemHeaders |
Output warnings from system headers matching HeaderFilterRegex
.
Definition at line 75 of file ClangTidyOptions.h.
Referenced by getDefaults(), clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic(), and mergeWith().
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 95 of file ClangTidyOptions.h.
Referenced by getDefaults(), llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), and mergeWith().
llvm::Optional<std::string> clang::tidy::ClangTidyOptions::WarningsAsErrors |
WarningsAsErrors filter.
Definition at line 68 of file ClangTidyOptions.h.
Referenced by getDefaults(), llvm::yaml::MappingTraits< ClangTidyOptions >::mapping(), mergeWith(), and clang::tidy::ClangTidyContext::setCurrentFile().