Separate flushing layer changes from rendering in CACFLayerTreeHost
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / win / LayerChangesFlusher.cpp
1 /*
2  * Copyright (C) 2011 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 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 #include "config.h"
27 #include "LayerChangesFlusher.h"
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "CACFLayerTreeHost.h"
32 #include "WebCoreInstanceHandle.h"
33 #include <wtf/StdLibExtras.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 LayerChangesFlusher& LayerChangesFlusher::shared()
39 {
40     DEFINE_STATIC_LOCAL(LayerChangesFlusher, flusher, ());
41     return flusher;
42 }
43
44 LayerChangesFlusher::LayerChangesFlusher()
45     : m_hook(0)
46     , m_isCallingHosts(false)
47 {
48 }
49
50 void LayerChangesFlusher::flushPendingLayerChangesSoon(CACFLayerTreeHost* host)
51 {
52     if (!m_hostsWithChangesToFlush.add(host).second || m_hook)
53         return;
54
55     setHook();
56 }
57
58 void LayerChangesFlusher::cancelPendingFlush(CACFLayerTreeHost* host)
59 {
60     m_hostsWithChangesToFlush.remove(host);
61
62     if (!m_hostsWithChangesToFlush.isEmpty() || !m_hook)
63         return;
64
65     // We handle removing the hook when we finish calling out to the hosts, so we shouldn't
66     // mess with it while we're in the process of calling them.
67     if (m_isCallingHosts)
68         return;
69
70     removeHook();
71 }
72
73 LRESULT LayerChangesFlusher::hookCallback(int code, WPARAM wParam, LPARAM lParam)
74 {
75     return shared().hookFired(code, wParam, lParam);
76 }
77
78 LRESULT LayerChangesFlusher::hookFired(int code, WPARAM wParam, LPARAM lParam)
79 {
80     ASSERT(m_hook);
81
82     // Calling out to the hosts can cause m_hostsWithChangesToFlush to be modified, so we copy it
83     // into a Vector first. We have to hold a reference to them because otherwise they could be
84     // destroyed while we're calling out to them.
85     Vector<RefPtr<CACFLayerTreeHost> > hosts;
86     copyToVector(m_hostsWithChangesToFlush, hosts);
87     m_hostsWithChangesToFlush.clear();
88
89     m_isCallingHosts = true;
90     for (size_t i = 0; i < hosts.size(); ++i)
91         hosts[i]->flushPendingLayerChangesNow();
92     m_isCallingHosts = false;
93
94     LRESULT result = ::CallNextHookEx(m_hook, code, wParam, lParam);
95
96     if (m_hostsWithChangesToFlush.isEmpty()) {
97         // We won't have any work to do next time around, so just remove our hook.
98         removeHook();
99     }
100
101     return result;
102 }
103
104 void LayerChangesFlusher::setHook()
105 {
106     ASSERT(!m_hook);
107     ASSERT(!m_isCallingHosts);
108
109     DWORD threadID = ::GetCurrentThreadId();
110
111     m_hook = ::SetWindowsHookExW(WH_GETMESSAGE, hookCallback, instanceHandle(), threadID);
112     ASSERT_WITH_MESSAGE(m_hook, "::SetWindowsHookExW failed with error %lu", ::GetLastError());
113
114     // Post a message to the message queue to prevent ::GetMessage from blocking, which will ensure
115     // our hook is called soon.
116     ::PostThreadMessageW(threadID, WM_NULL, 0, 0);
117 }
118
119 void LayerChangesFlusher::removeHook()
120 {
121     ASSERT(m_hook);
122     ASSERT(!m_isCallingHosts);
123
124     if (!::UnhookWindowsHookEx(m_hook))
125         ASSERT_WITH_MESSAGE(false, "::UnhookWindowsHookEx failed with error %lu", ::GetLastError());
126
127     m_hook = 0;
128 }
129
130 } // namespace WebCore
131
132 #endif // USE(ACCELERATED_COMPOSITING)