clang-tools  11.0.0
LoopConvertCheck.h
Go to the documentation of this file.
1 //===--- LoopConvertCheck.h - clang-tidy-------------------------*- C++ -*-===//
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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_LOOP_CONVERT_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_LOOP_CONVERT_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "LoopConvertUtils.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace modernize {
18 
20 public:
21  LoopConvertCheck(StringRef Name, ClangTidyContext *Context);
22  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
23  return LangOpts.CPlusPlus;
24  }
25  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
26  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
28 
29 private:
30  struct RangeDescriptor {
31  RangeDescriptor();
32  bool ContainerNeedsDereference;
33  bool DerefByConstRef;
34  bool DerefByValue;
35  std::string ContainerString;
36  QualType ElemType;
37  };
38 
39  void getAliasRange(SourceManager &SM, SourceRange &DeclRange);
40 
41  void doConversion(ASTContext *Context, const VarDecl *IndexVar,
42  const ValueDecl *MaybeContainer, const UsageResult &Usages,
43  const DeclStmt *AliasDecl, bool AliasUseRequired,
44  bool AliasFromForInit, const ForStmt *Loop,
45  RangeDescriptor Descriptor);
46 
47  StringRef getContainerString(ASTContext *Context, const ForStmt *Loop,
48  const Expr *ContainerExpr);
49 
50  void getArrayLoopQualifiers(ASTContext *Context,
51  const ast_matchers::BoundNodes &Nodes,
52  const Expr *ContainerExpr,
53  const UsageResult &Usages,
54  RangeDescriptor &Descriptor);
55 
56  void getIteratorLoopQualifiers(ASTContext *Context,
57  const ast_matchers::BoundNodes &Nodes,
58  RangeDescriptor &Descriptor);
59 
60  void determineRangeDescriptor(ASTContext *Context,
61  const ast_matchers::BoundNodes &Nodes,
62  const ForStmt *Loop, LoopFixerKind FixerKind,
63  const Expr *ContainerExpr,
64  const UsageResult &Usages,
65  RangeDescriptor &Descriptor);
66 
67  bool isConvertible(ASTContext *Context, const ast_matchers::BoundNodes &Nodes,
68  const ForStmt *Loop, LoopFixerKind FixerKind);
69 
70  std::unique_ptr<TUTrackingInfo> TUInfo;
71  const unsigned long long MaxCopySize;
72  const Confidence::Level MinConfidence;
73  const VariableNamer::NamingStyle NamingStyle;
74 };
75 
76 } // namespace modernize
77 } // namespace tidy
78 } // namespace clang
79 
80 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_LOOP_CONVERT_H
clang::tidy::modernize::UsageResult
llvm::SmallVector< Usage, 8 > UsageResult
Definition: LoopConvertUtils.h:270
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:114
clang::tidy::modernize::LoopConvertCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: LoopConvertCheck.cpp:821
clang::tidy::modernize::LoopConvertCheck
Definition: LoopConvertCheck.h:19
LoopConvertUtils.h
clang::tidy::modernize::LoopConvertCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: LoopConvertCheck.cpp:486
clang::tidy::modernize::LoopFixerKind
LoopFixerKind
Definition: LoopConvertUtils.h:29
clang::tidy::modernize::LoopConvertCheck::LoopConvertCheck
LoopConvertCheck(StringRef Name, ClangTidyContext *Context)
Definition: LoopConvertCheck.cpp:480
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:76
clang::tidy::modernize::Confidence::Level
Level
Definition: LoopConvertUtils.h:244
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::modernize::LoopConvertCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: LoopConvertCheck.h:22
clang::tidy::modernize::LoopConvertCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: LoopConvertCheck.cpp:492
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::VariableNamer::NamingStyle
NamingStyle
Definition: LoopConvertUtils.h:425
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:111