clang-tools-extra/clang-tidy/bugprone/SpuriouslyWakeUpFunctionsCheck.h

   1 //===--- SpuriouslyWakeUpFunctionsCheck.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_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Finds ``cnd_wait``, ``cnd_timedwait``, ``wait``, ``wait_for``, or
  17 /// ``wait_until`` function calls when the function is not invoked from a loop
  18 /// that checks whether a condition predicate holds or the function has a
  19 /// condition parameter.
  20 ///
  21 /// For the user-facing documentation see:
  22 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/spuriously-wake-up-functions.html
  23 class SpuriouslyWakeUpFunctionsCheck : public ClangTidyCheck {
  24 public:
  25   SpuriouslyWakeUpFunctionsCheck(StringRef Name, ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  28   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  29 };
  30
  31 } // namespace clang::tidy::bugprone
  32
  33 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPURIOUSLYWAKEUPFUNCTIONSCHECK_H