clang-tools 20.0.0git
SuspiciousEnumUsageCheck.h
Go to the documentation of this file.
1//===--- SuspiciousEnumUsageCheck.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_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
11
12#include "../ClangTidyCheck.h"
13
14namespace clang::tidy::bugprone {
15
16/// The checker detects various cases when an enum is probably misused (as a
17/// bitmask).
18/// For the user-facing documentation see:
19/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-enum-usage.html
21public:
23 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
24 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
25 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
26 std::optional<TraversalKind> getCheckTraversalKind() const override {
27 return TK_IgnoreUnlessSpelledInSource;
28 }
29
30private:
31 void checkSuspiciousBitmaskUsage(const Expr*, const EnumDecl*);
32 const bool StrictMode;
33};
34
35} // namespace clang::tidy::bugprone
36
37#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
The checker detects various cases when an enum is probably misused (as a bitmask).
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
std::optional< TraversalKind > getCheckTraversalKind() const override
llvm::StringMap< ClangTidyValue > OptionMap