clang-tools 10.0.0

UseEqualsDeleteCheck.h
Go to the documentation of this file.
1 //===--- UseEqualsDeleteCheck.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_USE_EQUALS_DELETE_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_EQUALS_DELETE_H
11
12 #include "../ClangTidyCheck.h"
13
14 namespace clang {
15 namespace tidy {
16 namespace modernize {
17
18 /// Mark unimplemented private special member functions with '= delete'.
19 /// \code
20 /// struct A {
21 /// private:
22 /// A(const A&);
23 /// A& operator=(const A&);
24 /// };
25 /// \endcode
26 /// Is converted to:
27 /// \code
28 /// struct A {
29 /// private:
30 /// A(const A&) = delete;
31 /// A& operator=(const A&) = delete;
32 /// };
33 /// \endcode
34 ///
35 /// For the user-facing documentation see:
36 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-equals-delete.html
37 class UseEqualsDeleteCheck : public ClangTidyCheck {
38 public:
39 UseEqualsDeleteCheck(StringRef Name, ClangTidyContext *Context)
40 : ClangTidyCheck(Name, Context),
41 IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", 1) != 0) {}
42 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
43 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
44 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
45
46 private:
47 const bool IgnoreMacros;
48 };
49
50 } // namespace modernize
51 } // namespace tidy
52 } // namespace clang
53
54 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_EQUALS_DELETE_H
clang::tidy::modernize::UseEqualsDeleteCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UseEqualsDeleteCheck.cpp:27
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:184
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:97
clang::tidy::modernize::UseEqualsDeleteCheck::UseEqualsDeleteCheck
UseEqualsDeleteCheck(StringRef Name, ClangTidyContext *Context)
Definition: UseEqualsDeleteCheck.h:39
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::modernize::UseEqualsDeleteCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UseEqualsDeleteCheck.cpp:57
clang::tidy::modernize::UseEqualsDeleteCheck
Mark unimplemented private special member functions with &#39;= delete&#39;.
Definition: UseEqualsDeleteCheck.h:37
clang::tidy::modernize::UseEqualsDeleteCheck::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: UseEqualsDeleteCheck.cpp:23