1/*
2 * Copyright (C) 2015 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 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#include "config.h"
30#include "WheelEventTestTrigger.h"
31
32#include "Logging.h"
33
34#if !LOG_DISABLED
35#include <wtf/text/CString.h>
36#include <wtf/text/StringBuilder.h>
37#endif
38
39namespace WebCore {
40
41WheelEventTestTrigger::WheelEventTestTrigger()
42 : m_testTriggerTimer(RunLoop::current(), this, &WheelEventTestTrigger::triggerTestTimerFired)
43{
44}
45
46void WheelEventTestTrigger::clearAllTestDeferrals()
47{
48 std::lock_guard<Lock> lock(m_testTriggerMutex);
49 m_deferTestTriggerReasons.clear();
50 m_testNotificationCallback = nullptr;
51 m_testTriggerTimer.stop();
52 LOG(WheelEventTestTriggers, " (=) WheelEventTestTrigger::clearAllTestDeferrals: cleared all test state.");
53}
54
55void WheelEventTestTrigger::setTestCallbackAndStartNotificationTimer(WTF::Function<void()>&& functionCallback)
56{
57 {
58 std::lock_guard<Lock> lock(m_testTriggerMutex);
59 m_testNotificationCallback = WTFMove(functionCallback);
60 }
61
62 if (!m_testTriggerTimer.isActive())
63 m_testTriggerTimer.startRepeating(1_s / 60.);
64}
65
66void WheelEventTestTrigger::deferTestsForReason(ScrollableAreaIdentifier identifier, DeferTestTriggerReason reason)
67{
68 std::lock_guard<Lock> lock(m_testTriggerMutex);
69 auto it = m_deferTestTriggerReasons.find(identifier);
70 if (it == m_deferTestTriggerReasons.end())
71 it = m_deferTestTriggerReasons.add(identifier, DeferTestTriggerReasonSet()).iterator;
72
73 LOG(WheelEventTestTriggers, " (=) WheelEventTestTrigger::deferTestsForReason: id=%p, reason=%d", identifier, reason);
74 it->value.insert(reason);
75}
76
77void WheelEventTestTrigger::removeTestDeferralForReason(ScrollableAreaIdentifier identifier, DeferTestTriggerReason reason)
78{
79 std::lock_guard<Lock> lock(m_testTriggerMutex);
80 auto it = m_deferTestTriggerReasons.find(identifier);
81 if (it == m_deferTestTriggerReasons.end())
82 return;
83
84 LOG(WheelEventTestTriggers, " (=) WheelEventTestTrigger::removeTestDeferralForReason: id=%p, reason=%d", identifier, reason);
85 it->value.erase(reason);
86
87 if (it->value.empty())
88 m_deferTestTriggerReasons.remove(it);
89}
90
91#if !LOG_DISABLED
92
93static void dumpState(WTF::HashMap<WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReasonSet> reasons)
94{
95 LOG(WheelEventTestTriggers, " WheelEventTestTrigger::dumpState:");
96 for (const auto& scrollRegion : reasons) {
97 LOG(WheelEventTestTriggers, " For scroll region %p", scrollRegion.key);
98 StringBuilder reasons;
99 for (const auto& reason : scrollRegion.value) {
100 if (!reasons.isEmpty())
101 reasons.appendLiteral(", ");
102 reasons.appendNumber(static_cast<unsigned>(reason));
103 }
104 LOG(WheelEventTestTriggers, " Reasons: %s", reasons.toString().utf8().data());
105 }
106}
107
108#endif
109
110void WheelEventTestTrigger::triggerTestTimerFired()
111{
112 WTF::Function<void()> functionCallback;
113
114 {
115 std::lock_guard<Lock> lock(m_testTriggerMutex);
116 if (!m_deferTestTriggerReasons.isEmpty()) {
117#if !LOG_DISABLED
118 if (isLogChannelEnabled("WheelEventTestTriggers"))
119 dumpState(m_deferTestTriggerReasons);
120#endif
121 return;
122 }
123
124 functionCallback = WTFMove(m_testNotificationCallback);
125 }
126
127 m_testTriggerTimer.stop();
128
129 LOG(WheelEventTestTriggers, " WheelEventTestTrigger::triggerTestTimerFired: FIRING TEST");
130 if (functionCallback)
131 functionCallback();
132}
133
134}
135