a371510a4d2dec00591840c695d863f734ce6f58
[WebKit-https.git] / Source / WebCore / bindings / js / GCController.h
1 /*
2  * Copyright (C) 2007 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 GCController_h
27 #define GCController_h
28
29 #if USE(CF)
30 #include <wtf/FastMalloc.h>
31 #include <wtf/Noncopyable.h>
32 #else
33 #include "Timer.h"
34 #endif
35
36 namespace WebCore {
37
38     class GCController {
39         WTF_MAKE_NONCOPYABLE(GCController); WTF_MAKE_FAST_ALLOCATED;
40         friend GCController& gcController();
41
42     public:
43         WEBCORE_EXPORT void garbageCollectSoon();
44         WEBCORE_EXPORT void garbageCollectNow(); // It's better to call garbageCollectSoon, unless you have a specific reason not to.
45
46         WEBCORE_EXPORT void garbageCollectOnAlternateThreadForDebugging(bool waitUntilDone); // Used for stress testing.
47         WEBCORE_EXPORT void releaseExecutableMemory();
48         WEBCORE_EXPORT void setJavaScriptGarbageCollectorTimerEnabled(bool);
49         WEBCORE_EXPORT void discardAllCompiledCode();
50
51     private:
52         GCController(); // Use gcController() instead
53
54 #if !USE(CF)
55         void gcTimerFired(Timer*);
56         Timer m_GCTimer;
57 #endif
58     };
59
60     // Function to obtain the global GC controller.
61     WEBCORE_EXPORT GCController& gcController() PURE_FUNCTION;
62
63 } // namespace WebCore
64
65 #endif // GCController_h