aboutsummaryrefslogtreecommitdiff
path: root/clang-tools-extra/clang-tidy/readability/OperatorsRepresentationCheck.h
blob: d315f3912a9140cb93d7c0b340665699081368bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
//===--- OperatorsRepresentationCheck.h - clang-tidy ------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H

#include "../ClangTidyCheck.h"
#include <vector>

namespace clang::tidy::readability {

/// Enforces consistent token representation for invoked binary, unary
/// and overloaded operators in C++ code.
///
/// For the user-facing documentation see:
/// http://clang.llvm.org/extra/clang-tidy/checks/readability/operators-representation.html
class OperatorsRepresentationCheck : public ClangTidyCheck {
public:
  OperatorsRepresentationCheck(StringRef Name, ClangTidyContext *Context);
  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
  std::optional<TraversalKind> getCheckTraversalKind() const override;

private:
  void registerBinaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
  void registerUnaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
  void registerOverloadedOperatorMatcher(ast_matchers::MatchFinder *Finder);

  std::vector<llvm::StringRef> BinaryOperators;
  std::vector<llvm::StringRef> OverloadedOperators;
};

} // namespace clang::tidy::readability

#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H