clang-tools  10.0.0svn
SpecialMemberFunctionsCheck.h
Go to the documentation of this file.
1 //===--- SpecialMemberFunctionsCheck.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_CPPCOREGUIDELINES_SPECIAL_MEMBER_FUNCTIONS_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_SPECIAL_MEMBER_FUNCTIONS_H
11 
12 #include "../ClangTidy.h"
13 
14 #include "llvm/ADT/DenseMapInfo.h"
15 
16 namespace clang {
17 namespace tidy {
18 namespace cppcoreguidelines {
19 
20 /// Checks for classes where some, but not all, of the special member functions
21 /// are defined.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-special-member-functions.html
26 public:
28  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
29  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31  void onEndOfTranslationUnit() override;
32 
33  enum class SpecialMemberFunctionKind : uint8_t {
34  Destructor,
41  };
42 
43  using ClassDefId = std::pair<SourceLocation, std::string>;
44 
46  llvm::DenseMap<ClassDefId,
47  llvm::SmallVector<SpecialMemberFunctionKind, 5>>;
48 
49 private:
50  void checkForMissingMembers(
51  const ClassDefId &ID,
52  llvm::ArrayRef<SpecialMemberFunctionKind> DefinedSpecialMembers);
53 
54  const bool AllowMissingMoveFunctions;
55  const bool AllowSoleDefaultDtor;
56  ClassDefiningSpecialMembersMap ClassWithSpecialMembers;
57 };
58 
59 } // namespace cppcoreguidelines
60 } // namespace tidy
61 } // namespace clang
62 
63 namespace llvm {
64 /// Specialisation of DenseMapInfo to allow ClassDefId objects in DenseMaps
65 /// FIXME: Move this to the corresponding cpp file as is done for
66 /// clang-tidy/readability/IdentifierNamingCheck.cpp.
67 template <>
68 struct DenseMapInfo<
70  using ClassDefId =
72 
73  static inline ClassDefId getEmptyKey() {
74  return ClassDefId(
75  clang::SourceLocation::getFromRawEncoding(static_cast<unsigned>(-1)),
76  "EMPTY");
77  }
78 
79  static inline ClassDefId getTombstoneKey() {
80  return ClassDefId(
81  clang::SourceLocation::getFromRawEncoding(static_cast<unsigned>(-2)),
82  "TOMBSTONE");
83  }
84 
85  static unsigned getHashValue(ClassDefId Val) {
86  assert(Val != getEmptyKey() && "Cannot hash the empty key!");
87  assert(Val != getTombstoneKey() && "Cannot hash the tombstone key!");
88 
89  std::hash<ClassDefId::second_type> SecondHash;
90  return Val.first.getRawEncoding() + SecondHash(Val.second);
91  }
92 
93  static bool isEqual(const ClassDefId &LHS, const ClassDefId &RHS) {
94  if (RHS == getEmptyKey())
95  return LHS == getEmptyKey();
96  if (RHS == getTombstoneKey())
97  return LHS == getTombstoneKey();
98  return LHS == RHS;
99  }
100 };
101 
102 } // namespace llvm
103 
104 #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.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Some operations such as code completion produce a set of candidates.
clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::ClassDefId ClassDefId
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.
llvm::DenseMap< ClassDefId, llvm::SmallVector< SpecialMemberFunctionKind, 5 > > ClassDefiningSpecialMembersMap
static constexpr llvm::StringLiteral Name
std::map< std::string, std::string > OptionMap
SpecialMemberFunctionsCheck(StringRef Name, ClangTidyContext *Context)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.