clang-tools  14.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 
14 namespace clang {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// The checker detects various cases when an enum is probably misused (as a
19 /// bitmask).
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-suspicious-enum-usage.html
23 public:
24  SuspiciousEnumUsageCheck(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  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
29  return TK_IgnoreUnlessSpelledInSource;
30  }
31 
32 private:
33  void checkSuspiciousBitmaskUsage(const Expr*, const EnumDecl*);
34  const bool StrictMode;
35 };
36 
37 } // namespace bugprone
38 } // namespace tidy
39 } // namespace clang
40 
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::bugprone::SuspiciousEnumUsageCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: SuspiciousEnumUsageCheck.cpp:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::SuspiciousEnumUsageCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: SuspiciousEnumUsageCheck.h:28
clang::tidy::bugprone::SuspiciousEnumUsageCheck::SuspiciousEnumUsageCheck
SuspiciousEnumUsageCheck(StringRef Name, ClangTidyContext *Context)
Definition: SuspiciousEnumUsageCheck.cpp:110
clang::tidy::bugprone::SuspiciousEnumUsageCheck
The checker detects various cases when an enum is probably misused (as a bitmask).
Definition: SuspiciousEnumUsageCheck.h:22
clang::tidy::bugprone::SuspiciousEnumUsageCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: SuspiciousEnumUsageCheck.cpp:119
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::SuspiciousEnumUsageCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: SuspiciousEnumUsageCheck.cpp:168