clang-tools  14.0.0git
MultiwayPathsCoveredCheck.h
Go to the documentation of this file.
1 //===--- MultiwayPathsCoveredCheck.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_HICPP_MULTIWAY_PATHS_COVERED_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace hicpp {
17 
18 /// Find occasions where not all codepaths are explicitly covered in code.
19 /// This includes 'switch' without a 'default'-branch and 'if'-'else if'-chains
20 /// without a final 'else'-branch.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/hicpp-multiway-paths-covered.html
25 public:
27  : ClangTidyCheck(Name, Context),
28  WarnOnMissingElse(Options.get("WarnOnMissingElse", false)) {}
29  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
30  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
31  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
32 
33 private:
34  void handleSwitchWithDefault(const SwitchStmt *Switch, std::size_t CaseCount);
35  void handleSwitchWithoutDefault(
36  const SwitchStmt *Switch, std::size_t CaseCount,
37  const ast_matchers::MatchFinder::MatchResult &Result);
38  /// This option can be configured to warn on missing 'else' branches in an
39  /// 'if-else if' chain. The default is false because this option might be
40  /// noisy on some code bases.
41  const bool WarnOnMissingElse;
42 };
43 
44 } // namespace hicpp
45 } // namespace tidy
46 } // namespace clang
47 
48 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H
clang::tidy::hicpp::MultiwayPathsCoveredCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: MultiwayPathsCoveredCheck.cpp:91
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::hicpp::MultiwayPathsCoveredCheck
Find occasions where not all codepaths are explicitly covered in code.
Definition: MultiwayPathsCoveredCheck.h:24
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:416
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::hicpp::MultiwayPathsCoveredCheck::MultiwayPathsCoveredCheck
MultiwayPathsCoveredCheck(StringRef Name, ClangTidyContext *Context)
Definition: MultiwayPathsCoveredCheck.h:26
clang::tidy::hicpp::MultiwayPathsCoveredCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: MultiwayPathsCoveredCheck.cpp:25
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::hicpp::MultiwayPathsCoveredCheck::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: MultiwayPathsCoveredCheck.cpp:20