clang-tidy/bugprone/SpuriouslyWakeUpFunctionsCheck.h

0001 //===--- SpuriouslyWakeUpFunctionsCheck.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_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::bugprone {
0015
0016 /// Finds ``cnd_wait``, ``cnd_timedwait``, ``wait``, ``wait_for``, or
0017 /// ``wait_until`` function calls when the function is not invoked from a loop
0018 /// that checks whether a condition predicate holds or the function has a
0019 /// condition parameter.
0020 ///
0021 /// For the user-facing documentation see:
0022 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/spuriously-wake-up-functions.html
0023 class SpuriouslyWakeUpFunctionsCheck : public ClangTidyCheck {
0024 public:
0025   SpuriouslyWakeUpFunctionsCheck(StringRef Name, 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 };
0030
0031 } // namespace clang::tidy::bugprone
0032
0033 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H