Home | History | Annotate | Download | only in dom 
      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 class UserGestureIndicator;
     36 
     37 enum ProcessingUserGestureState {
     38     DefinitelyProcessingNewUserGesture,
     39     DefinitelyProcessingUserGesture,
     40     PossiblyProcessingUserGesture,
     41     DefinitelyNotProcessingUserGesture
     42 };
     43 
     44 class UserGestureToken : public RefCounted<UserGestureToken> {
     45 public:
     46     virtual ~UserGestureToken() { }
     47     virtual bool hasGestures() const = 0;
     48     virtual void setOutOfProcess() = 0;
     49     virtual void setJavascriptPrompt() = 0;
     50 };
     51 
     52 class UserGestureIndicatorDisabler {
     53     WTF_MAKE_NONCOPYABLE(UserGestureIndicatorDisabler);
     54 public:
     55     UserGestureIndicatorDisabler();
     56     ~UserGestureIndicatorDisabler();
     57 
     58 private:
     59     ProcessingUserGestureState m_savedState;
     60     UserGestureIndicator* m_savedIndicator;
     61 };
     62 
     63 class UserGestureIndicator {
     64     WTF_MAKE_NONCOPYABLE(UserGestureIndicator);
     65     friend class UserGestureIndicatorDisabler;
     66 public:
     67     static bool processingUserGesture();
     68     static bool consumeUserGesture();
     69     static UserGestureToken* currentToken();
     70 
     71     explicit UserGestureIndicator(ProcessingUserGestureState);
     72     explicit UserGestureIndicator(PassRefPtr<UserGestureToken>);
     73     ~UserGestureIndicator();
     74 
     75 
     76 private:
     77     static ProcessingUserGestureState s_state;
     78     static UserGestureIndicator* s_topmostIndicator;
     79     ProcessingUserGestureState m_previousState;
     80     RefPtr<UserGestureToken> m_token;
     81 };
     82 
     83 }
     84 
     85 #endif
     86