1//===--- NoSuspendWithLockCheck.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_NOSUSPENDWITHLOCKCHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NOSUSPENDWITHLOCKCHECK_H
11
12#include "../ClangTidyCheck.h"
13
14namespace clang::tidy::cppcoreguidelines {
15
16/// Flag coroutines that suspend while any lock guard is alive.
17/// This check implements CppCoreGuideline CP.52.
18///
19/// For the user-facing documentation see:
20/// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/no-suspend-with-lock.html
21class NoSuspendWithLockCheck : public ClangTidyCheck {
22public:
23 NoSuspendWithLockCheck(StringRef Name, ClangTidyContext *Context)
24 : ClangTidyCheck(Name, Context),
25 LockGuards(Options.get(LocalName: "LockGuards",
26 Default: "::std::unique_lock;::std::scoped_lock;::"
27 "std::shared_lock;::std::lock_guard")) {}
28 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
29 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
32 return LangOpts.CPlusPlus20;
33 }
34
35private:
36 /// Semicolon-separated list of fully qualified names of lock guard template
37 /// types. Defaults to
38 /// `::std::unique_lock;::std::scoped_lock;::std::shared_lock;::std::lock_guard`.
39 const StringRef LockGuards;
40};
41
42} // namespace clang::tidy::cppcoreguidelines
43
44#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NOSUSPENDWITHLOCKCHECK_H
45

source code of clang-tools-extra/clang-tidy/cppcoreguidelines/NoSuspendWithLockCheck.h