[iOS] Export DefaultGCActivityCallback member functions
[WebKit-https.git] / Source / JavaScriptCore / runtime / GCActivityCallback.h
1 /*
2  * Copyright (C) 2010 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef GCActivityCallback_h
30 #define GCActivityCallback_h
31
32 #include "HeapTimer.h"
33 #include <wtf/OwnPtr.h>
34 #include <wtf/PassOwnPtr.h>
35
36 #if USE(CF)
37 #include <CoreFoundation/CoreFoundation.h>
38 #endif
39
40 namespace JSC {
41
42 class Heap;
43
44 class GCActivityCallback : public HeapTimer {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     virtual void didAllocate(size_t) { }
48     virtual void willCollect() { }
49     virtual void cancel() { }
50     bool isEnabled() const { return m_enabled; }
51     void setEnabled(bool enabled) { m_enabled = enabled; }
52
53     static bool s_shouldCreateGCTimer;
54
55 protected:
56 #if USE(CF)
57     GCActivityCallback(VM* vm, CFRunLoopRef runLoop)
58         : HeapTimer(vm, runLoop)
59         , m_enabled(true)
60     {
61     }
62 #elif PLATFORM(EFL)
63     GCActivityCallback(VM* vm, bool flag)
64         : HeapTimer(vm)
65         , m_enabled(flag)
66     {
67     }
68 #else
69     GCActivityCallback(VM* vm)
70         : HeapTimer(vm)
71         , m_enabled(true)
72     {
73     }
74 #endif
75
76     bool m_enabled;
77 };
78
79 class DefaultGCActivityCallback : public GCActivityCallback {
80 public:
81     static PassOwnPtr<DefaultGCActivityCallback> create(Heap*);
82
83     DefaultGCActivityCallback(Heap*);
84
85     JS_EXPORT_PRIVATE virtual void didAllocate(size_t) OVERRIDE;
86     JS_EXPORT_PRIVATE virtual void willCollect() OVERRIDE;
87     JS_EXPORT_PRIVATE virtual void cancel() OVERRIDE;
88
89     JS_EXPORT_PRIVATE virtual void doWork() OVERRIDE;
90
91 #if USE(CF)
92 protected:
93     JS_EXPORT_PRIVATE DefaultGCActivityCallback(Heap*, CFRunLoopRef);
94 #endif
95 #if USE(CF) || PLATFORM(EFL)
96 protected:
97     void cancelTimer();
98     void scheduleTimer(double);
99
100 private:
101     double m_delay;
102 #endif
103 };
104
105 inline PassOwnPtr<DefaultGCActivityCallback> DefaultGCActivityCallback::create(Heap* heap)
106 {
107     return GCActivityCallback::s_shouldCreateGCTimer ? adoptPtr(new DefaultGCActivityCallback(heap)) : nullptr;
108 }
109
110 }
111
112 #endif