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#pragma once
30
31#include <functional>
32#include <wtf/Function.h>
33#include <wtf/HashMap.h>
34#include <wtf/Lock.h>
35#include <wtf/RunLoop.h>
36#include <wtf/StdSet.h>
37#include <wtf/ThreadSafeRefCounted.h>
38
39namespace WebCore {
40
41class WheelEventTestTrigger : public ThreadSafeRefCounted<WheelEventTestTrigger> {
42 WTF_MAKE_NONCOPYABLE(WheelEventTestTrigger); WTF_MAKE_FAST_ALLOCATED;
43public:
44 WheelEventTestTrigger();
45
46 WEBCORE_EXPORT void setTestCallbackAndStartNotificationTimer(WTF::Function<void()>&&);
47 WEBCORE_EXPORT void clearAllTestDeferrals();
48
49 enum DeferTestTriggerReason {
50 RubberbandInProgress,
51 ScrollSnapInProgress,
52 ScrollingThreadSyncNeeded,
53 ContentScrollInProgress
54 };
55 using DeferTestTriggerReasonSet = StdSet<DeferTestTriggerReason>;
56 typedef const void* ScrollableAreaIdentifier;
57 void WEBCORE_EXPORT deferTestsForReason(ScrollableAreaIdentifier, DeferTestTriggerReason);
58 void WEBCORE_EXPORT removeTestDeferralForReason(ScrollableAreaIdentifier, DeferTestTriggerReason);
59 void triggerTestTimerFired();
60
61private:
62 WTF::Function<void()> m_testNotificationCallback;
63 RunLoop::Timer<WheelEventTestTrigger> m_testTriggerTimer;
64 mutable Lock m_testTriggerMutex;
65 WTF::HashMap<ScrollableAreaIdentifier, DeferTestTriggerReasonSet> m_deferTestTriggerReasons;
66};
67
68} // namespace WebCore
69