clang-tools  14.0.0git
MisleadingIndentationCheck.h
Go to the documentation of this file.
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 {
15 namespace tidy {
16 namespace readability {
17 
18 /// Checks the code for dangling else, and possible misleading indentations due
19 /// to missing braces. Note that this check only works as expected when the tabs
20 /// or spaces are used consistently and not mixed.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-misleading-indentation.html
25 public:
27  : ClangTidyCheck(Name, Context) {}
28  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
31  return TK_IgnoreUnlessSpelledInSource;
32  }
33 
34 private:
35  void danglingElseCheck(const SourceManager &SM, ASTContext *Context,
36  const IfStmt *If);
37  void missingBracesCheck(const SourceManager &SM, const CompoundStmt *CStmt);
38 };
39 
40 } // namespace readability
41 } // namespace tidy
42 } // namespace clang
43 
44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_MISLEADING_INDENTATION_H
clang::tidy::readability::MisleadingIndentationCheck
Checks the code for dangling else, and possible misleading indentations due to missing braces.
Definition: MisleadingIndentationCheck.h:24
clang::tidy::readability::MisleadingIndentationCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: MisleadingIndentationCheck.h:30
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::readability::MisleadingIndentationCheck::MisleadingIndentationCheck
MisleadingIndentationCheck(StringRef Name, ClangTidyContext *Context)
Definition: MisleadingIndentationCheck.h:26
clang::tidy::readability::MisleadingIndentationCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: MisleadingIndentationCheck.cpp:116
clang::tidy::readability::MisleadingIndentationCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: MisleadingIndentationCheck.cpp:108