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 24 class MultiwayPathsCoveredCheck : public ClangTidyCheck { 25 public: MultiwayPathsCoveredCheck(StringRef Name,ClangTidyContext * Context)26 MultiwayPathsCoveredCheck(StringRef Name, ClangTidyContext *Context) 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 49