clang-tidy/cppcoreguidelines/AvoidReferenceCoroutineParametersCheck.h

0001 //===--- AvoidReferenceCoroutineParametersCheck.h - clang-tidy --*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::cppcoreguidelines {
0015
0016 /// Warns on coroutines that accept reference parameters. Accessing a reference
0017 /// after a coroutine suspension point is not safe since the reference may no
0018 /// longer be valid. This implements CppCoreGuideline CP.53.
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-reference-coroutine-parameters.html
0022 class AvoidReferenceCoroutineParametersCheck : public ClangTidyCheck {
0023 public:
0024   AvoidReferenceCoroutineParametersCheck(StringRef Name,
0025                                          ClangTidyContext *Context)
0026       : ClangTidyCheck(Name, Context) {}
0027   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0028   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0029   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0030     return LangOpts.CPlusPlus20;
0031   }
0032 };
0033
0034 } // namespace clang::tidy::cppcoreguidelines
0035
0036 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H