clang-tools 18.0.0git
ClangTidy.cpp
Go to the documentation of this file.
1//===--- tools/extra/clang-tidy/ClangTidy.cpp - Clang tidy tool -----------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file This file implements a clang-tidy tool.
10///
11/// This tool uses the Clang Tooling infrastructure, see
12/// http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
13/// for details on setting it up with LLVM source tree.
14///
15//===----------------------------------------------------------------------===//
16
17#include "ClangTidy.h"
18#include "ClangTidyCheck.h"
21#include "ClangTidyProfiling.h"
23#include "clang-tidy-config.h"
24#include "clang/AST/ASTConsumer.h"
25#include "clang/ASTMatchers/ASTMatchFinder.h"
26#include "clang/Format/Format.h"
27#include "clang/Frontend/ASTConsumers.h"
28#include "clang/Frontend/CompilerInstance.h"
29#include "clang/Frontend/FrontendDiagnostic.h"
30#include "clang/Frontend/MultiplexConsumer.h"
31#include "clang/Frontend/TextDiagnosticPrinter.h"
32#include "clang/Lex/PPCallbacks.h"
33#include "clang/Lex/Preprocessor.h"
34#include "clang/Lex/PreprocessorOptions.h"
35#include "clang/Rewrite/Frontend/FixItRewriter.h"
36#include "clang/Rewrite/Frontend/FrontendActions.h"
37#include "clang/Tooling/Core/Diagnostic.h"
38#include "clang/Tooling/DiagnosticsYaml.h"
39#include "clang/Tooling/Refactoring.h"
40#include "clang/Tooling/ReplacementsYaml.h"
41#include "clang/Tooling/Tooling.h"
42#include "llvm/Support/Process.h"
43#include <algorithm>
44#include <utility>
45
46#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
47#include "clang/Analysis/PathDiagnostic.h"
48#include "clang/StaticAnalyzer/Frontend/AnalysisConsumer.h"
49#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
50
51using namespace clang::ast_matchers;
52using namespace clang::driver;
53using namespace clang::tooling;
54using namespace llvm;
55
56LLVM_INSTANTIATE_REGISTRY(clang::tidy::ClangTidyModuleRegistry)
57
58namespace clang::tidy {
59
60namespace {
61#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
62static const char *AnalyzerCheckNamePrefix = "clang-analyzer-";
63
64class AnalyzerDiagnosticConsumer : public ento::PathDiagnosticConsumer {
65public:
66 AnalyzerDiagnosticConsumer(ClangTidyContext &Context) : Context(Context) {}
67
68 void FlushDiagnosticsImpl(std::vector<const ento::PathDiagnostic *> &Diags,
69 FilesMade *FilesMade) override {
70 for (const ento::PathDiagnostic *PD : Diags) {
71 SmallString<64> CheckName(AnalyzerCheckNamePrefix);
72 CheckName += PD->getCheckerName();
73 Context.diag(CheckName, PD->getLocation().asLocation(),
74 PD->getShortDescription())
75 << PD->path.back()->getRanges();
76
77 for (const auto &DiagPiece :
78 PD->path.flatten(/*ShouldFlattenMacros=*/true)) {
79 Context.diag(CheckName, DiagPiece->getLocation().asLocation(),
80 DiagPiece->getString(), DiagnosticIDs::Note)
81 << DiagPiece->getRanges();
82 }
83 }
84 }
85
86 StringRef getName() const override { return "ClangTidyDiags"; }
87 bool supportsLogicalOpControlFlow() const override { return true; }
88 bool supportsCrossFileDiagnostics() const override { return true; }
89
90private:
91 ClangTidyContext &Context;
92};
93#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
94
95class ErrorReporter {
96public:
97 ErrorReporter(ClangTidyContext &Context, FixBehaviour ApplyFixes,
98 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS)
99 : Files(FileSystemOptions(), std::move(BaseFS)),
100 DiagOpts(new DiagnosticOptions()),
101 DiagPrinter(new TextDiagnosticPrinter(llvm::outs(), &*DiagOpts)),
102 Diags(IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs), &*DiagOpts,
103 DiagPrinter),
104 SourceMgr(Diags, Files), Context(Context), ApplyFixes(ApplyFixes) {
105 DiagOpts->ShowColors = Context.getOptions().UseColor.value_or(
106 llvm::sys::Process::StandardOutHasColors());
107 DiagPrinter->BeginSourceFile(LangOpts);
108 if (DiagOpts->ShowColors && !llvm::sys::Process::StandardOutIsDisplayed()) {
109 llvm::sys::Process::UseANSIEscapeCodes(true);
110 }
111 }
112
113 SourceManager &getSourceManager() { return SourceMgr; }
114
115 void reportDiagnostic(const ClangTidyError &Error) {
116 const tooling::DiagnosticMessage &Message = Error.Message;
117 SourceLocation Loc = getLocation(Message.FilePath, Message.FileOffset);
118 // Contains a pair for each attempted fix: location and whether the fix was
119 // applied successfully.
120 SmallVector<std::pair<SourceLocation, bool>, 4> FixLocations;
121 {
122 auto Level = static_cast<DiagnosticsEngine::Level>(Error.DiagLevel);
123 std::string Name = Error.DiagnosticName;
124 if (!Error.EnabledDiagnosticAliases.empty())
125 Name += "," + llvm::join(Error.EnabledDiagnosticAliases, ",");
126 if (Error.IsWarningAsError) {
127 Name += ",-warnings-as-errors";
128 Level = DiagnosticsEngine::Error;
129 WarningsAsErrors++;
130 }
131 auto Diag = Diags.Report(Loc, Diags.getCustomDiagID(Level, "%0 [%1]"))
132 << Message.Message << Name;
133 for (const FileByteRange &FBR : Error.Message.Ranges)
134 Diag << getRange(FBR);
135 // FIXME: explore options to support interactive fix selection.
136 const llvm::StringMap<Replacements> *ChosenFix = nullptr;
137 if (ApplyFixes != FB_NoFix &&
138 (ChosenFix = getFixIt(Error, ApplyFixes == FB_FixNotes))) {
139 for (const auto &FileAndReplacements : *ChosenFix) {
140 for (const auto &Repl : FileAndReplacements.second) {
141 ++TotalFixes;
142 bool CanBeApplied = false;
143 if (!Repl.isApplicable())
144 continue;
145 SourceLocation FixLoc;
146 SmallString<128> FixAbsoluteFilePath = Repl.getFilePath();
147 Files.makeAbsolutePath(FixAbsoluteFilePath);
148 tooling::Replacement R(FixAbsoluteFilePath, Repl.getOffset(),
149 Repl.getLength(), Repl.getReplacementText());
150 Replacements &Replacements = FileReplacements[R.getFilePath()];
151 llvm::Error Err = Replacements.add(R);
152 if (Err) {
153 // FIXME: Implement better conflict handling.
154 llvm::errs() << "Trying to resolve conflict: "
155 << llvm::toString(std::move(Err)) << "\n";
156 unsigned NewOffset =
157 Replacements.getShiftedCodePosition(R.getOffset());
158 unsigned NewLength = Replacements.getShiftedCodePosition(
159 R.getOffset() + R.getLength()) -
160 NewOffset;
161 if (NewLength == R.getLength()) {
162 R = Replacement(R.getFilePath(), NewOffset, NewLength,
163 R.getReplacementText());
164 Replacements = Replacements.merge(tooling::Replacements(R));
165 CanBeApplied = true;
166 ++AppliedFixes;
167 } else {
168 llvm::errs()
169 << "Can't resolve conflict, skipping the replacement.\n";
170 }
171 } else {
172 CanBeApplied = true;
173 ++AppliedFixes;
174 }
175 FixLoc = getLocation(FixAbsoluteFilePath, Repl.getOffset());
176 FixLocations.push_back(std::make_pair(FixLoc, CanBeApplied));
177 }
178 }
179 }
180 reportFix(Diag, Error.Message.Fix);
181 }
182 for (auto Fix : FixLocations) {
183 Diags.Report(Fix.first, Fix.second ? diag::note_fixit_applied
184 : diag::note_fixit_failed);
185 }
186 for (const auto &Note : Error.Notes)
187 reportNote(Note);
188 }
189
190 void finish() {
191 if (TotalFixes > 0) {
192 Rewriter Rewrite(SourceMgr, LangOpts);
193 for (const auto &FileAndReplacements : FileReplacements) {
194 StringRef File = FileAndReplacements.first();
195 llvm::ErrorOr<std::unique_ptr<MemoryBuffer>> Buffer =
196 SourceMgr.getFileManager().getBufferForFile(File);
197 if (!Buffer) {
198 llvm::errs() << "Can't get buffer for file " << File << ": "
199 << Buffer.getError().message() << "\n";
200 // FIXME: Maybe don't apply fixes for other files as well.
201 continue;
202 }
203 StringRef Code = Buffer.get()->getBuffer();
204 auto Style = format::getStyle(
205 *Context.getOptionsForFile(File).FormatStyle, File, "none");
206 if (!Style) {
207 llvm::errs() << llvm::toString(Style.takeError()) << "\n";
208 continue;
209 }
210 llvm::Expected<tooling::Replacements> Replacements =
211 format::cleanupAroundReplacements(Code, FileAndReplacements.second,
212 *Style);
213 if (!Replacements) {
214 llvm::errs() << llvm::toString(Replacements.takeError()) << "\n";
215 continue;
216 }
217 if (llvm::Expected<tooling::Replacements> FormattedReplacements =
218 format::formatReplacements(Code, *Replacements, *Style)) {
219 Replacements = std::move(FormattedReplacements);
220 if (!Replacements)
221 llvm_unreachable("!Replacements");
222 } else {
223 llvm::errs() << llvm::toString(FormattedReplacements.takeError())
224 << ". Skipping formatting.\n";
225 }
226 if (!tooling::applyAllReplacements(Replacements.get(), Rewrite)) {
227 llvm::errs() << "Can't apply replacements for file " << File << "\n";
228 }
229 }
230 if (Rewrite.overwriteChangedFiles()) {
231 llvm::errs() << "clang-tidy failed to apply suggested fixes.\n";
232 } else {
233 llvm::errs() << "clang-tidy applied " << AppliedFixes << " of "
234 << TotalFixes << " suggested fixes.\n";
235 }
236 }
237 }
238
239 unsigned getWarningsAsErrorsCount() const { return WarningsAsErrors; }
240
241private:
242 SourceLocation getLocation(StringRef FilePath, unsigned Offset) {
243 if (FilePath.empty())
244 return {};
245
246 auto File = SourceMgr.getFileManager().getFile(FilePath);
247 if (!File)
248 return {};
249
250 FileID ID = SourceMgr.getOrCreateFileID(*File, SrcMgr::C_User);
251 return SourceMgr.getLocForStartOfFile(ID).getLocWithOffset(Offset);
252 }
253
254 void reportFix(const DiagnosticBuilder &Diag,
255 const llvm::StringMap<Replacements> &Fix) {
256 for (const auto &FileAndReplacements : Fix) {
257 for (const auto &Repl : FileAndReplacements.second) {
258 if (!Repl.isApplicable())
259 continue;
260 FileByteRange FBR;
261 FBR.FilePath = Repl.getFilePath().str();
262 FBR.FileOffset = Repl.getOffset();
263 FBR.Length = Repl.getLength();
264
265 Diag << FixItHint::CreateReplacement(getRange(FBR),
266 Repl.getReplacementText());
267 }
268 }
269 }
270
271 void reportNote(const tooling::DiagnosticMessage &Message) {
272 SourceLocation Loc = getLocation(Message.FilePath, Message.FileOffset);
273 auto Diag =
274 Diags.Report(Loc, Diags.getCustomDiagID(DiagnosticsEngine::Note, "%0"))
275 << Message.Message;
276 for (const FileByteRange &FBR : Message.Ranges)
277 Diag << getRange(FBR);
278 reportFix(Diag, Message.Fix);
279 }
280
281 CharSourceRange getRange(const FileByteRange &Range) {
282 SmallString<128> AbsoluteFilePath{Range.FilePath};
283 Files.makeAbsolutePath(AbsoluteFilePath);
284 SourceLocation BeginLoc = getLocation(AbsoluteFilePath, Range.FileOffset);
285 SourceLocation EndLoc = BeginLoc.getLocWithOffset(Range.Length);
286 // Retrieve the source range for applicable highlights and fixes. Macro
287 // definition on the command line have locations in a virtual buffer and
288 // don't have valid file paths and are therefore not applicable.
289 return CharSourceRange::getCharRange(BeginLoc, EndLoc);
290 }
291
292 FileManager Files;
293 LangOptions LangOpts; // FIXME: use langopts from each original file
294 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
295 DiagnosticConsumer *DiagPrinter;
296 DiagnosticsEngine Diags;
297 SourceManager SourceMgr;
298 llvm::StringMap<Replacements> FileReplacements;
299 ClangTidyContext &Context;
300 FixBehaviour ApplyFixes;
301 unsigned TotalFixes = 0U;
302 unsigned AppliedFixes = 0U;
303 unsigned WarningsAsErrors = 0U;
304};
305
306class ClangTidyASTConsumer : public MultiplexConsumer {
307public:
308 ClangTidyASTConsumer(std::vector<std::unique_ptr<ASTConsumer>> Consumers,
309 std::unique_ptr<ClangTidyProfiling> Profiling,
310 std::unique_ptr<ast_matchers::MatchFinder> Finder,
311 std::vector<std::unique_ptr<ClangTidyCheck>> Checks)
312 : MultiplexConsumer(std::move(Consumers)),
313 Profiling(std::move(Profiling)), Finder(std::move(Finder)),
314 Checks(std::move(Checks)) {}
315
316private:
317 // Destructor order matters! Profiling must be destructed last.
318 // Or at least after Finder.
319 std::unique_ptr<ClangTidyProfiling> Profiling;
320 std::unique_ptr<ast_matchers::MatchFinder> Finder;
321 std::vector<std::unique_ptr<ClangTidyCheck>> Checks;
322};
323
324} // namespace
325
327 ClangTidyContext &Context,
328 IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> OverlayFS)
329 : Context(Context), OverlayFS(std::move(OverlayFS)),
330 CheckFactories(new ClangTidyCheckFactories) {
331 for (ClangTidyModuleRegistry::entry E : ClangTidyModuleRegistry::entries()) {
332 std::unique_ptr<ClangTidyModule> Module = E.instantiate();
333 Module->addCheckFactories(*CheckFactories);
334 }
335}
336
337#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
338static void
339setStaticAnalyzerCheckerOpts(const ClangTidyOptions &Opts,
340 clang::AnalyzerOptions &AnalyzerOptions) {
341 StringRef AnalyzerPrefix(AnalyzerCheckNamePrefix);
342 for (const auto &Opt : Opts.CheckOptions) {
343 StringRef OptName(Opt.getKey());
344 if (!OptName.consume_front(AnalyzerPrefix))
345 continue;
346 // Analyzer options are always local options so we can ignore priority.
347 AnalyzerOptions.Config[OptName] = Opt.getValue().Value;
348 }
349}
350
351using CheckersList = std::vector<std::pair<std::string, bool>>;
352
353static CheckersList getAnalyzerCheckersAndPackages(ClangTidyContext &Context,
354 bool IncludeExperimental) {
355 CheckersList List;
356
357 const auto &RegisteredCheckers =
358 AnalyzerOptions::getRegisteredCheckers(IncludeExperimental);
359 bool AnalyzerChecksEnabled = false;
360 for (StringRef CheckName : RegisteredCheckers) {
361 std::string ClangTidyCheckName((AnalyzerCheckNamePrefix + CheckName).str());
362 AnalyzerChecksEnabled |= Context.isCheckEnabled(ClangTidyCheckName);
363 }
364
365 if (!AnalyzerChecksEnabled)
366 return List;
367
368 // List all static analyzer checkers that our filter enables.
369 //
370 // Always add all core checkers if any other static analyzer check is enabled.
371 // This is currently necessary, as other path sensitive checks rely on the
372 // core checkers.
373 for (StringRef CheckName : RegisteredCheckers) {
374 std::string ClangTidyCheckName((AnalyzerCheckNamePrefix + CheckName).str());
375
376 if (CheckName.startswith("core") ||
377 Context.isCheckEnabled(ClangTidyCheckName)) {
378 List.emplace_back(std::string(CheckName), true);
379 }
380 }
381 return List;
382}
383#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
384
385std::unique_ptr<clang::ASTConsumer>
387 clang::CompilerInstance &Compiler, StringRef File) {
388 // FIXME: Move this to a separate method, so that CreateASTConsumer doesn't
389 // modify Compiler.
390 SourceManager *SM = &Compiler.getSourceManager();
391 Context.setSourceManager(SM);
392 Context.setCurrentFile(File);
393 Context.setASTContext(&Compiler.getASTContext());
394
395 auto WorkingDir = Compiler.getSourceManager()
396 .getFileManager()
397 .getVirtualFileSystem()
398 .getCurrentWorkingDirectory();
399 if (WorkingDir)
400 Context.setCurrentBuildDirectory(WorkingDir.get());
401
402 std::vector<std::unique_ptr<ClangTidyCheck>> Checks =
403 CheckFactories->createChecksForLanguage(&Context);
404
405 ast_matchers::MatchFinder::MatchFinderOptions FinderOptions;
406
407 std::unique_ptr<ClangTidyProfiling> Profiling;
408 if (Context.getEnableProfiling()) {
409 Profiling = std::make_unique<ClangTidyProfiling>(
410 Context.getProfileStorageParams());
411 FinderOptions.CheckProfiling.emplace(Profiling->Records);
412 }
413
414 std::unique_ptr<ast_matchers::MatchFinder> Finder(
415 new ast_matchers::MatchFinder(std::move(FinderOptions)));
416
417 Preprocessor *PP = &Compiler.getPreprocessor();
418 Preprocessor *ModuleExpanderPP = PP;
419
420 if (Context.canEnableModuleHeadersParsing() &&
421 Context.getLangOpts().Modules && OverlayFS != nullptr) {
422 auto ModuleExpander = std::make_unique<ExpandModularHeadersPPCallbacks>(
423 &Compiler, OverlayFS);
424 ModuleExpanderPP = ModuleExpander->getPreprocessor();
425 PP->addPPCallbacks(std::move(ModuleExpander));
426 }
427
428 for (auto &Check : Checks) {
429 Check->registerMatchers(&*Finder);
430 Check->registerPPCallbacks(*SM, PP, ModuleExpanderPP);
431 }
432
433 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
434 if (!Checks.empty())
435 Consumers.push_back(Finder->newASTConsumer());
436
437#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
438 AnalyzerOptions &AnalyzerOptions = Compiler.getAnalyzerOpts();
439 AnalyzerOptions.CheckersAndPackages = getAnalyzerCheckersAndPackages(
440 Context, Context.canEnableAnalyzerAlphaCheckers());
441 if (!AnalyzerOptions.CheckersAndPackages.empty()) {
442 setStaticAnalyzerCheckerOpts(Context.getOptions(), AnalyzerOptions);
443 AnalyzerOptions.AnalysisDiagOpt = PD_NONE;
444 AnalyzerOptions.eagerlyAssumeBinOpBifurcation = true;
445 std::unique_ptr<ento::AnalysisASTConsumer> AnalysisConsumer =
446 ento::CreateAnalysisConsumer(Compiler);
447 AnalysisConsumer->AddDiagnosticConsumer(
448 new AnalyzerDiagnosticConsumer(Context));
449 Consumers.push_back(std::move(AnalysisConsumer));
450 }
451#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
452 return std::make_unique<ClangTidyASTConsumer>(
453 std::move(Consumers), std::move(Profiling), std::move(Finder),
454 std::move(Checks));
455}
456
458 std::vector<std::string> CheckNames;
459 for (const auto &CheckFactory : *CheckFactories) {
460 if (Context.isCheckEnabled(CheckFactory.getKey()))
461 CheckNames.emplace_back(CheckFactory.getKey());
462 }
463
464#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
465 for (const auto &AnalyzerCheck : getAnalyzerCheckersAndPackages(
466 Context, Context.canEnableAnalyzerAlphaCheckers()))
467 CheckNames.push_back(AnalyzerCheckNamePrefix + AnalyzerCheck.first);
468#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
469
470 llvm::sort(CheckNames);
471 return CheckNames;
472}
473
476 std::vector<std::unique_ptr<ClangTidyCheck>> Checks =
477 CheckFactories->createChecks(&Context);
478 for (const auto &Check : Checks)
479 Check->storeOptions(Options);
480 return Options;
481}
482
483std::vector<std::string>
487 std::make_unique<DefaultOptionsProvider>(ClangTidyGlobalOptions(),
488 Options),
490 ClangTidyASTConsumerFactory Factory(Context);
491 return Factory.getCheckNames();
492}
493
498 std::make_unique<DefaultOptionsProvider>(ClangTidyGlobalOptions(),
499 Options),
501 ClangTidyDiagnosticConsumer DiagConsumer(Context);
502 DiagnosticsEngine DE(llvm::makeIntrusiveRefCnt<DiagnosticIDs>(),
503 llvm::makeIntrusiveRefCnt<DiagnosticOptions>(),
504 &DiagConsumer, /*ShouldOwnClient=*/false);
505 Context.setDiagnosticsEngine(&DE);
506 ClangTidyASTConsumerFactory Factory(Context);
507 return Factory.getCheckOptions();
508}
509
510std::vector<ClangTidyError>
512 const CompilationDatabase &Compilations,
513 ArrayRef<std::string> InputFiles,
514 llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> BaseFS,
515 bool ApplyAnyFix, bool EnableCheckProfile,
516 llvm::StringRef StoreCheckProfile) {
517 ClangTool Tool(Compilations, InputFiles,
518 std::make_shared<PCHContainerOperations>(), BaseFS);
519
520 // Add extra arguments passed by the clang-tidy command-line.
521 ArgumentsAdjuster PerFileExtraArgumentsInserter =
522 [&Context](const CommandLineArguments &Args, StringRef Filename) {
523 ClangTidyOptions Opts = Context.getOptionsForFile(Filename);
524 CommandLineArguments AdjustedArgs = Args;
525 if (Opts.ExtraArgsBefore) {
526 auto I = AdjustedArgs.begin();
527 if (I != AdjustedArgs.end() && !StringRef(*I).startswith("-"))
528 ++I; // Skip compiler binary name, if it is there.
529 AdjustedArgs.insert(I, Opts.ExtraArgsBefore->begin(),
530 Opts.ExtraArgsBefore->end());
531 }
532 if (Opts.ExtraArgs)
533 AdjustedArgs.insert(AdjustedArgs.end(), Opts.ExtraArgs->begin(),
534 Opts.ExtraArgs->end());
535 return AdjustedArgs;
536 };
537
538 Tool.appendArgumentsAdjuster(PerFileExtraArgumentsInserter);
539 Tool.appendArgumentsAdjuster(getStripPluginsAdjuster());
540 Context.setEnableProfiling(EnableCheckProfile);
541 Context.setProfileStoragePrefix(StoreCheckProfile);
542
543 ClangTidyDiagnosticConsumer DiagConsumer(Context, nullptr, true, ApplyAnyFix);
544 DiagnosticsEngine DE(new DiagnosticIDs(), new DiagnosticOptions(),
545 &DiagConsumer, /*ShouldOwnClient=*/false);
546 Context.setDiagnosticsEngine(&DE);
547 Tool.setDiagnosticConsumer(&DiagConsumer);
548
549 class ActionFactory : public FrontendActionFactory {
550 public:
551 ActionFactory(ClangTidyContext &Context,
552 IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> BaseFS)
553 : ConsumerFactory(Context, std::move(BaseFS)) {}
554 std::unique_ptr<FrontendAction> create() override {
555 return std::make_unique<Action>(&ConsumerFactory);
556 }
557
558 bool runInvocation(std::shared_ptr<CompilerInvocation> Invocation,
559 FileManager *Files,
560 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
561 DiagnosticConsumer *DiagConsumer) override {
562 // Explicitly ask to define __clang_analyzer__ macro.
563 Invocation->getPreprocessorOpts().SetUpStaticAnalyzer = true;
564 return FrontendActionFactory::runInvocation(
565 Invocation, Files, PCHContainerOps, DiagConsumer);
566 }
567
568 private:
569 class Action : public ASTFrontendAction {
570 public:
571 Action(ClangTidyASTConsumerFactory *Factory) : Factory(Factory) {}
572 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &Compiler,
573 StringRef File) override {
574 return Factory->createASTConsumer(Compiler, File);
575 }
576
577 private:
579 };
580
581 ClangTidyASTConsumerFactory ConsumerFactory;
582 };
583
584 ActionFactory Factory(Context, std::move(BaseFS));
585 Tool.run(&Factory);
586 return DiagConsumer.take();
587}
588
589void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
591 unsigned &WarningsAsErrorsCount,
592 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS) {
593 ErrorReporter Reporter(Context, Fix, std::move(BaseFS));
594 llvm::vfs::FileSystem &FileSystem =
595 Reporter.getSourceManager().getFileManager().getVirtualFileSystem();
596 auto InitialWorkingDir = FileSystem.getCurrentWorkingDirectory();
597 if (!InitialWorkingDir)
598 llvm::report_fatal_error("Cannot get current working path.");
599
600 for (const ClangTidyError &Error : Errors) {
601 if (!Error.BuildDirectory.empty()) {
602 // By default, the working directory of file system is the current
603 // clang-tidy running directory.
604 //
605 // Change the directory to the one used during the analysis.
606 FileSystem.setCurrentWorkingDirectory(Error.BuildDirectory);
607 }
608 Reporter.reportDiagnostic(Error);
609 // Return to the initial directory to correctly resolve next Error.
610 FileSystem.setCurrentWorkingDirectory(InitialWorkingDir.get());
611 }
612 Reporter.finish();
613 WarningsAsErrorsCount += Reporter.getWarningsAsErrorsCount();
614}
615
616void exportReplacements(const llvm::StringRef MainFilePath,
617 const std::vector<ClangTidyError> &Errors,
618 raw_ostream &OS) {
619 TranslationUnitDiagnostics TUD;
620 TUD.MainSourceFile = std::string(MainFilePath);
621 for (const auto &Error : Errors) {
622 tooling::Diagnostic Diag = Error;
623 if (Error.IsWarningAsError)
624 Diag.DiagLevel = tooling::Diagnostic::Error;
625 TUD.Diagnostics.insert(TUD.Diagnostics.end(), Diag);
626 }
627
628 yaml::Output YAML(OS);
629 YAML << TUD;
630}
631
632NamesAndOptions
634 NamesAndOptions Result;
635 ClangTidyOptions Opts;
636 Opts.Checks = "*";
638 std::make_unique<DefaultOptionsProvider>(ClangTidyGlobalOptions(), Opts),
640 ClangTidyCheckFactories Factories;
641 for (const ClangTidyModuleRegistry::entry &Module :
642 ClangTidyModuleRegistry::entries()) {
643 Module.instantiate()->addCheckFactories(Factories);
644 }
645
646 for (const auto &Factory : Factories)
647 Result.Names.insert(Factory.getKey());
648
649#if CLANG_TIDY_ENABLE_STATIC_ANALYZER
650 SmallString<64> Buffer(AnalyzerCheckNamePrefix);
651 size_t DefSize = Buffer.size();
652 for (const auto &AnalyzerCheck : AnalyzerOptions::getRegisteredCheckers(
654 Buffer.truncate(DefSize);
655 Buffer.append(AnalyzerCheck);
656 Result.Names.insert(Buffer);
657 }
658#endif // CLANG_TIDY_ENABLE_STATIC_ANALYZER
659
660 Context.setOptionsCollector(&Result.Options);
661 for (const auto &Factory : Factories) {
662 Factory.getValue()(Factory.getKey(), &Context);
663 }
664
665 return Result;
666}
667} // namespace clang::tidy
const Expr * E
static cl::opt< bool > EnableCheckProfile("enable-check-profile", desc(R"( Enable per-check timing profiles, and print a report to stderr. )"), cl::init(false), cl::cat(ClangTidyCategory))
static cl::opt< bool > Fix("fix", 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 > 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.
static cl::opt< std::string > StoreCheckProfile("store-check-profile", 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))
size_t Offset
static constexpr llvm::SourceMgr::DiagKind Error
std::string Code
llvm::StringRef Name
CharSourceRange Range
SourceRange for the file name.
std::string Filename
Filename as a string.
SourceLocation Loc
FieldAction Action
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:160
llvm::json::Object Args
Definition: Trace.cpp:138
std::unique_ptr< clang::ASTConsumer > createASTConsumer(clang::CompilerInstance &Compiler, StringRef File)
Returns an ASTConsumer that runs the specified clang-tidy checks.
Definition: ClangTidy.cpp:386
ClangTidyOptions::OptionMap getCheckOptions()
Get the union of options from all checks.
Definition: ClangTidy.cpp:474
ClangTidyASTConsumerFactory(ClangTidyContext &Context, IntrusiveRefCntPtr< llvm::vfs::OverlayFileSystem > OverlayFS=nullptr)
Definition: ClangTidy.cpp:326
std::vector< std::string > getCheckNames()
Get the list of enabled checks.
Definition: ClangTidy.cpp:457
A collection of ClangTidyCheckFactory instances.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
A diagnostic consumer that turns each Diagnostic into a SourceManager-independent ClangTidyError.
void reportDiagnostic(DiagnosticBuilder D, const T *Node, SourceRange SR, bool DefaultConstruction)
constexpr llvm::StringLiteral Message
const llvm::StringMap< tooling::Replacements > * getFixIt(const tooling::Diagnostic &Diagnostic, bool AnyFix)
Gets the Fix attached to Diagnostic.
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.
Definition: ClangTidy.cpp:484
FixBehaviour
Controls what kind of fixes clang-tidy is allowed to apply.
Definition: ClangTidy.h:95
@ FB_NoFix
Don't try to apply any fix.
Definition: ClangTidy.h:97
@ FB_FixNotes
Apply fixes found in notes.
Definition: ClangTidy.h:101
ClangTidyOptions::OptionMap getCheckOptions(const ClangTidyOptions &Options, bool AllowEnablingAnalyzerAlphaCheckers)
Returns the effective check-specific options.
Definition: ClangTidy.cpp:495
void handleErrors(llvm::ArrayRef< ClangTidyError > Errors, ClangTidyContext &Context, FixBehaviour Fix, unsigned &WarningsAsErrorsCount, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > BaseFS)
Displays the found Errors to the users.
Definition: ClangTidy.cpp:589
std::vector< ClangTidyError > runClangTidy(clang::tidy::ClangTidyContext &Context, const CompilationDatabase &Compilations, ArrayRef< std::string > InputFiles, llvm::IntrusiveRefCntPtr< llvm::vfs::OverlayFileSystem > BaseFS, bool ApplyAnyFix, bool EnableCheckProfile, llvm::StringRef StoreCheckProfile)
Definition: ClangTidy.cpp:511
NamesAndOptions getAllChecksAndOptions(bool AllowEnablingAnalyzerAlphaCheckers)
Definition: ClangTidy.cpp:633
llvm::Registry< ClangTidyModule > ClangTidyModuleRegistry
void exportReplacements(const llvm::StringRef MainFilePath, const std::vector< ClangTidyError > &Errors, raw_ostream &OS)
Definition: ClangTidy.cpp:616
Some operations such as code completion produce a set of candidates.
A detected error complete with information to display diagnostic and automatic fix.
Contains options for clang-tidy.
llvm::StringMap< ClangTidyValue > OptionMap