b1160b227067c94556854354f3ff92f4082c1dd4
[WebKit-https.git] / Source / WebCore / replay / UserInputBridge.h
1 /*
2  * Copyright (C) 2012, 2013 University of Washington. All rights reserved.
3  * Copyright (C) 2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
16  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
18  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #ifndef UserInputBridge_h
29 #define UserInputBridge_h
30
31 #include "ScrollTypes.h"
32 #include <wtf/Noncopyable.h>
33
34 namespace WebCore {
35
36 struct FrameLoadRequest;
37
38 class Frame;
39 class Page;
40 class PlatformKeyboardEvent;
41 class PlatformMouseEvent;
42 class PlatformWheelEvent;
43
44 // Real user inputs come from WebKit or WebKit2.
45 // Synthetic inputs come from within WebCore (i.e., from web replay or fake mouse moves).
46 enum class InputSource {
47     User,
48     Synthetic
49 };
50
51 class UserInputBridge {
52     WTF_MAKE_NONCOPYABLE(UserInputBridge);
53 public:
54     UserInputBridge(Page&);
55
56     // User input APIs.
57 #if ENABLE(CONTEXT_MENUS)
58     bool handleContextMenuEvent(const PlatformMouseEvent&, const Frame*, InputSource source = InputSource::User);
59 #endif
60     bool handleMousePressEvent(const PlatformMouseEvent&, InputSource source = InputSource::User);
61     bool handleMouseReleaseEvent(const PlatformMouseEvent&, InputSource source = InputSource::User);
62     bool handleMouseMoveEvent(const PlatformMouseEvent&, InputSource source = InputSource::User);
63     bool handleMouseMoveOnScrollbarEvent(const PlatformMouseEvent&, InputSource source = InputSource::User);
64     bool handleWheelEvent(const PlatformWheelEvent&, InputSource source = InputSource::User);
65     bool handleKeyEvent(const PlatformKeyboardEvent&, InputSource source = InputSource::User);
66     bool handleAccessKeyEvent(const PlatformKeyboardEvent&, InputSource source = InputSource::User);
67     void focusSetActive(bool active, InputSource source = InputSource::User);
68     void focusSetFocused(bool focused, InputSource source = InputSource::User);
69     bool scrollRecursively(ScrollDirection, ScrollGranularity, InputSource source = InputSource::User);
70     bool logicalScrollRecursively(ScrollLogicalDirection, ScrollGranularity, InputSource source = InputSource::User);
71
72     // Navigation APIs.
73     void loadRequest(const FrameLoadRequest&, InputSource source = InputSource::User);
74     void reloadFrame(Frame*, bool endToEndReload, InputSource source = InputSource::User);
75     void stopLoadingFrame(Frame*, InputSource source = InputSource::User);
76     bool tryClosePage(InputSource source = InputSource::User);
77
78 private:
79     Page& m_page;
80 };
81
82 } // namespace WebCore
83
84 #endif // UserInputBridge_h