clang-tidy/hicpp/MultiwayPathsCoveredCheck.h

0001 //===--- MultiwayPathsCoveredCheck.h - clang-tidy----------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::hicpp {
0015
0016 /// Find occasions where not all codepaths are explicitly covered in code.
0017 /// This includes 'switch' without a 'default'-branch and 'if'-'else if'-chains
0018 /// without a final 'else'-branch.
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/hicpp/multiway-paths-covered.html
0022 class MultiwayPathsCoveredCheck : public ClangTidyCheck {
0023 public:
0024   MultiwayPathsCoveredCheck(StringRef Name, ClangTidyContext *Context)
0025       : ClangTidyCheck(Name, Context),
0026         WarnOnMissingElse(Options.get("WarnOnMissingElse", false)) {}
0027   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0028   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0029   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0030
0031 private:
0032   void handleSwitchWithDefault(const SwitchStmt *Switch, std::size_t CaseCount);
0033   void handleSwitchWithoutDefault(
0034       const SwitchStmt *Switch, std::size_t CaseCount,
0035       const ast_matchers::MatchFinder::MatchResult &Result);
0036   /// This option can be configured to warn on missing 'else' branches in an
0037   /// 'if-else if' chain. The default is false because this option might be
0038   /// noisy on some code bases.
0039   const bool WarnOnMissingElse;
0040 };
0041
0042 } // namespace clang::tidy::hicpp
0043
0044 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_MULTIWAY_PATHS_COVERED_H