Remove Platform.h include from the header files.
[WebKit-https.git] / Source / WTF / wtf / MainThread.h
1 /*
2  * Copyright (C) 2007, 2008, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef MainThread_h
31 #define MainThread_h
32
33 #include <stdint.h>
34
35 namespace WTF {
36
37 typedef uint32_t ThreadIdentifier;
38 typedef void MainThreadFunction(void*);
39
40 // Must be called from the main thread.
41 WTF_EXPORT_PRIVATE void initializeMainThread();
42
43 WTF_EXPORT_PRIVATE void callOnMainThread(MainThreadFunction*, void* context);
44 WTF_EXPORT_PRIVATE void callOnMainThreadAndWait(MainThreadFunction*, void* context);
45 WTF_EXPORT_PRIVATE void cancelCallOnMainThread(MainThreadFunction*, void* context);
46
47 template<typename> class Function;
48 WTF_EXPORT_PRIVATE void callOnMainThread(const Function<void ()>&);
49     
50 WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
51
52 WTF_EXPORT_PRIVATE bool isMainThread();
53
54 void initializeGCThreads();
55
56 #if ENABLE(PARALLEL_GC)
57 void registerGCThread();
58 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
59 #elif PLATFORM(MAC)
60 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
61 #else
62 inline bool isMainThreadOrGCThread() { return isMainThread(); }
63 #endif
64
65 // NOTE: these functions are internal to the callOnMainThread implementation.
66 void initializeMainThreadPlatform();
67 void scheduleDispatchFunctionsOnMainThread();
68 void dispatchFunctionsFromMainThread();
69
70 #if PLATFORM(MAC)
71 // This version of initializeMainThread sets up the main thread as corresponding
72 // to the process's main thread, and not necessarily the thread that calls this
73 // function. It should only be used as a legacy aid for Mac WebKit.
74 WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
75 void initializeMainThreadToProcessMainThreadPlatform();
76 #endif
77
78 } // namespace WTF
79
80 using WTF::callOnMainThread;
81 using WTF::callOnMainThreadAndWait;
82 using WTF::cancelCallOnMainThread;
83 using WTF::setMainThreadCallbacksPaused;
84 using WTF::isMainThread;
85 using WTF::isMainThreadOrGCThread;
86 #endif // MainThread_h