clang-tools  14.0.0git
NoEscapeCheck.h
Go to the documentation of this file.
1 //===--- NoEscapeCheck.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_BUGPRONE_NOESCAPECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_NOESCAPECHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// Block arguments in `dispatch_async()` and `dispatch_after()` are guaranteed
19 /// to escape. If those blocks capture any pointers with the `noescape`
20 /// attribute, then we warn the user of their error.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-no-escape.html
24 class NoEscapeCheck : public ClangTidyCheck {
25 public:
26  NoEscapeCheck(StringRef Name, ClangTidyContext *Context)
27  : ClangTidyCheck(Name, Context) {}
28  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
29  return LangOpts.Blocks;
30  }
31  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
32  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
33 };
34 
35 } // namespace bugprone
36 } // namespace tidy
37 } // namespace clang
38 
39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_NOESCAPECHECK_H
clang::tidy::bugprone::NoEscapeCheck
Block arguments in dispatch_async() and dispatch_after() are guaranteed to escape.
Definition: NoEscapeCheck.h:24
clang::tidy::bugprone::NoEscapeCheck::NoEscapeCheck
NoEscapeCheck(StringRef Name, ClangTidyContext *Context)
Definition: NoEscapeCheck.h:26
clang::tidy::bugprone::NoEscapeCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: NoEscapeCheck.cpp:19
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::bugprone::NoEscapeCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: NoEscapeCheck.cpp:30
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::NoEscapeCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: NoEscapeCheck.h:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27