clang-tools 10.0.0

ForwardingReferenceOverloadCheck.h
Go to the documentation of this file.
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 {
15 namespace tidy {
16 namespace bugprone {
17
18 /// The checker looks for constructors that can act as copy or move constructors
19 /// through their forwarding reference parameters. If a non const lvalue
20 /// reference is passed to the constructor, the forwarding reference parameter
21 /// can be a perfect match while the const reference parameter of the copy
22 /// constructor can't. The forwarding reference constructor will be called,
23 /// which can lead to confusion.
24 /// For detailed description of this problem see: Scott Meyers, Effective Modern
25 /// C++ Design, item 26.
26 ///
27 /// For the user-facing documentation see:
28 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-forwarding-reference-overload.html
29 class ForwardingReferenceOverloadCheck : public ClangTidyCheck {
30 public:
31 ForwardingReferenceOverloadCheck(StringRef Name, ClangTidyContext *Context)
32 : ClangTidyCheck(Name, Context) {}
33 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
34 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
35 };
36
37 } // namespace bugprone
38 } // namespace tidy
39 } // namespace clang
40
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_FORWARDINGREFERENCEOVERLOADCHECK_H
clang::tidy::bugprone::ForwardingReferenceOverloadCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ForwardingReferenceOverloadCheck.cpp:62
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::bugprone::ForwardingReferenceOverloadCheck
The checker looks for constructors that can act as copy or move constructors through their forwarding...
Definition: ForwardingReferenceOverloadCheck.h:29
clang::tidy::bugprone::ForwardingReferenceOverloadCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ForwardingReferenceOverloadCheck.cpp:88
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::bugprone::ForwardingReferenceOverloadCheck::ForwardingReferenceOverloadCheck
ForwardingReferenceOverloadCheck(StringRef Name, ClangTidyContext *Context)
Definition: ForwardingReferenceOverloadCheck.h:31
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