xref: /llvm-project/clang-tools-extra/clang-tidy/readability/OperatorsRepresentationCheck.h (revision a084854266ca60748982228a4c98d036bca5f762)
1 //===--- OperatorsRepresentationCheck.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_READABILITY_OPERATORSREPRESENTATIONCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include <vector>
14 
15 namespace clang::tidy::readability {
16 
17 /// Enforces consistent token representation for invoked binary, unary
18 /// and overloaded operators in C++ code.
19 ///
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/operators-representation.html
22 class OperatorsRepresentationCheck : public ClangTidyCheck {
23 public:
24   OperatorsRepresentationCheck(StringRef Name, ClangTidyContext *Context);
25   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
26   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
27   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
28   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
29   std::optional<TraversalKind> getCheckTraversalKind() const override;
30 
31 private:
32   void registerBinaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
33   void registerUnaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
34   void registerOverloadedOperatorMatcher(ast_matchers::MatchFinder *Finder);
35 
36   std::vector<llvm::StringRef> BinaryOperators;
37   std::vector<llvm::StringRef> OverloadedOperators;
38 };
39 
40 } // namespace clang::tidy::readability
41 
42 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H
43