clang-tools-extra/clang-tidy/readability/MisleadingIndentationCheck.h

   1 //===--- MisleadingIndentationCheck.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_READABILITY_MISLEADING_INDENTATION_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_MISLEADING_INDENTATION_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::readability {
  15
  16 /// Checks the code for dangling else, and possible misleading indentations due
  17 /// to missing braces. Note that this check only works as expected when the tabs
  18 /// or spaces are used consistently and not mixed.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/misleading-indentation.html
  22 class MisleadingIndentationCheck : public ClangTidyCheck {
  23 public:
  24   MisleadingIndentationCheck(StringRef Name, ClangTidyContext *Context)
  25       : ClangTidyCheck(Name, Context) {}
  26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  28   std::optional<TraversalKind> getCheckTraversalKind() const override {
  29     return TK_IgnoreUnlessSpelledInSource;
  30   }
  31
  32 private:
  33   void danglingElseCheck(const SourceManager &SM, ASTContext *Context,
  34                          const IfStmt *If);
  35   void missingBracesCheck(const SourceManager &SM, const CompoundStmt *CStmt,
  36                           const LangOptions &LangOpts);
  37 };
  38
  39 } // namespace clang::tidy::readability
  40
  41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_MISLEADING_INDENTATION_H