clang-tidy/cppcoreguidelines/NoSuspendWithLockCheck.h

0001 //===--- NoSuspendWithLockCheck.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_NOSUSPENDWITHLOCKCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NOSUSPENDWITHLOCKCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::cppcoreguidelines {
0015
0016 /// Flag coroutines that suspend while any lock guard is alive.
0017 /// This check implements CppCoreGuideline CP.52.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/no-suspend-with-lock.html
0021 class NoSuspendWithLockCheck : public ClangTidyCheck {
0022 public:
0023   NoSuspendWithLockCheck(StringRef Name, ClangTidyContext *Context)
0024       : ClangTidyCheck(Name, Context),
0025         LockGuards(Options.get("LockGuards",
0026                                "::std::unique_lock;::std::scoped_lock;::"
0027                                "std::shared_lock;::std::lock_guard")) {}
0028   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0029   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0030   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0031   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0032     return LangOpts.CPlusPlus20;
0033   }
0034
0035 private:
0036   /// Semicolon-separated list of fully qualified names of lock guard template
0037   /// types. Defaults to
0038   /// `::std::unique_lock;::std::scoped_lock;::std::shared_lock;::std::lock_guard`.
0039   const StringRef LockGuards;
0040 };
0041
0042 } // namespace clang::tidy::cppcoreguidelines
0043
0044 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NOSUSPENDWITHLOCKCHECK_H