Added missing override and final specifiers
[WebKit-https.git] / Source / WebKit2 / WebProcess / Automation / WebAutomationSessionProxy.h
1 /*
2  * Copyright (C) 2016 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 WebAutomationSessionProxy_h
27 #define WebAutomationSessionProxy_h
28
29 #include "Connection.h"
30 #include <JavaScriptCore/JSBase.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WebCore {
34 class Element;
35 }
36
37 namespace WebKit {
38
39 class WebFrame;
40 class WebPage;
41
42 class WebAutomationSessionProxy : public IPC::MessageReceiver {
43 public:
44     WebAutomationSessionProxy(const String& sessionIdentifier);
45     ~WebAutomationSessionProxy();
46
47     String sessionIdentifier() const { return m_sessionIdentifier; }
48
49     void didClearWindowObjectForFrame(WebFrame&);
50
51     void didEvaluateJavaScriptFunction(uint64_t frameID, uint64_t callbackID, const String& result, const String& errorType);
52
53 private:
54     JSObjectRef scriptObjectForFrame(WebFrame&);
55     WebCore::Element* elementForNodeHandle(WebFrame&, const String&);
56
57     // Implemented in generated WebAutomationSessionProxyMessageReceiver.cpp
58     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
59
60     // Called by WebAutomationSessionProxy messages
61     void evaluateJavaScriptFunction(uint64_t pageID, uint64_t frameID, const String& function, Vector<String> arguments, bool expectsImplicitCallbackArgument, int callbackTimeout, uint64_t callbackID);
62     void resolveChildFrameWithOrdinal(uint64_t pageID, uint64_t frameID, uint32_t ordinal, uint64_t callbackID);
63     void resolveChildFrameWithNodeHandle(uint64_t pageID, uint64_t frameID, const String& nodeHandle, uint64_t callbackID);
64     void resolveChildFrameWithName(uint64_t pageID, uint64_t frameID, const String& name, uint64_t callbackID);
65     void resolveParentFrame(uint64_t pageID, uint64_t frameID, uint64_t callbackID);
66     void focusFrame(uint64_t pageID, uint64_t frameID);
67     void computeElementLayout(uint64_t pageID, uint64_t frameID, String nodeHandle, bool scrollIntoViewIfNeeded, bool useViewportCoordinates, uint64_t callbackID);
68     void takeScreenshot(uint64_t pageID, uint64_t callbackID);
69     void getCookiesForFrame(uint64_t pageID, uint64_t frameID, uint64_t callbackID);
70     void deleteCookie(uint64_t pageID, uint64_t frameID, String cookieName, uint64_t callbackID);
71
72     String m_sessionIdentifier;
73
74     HashMap<uint64_t, JSObjectRef, DefaultHash<uint64_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> m_webFrameScriptObjectMap;
75     HashMap<uint64_t, Vector<uint64_t>, DefaultHash<uint64_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> m_webFramePendingEvaluateJavaScriptCallbacksMap;
76 };
77
78 } // namespace WebKit
79
80 #endif // WebAutomationSessionProxy_h