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