b06b248ad9
Implement CppCoreGuideline CP.53 to warn when a coroutine accepts references parameters. Although the guideline mentions that it is safe to access a reference parameter before suspension points, the guideline recommends flagging all coroutine parameter references. Reviewed By: carlosgalvezp Differential Revision: https://reviews.llvm.org/D140793
41 lines
1.7 KiB
C++
41 lines
1.7 KiB
C++
//===--- AvoidReferenceCoroutineParametersCheck.h - clang-tidy --*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
|
|
|
|
#include "../ClangTidyCheck.h"
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace cppcoreguidelines {
|
|
|
|
/// Warns on coroutines that accept reference parameters. Accessing a reference
|
|
/// after a coroutine suspension point is not safe since the reference may no
|
|
/// longer be valid. This implements CppCoreGuideline CP.53.
|
|
///
|
|
/// For the user-facing documentation see:
|
|
/// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-reference-coroutine-parameters.html
|
|
class AvoidReferenceCoroutineParametersCheck : public ClangTidyCheck {
|
|
public:
|
|
AvoidReferenceCoroutineParametersCheck(StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context) {}
|
|
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
|
|
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
|
|
return LangOpts.CPlusPlus20;
|
|
}
|
|
};
|
|
|
|
} // namespace cppcoreguidelines
|
|
} // namespace tidy
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDREFERENCECOROUTINEPARAMETERSCHECK_H
|