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::tidy::hicpp {
15 
16 /// Find occasions where not all codepaths are explicitly covered in code.
17 /// This includes 'switch' without a 'default'-branch and 'if'-'else if'-chains
18 /// without a final 'else'-branch.
19 ///
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/hicpp/multiway-paths-covered.html
22 class MultiwayPathsCoveredCheck : public ClangTidyCheck {
23 public:
MultiwayPathsCoveredCheck(StringRef Name,ClangTidyContext * Context)24   MultiwayPathsCoveredCheck(StringRef Name, ClangTidyContext *Context)
25       : ClangTidyCheck(Name, Context),
26         WarnOnMissingElse(Options.get("WarnOnMissingElse", false)) {}
27   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
28   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30 
31 private:
32   void handleSwitchWithDefault(const SwitchStmt *Switch, std::size_t CaseCount);
33   void handleSwitchWithoutDefault(
34       const SwitchStmt *Switch, std::size_t CaseCount,
35       const ast_matchers::MatchFinder::MatchResult &Result);
36   /// This option can be configured to warn on missing 'else' branches in an
37   /// 'if-else if' chain. The default is false because this option might be
38   /// noisy on some code bases.
39   const bool WarnOnMissingElse;
40 };
41 
42 } // namespace clang::tidy::hicpp
43 
44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H
45