Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSRunLoopTimer.h
1 /*
2  * Copyright (C) 2012, 2015-2017 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 #pragma once
27
28 #include <wtf/HashSet.h>
29 #include <wtf/Lock.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/RetainPtr.h>
32 #include <wtf/RunLoop.h>
33 #include <wtf/SharedTask.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 #if USE(CF)
37 #include <CoreFoundation/CoreFoundation.h>
38 #endif
39
40 namespace JSC {
41
42 class JSLock;
43 class VM;
44
45 class JSRunLoopTimer : public ThreadSafeRefCounted<JSRunLoopTimer> {
46 public:
47     typedef void TimerNotificationType();
48     using TimerNotificationCallback = RefPtr<WTF::SharedTask<TimerNotificationType>>;
49
50     JSRunLoopTimer(VM*);
51 #if USE(CF)
52     static void timerDidFireCallback(CFRunLoopTimerRef, void*);
53 #else
54     void timerDidFireCallback();
55 #endif
56
57     JS_EXPORT_PRIVATE virtual ~JSRunLoopTimer();
58     virtual void doWork() = 0;
59
60     void scheduleTimer(Seconds intervalInSeconds);
61     void cancelTimer();
62     bool isScheduled() const { return m_isScheduled; }
63
64     // Note: The only thing the timer notification callback cannot do is
65     // call scheduleTimer(). This will cause a deadlock. It would not
66     // be hard to make this work, however, there are no clients that need
67     // this behavior. We should implement it only if we find that we need it.
68     JS_EXPORT_PRIVATE void addTimerSetNotification(TimerNotificationCallback);
69     JS_EXPORT_PRIVATE void removeTimerSetNotification(TimerNotificationCallback);
70
71 #if USE(CF)
72     JS_EXPORT_PRIVATE void setRunLoop(CFRunLoopRef);
73 #endif // USE(CF)
74
75 protected:
76     VM* m_vm;
77
78     static const Seconds s_decade;
79
80     RefPtr<JSLock> m_apiLock;
81     bool m_isScheduled { false };
82 #if USE(CF)
83     RetainPtr<CFRunLoopTimerRef> m_timer;
84     RetainPtr<CFRunLoopRef> m_runLoop;
85
86     CFRunLoopTimerContext m_context;
87
88     Lock m_shutdownMutex;
89 #else
90     RunLoop::Timer<JSRunLoopTimer> m_timer;
91 #endif
92
93     Lock m_timerCallbacksLock;
94     HashSet<TimerNotificationCallback> m_timerSetCallbacks;
95     
96 private:
97     void timerDidFire();
98 };
99     
100 } // namespace JSC