blob: 829c91dbfb48fb45be6b99a478bc5e26f6904893 [file] [log] [blame]
Olivier Deprezf4ef2d02021-04-20 13:36:24 +02001//===--- 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
14namespace clang {
15namespace tidy {
16namespace 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
29class UnconventionalAssignOperatorCheck : public ClangTidyCheck {
30public:
31 UnconventionalAssignOperatorCheck(StringRef Name, ClangTidyContext *Context)
32 : ClangTidyCheck(Name, Context) {}
33 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
34 return LangOpts.CPlusPlus;
35 }
36 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
37 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
38};
39
40} // namespace misc
41} // namespace tidy
42} // namespace clang
43
44#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ASSIGNOPERATORSIGNATURECHECK_H