clang-tools 10.0.0

UnconventionalAssignOperatorCheck.h
Go to the documentation of this file.
1 //===--- UnconventionalAssignOperatorCheck.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_MISC_ASSIGNOPERATORSIGNATURECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ASSIGNOPERATORSIGNATURECHECK_H
11
12 #include "../ClangTidyCheck.h"
13
14 namespace clang {
15 namespace tidy {
16 namespace misc {
17
18 /// Finds declarations of assignment operators with the wrong return and/or
19 /// argument types and definitions with good return type but wrong return
20 /// statements.
21 ///
22 /// * The return type must be `Class&`.
23 /// * Works with move-assign and assign by value.
24 /// * Private and deleted operators are ignored.
25 /// * The operator must always return ``*this``.
26 ///
27 /// For the user-facing documentation see:
28 /// http://clang.llvm.org/extra/clang-tidy/checks/misc-unconventional-assign-operator.html
29 class UnconventionalAssignOperatorCheck : public ClangTidyCheck {
30 public:
31 UnconventionalAssignOperatorCheck(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 misc
38 } // namespace tidy
39 } // namespace clang
40
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ASSIGNOPERATORSIGNATURECHECK_H
clang::tidy::misc::UnconventionalAssignOperatorCheck::UnconventionalAssignOperatorCheck
UnconventionalAssignOperatorCheck(StringRef Name, ClangTidyContext *Context)
Definition: UnconventionalAssignOperatorCheck.h:31
clang::tidy::misc::UnconventionalAssignOperatorCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UnconventionalAssignOperatorCheck.cpp:19
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::misc::UnconventionalAssignOperatorCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UnconventionalAssignOperatorCheck.cpp:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::misc::UnconventionalAssignOperatorCheck
Finds declarations of assignment operators with the wrong return and/or argument types and definition...
Definition: UnconventionalAssignOperatorCheck.h:29
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