Source/WebCore/platform/cf/RunLoopObserver.h

   1 /*
   2  * Copyright (C) 2011, 2014 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef RunLoopObserver_h
  27 #define RunLoopObserver_h
  28
  29 #include <CoreFoundation/CoreFoundation.h>
  30 #include <functional>
  31 #include <wtf/Noncopyable.h>
  32 #include <wtf/RetainPtr.h>
  33
  34 namespace WebCore {
  35
  36 class RunLoopObserver {
  37     WTF_MAKE_NONCOPYABLE(RunLoopObserver);
  38 public:
  39     typedef std::function<void ()> RunLoopObserverCallback;
  40
  41     RunLoopObserver(CFIndex order, RunLoopObserverCallback callback)
  42         : m_order(order)
  43         , m_callback(callback)
  44     { }
  45
  46     WEBCORE_EXPORT ~RunLoopObserver();
  47
  48     WEBCORE_EXPORT void schedule(CFRunLoopRef = nullptr, CFRunLoopActivity = kCFRunLoopBeforeWaiting | kCFRunLoopExit);
  49     WEBCORE_EXPORT void invalidate();
  50
  51     bool isScheduled() const { return m_runLoopObserver; }
  52
  53     enum class WellKnownRunLoopOrders : CFIndex {
  54         CoreAnimationCommit = 2000000
  55     };
  56
  57 protected:
  58     void runLoopObserverFired();
  59
  60 private:
  61     static void runLoopObserverFired(CFRunLoopObserverRef, CFRunLoopActivity, void* context);
  62
  63     CFIndex m_order;
  64     RunLoopObserverCallback m_callback;
  65     RetainPtr<CFRunLoopObserverRef> m_runLoopObserver;
  66 };
  67
  68 } // namespace WebCore
  69
  70 #endif // RunLoopObserver_h