clang-tools-extra/clang-tidy/bugprone/NoEscapeCheck.h

   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::tidy::bugprone {
  15
  16 /// Block arguments in `dispatch_async()` and `dispatch_after()` are guaranteed
  17 /// to escape. If those blocks capture any pointers with the `noescape`
  18 /// attribute, then we warn the user of their error.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/no-escape.html
  22 class NoEscapeCheck : public ClangTidyCheck {
  23 public:
  24   NoEscapeCheck(StringRef Name, ClangTidyContext *Context)
  25       : ClangTidyCheck(Name, Context) {}
  26   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  27     return LangOpts.Blocks;
  28   }
  29   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  30   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  31 };
  32
  33 } // namespace clang::tidy::bugprone
  34
  35 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_NOESCAPECHECK_H