[Win] MSVC doesn't seem to like "friend class NeverDestroyed<Foo>"
[WebKit-https.git] / Source / WebKit / UIProcess / gtk / WaylandCompositor.h
1 /*
2  * Copyright (C) 2016 Igalia S.L.
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 #pragma once
27
28 #if PLATFORM(WAYLAND) && USE(EGL)
29
30 #include "WebPageProxy.h"
31 #include <WebCore/RefPtrCairo.h>
32 #include <WebCore/WlUniquePtr.h>
33 #include <gtk/gtk.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/NeverDestroyed.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/WeakPtr.h>
38 #include <wtf/glib/GRefPtr.h>
39 #include <wtf/text/WTFString.h>
40
41 typedef void *EGLImageKHR;
42
43 namespace WebCore {
44 class GLContext;
45 }
46
47 namespace WebKit {
48
49 class WebPageProxy;
50
51 class WaylandCompositor {
52     WTF_MAKE_NONCOPYABLE(WaylandCompositor);
53     friend NeverDestroyed<WaylandCompositor>;
54 public:
55     static WaylandCompositor& singleton();
56
57     class Buffer {
58         WTF_MAKE_NONCOPYABLE(Buffer); WTF_MAKE_FAST_ALLOCATED;
59     public:
60         static Buffer* getOrCreate(struct wl_resource*);
61         ~Buffer();
62
63         void use();
64         void unuse();
65
66         EGLImageKHR createImage() const;
67         WebCore::IntSize size() const;
68
69         WeakPtr<Buffer> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(*this); }
70
71     private:
72         Buffer(struct wl_resource*);
73         static void destroyListenerCallback(struct wl_listener*, void*);
74
75         struct wl_resource* m_resource { nullptr };
76         struct wl_listener m_destroyListener;
77         uint32_t m_busyCount { 0 };
78         WeakPtrFactory<Buffer> m_weakPtrFactory;
79     };
80
81     class Surface {
82         WTF_MAKE_NONCOPYABLE(Surface); WTF_MAKE_FAST_ALLOCATED;
83     public:
84         Surface();
85         ~Surface();
86
87         void attachBuffer(struct wl_resource*);
88         void requestFrame(struct wl_resource*);
89         void commit();
90
91         void setWebPage(WebPageProxy*);
92         bool prepareTextureForPainting(unsigned&, WebCore::IntSize&);
93
94     private:
95         void flushFrameCallbacks();
96         void flushPendingFrameCallbacks();
97         void makePendingBufferCurrent();
98
99         WeakPtr<Buffer> m_buffer;
100         WeakPtr<Buffer> m_pendingBuffer;
101         unsigned m_texture;
102         EGLImageKHR m_image;
103         WebCore::IntSize m_imageSize;
104         Vector<wl_resource*> m_pendingFrameCallbackList;
105         Vector<wl_resource*> m_frameCallbackList;
106         WebPageProxy* m_webPage { nullptr };
107         unsigned m_tickCallbackID { 0 };
108     };
109
110     bool isRunning() const { return !!m_display; }
111     String displayName() const { return m_displayName; }
112
113     void bindSurfaceToWebPage(Surface*, uint64_t pageID);
114     void registerWebPage(WebPageProxy&);
115     void unregisterWebPage(WebPageProxy&);
116
117     bool getTexture(WebPageProxy&, unsigned&, WebCore::IntSize&);
118
119 private:
120     WaylandCompositor();
121
122     bool initializeEGL();
123
124     String m_displayName;
125     WebCore::WlUniquePtr<struct wl_display> m_display;
126     WebCore::WlUniquePtr<struct wl_global> m_compositorGlobal;
127     WebCore::WlUniquePtr<struct wl_global> m_webkitgtkGlobal;
128     GRefPtr<GSource> m_eventSource;
129     std::unique_ptr<WebCore::GLContext> m_eglContext;
130     HashMap<WebPageProxy*, Surface*> m_pageMap;
131 };
132
133 } // namespace WebKit
134
135 #endif // PLATFORM(WAYLAND) && USE(EGL)