17 #include "../ClangTidy.h" 18 #include "../ClangTidyForceLinker.h" 19 #include "clang/Tooling/CommonOptionsParser.h" 20 #include "llvm/Support/Process.h" 21 #include "llvm/Support/Signals.h" 22 #include "llvm/Support/TargetSelect.h" 31 static cl::extrahelp
CommonHelp(CommonOptionsParser::HelpMessage);
34 clang-tidy attempts to read configuration for each source file from a 35 .clang-tidy file located in the closest parent directory of the source 36 file. If any configuration options have a corresponding command-line 37 option, command-line option takes precedence. The effective 38 configuration can be inspected using -dump-config: 40 $ clang-tidy -dump-config 42 Checks: '-*,some-check' 48 - key: some-check.SomeOption 58 static cl::opt<std::string>
Checks(
"checks", cl::desc(R
"( 59 Comma-separated list of globs with optional '-' 60 prefix. Globs are processed in order of 61 appearance in the list. Globs without '-' 62 prefix add checks with matching names to the 63 set, globs with the '-' prefix remove checks 64 with matching names from the set of enabled 65 checks. This option's value is appended to the 66 value of the 'Checks' option in .clang-tidy 71 static cl::opt<std::string>
WarningsAsErrors(
"warnings-as-errors", cl::desc(R
"( 72 Upgrades warnings to errors. Same format as 74 This option's value is appended to the value of 75 the 'WarningsAsErrors' option in .clang-tidy 81 static cl::opt<std::string>
HeaderFilter(
"header-filter", cl::desc(R
"( 82 Regular expression matching the names of the 83 headers to output diagnostics from. Diagnostics 84 from the main file of each translation unit are 86 Can be used together with -line-filter. 87 This option overrides the 'HeaderFilterRegex' 88 option in .clang-tidy file, if any. 95 cl::desc(
"Display the errors from system headers."),
97 static cl::opt<std::string>
LineFilter(
"line-filter", cl::desc(R
"( 98 List of files with line ranges to filter the 99 warnings. Can be used together with 100 -header-filter. The format of the list is a 101 JSON array of objects: 103 {"name":"file1.cpp","lines":[[1,3],[5,7]]}, 110 static cl::opt<bool>
Fix(
"fix", cl::desc(R
"( 111 Apply suggested fixes. Without -fix-errors 112 clang-tidy will bail out if any compilation 117 static cl::opt<bool>
FixErrors(
"fix-errors", cl::desc(R
"( 118 Apply suggested fixes even if compilation 119 errors were found. If compiler errors have 120 attached fix-its, clang-tidy will apply them as 125 static cl::opt<std::string>
FormatStyle(
"format-style", cl::desc(R
"( 126 Style for formatting code around applied fixes: 127 - 'none' (default) turns off formatting 128 - 'file' (literally 'file', not a placeholder) 129 uses .clang-format file in the closest parent 131 - '{ <json> }' specifies options inline, e.g. 132 -format-style='{BasedOnStyle: llvm, IndentWidth: 8}' 133 - 'llvm', 'google', 'webkit', 'mozilla' 134 See clang-format documentation for the up-to-date 135 information about formatting styles and options. 136 This option overrides the 'FormatStyle` option in 137 .clang-tidy file, if any. 142 static cl::opt<bool>
ListChecks(
"list-checks", cl::desc(R
"( 143 List all enabled checks and exit. Use with 144 -checks=* to list all available checks. 148 static cl::opt<bool>
ExplainConfig(
"explain-config", cl::desc(R
"( 149 For each enabled check explains, where it is 150 enabled, i.e. in clang-tidy binary, command 151 line or a specific configuration file. 155 static cl::opt<std::string>
Config(
"config", cl::desc(R
"( 156 Specifies a configuration in YAML/JSON format: 157 -config="{Checks: '*', 158 CheckOptions: [{key: x, 160 When the value is empty, clang-tidy will 161 attempt to find a file named .clang-tidy for 162 each source file in its parent directories. 166 static cl::opt<bool>
DumpConfig(
"dump-config", cl::desc(R
"( 167 Dumps configuration in the YAML format to 168 stdout. This option can be used along with a 169 file name (and '--' if the file is outside of a 170 project with configured compilation database). 171 The configuration used for this file will be 173 Use along with -checks=* to include 174 configuration of all checks. 179 Enable per-check timing profiles, and print a 187 By default reports are printed in tabulated 188 format to stderr. When this option is passed, 189 these per-TU profiles are instead stored as JSON. 191 cl::value_desc("prefix"),
199 cl::init(
false), cl::Hidden,
202 static cl::opt<std::string>
ExportFixes(
"export-fixes", cl::desc(R
"( 203 YAML file to store suggested fixes in. The 204 stored fixes can be applied to the input source 205 code with clang-apply-replacements. 207 cl::value_desc("filename"),
210 static cl::opt<bool>
Quiet(
"quiet", cl::desc(R
"( 211 Run clang-tidy in quiet mode. This suppresses 212 printing statistics about ignored warnings and 213 warnings treated as errors if the respective 214 options are specified. 219 static cl::opt<std::string>
VfsOverlay(
"vfsoverlay", cl::desc(R
"( 220 Overlay the virtual filesystem described by file 221 over the real file system. 223 cl::value_desc("filename"),
231 llvm::errs() <<
"Suppressed " << Stats.
errorsIgnored() <<
" warnings (";
239 <<
" due to line filter";
248 <<
" with check filters";
249 llvm::errs() <<
").\n";
251 llvm::errs() <<
"Use -header-filter=.* to display errors from all " 252 "non-system headers. Use -system-headers to display " 253 "errors from system headers as well.\n";
258 llvm::IntrusiveRefCntPtr<vfs::FileSystem>
FS) {
261 llvm::errs() <<
"Invalid LineFilter: " << Err.message() <<
"\n\nUsage:\n";
262 llvm::cl::PrintHelpMessage(
false,
true);
272 DefaultOptions.
User = llvm::sys::Process::GetEnv(
"USER");
274 if (!DefaultOptions.
User)
275 DefaultOptions.
User = llvm::sys::Process::GetEnv(
"USERNAME");
278 if (
Checks.getNumOccurrences() > 0)
290 if (llvm::ErrorOr<ClangTidyOptions> ParsedConfig =
292 return llvm::make_unique<ConfigOptionsProvider>(
294 ClangTidyOptions::getDefaults().mergeWith(DefaultOptions),
295 *ParsedConfig, OverrideOptions);
297 llvm::errs() <<
"Error: invalid configuration specified.\n" 298 << ParsedConfig.getError().message() <<
"\n";
302 return llvm::make_unique<FileOptionsProvider>(GlobalOptions, DefaultOptions,
303 OverrideOptions, std::move(FS));
306 llvm::IntrusiveRefCntPtr<vfs::FileSystem>
308 llvm::IntrusiveRefCntPtr<vfs::FileSystem> BaseFS) {
309 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
310 BaseFS->getBufferForFile(OverlayFile);
312 llvm::errs() <<
"Can't load virtual filesystem overlay file '" 313 << OverlayFile <<
"': " << Buffer.getError().message()
318 IntrusiveRefCntPtr<vfs::FileSystem> FS = vfs::getVFSFromYAML(
319 std::move(Buffer.get()),
nullptr, OverlayFile);
321 llvm::errs() <<
"Error: invalid virtual filesystem overlay file '" 322 << OverlayFile <<
"'.\n";
329 llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
332 llvm::IntrusiveRefCntPtr<vfs::OverlayFileSystem> BaseFS(
333 new vfs::OverlayFileSystem(vfs::getRealFileSystem()));
336 IntrusiveRefCntPtr<vfs::FileSystem> VfsFromFile =
340 BaseFS->pushOverlay(VfsFromFile);
344 auto *OptionsProvider = OwningOptionsProvider.get();
345 if (!OptionsProvider)
348 auto MakeAbsolute = [](
const std::string &Input) -> SmallString<256> {
351 SmallString<256> AbsolutePath(Input);
353 llvm::errs() <<
"Can't make absolute path from " << Input <<
": " 354 << EC.message() <<
"\n";
362 auto PathList = OptionsParser.getSourcePathList();
363 if (!PathList.empty()) {
367 SmallString<256> FilePath = MakeAbsolute(
FileName);
370 std::vector<std::string> EnabledChecks =
375 std::vector<clang::tidy::ClangTidyOptionsProvider::OptionsSource>
376 RawOptions = OptionsProvider->getRawOptions(FilePath);
377 for (
const std::string &Check : EnabledChecks) {
378 for (
auto It = RawOptions.rbegin(); It != RawOptions.rend(); ++It) {
379 if (It->first.Checks && GlobList(*It->first.Checks).contains(Check)) {
380 llvm::outs() <<
"'" << Check <<
"' is enabled in the " << It->second
390 if (EnabledChecks.empty()) {
391 llvm::errs() <<
"No checks enabled.\n";
394 llvm::outs() <<
"Enabled checks:";
395 for (
const auto &CheckName : EnabledChecks)
396 llvm::outs() <<
"\n " << CheckName;
397 llvm::outs() <<
"\n\n";
405 ClangTidyOptions::getDefaults().mergeWith(
411 if (EnabledChecks.empty()) {
412 llvm::errs() <<
"Error: no checks enabled.\n";
413 llvm::cl::PrintHelpMessage(
false,
true);
417 if (PathList.empty()) {
418 llvm::errs() <<
"Error: no input files specified.\n";
419 llvm::cl::PrintHelpMessage(
false,
true);
423 llvm::InitializeAllTargetInfos();
424 llvm::InitializeAllTargetMCs();
425 llvm::InitializeAllAsmParsers();
427 ClangTidyContext Context(std::move(OwningOptionsProvider),
429 std::vector<ClangTidyError> Errors =
430 runClangTidy(Context, OptionsParser.getCompilations(), PathList, BaseFS,
432 bool FoundErrors = llvm::find_if(Errors, [](
const ClangTidyError &E) {
433 return E.DiagLevel == ClangTidyError::Error;
436 const bool DisableFixes =
Fix && FoundErrors && !
FixErrors;
438 unsigned WErrorCount = 0;
446 llvm::raw_fd_ostream OS(
ExportFixes, EC, llvm::sys::fs::F_None);
448 llvm::errs() <<
"Error opening output file: " << EC.message() <<
'\n';
458 <<
"Found compiler errors, but -fix-errors was not specified.\n" 459 "Fixes have NOT been applied.\n\n";
464 StringRef Plural = WErrorCount == 1 ?
"" :
"s";
465 llvm::errs() << WErrorCount <<
" warning" << Plural <<
" treated as error" 480 llvm::errs() <<
"Found compiler error(s).\n";
490 int main(
int argc,
const char **argv) {
static cl::extrahelp ClangTidyHelp(R"(
Configuration files:
clang-tidy attempts to read configuration for each source file from a
.clang-tidy file located in the closest parent directory of the source
file. If any configuration options have a corresponding command-line
option, command-line option takes precedence. The effective
configuration can be inspected using -dump-config:
$ clang-tidy -dump-config
---
Checks: '-*,some-check'
WarningsAsErrors: ''
HeaderFilterRegex: ''
FormatStyle: none
User: user
CheckOptions:
- key: some-check.SomeOption
value: 'some value'
...
)")
llvm::Optional< std::string > Checks
Checks filter.
static void printStats(const ClangTidyStats &Stats)
Some operations such as code completion produce a set of candidates.
llvm::Optional< std::string > User
Specifies the name or e-mail of the user running clang-tidy.
static cl::opt< bool > SystemHeaders("system-headers", cl::desc("Display the errors from system headers."), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< bool > FixErrors("fix-errors", cl::desc(R"(
Apply suggested fixes even if compilation
errors were found. If compiler errors have
attached fix-its, clang-tidy will apply them as
well.
)"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< bool > DumpConfig("dump-config", cl::desc(R"(
Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
The configuration used for this file will be
printed.
Use along with -checks=* to include
configuration of all checks.
)"), cl::init(false), cl::cat(ClangTidyCategory))
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))
static cl::opt< bool > ExplainConfig("explain-config", cl::desc(R"(
For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
)"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< std::string > StoreCheckProfile("store-check-profile", cl::desc(R"(
By default reports are printed in tabulated
format to stderr. When this option is passed,
these per-TU profiles are instead stored as JSON.
)"), cl::value_desc("prefix"), cl::cat(ClangTidyCategory))
llvm::Optional< std::string > HeaderFilterRegex
Output warnings from headers matching this filter.
def make_absolute(f, directory)
Contains options for clang-tidy.
unsigned ErrorsIgnoredCheckFilter
ClangTidyOptions::OptionMap getCheckOptions(const ClangTidyOptions &Options, bool AllowEnablingAnalyzerAlphaCheckers)
Returns the effective check-specific options.
std::error_code parseLineFilter(StringRef LineFilter, clang::tidy::ClangTidyGlobalOptions &Options)
Parses -line-filter option and stores it to the Options.
llvm::ErrorOr< ClangTidyOptions > parseConfiguration(StringRef Config)
unsigned ErrorsIgnoredNOLINT
static cl::opt< bool > ListChecks("list-checks", cl::desc(R"(
List all enabled checks and exit. Use with
-checks=* to list all available checks.
)"), cl::init(false), cl::cat(ClangTidyCategory))
OptionMap CheckOptions
Key-value mapping used to store check-specific options.
llvm::IntrusiveRefCntPtr< vfs::FileSystem > getVfsFromFile(const std::string &OverlayFile, llvm::IntrusiveRefCntPtr< vfs::FileSystem > BaseFS)
llvm::Optional< bool > SystemHeaders
Output warnings from system headers matching HeaderFilterRegex.
std::vector< ClangTidyError > runClangTidy(clang::tidy::ClangTidyContext &Context, const CompilationDatabase &Compilations, ArrayRef< std::string > InputFiles, llvm::IntrusiveRefCntPtr< llvm::vfs::OverlayFileSystem > BaseFS, bool EnableCheckProfile, llvm::StringRef StoreCheckProfile)
void handleErrors(llvm::ArrayRef< ClangTidyError > Errors, ClangTidyContext &Context, bool Fix, unsigned &WarningsAsErrorsCount, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > BaseFS)
Displays the found Errors to the users.
llvm::Optional< std::string > FormatStyle
Format code around applied fixes with clang-format using this style.
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))
static cl::opt< bool > AllowEnablingAnalyzerAlphaCheckers("allow-enabling-analyzer-alpha-checkers", cl::init(false), cl::Hidden, cl::cat(ClangTidyCategory))
This option allows enabling the experimental alpha checkers from the static analyzer.
unsigned errorsIgnored() const
unsigned ErrorsIgnoredNonUserCode
std::string configurationAsText(const ClangTidyOptions &Options)
Serializes configuration to a YAML-encoded string.
static cl::OptionCategory ClangTidyCategory("clang-tidy options")
static cl::opt< std::string > WarningsAsErrors("warnings-as-errors", cl::desc(R"(
Upgrades warnings to errors. Same format as
'-checks'.
This option's value is appended to the value of
the 'WarningsAsErrors' option in .clang-tidy
file, if any.
)"), cl::init(""), cl::cat(ClangTidyCategory))
unsigned ErrorsIgnoredLineFilter
static cl::opt< bool > EnableCheckProfile("enable-check-profile", cl::desc(R"(
Enable per-check timing profiles, and print a
report to stderr.
)"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage)
llvm::Optional< std::string > WarningsAsErrors
WarningsAsErrors filter.
static cl::opt< std::string > VfsOverlay("vfsoverlay", cl::desc(R"(
Overlay the virtual filesystem described by file
over the real file system.
)"), cl::value_desc("filename"), cl::cat(ClangTidyCategory))
static cl::opt< std::string > ExportFixes("export-fixes", cl::desc(R"(
YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
)"), cl::value_desc("filename"), cl::cat(ClangTidyCategory))
static int clangTidyMain(int argc, const char **argv)
static std::unique_ptr< ClangTidyOptionsProvider > createOptionsProvider(llvm::IntrusiveRefCntPtr< vfs::FileSystem > FS)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
void exportReplacements(const llvm::StringRef MainFilePath, const std::vector< ClangTidyError > &Errors, raw_ostream &OS)
std::vector< std::string > getCheckNames(const ClangTidyOptions &Options, bool AllowEnablingAnalyzerAlphaCheckers)
Fills the list of check names that are enabled when the provided filters are applied.
static cl::opt< std::string > HeaderFilter("header-filter", cl::desc(R"(
Regular expression matching the names of the
headers to output diagnostics from. Diagnostics
from the main file of each translation unit are
always displayed.
Can be used together with -line-filter.
This option overrides the 'HeaderFilterRegex'
option in .clang-tidy file, if any.
)"), cl::init(""), cl::cat(ClangTidyCategory))
const char DefaultChecks[]
int main(int argc, const char **argv)
Contains displayed and ignored diagnostic counters for a ClangTidy run.
static cl::opt< std::string > Checks("checks", cl::desc(R"(
Comma-separated list of globs with optional '-'
prefix. Globs are processed in order of
appearance in the list. Globs without '-'
prefix add checks with matching names to the
set, globs with the '-' prefix remove checks
with matching names from the set of enabled
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
)"), cl::init(""), cl::cat(ClangTidyCategory))
static cl::opt< bool > Fix("fix", cl::desc(R"(
Apply suggested fixes. Without -fix-errors
clang-tidy will bail out if any compilation
errors were found.
)"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< bool > Quiet("quiet", cl::desc(R"(
Run clang-tidy in quiet mode. This suppresses
printing statistics about ignored warnings and
warnings treated as errors if the respective
options are specified.
)"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< std::string > FormatStyle("format-style", cl::desc(R"(
Style for formatting code around applied fixes:
- 'none' (default) turns off formatting
- 'file' (literally 'file', not a placeholder)
uses .clang-format file in the closest parent
directory
- '{ <json> }' specifies options inline, e.g.
-format-style='{BasedOnStyle: llvm, IndentWidth: 8}'
- 'llvm', 'google', 'webkit', 'mozilla'
See clang-format documentation for the up-to-date
information about formatting styles and options.
This option overrides the 'FormatStyle` option in
.clang-tidy file, if any.
)"), cl::init("none"), cl::cat(ClangTidyCategory))