clang-tools-extra/clang-tidy/modernize/UseEqualsDeleteCheck.h

   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::tidy::modernize {
  15
  16 /// Identifies unimplemented private special member functions, and recommends
  17 /// using ``= delete`` for them. Additionally, it recommends relocating any
  18 /// deleted member function from the ``private`` to the ``public`` section.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-equals-delete.html
  22 class UseEqualsDeleteCheck : public ClangTidyCheck {
  23 public:
  24   UseEqualsDeleteCheck(StringRef Name, ClangTidyContext *Context);
  25   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  26     return LangOpts.CPlusPlus;
  27   }
  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   std::optional<TraversalKind> getCheckTraversalKind() const override {
  32     return TK_IgnoreUnlessSpelledInSource;
  33   }
  34
  35 private:
  36   const bool IgnoreMacros;
  37 };
  38
  39 } // namespace clang::tidy::modernize
  40
  41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_EQUALS_DELETE_H