clang-tidy/bugprone/SuspiciousEnumUsageCheck.h

0001 //===--- SuspiciousEnumUsageCheck.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_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::bugprone {
0015
0016 /// The checker detects various cases when an enum is probably misused (as a
0017 /// bitmask).
0018 /// For the user-facing documentation see:
0019 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-enum-usage.html
0020 class SuspiciousEnumUsageCheck : public ClangTidyCheck {
0021 public:
0022   SuspiciousEnumUsageCheck(StringRef Name, ClangTidyContext *Context);
0023   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0024   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0025   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0026   std::optional<TraversalKind> getCheckTraversalKind() const override {
0027     return TK_IgnoreUnlessSpelledInSource;
0028   }
0029
0030 private:
0031   void checkSuspiciousBitmaskUsage(const Expr*, const EnumDecl*);
0032   const bool StrictMode;
0033 };
0034
0035 } // namespace clang::tidy::bugprone
0036
0037 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H