Crash in WebCore::UserGestureIndicator::processingUserGesture with WebWorkers
[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 #ifndef UserGestureIndicator_h
27 #define UserGestureIndicator_h
28
29 #include <wtf/Noncopyable.h>
30
31 namespace WebCore {
32
33 class Document;
34
35 enum ProcessingUserGestureState {
36     DefinitelyProcessingUserGesture,
37     PossiblyProcessingUserGesture,
38     DefinitelyNotProcessingUserGesture
39 };
40
41 class UserGestureIndicator {
42     WTF_MAKE_NONCOPYABLE(UserGestureIndicator);
43 public:
44     static bool processingUserGesture();
45
46     // If a document is provided, its last known user gesture timestamp is updated.
47     WEBCORE_EXPORT explicit UserGestureIndicator(ProcessingUserGestureState, Document* = nullptr);
48     WEBCORE_EXPORT ~UserGestureIndicator();
49
50 private:
51     WEBCORE_EXPORT static ProcessingUserGestureState s_state;
52     ProcessingUserGestureState m_previousState;
53 };
54
55 }
56
57 #endif