[GTK][WPE] Unreviewed test gardening. Update baselines after r268958.
[WebKit-https.git] / Source / WTF / wtf / MainThread.h
1 /*
2  * Copyright (C) 2007, 2008, 2010, 2016 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 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 #pragma once
31
32 #include <stdint.h>
33 #include <wtf/Forward.h>
34 #include <wtf/Function.h>
35 #include <wtf/ThreadingPrimitives.h>
36
37 namespace WTF {
38
39 class PrintStream;
40 class Thread;
41
42 // Must be called from the main thread.
43 WTF_EXPORT_PRIVATE void initializeMainThread();
44
45 WTF_EXPORT_PRIVATE void callOnMainThread(Function<void()>&&);
46 WTF_EXPORT_PRIVATE void callOnMainThreadAndWait(Function<void()>&&);
47
48 #if PLATFORM(COCOA)
49 WTF_EXPORT_PRIVATE void dispatchAsyncOnMainThreadWithWebThreadLockIfNeeded(void (^block)());
50 WTF_EXPORT_PRIVATE void callOnWebThreadOrDispatchAsyncOnMainThread(void (^block)());
51 #endif
52
53 WTF_EXPORT_PRIVATE bool isMainThread();
54
55 WTF_EXPORT_PRIVATE bool canCurrentThreadAccessThreadLocalData(Thread&);
56
57 WTF_EXPORT_PRIVATE bool isMainRunLoop();
58 WTF_EXPORT_PRIVATE void callOnMainRunLoop(Function<void()>&&);
59 WTF_EXPORT_PRIVATE void callOnMainRunLoopAndWait(Function<void()>&&);
60
61 #if USE(WEB_THREAD)
62 WTF_EXPORT_PRIVATE bool isWebThread();
63 WTF_EXPORT_PRIVATE bool isUIThread();
64 WTF_EXPORT_PRIVATE void initializeWebThread();
65 WTF_EXPORT_PRIVATE void initializeApplicationUIThread();
66 #else
67 inline bool isWebThread() { return isMainThread(); }
68 inline bool isUIThread() { return isMainThread(); }
69 #endif // USE(WEB_THREAD)
70
71 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
72
73 // NOTE: these functions are internal to the callOnMainThread implementation.
74 void initializeMainThreadPlatform();
75
76 } // namespace WTF
77
78 using WTF::callOnMainThread;
79 using WTF::callOnMainThreadAndWait;
80 using WTF::callOnMainRunLoop;
81 using WTF::callOnMainRunLoopAndWait;
82 using WTF::canCurrentThreadAccessThreadLocalData;
83 using WTF::isMainThread;
84 using WTF::isMainThreadOrGCThread;
85 using WTF::isUIThread;
86 using WTF::isWebThread;
87 #if PLATFORM(COCOA)
88 using WTF::dispatchAsyncOnMainThreadWithWebThreadLockIfNeeded;
89 using WTF::callOnWebThreadOrDispatchAsyncOnMainThread;
90 #endif
91 #if USE(WEB_THREAD)
92 using WTF::initializeWebThread;
93 using WTF::initializeApplicationUIThread;
94 #endif