[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / dom / UserGestureIndicator.h
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 #pragma once
27
28 #include <wtf/Function.h>
29 #include <wtf/Noncopyable.h>
30 #include <wtf/Optional.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class Document;
38
39 enum ProcessingUserGestureState {
40     ProcessingUserGesture,
41     ProcessingPotentialUserGesture,
42     NotProcessingUserGesture
43 };
44
45 class UserGestureToken : public RefCounted<UserGestureToken> {
46 public:
47     static RefPtr<UserGestureToken> create(ProcessingUserGestureState state)
48     {
49         return adoptRef(new UserGestureToken(state));
50     }
51
52     WEBCORE_EXPORT ~UserGestureToken();
53
54     ProcessingUserGestureState state() const { return m_state; }
55     bool processingUserGesture() const { return m_state == ProcessingUserGesture; }
56     bool processingUserGestureForMedia() const { return m_state == ProcessingUserGesture || m_state == ProcessingPotentialUserGesture; }
57
58     void addDestructionObserver(WTF::Function<void (UserGestureToken&)>&& observer)
59     {
60         m_destructionObservers.append(WTFMove(observer));
61     }
62
63 private:
64     UserGestureToken(ProcessingUserGestureState state)
65         : m_state(state)
66     {
67     }
68
69     ProcessingUserGestureState m_state = NotProcessingUserGesture;
70     Vector<WTF::Function<void (UserGestureToken&)>> m_destructionObservers;
71 };
72
73 class UserGestureIndicator {
74     WTF_MAKE_NONCOPYABLE(UserGestureIndicator);
75 public:
76     WEBCORE_EXPORT static RefPtr<UserGestureToken> currentUserGesture();
77
78     WEBCORE_EXPORT static bool processingUserGesture();
79     WEBCORE_EXPORT static bool processingUserGestureForMedia();
80
81     // If a document is provided, its last known user gesture timestamp is updated.
82     WEBCORE_EXPORT explicit UserGestureIndicator(std::optional<ProcessingUserGestureState>, Document* = nullptr);
83     WEBCORE_EXPORT explicit UserGestureIndicator(RefPtr<UserGestureToken>);
84     WEBCORE_EXPORT ~UserGestureIndicator();
85
86 private:
87     RefPtr<UserGestureToken> m_previousToken;
88 };
89
90 }