clang-tools-extra/clang-tidy/bugprone/ForwardingReferenceOverloadCheck.h

   1 //===--- ForwardingReferenceOverloadCheck.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_BUGPRONE_FORWARDINGREFERENCEOVERLOADCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_FORWARDINGREFERENCEOVERLOADCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// The checker looks for constructors that can act as copy or move constructors
  17 /// through their forwarding reference parameters. If a non const lvalue
  18 /// reference is passed to the constructor, the forwarding reference parameter
  19 /// can be a perfect match while the const reference parameter of the copy
  20 /// constructor can't. The forwarding reference constructor will be called,
  21 /// which can lead to confusion.
  22 /// For detailed description of this problem see: Scott Meyers, Effective Modern
  23 /// C++ Design, item 26.
  24 ///
  25 /// For the user-facing documentation see:
  26 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/forwarding-reference-overload.html
  27 class ForwardingReferenceOverloadCheck : public ClangTidyCheck {
  28 public:
  29   ForwardingReferenceOverloadCheck(StringRef Name, ClangTidyContext *Context)
  30       : ClangTidyCheck(Name, Context) {}
  31   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  32     return LangOpts.CPlusPlus11;
  33   }
  34   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  35   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  36 };
  37
  38 } // namespace clang::tidy::bugprone
  39
  40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_FORWARDINGREFERENCEOVERLOADCHECK_H