Refactor UserGestureIndicator::Token to be a top-level class
[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 #include <wtf/RefCounted.h>
31 #include <wtf/RefPtr.h>
32
33 namespace WebCore {
34
35 enum ProcessingUserGestureState {
36     DefinitelyProcessingUserGesture,
37     PossiblyProcessingUserGesture,
38     DefinitelyNotProcessingUserGesture
39 };
40
41 class UserGestureToken : public RefCounted<UserGestureToken> {
42 public:
43     virtual ~UserGestureToken() { }
44 };
45
46
47 class UserGestureIndicator {
48     WTF_MAKE_NONCOPYABLE(UserGestureIndicator);
49 public:
50     static bool processingUserGesture();
51     static bool consumeUserGesture();
52     static UserGestureToken* currentToken();
53
54     explicit UserGestureIndicator(ProcessingUserGestureState);
55     explicit UserGestureIndicator(PassRefPtr<UserGestureToken>);
56     ~UserGestureIndicator();
57
58
59 private:
60     static ProcessingUserGestureState s_state;
61     static UserGestureIndicator* s_topmostIndicator;
62     ProcessingUserGestureState m_previousState;
63     RefPtr<UserGestureToken> m_token;
64 };
65
66 }
67
68 #endif