clang-tools  14.0.0git
UseEqualsDefaultCheck.h
Go to the documentation of this file.
1 //===--- UseEqualsDefaultCheck.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_DEFAULT_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_EQUALS_DEFAULT_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace modernize {
17 
18 /// Replace default bodies of special member functions with '= default;'.
19 /// \code
20 /// struct A {
21 /// A() {}
22 /// ~A();
23 /// };
24 /// A::~A() {}
25 /// \endcode
26 /// Is converted to:
27 /// \code
28 /// struct A {
29 /// A() = default;
30 /// ~A();
31 /// };
32 /// A::~A() = default;
33 /// \endcode
34 ///
35 /// For the user-facing documentation see:
36 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-equals-default.html
38 public:
39  UseEqualsDefaultCheck(StringRef Name, ClangTidyContext *Context);
40  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
41  return LangOpts.CPlusPlus;
42  }
43  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
44  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
45  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
46 
47 private:
48  const bool IgnoreMacros;
49 };
50 
51 } // namespace modernize
52 } // namespace tidy
53 } // namespace clang
54 
55 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_EQUALS_DEFAULT_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::modernize::UseEqualsDefaultCheck
Replace default bodies of special member functions with '= default;'.
Definition: UseEqualsDefaultCheck.h:37
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::modernize::UseEqualsDefaultCheck::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: UseEqualsDefaultCheck.h:40
clang::tidy::modernize::UseEqualsDefaultCheck::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: UseEqualsDefaultCheck.cpp:213
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::modernize::UseEqualsDefaultCheck::UseEqualsDefaultCheck
UseEqualsDefaultCheck(StringRef Name, ClangTidyContext *Context)
Definition: UseEqualsDefaultCheck.cpp:208
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::UseEqualsDefaultCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UseEqualsDefaultCheck.cpp:247
clang::tidy::modernize::UseEqualsDefaultCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UseEqualsDefaultCheck.cpp:217