blob: f05f3e1c54e03116768f58346d856a6d917f33e9 [file] [log] [blame]
Gabor Horvath2953b422016-12-27 10:07:39 +00001//===--- SuspiciousEnumUsageCheck.h - clang-tidy--------------------------*- C++ -*-===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Gabor Horvath2953b422016-12-27 10:07:39 +00006//
7//===----------------------------------------------------------------------===//
8
Alexander Kornienkocb6d3202018-02-28 23:30:29 +00009#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H
Gabor Horvath2953b422016-12-27 10:07:39 +000011
Alexander Kornienko478fc5c2019-03-25 12:38:26 +000012#include "../ClangTidyCheck.h"
Gabor Horvath2953b422016-12-27 10:07:39 +000013
14namespace clang {
15namespace tidy {
Alexander Kornienkocb6d3202018-02-28 23:30:29 +000016namespace bugprone {
Gabor Horvath2953b422016-12-27 10:07:39 +000017
18/// The checker detects various cases when an enum is probably misused (as a
19/// bitmask).
20/// For the user-facing documentation see:
Alexander Kornienkocb6d3202018-02-28 23:30:29 +000021/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-suspicious-enum-usage.html
Gabor Horvath2953b422016-12-27 10:07:39 +000022class SuspiciousEnumUsageCheck : public ClangTidyCheck {
23public:
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
29private:
30 void checkSuspiciousBitmaskUsage(const Expr*, const EnumDecl*);
31 const bool StrictMode;
32};
33
Alexander Kornienkocb6d3202018-02-28 23:30:29 +000034} // namespace bugprone
Gabor Horvath2953b422016-12-27 10:07:39 +000035} // namespace tidy
36} // namespace clang
37
Alexander Kornienkocb6d3202018-02-28 23:30:29 +000038#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSENUMUSAGECHECK_H