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 "platform/PlatformExport.h" 30 #include "wtf/Noncopyable.h" 31 #include "wtf/RefCounted.h" 32 #include "wtf/RefPtr.h" 33 34 namespace WebCore { 35 36 class UserGestureIndicator; 37 38 enum ProcessingUserGestureState { 39 DefinitelyProcessingNewUserGesture, 40 DefinitelyProcessingUserGesture, 41 PossiblyProcessingUserGesture, 42 DefinitelyNotProcessingUserGesture 43 }; 44 45 class PLATFORM_EXPORT UserGestureToken : public RefCounted<UserGestureToken> { 46 public: ~UserGestureToken()47 virtual ~UserGestureToken() { } 48 virtual bool hasGestures() const = 0; 49 virtual void setOutOfProcess() = 0; 50 virtual void setJavascriptPrompt() = 0; 51 }; 52 53 class PLATFORM_EXPORT UserGestureIndicatorDisabler { 54 WTF_MAKE_NONCOPYABLE(UserGestureIndicatorDisabler); 55 public: 56 UserGestureIndicatorDisabler(); 57 ~UserGestureIndicatorDisabler(); 58 59 private: 60 ProcessingUserGestureState m_savedState; 61 UserGestureIndicator* m_savedIndicator; 62 }; 63 64 class PLATFORM_EXPORT UserGestureIndicator { 65 WTF_MAKE_NONCOPYABLE(UserGestureIndicator); 66 friend class UserGestureIndicatorDisabler; 67 public: 68 static bool processingUserGesture(); 69 static bool consumeUserGesture(); 70 static UserGestureToken* currentToken(); 71 static void clearProcessedUserGestureInPast(); 72 static bool processedUserGestureInPast(); 73 74 explicit UserGestureIndicator(ProcessingUserGestureState); 75 explicit UserGestureIndicator(PassRefPtr<UserGestureToken>); 76 ~UserGestureIndicator(); 77 78 79 private: 80 static ProcessingUserGestureState s_state; 81 static UserGestureIndicator* s_topmostIndicator; 82 static bool s_processedUserGestureInPast; 83 ProcessingUserGestureState m_previousState; 84 RefPtr<UserGestureToken> m_token; 85 }; 86 87 } 88 89 #endif 90