Move WebCore into Source
[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 COMPUTER, 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 COMPUTER, 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 #include <wtf/Noncopyable.h>
30 #include "Timer.h"
31
32 namespace WebCore {
33
34     class GCController : public Noncopyable {
35         friend GCController& gcController();
36
37     public:
38         void garbageCollectSoon();
39         void garbageCollectNow(); // It's better to call garbageCollectSoon, unless you have a specific reason not to.
40
41         void garbageCollectOnAlternateThreadForDebugging(bool waitUntilDone); // Used for stress testing.
42
43     private:
44         GCController(); // Use gcController() instead
45         void gcTimerFired(Timer<GCController>*);
46         
47         Timer<GCController> m_GCTimer;
48     };
49
50     // Function to obtain the global GC controller.
51     GCController& gcController();
52
53 } // namespace WebCore
54
55 #endif // GCController_h