1/*
2 * Copyright (C) 2013 Google 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 are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef WebUserGestureToken_h
32#define WebUserGestureToken_h
33
34#include "../platform/WebPrivatePtr.h"
35
36namespace blink {
37
38class UserGestureToken;
39
40// A WebUserGestureToken allows for storing the user gesture state of the
41// currently active context and reinstantiating it later on to continue
42// processing the user gesture in case it was not consumed meanwhile.
43class WebUserGestureToken {
44public:
45    WebUserGestureToken() { }
46    WebUserGestureToken(const WebUserGestureToken& other) { assign(other); }
47    WebUserGestureToken& operator=(const WebUserGestureToken& other)
48    {
49        assign(other);
50        return *this;
51    }
52    ~WebUserGestureToken() { reset(); }
53
54    BLINK_EXPORT bool hasGestures() const;
55    BLINK_EXPORT void setOutOfProcess();
56    BLINK_EXPORT void setJavascriptPrompt();
57    bool isNull() const { return m_token.isNull(); }
58
59#if BLINK_IMPLEMENTATION
60    explicit WebUserGestureToken(PassRefPtr<UserGestureToken>);
61    operator PassRefPtr<UserGestureToken>() const;
62#endif
63
64private:
65    BLINK_EXPORT void assign(const WebUserGestureToken&);
66    BLINK_EXPORT void reset();
67
68    WebPrivatePtr<UserGestureToken> m_token;
69};
70
71} // namespace blink
72
73#endif // WebUserGestureToken_h
74