fad861a0e28fe5c99b84ee414c6326d2321834c0
[WebKit-https.git] / Source / WebDriver / Session.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
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 #pragma once
27
28 #include "Capabilities.h"
29 #include <wtf/Forward.h>
30 #include <wtf/Function.h>
31 #include <wtf/OptionSet.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace Inspector {
37 class InspectorArray;
38 class InspectorObject;
39 class InspectorValue;
40 }
41
42 namespace WebDriver {
43
44 class CommandResult;
45 class SessionHost;
46
47 class Session : public RefCounted<Session> {
48 public:
49     static Ref<Session> create(std::unique_ptr<SessionHost>&& host)
50     {
51         return adoptRef(*new Session(WTFMove(host)));
52     }
53     ~Session();
54
55     const String& id() const { return m_id; }
56     const Capabilities& capabilities() const;
57
58     enum class FindElementsMode { Single, Multiple };
59     enum class ExecuteScriptMode { Sync, Async };
60     enum class Timeout { Script, PageLoad, Implicit };
61
62     void waitForNavigationToComplete(Function<void (CommandResult&&)>&&);
63     void createTopLevelBrowsingContext(Function<void (CommandResult&&)>&&);
64     void close(Function<void (CommandResult&&)>&&);
65     void getTimeouts(Function<void (CommandResult&&)>&&);
66     void setTimeouts(const Timeouts&, Function<void (CommandResult&&)>&&);
67
68     void go(const String& url, Function<void (CommandResult&&)>&&);
69     void getCurrentURL(Function<void (CommandResult&&)>&&);
70     void back(Function<void (CommandResult&&)>&&);
71     void forward(Function<void (CommandResult&&)>&&);
72     void refresh(Function<void (CommandResult&&)>&&);
73     void getTitle(Function<void (CommandResult&&)>&&);
74     void getWindowHandle(Function<void (CommandResult&&)>&&);
75     void closeWindow(Function<void (CommandResult&&)>&&);
76     void switchToWindow(const String& windowHandle, Function<void (CommandResult&&)>&&);
77     void getWindowHandles(Function<void (CommandResult&&)>&&);
78     void switchToFrame(RefPtr<Inspector::InspectorValue>&&, Function<void (CommandResult&&)>&&);
79     void switchToParentFrame(Function<void (CommandResult&&)>&&);
80     void getWindowPosition(Function<void (CommandResult&&)>&&);
81     void setWindowPosition(int windowX, int windowY, Function<void (CommandResult&&)>&&);
82     void getWindowSize(Function<void (CommandResult&&)>&&);
83     void setWindowSize(int windowWidth, int windowHeight, Function<void (CommandResult&&)>&&);
84     void findElements(const String& strategy, const String& selector, FindElementsMode, const String& rootElementID, Function<void (CommandResult&&)>&&);
85     void isElementSelected(const String& elementID, Function<void (CommandResult&&)>&&);
86     void getElementText(const String& elementID, Function<void (CommandResult&&)>&&);
87     void getElementTagName(const String& elementID, Function<void (CommandResult&&)>&&);
88     void getElementRect(const String& elementID, Function<void (CommandResult&&)>&&);
89     void isElementEnabled(const String& elementID, Function<void (CommandResult&&)>&&);
90     void isElementDisplayed(const String& elementID, Function<void (CommandResult&&)>&&);
91     void getElementAttribute(const String& elementID, const String& attribute, Function<void (CommandResult&&)>&&);
92     void elementClick(const String& elementID, Function<void (CommandResult&&)>&&);
93     void elementClear(const String& elementID, Function<void (CommandResult&&)>&&);
94     void elementSendKeys(const String& elementID, Vector<String>&& keys, Function<void (CommandResult&&)>&&);
95     void elementSubmit(const String& elementID, Function<void (CommandResult&&)>&&);
96     void executeScript(const String& script, RefPtr<Inspector::InspectorArray>&& arguments, ExecuteScriptMode, Function<void (CommandResult&&)>&&);
97
98 private:
99     Session(std::unique_ptr<SessionHost>&&);
100
101     void switchToTopLevelBrowsingContext(std::optional<String>);
102     void switchToBrowsingContext(std::optional<String>);
103
104     RefPtr<Inspector::InspectorObject> createElement(RefPtr<Inspector::InspectorValue>&&);
105     RefPtr<Inspector::InspectorObject> createElement(const String& elementID);
106     RefPtr<Inspector::InspectorObject> extractElement(Inspector::InspectorValue&);
107     String extractElementID(Inspector::InspectorValue&);
108     RefPtr<Inspector::InspectorValue> handleScriptResult(RefPtr<Inspector::InspectorValue>&&);
109
110     struct Point {
111         int x { 0 };
112         int y { 0 };
113     };
114
115     struct Size {
116         int width { 0 };
117         int height { 0 };
118     };
119
120     struct Rect {
121         Point origin;
122         Size size;
123     };
124
125     enum class ElementLayoutOption {
126         ScrollIntoViewIfNeeded = 1 << 0,
127         UseViewportCoordinates = 1 << 1,
128     };
129     void computeElementLayout(const String& elementID, OptionSet<ElementLayoutOption>, Function<void (std::optional<Rect>&&, std::optional<Point>&&, bool, RefPtr<Inspector::InspectorObject>&&)>&&);
130
131     enum class MouseButton { None, Left, Middle, Right };
132     enum class MouseInteraction { Move, Down, Up, SingleClick, DoubleClick };
133     void performMouseInteraction(int x, int y, MouseButton, MouseInteraction, Function<void (CommandResult&&)>&&);
134
135     enum class KeyboardInteractionType { KeyPress, KeyRelease, InsertByKey };
136     struct KeyboardInteraction {
137         KeyboardInteractionType type { KeyboardInteractionType::InsertByKey };
138         std::optional<String> text;
139         std::optional<String> key;
140     };
141     enum KeyModifier {
142         None = 0,
143         Shift = 1 << 0,
144         Control = 1 << 1,
145         Alternate = 1 << 2,
146         Meta = 1 << 3,
147     };
148     String virtualKeyForKeySequence(const String& keySequence, KeyModifier&);
149     void performKeyboardInteractions(Vector<KeyboardInteraction>&&, Function<void (CommandResult&&)>&&);
150
151     std::unique_ptr<SessionHost> m_host;
152     Timeouts m_timeouts;
153     String m_id;
154     std::optional<String> m_toplevelBrowsingContext;
155     std::optional<String> m_currentBrowsingContext;
156 };
157
158 } // WebDriver