12 #include "clang/Basic/LLVM.h"
13 #include "llvm/ADT/SmallString.h"
14 #include "llvm/Support/Debug.h"
15 #include "llvm/Support/Errc.h"
16 #include "llvm/Support/FileSystem.h"
17 #include "llvm/Support/Path.h"
18 #include "llvm/Support/YAMLTraits.h"
19 #include "llvm/Support/raw_ostream.h"
22 #define DEBUG_TYPE "clang-tidy-options"
29 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(
FileFilter::LineRange)
31 LLVM_YAML_IS_SEQUENCE_VECTOR(std::
string)
37 template <>
struct SequenceTraits<
FileFilter::LineRange> {
38 static size_t size(IO &IO, FileFilter::LineRange &
Range) {
39 return Range.first == 0 ? 0 : Range.second == 0 ? 1 : 2;
41 static unsigned &
element(IO &IO, FileFilter::LineRange &
Range,
size_t Index) {
43 IO.setError(
"Too many elements in line range.");
44 return Index == 0 ? Range.first : Range.second;
50 IO.mapRequired(
"name", File.
Name);
54 if (File.
Name.empty())
55 return "No file name specified";
57 if (Range.first <= 0 || Range.second <= 0)
58 return "Invalid line range";
65 static void mapping(IO &IO, ClangTidyOptions::StringPair &KeyValue) {
66 IO.mapRequired(
"key", KeyValue.first);
67 IO.mapRequired(
"value", KeyValue.second);
73 NOptionMap(IO &,
const ClangTidyOptions::OptionMap &OptionMap)
74 : Options(OptionMap.begin(), OptionMap.end()) {}
76 ClangTidyOptions::OptionMap Map;
77 for (
const auto &KeyValue : Options)
78 Map[KeyValue.first] = KeyValue.second;
81 std::vector<ClangTidyOptions::StringPair>
Options;
86 MappingNormalization<NOptionMap, ClangTidyOptions::OptionMap> NOpts(
88 IO.mapOptional(
"Checks", Options.
Checks);
92 IO.mapOptional(
"User", Options.
User);
93 IO.mapOptional(
"CheckOptions", NOpts->Options);
94 IO.mapOptional(
"ExtraArgs", Options.
ExtraArgs);
112 Options.
User = llvm::None;
113 for (ClangTidyModuleRegistry::iterator I = ClangTidyModuleRegistry::begin(),
114 E = ClangTidyModuleRegistry::end();
116 Options = Options.
mergeWith(I->instantiate()->getModuleOptions());
158 "command-line option '-checks'";
161 "command-line option '-config'";
171 std::vector<OptionsSource>
173 std::vector<OptionsSource>
Result;
184 ConfigOptions(ConfigOptions), OverrideOptions(OverrideOptions) {}
186 std::vector<OptionsSource>
188 std::vector<OptionsSource> RawOptions =
190 RawOptions.emplace_back(ConfigOptions,
192 RawOptions.emplace_back(OverrideOptions,
202 OverrideOptions(OverrideOptions) {
212 OverrideOptions(OverrideOptions), ConfigHandlers(ConfigHandlers) {
218 std::vector<OptionsSource>
220 DEBUG(llvm::dbgs() <<
"Getting options for file " << FileName <<
"...\n");
222 std::vector<OptionsSource> RawOptions =
228 StringRef
Path = llvm::sys::path::parent_path(FileName);
229 for (StringRef CurrentPath = Path; !CurrentPath.empty();
230 CurrentPath = llvm::sys::path::parent_path(CurrentPath)) {
231 llvm::Optional<OptionsSource>
Result;
235 Result = Iter->second;
242 while (Path != CurrentPath) {
243 DEBUG(llvm::dbgs() <<
"Caching configuration for path " << Path
246 Path = llvm::sys::path::parent_path(Path);
250 RawOptions.push_back(*Result);
254 RawOptions.push_back(CommandLineOptions);
258 llvm::Optional<OptionsSource>
260 assert(!Directory.empty());
262 if (!llvm::sys::fs::is_directory(Directory)) {
263 llvm::errs() <<
"Error reading configuration from " << Directory
264 <<
": directory doesn't exist.\n";
269 SmallString<128> ConfigFile(Directory);
270 llvm::sys::path::append(ConfigFile, ConfigHandler.first);
271 DEBUG(llvm::dbgs() <<
"Trying " << ConfigFile <<
"...\n");
276 llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
280 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
281 llvm::MemoryBuffer::getFile(ConfigFile.c_str());
282 if (std::error_code EC = Text.getError()) {
283 llvm::errs() <<
"Can't read " << ConfigFile <<
": " << EC.message()
290 if ((*Text)->getBuffer().empty())
292 llvm::ErrorOr<ClangTidyOptions> ParsedOptions =
293 ConfigHandler.second((*Text)->getBuffer());
294 if (!ParsedOptions) {
295 if (ParsedOptions.getError())
296 llvm::errs() <<
"Error parsing " << ConfigFile <<
": "
297 << ParsedOptions.getError().message() <<
"\n";
308 llvm::yaml::Input Input(LineFilter);
310 return Input.error();
314 llvm::yaml::Input Input(Config);
318 return Input.error();
324 llvm::raw_string_ostream Stream(Text);
325 llvm::yaml::Output Output(Stream);
329 Output << NonConstValue;
llvm::Optional< std::string > Checks
Checks filter.
std::vector< OptionsSource > getRawOptions(llvm::StringRef FileName) override
Returns an ordered vector of OptionsSources, in order of increasing priority.
llvm::Optional< ArgList > ExtraArgs
Add extra compilation arguments to the end of the list.
llvm::Optional< std::string > User
Specifies the name or e-mail of the user running clang-tidy.
virtual std::vector< OptionsSource > getRawOptions(llvm::StringRef FileName)=0
Returns an ordered vector of OptionsSources, in order of increasing priority.
llvm::Optional< std::string > HeaderFilterRegex
Output warnings from headers matching this filter.
static void mapping(IO &IO, FileFilter &File)
static const char OptionsSourceTypeCheckCommandLineOption[]
Contains options for clang-tidy.
static const char OptionsSourceTypeConfigCommandLineOption[]
std::vector< OptionsSource > getRawOptions(llvm::StringRef FileName) override
Returns an ordered vector of OptionsSources, in order of increasing priority.
std::error_code parseLineFilter(StringRef LineFilter, clang::tidy::ClangTidyGlobalOptions &Options)
Parses -line-filter option and stores it to the Options.
std::vector< HeaderHandle > Path
llvm::ErrorOr< ClangTidyOptions > parseConfiguration(StringRef Config)
static StringRef validate(IO &io, FileFilter &File)
NOptionMap(IO &, const ClangTidyOptions::OptionMap &OptionMap)
OptionMap CheckOptions
Key-value mapping used to store check-specific options.
llvm::Optional< bool > SystemHeaders
Output warnings from system headers matching HeaderFilterRegex.
ClangTidyOptions OverrideOptions
ConfigFileHandlers ConfigHandlers
llvm::Optional< ArgList > ExtraArgsBefore
Add extra compilation arguments to the start of the list.
static cl::opt< std::string > Directory(cl::Positional, cl::Required, cl::desc("<Search Root Directory>"))
static cl::opt< std::string > LineFilter("line-filter", cl::desc(R"(
List of files with line ranges to filter the
warnings. Can be used together with
-header-filter. The format of the list is a
JSON array of objects:
[
{"name":"file1.cpp","lines":[[1,3],[5,7]]},
{"name":"file2.h"}
]
)"), cl::init(""), cl::cat(ClangTidyCategory))
std::vector< OptionsSource > getRawOptions(llvm::StringRef FileName) override
Returns an ordered vector of OptionsSources, in order of increasing priority.
std::string configurationAsText(const ClangTidyOptions &Options)
Serializes configuration to a YAML-encoded string.
static unsigned & element(IO &IO, FileFilter::LineRange &Range, size_t Index)
llvm::StringMap< OptionsSource > CachedOptions
static void mapping(IO &IO, ClangTidyOptions &Options)
std::vector< FileFilter > LineFilter
Output warnings from certain line ranges of certain files only.
ClangTidyOptions mergeWith(const ClangTidyOptions &Other) const
Creates a new ClangTidyOptions instance combined from all fields of this instance overridden by the f...
static void mapping(IO &IO, ClangTidyOptions::StringPair &KeyValue)
static cl::opt< std::string > Config("config", cl::desc(R"(
Specifies a configuration in YAML/JSON format:
-config="{Checks: '*', CheckOptions:[{key:x, value:y}]}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
)"), cl::init(""), cl::cat(ClangTidyCategory))
std::pair< std::string, std::function< llvm::ErrorOr< ClangTidyOptions > llvm::StringRef)> > ConfigFileHandler
llvm::Optional< std::string > WarningsAsErrors
WarningsAsErrors filter.
std::vector< ConfigFileHandler > ConfigFileHandlers
Configuration file handlers listed in the order of priority.
Contains a list of line ranges in a single file.
llvm::Optional< bool > AnalyzeTemporaryDtors
Turns on temporary destructor-based analysis.
CharSourceRange Range
SourceRange for the file name.
std::vector< ClangTidyOptions::StringPair > Options
static size_t size(IO &IO, FileFilter::LineRange &Range)
std::pair< ClangTidyOptions, std::string > OptionsSource
ClangTidyOptions and its source.
ClangTidyOptions::OptionMap denormalize(IO &)
std::vector< LineRange > LineRanges
A list of line ranges in this file, for which we show warnings.
static ClangTidyOptions getDefaults()
These options are used for all settings that haven't been overridden by the OptionsProvider.
ClangTidyOptions getOptions(llvm::StringRef FileName)
Returns options applying to a specific translation unit with the specified FileName.
clang::tidy::ClangTidyOptionsProvider::OptionsSource OptionsSource
FileOptionsProvider(const ClangTidyGlobalOptions &GlobalOptions, const ClangTidyOptions &DefaultOptions, const ClangTidyOptions &OverrideOptions)
Initializes the FileOptionsProvider instance.
std::string Name
File name.
llvm::Optional< OptionsSource > tryReadConfigFile(llvm::StringRef Directory)
Try to read configuration files from Directory using registered ConfigHandlers.
ConfigOptionsProvider(const ClangTidyGlobalOptions &GlobalOptions, const ClangTidyOptions &DefaultOptions, const ClangTidyOptions &ConfigOptions, const ClangTidyOptions &OverrideOptions)
Implementation of the ClangTidyOptionsProvider interface, which returns the same options for all file...
static const char OptionsSourceTypeDefaultBinary[]