ece68f1d58bf798415dec512e3109b8cd2380ed8
[WebKit-https.git] / Source / WebCore / dom / UserGestureIndicator.cpp
1 /*
2  * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "UserGestureIndicator.h"
28
29 #include "Document.h"
30 #include <wtf/MainThread.h>
31 #include <wtf/NeverDestroyed.h>
32
33 namespace WebCore {
34
35 static RefPtr<UserGestureToken>& currentToken()
36 {
37     static NeverDestroyed<RefPtr<UserGestureToken>> token;
38     return token;
39 }
40
41 UserGestureToken::~UserGestureToken()
42 {
43     for (auto& observer : m_destructionObservers)
44         observer(*this);
45 }
46
47 UserGestureIndicator::UserGestureIndicator(std::optional<ProcessingUserGestureState> state, Document* document)
48     : m_previousToken(currentToken())
49 {
50     // Silently ignore UserGestureIndicators on non main threads.
51     if (!isMainThread())
52         return;
53
54     if (state)
55         currentToken() = UserGestureToken::create(state.value());
56
57     if (document && currentToken()->processingUserGesture())
58         document->topDocument().updateLastHandledUserGestureTimestamp();
59 }
60
61 UserGestureIndicator::UserGestureIndicator(RefPtr<UserGestureToken> token)
62     : m_previousToken(currentToken())
63 {
64     if (!isMainThread())
65         return;
66
67     if (token)
68         currentToken() = token;
69 }
70
71 UserGestureIndicator::~UserGestureIndicator()
72 {
73     if (!isMainThread())
74         return;
75     
76     currentToken() = m_previousToken;
77 }
78
79 RefPtr<UserGestureToken> UserGestureIndicator::currentUserGesture()
80 {
81     if (!isMainThread())
82         return nullptr;
83
84     return currentToken();
85 }
86
87 bool UserGestureIndicator::processingUserGesture()
88 {
89     if (!isMainThread())
90         return false;
91
92     return currentToken() ? currentToken()->processingUserGesture() : false;
93 }
94
95 bool UserGestureIndicator::processingUserGestureForMedia()
96 {
97     if (!isMainThread())
98         return false;
99
100     return currentToken() ? currentToken()->processingUserGestureForMedia() : false;
101 }
102
103 }