clang-tools  4.0.0
SpecialMemberFunctionsCheck.h
Go to the documentation of this file.
1 //===--- SpecialMemberFunctionsCheck.h - clang-tidy--------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_SPECIAL_MEMBER_FUNCTIONS_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_SPECIAL_MEMBER_FUNCTIONS_H
12 
13 #include "../ClangTidy.h"
14 
15 #include "llvm/ADT/DenseMapInfo.h"
16 
17 namespace clang {
18 namespace tidy {
19 namespace cppcoreguidelines {
20 
21 /// Checks for classes where some, but not all, of the special member functions
22 /// are defined.
23 ///
24 /// For the user-facing documentation see:
25 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-special-member-functions.html
27 public:
29  : ClangTidyCheck(Name, Context) {}
30  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
31  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
32  void onEndOfTranslationUnit() override;
33 
34  enum class SpecialMemberFunctionKind : uint8_t {
35  Destructor,
40  };
41 
42  using ClassDefId = std::pair<SourceLocation, std::string>;
43 
45  llvm::DenseMap<ClassDefId,
46  llvm::SmallVector<SpecialMemberFunctionKind, 5>>;
47 
48 private:
49  ClassDefiningSpecialMembersMap ClassWithSpecialMembers;
50 };
51 
52 } // namespace cppcoreguidelines
53 } // namespace tidy
54 } // namespace clang
55 
56 namespace llvm {
57 /// Specialisation of DenseMapInfo to allow ClassDefId objects in DenseMaps
58 /// FIXME: Move this to the corresponding cpp file as is done for
59 /// clang-tidy/readability/IdentifierNamingCheck.cpp.
60 template <>
61 struct DenseMapInfo<
62  clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::ClassDefId> {
63  using ClassDefId =
65 
66  static inline ClassDefId getEmptyKey() {
67  return ClassDefId(
68  clang::SourceLocation::getFromRawEncoding(static_cast<unsigned>(-1)),
69  "EMPTY");
70  }
71 
72  static inline ClassDefId getTombstoneKey() {
73  return ClassDefId(
74  clang::SourceLocation::getFromRawEncoding(static_cast<unsigned>(-2)),
75  "TOMBSTONE");
76  }
77 
78  static unsigned getHashValue(ClassDefId Val) {
79  assert(Val != getEmptyKey() && "Cannot hash the empty key!");
80  assert(Val != getTombstoneKey() && "Cannot hash the tombstone key!");
81 
82  std::hash<ClassDefId::second_type> SecondHash;
83  return Val.first.getRawEncoding() + SecondHash(Val.second);
84  }
85 
86  static bool isEqual(ClassDefId LHS, ClassDefId RHS) {
87  if (RHS == getEmptyKey())
88  return LHS == getEmptyKey();
89  if (RHS == getTombstoneKey())
90  return LHS == getTombstoneKey();
91  return LHS == RHS;
92  }
93 };
94 
95 } // namespace llvm
96 
97 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_SPECIAL_MEMBER_FUNCTIONS_H
Checks for classes where some, but not all, of the special member functions are defined.
const std::string Name
Definition: USRFinder.cpp:164
clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::ClassDefId ClassDefId
std::unique_ptr< ast_matchers::MatchFinder > Finder
Definition: ClangTidy.cpp:262
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
llvm::DenseMap< ClassDefId, llvm::SmallVector< SpecialMemberFunctionKind, 5 >> ClassDefiningSpecialMembersMap
SpecialMemberFunctionsCheck(StringRef Name, ClangTidyContext *Context)
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
const NamedDecl * Result
Definition: USRFinder.cpp:162