clang-tools-extra/clang-tidy/cppcoreguidelines/AvoidReferenceCoroutineParametersCheck.h

   1 //===--- AvoidReferenceCoroutineParametersCheck.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_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::cppcoreguidelines {
  15
  16 /// Warns on coroutines that accept reference parameters. Accessing a reference
  17 /// after a coroutine suspension point is not safe since the reference may no
  18 /// longer be valid. This implements CppCoreGuideline CP.53.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-reference-coroutine-parameters.html
  22 class AvoidReferenceCoroutineParametersCheck : public ClangTidyCheck {
  23 public:
  24   AvoidReferenceCoroutineParametersCheck(StringRef Name,
  25                                          ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  28   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  29   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  30     return LangOpts.CPlusPlus20;
  31   }
  32 };
  33
  34 } // namespace clang::tidy::cppcoreguidelines
  35
  36 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H