clang-tidy/readability/OperatorsRepresentationCheck.h

0001 //===--- OperatorsRepresentationCheck.h - clang-tidy ------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include <vector>
0014
0015 namespace clang::tidy::readability {
0016
0017 /// Enforces consistent token representation for invoked binary, unary
0018 /// and overloaded operators in C++ code.
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/operators-representation.html
0022 class OperatorsRepresentationCheck : public ClangTidyCheck {
0023 public:
0024   OperatorsRepresentationCheck(StringRef Name, ClangTidyContext *Context);
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0028   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
0029   std::optional<TraversalKind> getCheckTraversalKind() const override;
0030
0031 private:
0032   void registerBinaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
0033   void registerUnaryOperatorMatcher(ast_matchers::MatchFinder *Finder);
0034   void registerOverloadedOperatorMatcher(ast_matchers::MatchFinder *Finder);
0035
0036   std::vector<llvm::StringRef> BinaryOperators;
0037   std::vector<llvm::StringRef> OverloadedOperators;
0038 };
0039
0040 } // namespace clang::tidy::readability
0041
0042 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_OPERATORSREPRESENTATIONCHECK_H