Unreviewed, rolling out r150386 and r150397.
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / InjectedBundlePage.h
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 InjectedBundlePage_h
27 #define InjectedBundlePage_h
28
29 #include <WebKit2/WKBundlePage.h>
30 #include <WebKit2/WKBundleScriptWorld.h>
31 #include <WebKit2/WKRetainPtr.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WTR {
35
36 class InjectedBundlePage {
37 public:
38     InjectedBundlePage(WKBundlePageRef);
39     ~InjectedBundlePage();
40
41     WKBundlePageRef page() const { return m_page; }
42
43     void dump();
44
45     void stopLoading();
46
47     void prepare();
48     void resetAfterTest();
49
50     void dumpBackForwardList(WTF::StringBuilder&);
51
52 private:
53     // Loader Client
54     static void didStartProvisionalLoadForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
55     static void didReceiveServerRedirectForProvisionalLoadForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
56     static void didFailProvisionalLoadWithErrorForFrame(WKBundlePageRef, WKBundleFrameRef, WKErrorRef, WKTypeRef*, const void*);
57     static void didCommitLoadForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
58     static void didFinishLoadForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
59     static void didFinishProgress(WKBundlePageRef, const void*);
60     static void didFinishDocumentLoadForFrame(WKBundlePageRef, WKBundleFrameRef,  WKTypeRef*, const void*);
61     static void didFailLoadWithErrorForFrame(WKBundlePageRef, WKBundleFrameRef, WKErrorRef, WKTypeRef*, const void*);
62     static void didReceiveTitleForFrame(WKBundlePageRef, WKStringRef title, WKBundleFrameRef, WKTypeRef*, const void*);
63     static void didClearWindowForFrame(WKBundlePageRef, WKBundleFrameRef, WKBundleScriptWorldRef, const void*);
64     static void didCancelClientRedirectForFrame(WKBundlePageRef, WKBundleFrameRef, const void*);
65     static void willPerformClientRedirectForFrame(WKBundlePageRef, WKBundleFrameRef, WKURLRef url, double delay, double date, const void*);
66     static void didSameDocumentNavigationForFrame(WKBundlePageRef, WKBundleFrameRef, WKSameDocumentNavigationType, WKTypeRef*, const void*);
67     static void didHandleOnloadEventsForFrame(WKBundlePageRef, WKBundleFrameRef, const void*);
68     static void didDisplayInsecureContentForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
69     static void didRunInsecureContentForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
70     static void didDetectXSSForFrame(WKBundlePageRef, WKBundleFrameRef, WKTypeRef*, const void*);
71     static void didInitiateLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLRequestRef, bool pageLoadIsProvisional, const void*);
72     static WKURLRequestRef willSendRequestForFrame(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLRequestRef, WKURLResponseRef, const void*);
73     static void didReceiveResponseForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLResponseRef, const void*);
74     static void didReceiveContentLengthForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, uint64_t length, const void*);
75     static void didFinishLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, const void*);
76     static void didFailLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKErrorRef, const void*);
77     static bool shouldCacheResponse(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, const void*);
78
79     void didStartProvisionalLoadForFrame(WKBundleFrameRef);
80     void didReceiveServerRedirectForProvisionalLoadForFrame(WKBundleFrameRef);
81     void didFailProvisionalLoadWithErrorForFrame(WKBundleFrameRef, WKErrorRef);
82     void didCommitLoadForFrame(WKBundleFrameRef);
83     void didFinishLoadForFrame(WKBundleFrameRef);
84     void didFinishProgress();
85     void didFailLoadWithErrorForFrame(WKBundleFrameRef, WKErrorRef);
86     void didReceiveTitleForFrame(WKStringRef title, WKBundleFrameRef);
87     void didClearWindowForFrame(WKBundleFrameRef, WKBundleScriptWorldRef);
88     void didCancelClientRedirectForFrame(WKBundleFrameRef);
89     void willPerformClientRedirectForFrame(WKBundleFrameRef, WKURLRef url, double delay, double date);
90     void didSameDocumentNavigationForFrame(WKBundleFrameRef, WKSameDocumentNavigationType);
91     void didFinishDocumentLoadForFrame(WKBundleFrameRef);
92     void didHandleOnloadEventsForFrame(WKBundleFrameRef);
93     void didDisplayInsecureContentForFrame(WKBundleFrameRef);
94     void didRunInsecureContentForFrame(WKBundleFrameRef);
95     void didDetectXSSForFrame(WKBundleFrameRef);
96
97     // Resource Load Client
98     void didInitiateLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLRequestRef, bool pageLoadIsProvisional);
99     WKURLRequestRef willSendRequestForFrame(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLRequestRef, WKURLResponseRef);
100     void didReceiveResponseForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKURLResponseRef);
101     void didReceiveContentLengthForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, uint64_t length);
102     void didFinishLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier);
103     void didFailLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKErrorRef);
104     bool shouldCacheResponse(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier);
105
106     // WKBundlePagePolicyClient
107     static WKBundlePagePolicyAction decidePolicyForNavigationAction(WKBundlePageRef, WKBundleFrameRef, WKBundleNavigationActionRef, WKURLRequestRef, WKTypeRef*, const void*);
108     static WKBundlePagePolicyAction decidePolicyForNewWindowAction(WKBundlePageRef, WKBundleFrameRef, WKBundleNavigationActionRef, WKURLRequestRef, WKStringRef frameName, WKTypeRef*, const void*);
109     static WKBundlePagePolicyAction decidePolicyForResponse(WKBundlePageRef, WKBundleFrameRef, WKURLResponseRef, WKURLRequestRef, WKTypeRef*, const void*);
110     static void unableToImplementPolicy(WKBundlePageRef, WKBundleFrameRef, WKErrorRef, WKTypeRef*, const void*);
111     WKBundlePagePolicyAction decidePolicyForNavigationAction(WKBundlePageRef, WKBundleFrameRef, WKBundleNavigationActionRef, WKURLRequestRef, WKTypeRef*);
112     WKBundlePagePolicyAction decidePolicyForNewWindowAction(WKBundlePageRef, WKBundleFrameRef, WKBundleNavigationActionRef, WKURLRequestRef, WKStringRef frameName, WKTypeRef*);
113     WKBundlePagePolicyAction decidePolicyForResponse(WKBundlePageRef, WKBundleFrameRef, WKURLResponseRef, WKURLRequestRef, WKTypeRef*);
114     void unableToImplementPolicy(WKBundlePageRef, WKBundleFrameRef, WKErrorRef, WKTypeRef*);
115
116     // UI Client
117     static void willAddMessageToConsole(WKBundlePageRef, WKStringRef message, uint32_t lineNumber, const void* clientInfo);
118     static void willSetStatusbarText(WKBundlePageRef, WKStringRef statusbarText, const void* clientInfo);
119     static void willRunJavaScriptAlert(WKBundlePageRef, WKStringRef message, WKBundleFrameRef frame, const void* clientInfo);
120     static void willRunJavaScriptConfirm(WKBundlePageRef, WKStringRef message, WKBundleFrameRef frame, const void* clientInfo);
121     static void willRunJavaScriptPrompt(WKBundlePageRef, WKStringRef message, WKStringRef defaultValue, WKBundleFrameRef frame, const void* clientInfo);
122     static void didReachApplicationCacheOriginQuota(WKBundlePageRef, WKSecurityOriginRef, int64_t totalBytesNeeded, const void* clientInfo);
123     static uint64_t didExceedDatabaseQuota(WKBundlePageRef, WKSecurityOriginRef, WKStringRef databaseName, WKStringRef databaseDisplayName, uint64_t currentQuotaBytes, uint64_t currentOriginUsageBytes, uint64_t currentDatabaseUsageBytes, uint64_t expectedUsageBytes, const void* clientInfo);
124     void willAddMessageToConsole(WKStringRef message, uint32_t lineNumber);
125     void willSetStatusbarText(WKStringRef statusbarText);
126     void willRunJavaScriptAlert(WKStringRef message, WKBundleFrameRef);
127     void willRunJavaScriptConfirm(WKStringRef message, WKBundleFrameRef);
128     void willRunJavaScriptPrompt(WKStringRef message, WKStringRef defaultValue, WKBundleFrameRef);
129     void didReachApplicationCacheOriginQuota(WKSecurityOriginRef, int64_t totalBytesNeeded);
130     uint64_t didExceedDatabaseQuota(WKSecurityOriginRef, WKStringRef databaseName, WKStringRef databaseDisplayName, uint64_t currentQuotaBytes, uint64_t currentOriginUsageBytes, uint64_t currentDatabaseUsageBytes, uint64_t expectedUsageBytes);
131
132 #if ENABLE(FULLSCREEN_API)
133     // Full Screen client
134     static bool supportsFullScreen(WKBundlePageRef, WKFullScreenKeyboardRequestType);
135     static void setHasCustomFullScreenBehavior(WKBundlePageRef, bool value);
136     static void enterFullScreenForElement(WKBundlePageRef, WKBundleNodeHandleRef element);
137     static void exitFullScreenForElement(WKBundlePageRef, WKBundleNodeHandleRef element);
138     static void beganEnterFullScreen(WKBundlePageRef, WKRect initialFrame, WKRect finalFrame);
139     static void beganExitFullScreen(WKBundlePageRef, WKRect initialFrame, WKRect finalFrame);
140     static void closeFullScreen(WKBundlePageRef);
141 #endif
142
143     // Editor client
144     static bool shouldBeginEditing(WKBundlePageRef, WKBundleRangeHandleRef, const void* clientInfo);
145     static bool shouldEndEditing(WKBundlePageRef, WKBundleRangeHandleRef, const void* clientInfo);
146     static bool shouldInsertNode(WKBundlePageRef, WKBundleNodeHandleRef, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType, const void* clientInfo);
147     static bool shouldInsertText(WKBundlePageRef, WKStringRef, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType, const void* clientInfo);
148     static bool shouldDeleteRange(WKBundlePageRef, WKBundleRangeHandleRef, const void* clientInfo);
149     static bool shouldChangeSelectedRange(WKBundlePageRef, WKBundleRangeHandleRef fromRange, WKBundleRangeHandleRef toRange, WKAffinityType, bool stillSelecting, const void* clientInfo);
150     static bool shouldApplyStyle(WKBundlePageRef, WKBundleCSSStyleDeclarationRef style, WKBundleRangeHandleRef range, const void* clientInfo);
151     static void didBeginEditing(WKBundlePageRef, WKStringRef notificationName, const void* clientInfo);
152     static void didEndEditing(WKBundlePageRef, WKStringRef notificationName, const void* clientInfo);
153     static void didChange(WKBundlePageRef, WKStringRef notificationName, const void* clientInfo);
154     static void didChangeSelection(WKBundlePageRef, WKStringRef notificationName, const void* clientInfo);
155     bool shouldBeginEditing(WKBundleRangeHandleRef);
156     bool shouldEndEditing(WKBundleRangeHandleRef);
157     bool shouldInsertNode(WKBundleNodeHandleRef, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType);
158     bool shouldInsertText(WKStringRef, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType);
159     bool shouldDeleteRange(WKBundleRangeHandleRef);
160     bool shouldChangeSelectedRange(WKBundleRangeHandleRef fromRange, WKBundleRangeHandleRef toRange, WKAffinityType, bool stillSelecting);
161     bool shouldApplyStyle(WKBundleCSSStyleDeclarationRef style, WKBundleRangeHandleRef range);
162     void didBeginEditing(WKStringRef notificationName);
163     void didEndEditing(WKStringRef notificationName);
164     void didChange(WKStringRef notificationName);
165     void didChangeSelection(WKStringRef notificationName);
166
167     void dumpAllFramesText(WTF::StringBuilder&);
168     void dumpAllFrameScrollPositions(WTF::StringBuilder&);
169     void dumpDOMAsWebArchive(WKBundleFrameRef, WTF::StringBuilder&);
170
171     void platformDidStartProvisionalLoadForFrame(WKBundleFrameRef);
172
173     void frameDidChangeLocation(WKBundleFrameRef, bool shouldDump = false);
174
175     WKBundlePageRef m_page;
176     WKRetainPtr<WKBundleScriptWorldRef> m_world;
177     WKRetainPtr<WKBundleBackForwardListItemRef> m_previousTestBackForwardListItem;
178 };
179
180 } // namespace WTR
181
182 #endif // InjectedBundlePage_h