xref: /llvm-project/clang-tools-extra/clang-tidy/misc/UnconventionalAssignOperatorCheck.h (revision 4718da506091a37ca4863d979bc541e359b79b10)
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::tidy::misc {
15 
16 /// Finds declarations of assignment operators with the wrong return and/or
17 /// argument types and definitions with good return type but wrong return
18 /// statements.
19 ///
20 ///   * The return type must be `Class&`.
21 ///   * Works with move-assign and assign by value.
22 ///   * Private and deleted operators are ignored.
23 ///   * The operator must always return ``*this``.
24 ///
25 /// For the user-facing documentation see:
26 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/unconventional-assign-operator.html
27 class UnconventionalAssignOperatorCheck : public ClangTidyCheck {
28 public:
UnconventionalAssignOperatorCheck(StringRef Name,ClangTidyContext * Context)29   UnconventionalAssignOperatorCheck(StringRef Name, ClangTidyContext *Context)
30       : ClangTidyCheck(Name, Context) {}
isLanguageVersionSupported(const LangOptions & LangOpts)31   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
32     return LangOpts.CPlusPlus;
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::misc
39 
40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ASSIGNOPERATORSIGNATURECHECK_H
41